[ aws . codeguru-security ]
batch-get-findings
Описание
Возвращает список запрошенных находок из стандартных сканирований.
См. также: Документацию API AWS
Синтаксис
batch-get-findings
--finding-identifiers <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]
Параметры
--finding-identifiers (список)
Список идентификаторов находок. Каждый идентификатор состоит из scanName и findingId. Вы получаете findingId при вызове GetFindings.
(структура)
Объект, содержащий информацию о находке и сканировании, которое её выявило.
findingId -> (строка)
scanName -> (строка)
Сокращённый синтаксис:
findingId=string,scanName=string ...
Синтаксис JSON:
[
{
"findingId": "string",
"scanName": "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-auto-prompt (логическое значение)
Автоматически запрашивать входные параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса входных параметров CLI.
Вывод
failedFindings -> (список)
Список ошибок для отдельных находок, которые не были получены. Каждый BatchGetFindingsError содержит scanName, findingId, errorCode и ошибку message.
(структура)
Содержит информацию об ошибке, которая привела к тому, что находка не была получена.
errorCode -> (строка)
findingId -> (строка)
message -> (строка)
scanName -> (строка)
findings -> (список)
Список всех находок, которые были успешно получены.
(структура)
Информация о находке, обнаруженной Amazon CodeGuru Security в вашем коде.
createdAt -> (временная метка)
description -> (строка)
detectorId -> (строка)
detectorName -> (строка)
detectorTags -> (список)
Один или несколько тегов или категорий, связанных с детектором. Эти теги определяются по типу, языку программирования или другим классификациям, таким как поддерживаемость или согласованность.
(строка)
generatorId -> (строка)
id -> (строка)
remediation -> (структура)
Объект, содержащий сведения о том, как устранить находку.
recommendation -> (структура)
Объект, содержащий информацию о рекомендуемом способе устранения находки.
text -> (строка)
url -> (строка)
suggestedFixes -> (список)
Список объектов SuggestedFix. Каждый объект содержит информацию о предложенном исправлении кода для устранения находки.
(структура)
Информация о предложенном исправлении кода для устранения находки.
code -> (строка)
description -> (строка)
resource -> (структура)
Ресурс, где Amazon CodeGuru Security обнаружил находку.
id -> (строка)
scanName сканирования, которое было выполнено на ресурсе.subResourceId -> (строка)
ruleId -> (строка)
severity -> (строка)
status -> (строка)
title -> (строка)
type -> (строка)
updatedAt -> (временная метка)
vulnerability -> (структура)
Объект, описывающий обнаруженную уязвимость безопасности.
filePath -> (структура)
Объект, описывающий расположение обнаруженной уязвимости безопасности в вашем коде.
codeSnippet -> (список)
Список объектов CodeLine, которые описывают, где появляется уязвимость безопасности в вашем коде.
(структура)
Строка кода, где была обнаружена находка.
content -> (строка)
number -> (целое число)
endLine -> (целое число)
name -> (строка)
path -> (строка)
startLine -> (целое число)
id -> (строка)
itemCount -> (целое число)
referenceUrls -> (список)
Один или несколько URL-адресов, которые содержат подробности об уязвимости.
(строка)
relatedVulnerabilities -> (список)
Одна или несколько уязвимостей, связанных с описываемой уязвимостью.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|