создание группы отчетов
Описание
Создает группу отчетов. Группа отчетов содержит набор отчетов.
См. также: Документация API AWS
Синтаксис
create-report-group
--name <value>
--type <value>
--export-config <value>
[--tags <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]
Параметры
--name (строка)
--type (строка)
Тип группы отчетов.
Возможные значения:
TESTCODE_COVERAGE
--export-config (структура)
Объект ReportExportConfig, содержащий информацию о том, куда экспортируются результаты тестирования группы отчетов.
exportConfigType -> (строка)
Тип конфигурации экспорта. Допустимые значения:
-
S3: Результаты отчетов экспортируются в ведро S3. -
NO_EXPORT: Результаты отчетов не экспортируются.
s3Destination -> (структура)
Объект S3ReportExportConfig, содержащий информацию о ведре S3, в которое экспортируются результаты выполнения отчета.
bucket -> (строка)
bucketOwner -> (строка)
path -> (строка)
packaging -> (строка)
Тип артефакта выходных данных сборки для создания. Допустимые значения включают:
-
NONE: CodeBuild создает исходные данные в ведре вывода. Это значение по умолчанию, если packaging не указано. -
ZIP: CodeBuild создает ZIP-архив с исходными данными в ведре вывода.
encryptionKey -> (строка)
encryptionDisabled -> (булево)
Сокращенный синтаксис:
exportConfigType=string,s3Destination={bucket=string,bucketOwner=string,path=string,packaging=string,encryptionKey=string,encryptionDisabled=boolean}
Синтаксис JSON:
{
"exportConfigType": "S3"|"NO_EXPORT",
"s3Destination": {
"bucket": "string",
"bucketOwner": "string",
"path": "string",
"packaging": "ZIP"|"NONE",
"encryptionKey": "string",
"encryptionDisabled": true|false
}
}
--tags (список)
Список пар ключ-значение тегов, связанных с этой группой отчетов.
Эти теги доступны для использования сервисами Amazon Web Services, поддерживающими теги группы отчетов CodeBuild.
(структура)
Тег, состоящий из ключа и значения.
Этот тег доступен для использования сервисами Amazon Web Services, поддерживающими теги в CodeBuild.
key -> (строка)
value -> (строка)
Сокращенный синтаксис:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "string",
"value": "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.
Следующий пример create-report-group создает новую группу отчетов.
aws codebuild create-report-group \
--cli-input-json file://create-report-group-source.json
Содержимое create-report-group-source.json:
{
"name": "cli-created-report-group",
"type": "TEST",
"exportConfig": {
"exportConfigType": "S3",
"s3Destination": {
"bucket": "amzn-s3-demo-bucket",
"path": "",
"packaging": "ZIP",
"encryptionDisabled": true
}
}
}
Вывод:
{
"reportGroup": {
"arn": "arn:aws:codebuild:<region-ID>:<user-ID>:report-group/cli-created-report-group",
"name": "cli-created-report-group",
"type": "TEST",
"exportConfig": {
"exportConfigType": "S3",
"s3Destination": {
"bucket": "amzn-s3-demo-bucket",
"path": "",
"packaging": "ZIP",
"encryptionDisabled": true
}
},
"created": 1602020026.775,
"lastModified": 1602020026.775
}
}
Для получения дополнительной информации см. Работа с группами отчетов в Руководстве пользователя AWS CodeBuild.
Вывод
reportGroup -> (структура)
Информация о созданной группе отчетов.
arn -> (строка)
ReportGroup .name -> (строка)
ReportGroup .type -> (строка)
Тип созданной ReportGroup . Может иметь одно из следующих значений:
Группа отчетов содержит отчеты о покрытии кода.
Группа отчетов содержит отчеты о тестах.
exportConfig -> (структура)
Информация о месте назначения, куда экспортируются исходные данные этой ReportGroup .
exportConfigType -> (строка)
Тип конфигурации экспорта. Допустимые значения:
-
S3: Результаты отчетов экспортируются в ведро S3. -
NO_EXPORT: Результаты отчетов не экспортируются.
s3Destination -> (структура)
Объект S3ReportExportConfig, содержащий информацию о ведре S3, в которое экспортируется выполнение отчета.
bucket -> (строка)
bucketOwner -> (строка)
path -> (строка)
packaging -> (строка)
Тип артефакта выходных данных сборки для создания. Допустимые значения включают:
-
NONE: CodeBuild создает исходные данные в ведре вывода. Это значение по умолчанию, если packaging не указано. -
ZIP: CodeBuild создает ZIP-архив с исходными данными в ведре вывода.
encryptionKey -> (строка)
encryptionDisabled -> (булево)
created -> (метка времени)
ReportGroup .lastModified -> (метка времени)
ReportGroup .tags -> (список)
Список пар ключ-значение тегов, связанных с этой группой отчетов.
Эти теги доступны для использования сервисами Amazon Web Services, поддерживающими теги группы отчетов CodeBuild.
(структура)
Тег, состоящий из ключа и значения.
Этот тег доступен для использования сервисами Amazon Web Services, поддерживающими теги в CodeBuild.
key -> (строка)
value -> (строка)
status -> (строка)
Статус группы отчетов. Это свойство является только для чтения.
Это может быть одно из следующих значений:
Группа отчетов активна.
Группа отчетов находится в процессе удаления.
© Copyright 2025, Amazon Web Services. Created using Sphinx.