Spec-Zone.ru › AWS CLI v2

[ aws . inspector ]

list-findings

Описание

Отображает данные о найденных проблемах, сгенерированных в ходе проверок, указанных с помощью ARNs соответствующих проверочных задач.

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

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

Синтаксис

  list-findings
[--assessment-run-arns <value>]
[--filter <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]

Параметры

--assessment-run-arns (список)

ARNы проверочных задач, результаты которых нужно получить.

(строка)

Синтаксис:

"string" "string" ...

--filter (структура)

Этот параметр позволяет указать подмножество данных, которые должны быть включены в ответ на действие.

Для соответствия записи фильтру все указанные атрибуты фильтра должны совпадать. Если для атрибута фильтра указано несколько значений, может совпасть любое из них.

agentIds -> (список)

Для соответствия записи фильтру одно из значений, указанных для этого свойства типа данных, должно точно совпадать со значением свойства agentId типа данных Finding.

(строка)

autoScalingGroups -> (список)

Для соответствия записи фильтру одно из значений, указанных для этого свойства типа данных, должно точно совпадать со значением свойства autoScalingGroup типа данных Finding.

(строка)

ruleNames -> (список)

Для соответствия записи фильтру одно из значений, указанных для этого свойства типа данных, должно точно совпадать со значением свойства ruleName типа данных Finding.

(строка)

severities -> (список)

Для соответствия записи фильтру одно из значений, указанных для этого свойства типа данных, должно точно совпадать со значением свойства severity типа данных Finding.

(строка)

rulesPackageArns -> (список)

Для соответствия записи фильтру одно из значений, указанных для этого свойства типа данных, должно точно совпадать со значением свойства rulesPackageArn типа данных Finding.

(строка)

attributes -> (список)

Для соответствия записи фильтру список значений, указанных для этого свойства типа данных, должен содержаться в списке значений свойства attributes типа данных Finding.

(структура)

Этот тип данных используется в качестве параметра запроса в действиях AddAttributesToFindings и CreateAssessmentTemplate.

key -> (строка)

Ключ атрибута.

value -> (строка)

Значение, присвоенное ключу атрибута.

userAttributes -> (список)

Для соответствия записи фильтру значение, указанное для этого свойства типа данных, должно содержаться в списке значений свойства userAttributes типа данных Finding.

(структура)

Этот тип данных используется в качестве параметра запроса в действиях AddAttributesToFindings и CreateAssessmentTemplate.

key -> (строка)

Ключ атрибута.

value -> (строка)

Значение, присвоенное ключу атрибута.

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

Диапазон времени, в течение которого была сгенерирована проблема.

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

Минимальное значение диапазона меток времени.

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

Максимальное значение диапазона меток времени.

Сокращенный синтаксис:

agentIds=string,string,autoScalingGroups=string,string,ruleNames=string,string,severities=string,string,rulesPackageArns=string,string,attributes=[{key=string,value=string},{key=string,value=string}],userAttributes=[{key=string,value=string},{key=string,value=string}],creationTimeRange={beginDate=timestamp,endDate=timestamp}

Синтаксис JSON:

{
  "agentIds": ["string", ...],
  "autoScalingGroups": ["string", ...],
  "ruleNames": ["string", ...],
  "severities": ["Low"|"Medium"|"High"|"Informational"|"Undefined", ...],
  "rulesPackageArns": ["string", ...],
  "attributes": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "userAttributes": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "creationTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  }
}

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

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

Маркер, указывающий, с какой точки начать постраничную выгрузку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная выгрузка в руководстве Пользовательское руководство по AWS CLI.

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

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

Примеры использования см. в разделе Постраничная выгрузка в руководстве Пользовательское руководство по AWS CLI.

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

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

Примеры использования см. в разделе Постраничная выгрузка в руководстве Пользовательское руководство по AWS CLI.

--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 (строка)

Включить/отключить вывод цветного текста.

  • включено
  • выключено
  • автоматически

--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.

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для получения списка проблем

Следующая list-findings команда отображает все найденные проблемы:

aws inspector list-findings

Вывод:

{
        "findingArns": [
        "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4",
        "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy"
      ]
}

Дополнительную информацию см. в руководстве Amazon Inspector в разделе «Найденные проблемы Amazon Inspector».

Вывод

findingArns -> (список)

Список ARNs, указывающий на найденные проблемы, возвращенные действием.

(строка)

nextToken -> (строка)

Если в ответе присутствуют дополнительные данные, которые необходимо отобразить, этот параметр содержится в ответе и содержит значение для использования в качестве параметра nextToken в последующем запросе постраничной выгрузки. Если больше данных нет, этот параметр имеет значение null.

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

Spec-Zone.ru

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