Spec-Zone.ru › AWS CLI v2

[ aws . codeguru-security ]

get-findings

Описание

Возвращает список всех результатов сканирования, сгенерированных определенным сканированием.

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

get-findings является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: findings

Синтаксис

  get-findings
--scan-name <value>
[--status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--scan-name (строка)

Имя сканирования, из которого нужно получить результаты.

--status (строка)

Статус результатов, которые нужно получить. Передайте значение Open , Closed или All.

Возможные значения:

  • Closed
  • Open
  • All

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

--starting-token (строка)

Токен для указания точки начала постраничной выборки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной выборки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

findings -> (список)

Список результатов, сгенерированных указанным сканированием.

(структура)

Информация об обнаруженном результатах в вашем коде.

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

Время создания результата.

description -> (строка)

Описание результата.

detectorId -> (строка)

Идентификатор детектора, который обнаружил результат в вашем коде. Детектор — это определённое правило, основанное на отраслевых стандартах и рекомендациях AWS.

detectorName -> (строка)

Название детектора, который выявил уязвимость безопасности в вашем коде.

detectorTags -> (список)

Один или несколько тегов или категорий, связанных с детектором. Эти теги определены по типу, языку программирования или другой классификации, например, по поддержке или согласованности.

(строка)

generatorId -> (строка)

Идентификатор компонента, который сгенерировал результат, например, AmazonCodeGuruSecurity.

id -> (строка)

Идентификатор результата.

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

Объект, содержащий сведения о том, как устранить результат.

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

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

text -> (строка)

Рекомендованный способ устранения результата.

url -> (строка)

Адрес URL-адреса рекомендации по устранению результата.

suggestedFixes -> (список)

Список SuggestedFix объектов. Каждый объект содержит информацию о предложенном исправлении кода для устранения результата.

(структура)

Информация о предложенном исправлении кода для устранения результата.

code -> (строка)

Предложенное исправление кода. При необходимости включает исправление кода для замены исходного кода.

description -> (строка)

Описание предложенного исправления кода и причины его предложения.

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

Ресурс, где Amazon CodeGuru Security обнаружил результат.

id -> (строка)

scanName сканирования, которое было запущено на ресурсе.

subResourceId -> (строка)

Идентификатор раздела ресурса.

ruleId -> (строка)

Идентификатор правила, которое сгенерировало результат.

severity -> (строка)

Серьёзность результата. Серьёзность может быть критической, высокой, средней, низкой или информационной. Сведения о уровнях серьёзности см. в разделе «Уровни серьёзности результатов» в Руководстве пользователя Amazon CodeGuru Security.

status -> (строка)

Статус результата. Статус результата может быть открытым или закрытым.

title -> (строка)

Заголовок результата.

type -> (строка)

Тип результата.

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

Время последнего обновления результата. Результаты обновляются при устранении или изменении расположения кода результата.

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

Объект, описывающий обнаруженную уязвимость безопасности.

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

Объект, описывающий расположение обнаруженной уязвимости безопасности в вашем коде.

codeSnippet -> (список)

Список CodeLine объектов, описывающих, где уязвимость безопасности появляется в вашем коде.

(структура)

Строка кода, где был обнаружен результат.

content -> (строка)

Код, содержащий уязвимость.

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

Номер строки кода.

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

Последний номер строки фрагмента кода, где появляется уязвимость безопасности в вашем коде.

name -> (строка)

Имя файла.

path -> (строка)

Путь к ресурсу с уязвимостью безопасности.

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

Первый номер строки фрагмента кода, где появляется уязвимость безопасности в вашем коде.

id -> (строка)

Идентификатор уязвимости.

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

Количество раз, когда уязвимость появляется в вашем коде.

referenceUrls -> (список)

Один или несколько URL-адресов, содержащих сведения об уязвимости.

(строка)

relatedVulnerabilities -> (список)

Одна или несколько уязвимостей, связанных с описываемой уязвимостью.

(строка)

nextToken -> (строка)

Токен постраничной выборки. Вы можете использовать его в будущих вызовах GetFindings для продолжения перечисления результатов после текущей страницы.

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

Spec-Zone.ru

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