[ aws . codeguru-security ]
create-scan
Описание
Используется для создания сканирования с использованием кода, загруженного в ведро Amazon S3.
См. также: Документация API AWS
Синтаксис
create-scan
[--analysis-type <value>]
[--client-token <value>]
--resource-id <value>
--scan-name <value>
[--scan-type <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]
Параметры
--analysis-type (строка)
Тип анализа, который CodeGuru Security должен выполнить при сканировании, либо Security, либо All. Тип Security генерирует только результаты, относящиеся к безопасности. Тип All генерирует как результаты по безопасности, так и результаты качества. По умолчанию используется тип Security, если он не указан.
Возможные значения:
SecurityAll
--client-token (строка)
--resource-id (структура помеченных союзов)
Идентификатор объекта ресурса, который будет просканирован.
Примечание
Это структура помеченных союзов. Только один из следующих верхних уровней ключей может быть задан:codeArtifactId.codeArtifactId -> (строка)
CreateUploadUrl при загрузке ресурсов для сканирования.Сокращенный синтаксис:
codeArtifactId=string
Синтаксис JSON:
{
"codeArtifactId": "string"
}
--scan-name (строка)
STANDARD.--scan-type (строка)
Тип сканирования, либо Standard, либо Express. По умолчанию используется тип Standard, если он не указан.
Express сканирования выполняются на ограниченных ресурсах и используют ограниченный набор детекторов для анализа вашего кода в режиме реального времени. Standard сканирования имеют стандартные ограничения ресурсов и используют полный набор детекторов для анализа вашего кода.Возможные значения:
StandardExpress
--tags (массив)
Массив пар ключ-значение, используемых для тегирования сканирования. Тег — это пользовательская метка атрибута с двумя частями:
- Ключ тега. Например,
CostCenter,EnvironmentилиSecret. Ключи тегов чувствительны к регистру. - Необязательное поле значения тега. Например,
111122223333,Productionили имя команды. Пропуск значения тега эквивалентен использованию пустой строки. Значения тегов чувствительны к регистру.
key -> (строка)
value -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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.
Вывод
resourceId -> (структура помеченных союзов)
Идентификатор объекта ресурса, содержащего просканированные ресурсы.
Примечание
Это структура помеченных союзов. Только один из следующих верхних уровней ключей может быть задан:codeArtifactId.codeArtifactId -> (строка)
CreateUploadUrl при загрузке ресурсов для сканирования.runId -> (строка)
scanName -> (строка)
scanNameArn -> (строка)
scanState -> (строка)
InProgress, либо Successful, либо Failed.
© Copyright 2025, Amazon Web Services. Created using Sphinx.