Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

batch-get-reports

Описание

Возвращает массив отчетов.

См. также: Документация API AWS

Синтаксис

  batch-get-reports
--report-arns <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--report-arns (список)

Массив ARNs, идентифицирующих объекты Report, которые нужно вернуть.

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладовую запись в журнал.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для заданной настройки cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страниц CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы входных параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее об этом см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. Подробнее см. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы получить информацию об одном или нескольких отчетах в AWS CodeBuild.

Следующий пример batch-get-reports извлекает информацию об отчетах с указанными ARN.

aws codebuild batch-get-reports \
    --report-arns arn:aws:codebuild:<region-ID>:<user-ID>:report/<report-group-name>:<report 1 ID> arn:aws:codebuild:<region-ID>:<user-ID>:report/<report-group-name>:<report 2 ID>

Вывод:

{
    "reports": [
        {
            "arn": "arn:aws:codebuild:<region-ID>:<user-ID>:report/<report-group-name>:<report 1 ID>",
            "type": "TEST",
            "name": "<report-group-name>",
            "reportGroupArn": "arn:aws:codebuild:<region-ID>:<user-ID>:report-group/<report-group-name>",
            "executionId": "arn:aws:codebuild:<region-ID>:<user-ID>:build/test-reports:<ID>",
            "status": "FAILED",
            "created": "2020-10-01T11:25:22.531000-07:00",
            "expired": "2020-10-31T11:25:22-07:00",
            "exportConfig": {
                "exportConfigType": "NO_EXPORT"
            },
            "truncated": false,
            "testSummary": {
                "total": 28,
                "statusCounts": {
                    "ERROR": 5,
                    "FAILED": 1,
                    "SKIPPED": 4,
                    "SUCCEEDED": 18,
                    "UNKNOWN": 0
                },
                "durationInNanoSeconds": 94000000
            }
        },
        {
            "arn": "arn:aws:codebuild:<region-ID>:<user-ID>:report/<report-group-name>:<report 2 ID>",
            "type": "TEST",
            "name": "<report-group-name>",
            "reportGroupArn": "arn:aws:codebuild:<region-ID>:<user-ID>:report-group/<report-group-name>",
            "executionId": "arn:aws:codebuild:<region-ID>:<user-ID>:build/test-reports:<ID>",
            "status": "FAILED",
            "created": "2020-10-01T11:13:05.816000-07:00",
            "expired": "2020-10-31T11:13:05-07:00",
            "exportConfig": {
                "exportConfigType": "NO_EXPORT"
            },
            "truncated": false,
            "testSummary": {
                "total": 28,
                "statusCounts": {
                    "ERROR": 5,
                    "FAILED": 1,
                    "SKIPPED": 4,
                    "SUCCEEDED": 18,
                    "UNKNOWN": 0
                },
                "durationInNanoSeconds": 94000000
            }
        }
    ],
    "reportsNotFound": []
}

Дополнительную информацию см. в разделе Работа с отчетами в Руководстве пользователя AWS CodeBuild.

Вывод

reports -> (список)

Массив объектов Report, возвращённых BatchGetReports.

(структура)

Информация о результатах выполнения ряда наборов тестовых случаев во время выполнения проекта сборки. Тестовые случаи указываются в buildspec для проекта сборки с использованием одного или нескольких путей к файлам тестовых случаев. Можно указывать любые типы тестов, такие как unit-тесты, интеграционные тесты и функциональные тесты.

arn -> (строка)

ARN выполнения отчета.

type -> (строка)

Тип отчета, который был выполнен.

CODE_COVERAGE

Отчет о покрытии кода.

TEST

Отчет о результатах тестирования.

name -> (строка)

Имя отчета, который был выполнен.

reportGroupArn -> (строка)

ARN группы отчетов, связанной с этим отчетом.

executionId -> (строка)

ARN выполнения сборки, которая сгенерировала этот отчет.

status -> (строка)

Статус этого отчета.

created -> (метка времени)

Дата и время выполнения этого отчета.

expired -> (метка времени)

Дата и время истечения срока действия отчета. Срок действия отчета истекает через 30 дней после его создания. Истекший отчет недоступен для просмотра в CodeBuild.

exportConfig -> (структура)

Информация о том, куда были экспортированы исходные данные, используемые для генерации этого отчета.

exportConfigType -> (строка)

Тип конфигурации экспорта. Допустимые значения:

  • S3 : Результаты отчета экспортируются в хранилище S3.
  • NO_EXPORT : Результаты отчета не экспортируются.

s3Destination -> (структура)

Объект S3ReportExportConfig, содержащий информацию о хранилище S3, в которое экспортируется выполнение отчета.

bucket -> (строка)

Название хранилища S3, в которое экспортируются исходные данные отчета.

bucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services владельца хранилища Amazon S3. Это позволяет экспортировать данные отчета в хранилище Amazon S3, принадлежащее учетной записи, отличной от учетной записи, выполняющей сборку.

path -> (строка)

Путь к экспортированным результатам исходных данных отчета.

packaging -> (строка)

Тип артефакта выходных данных сборки для создания. Допустимые значения включают:

  • NONE : CodeBuild создает исходные данные в выходном хранилище. Это значение по умолчанию, если упаковка не указана.
  • ZIP : CodeBuild создает ZIP-архив с исходными данными в выходном хранилище.

encryptionKey -> (строка)

Ключ шифрования для зашифрованных исходных данных отчета.

encryptionDisabled -> (логическое значение)

Логическое значение, указывающее, зашифрованы ли результаты отчета.

truncated -> (логическое значение)

Логическое значение, указывающее, усечен ли данный запуск отчета. Список тестовых случаев усекается после достижения максимального количества тестовых случаев.

testSummary -> (структура)

Объект TestReportSummary, содержащий информацию об этом отчете о результатах тестирования.

total -> (целое число)

Количество тестовых случаев в этом TestReportSummary. Общая сумма включает усечённые тестовые случаи.

statusCounts -> (карта)

Карта, содержащая количество каждого типа статуса, возвращенного результатами тестирования в этом TestReportSummary.

ключ -> (строка)

значение -> (целое число)

durationInNanoSeconds -> (длинное целое число)

Количество наносекунд, затраченное на выполнение всех тестовых случаев в этом отчете.

codeCoverageSummary -> (структура)

Объект CodeCoverageReportSummary, содержащий сводку по покрытию кода для этого отчета.

lineCoveragePercentage -> (двойное число)

Процент строк, покрытых вашими тестами.

linesCovered -> (целое число)

Количество строк, покрытых вашими тестами.

linesMissed -> (целое число)

Количество строк, которые не покрыты вашими тестами.

branchCoveragePercentage -> (двойное число)

Процент ветвей, покрытых вашими тестами.

branchesCovered -> (целое число)

Количество условных ветвей, покрытых вашими тестами.

branchesMissed -> (целое число)

Количество условных ветвей, которые не покрыты вашими тестами.

reportsNotFound -> (список)

Массив ARN, переданных в BatchGetReportGroups, которые не связаны с Report.

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API