Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

batch-get-report-groups

Описание

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

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

Синтаксис

  batch-get-report-groups
--report-group-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-group-arns (список)

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

(строка)

Синтаксис:

"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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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-report-groups пример получает информацию о группе отчетов с указанным ARN.

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

Вывод:

{
    "reportGroups": [
        {
            "arn": "arn:aws:codebuild:<region-ID>:<user-ID>:report-group/<report-group-name>",
            "name": "report-group-name",
            "type": "TEST",
            "exportConfig": {
                "exportConfigType": "NO_EXPORT"
            },
            "created": "2020-10-01T18:04:08.466000+00:00",
            "lastModified": "2020-10-01T18:04:08.466000+00:00",
            "tags": []
        }
    ],
    "reportGroupsNotFound": []
}

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

Вывод

reportGroups -> (список)

Массив групп отчетов, возвращаемых BatchGetReportGroups.

(структура)

Ряд отчетов. Каждый отчет содержит информацию о результатах выполнения ряда наборов тестов. Наборы тестов для группы отчетов указываются в buildspec для проекта сборки с использованием одного или нескольких путей к файлам наборов тестов.

arn -> (строка)

ARN ReportGroup.

name -> (строка)

Имя ReportGroup.

type -> (строка)

Тип ReportGroup. Это может быть одно из следующих значений:

CODE_COVERAGE

Группа отчетов содержит отчеты о покрытии кода.

TEST

Группа отчетов содержит отчеты о тестах.

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

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

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 -> (булево)

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

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

Дата и время создания ReportGroup.

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

Дата и время последнего изменения ReportGroup.

tags -> (список)

Список пар ключ-значение тегов, связанных с этой группой отчетов.

Эти теги доступны для использования службами Amazon Web Services, поддерживающими теги групп отчетов CodeBuild.

(структура)

Тег, состоящий из ключа и значения.

Этот тег доступен для использования службами Amazon Web Services, поддерживающими теги в CodeBuild.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

status -> (строка)

Статус группы отчетов. Это свойство только для чтения.

Это может быть одно из следующих значений:

ACTIVE

Группа отчетов активна.

DELETING

Группа отчетов находится в процессе удаления.

reportGroupsNotFound -> (список)

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

(строка)

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

Spec-Zone.ru

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