Spec-Zone.ru › AWS CLI v2

[ aws . inspector ]

list-assessment-runs

Описание

Выводит списки запусков оценок, соответствующие шаблонам оценок, которые заданы с помощью ARNs шаблонов оценок.

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

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

Синтаксис

  list-assessment-runs
[--assessment-template-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-template-arns (список)

ARN, определяющие шаблоны оценок, запуски оценок которых требуется получить.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

namePattern -> (строка)

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

states -> (список)

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

(строка)

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

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

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

Минимальное значение диапазона продолжительности. Должно быть больше нуля.

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

Максимальное значение диапазона продолжительности. Должно быть меньше или равно 604800 секундам (1 неделя).

rulesPackageArns -> (список)

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

namePattern=string,states=string,string,durationRange={minSeconds=integer,maxSeconds=integer},rulesPackageArns=string,string,startTimeRange={beginDate=timestamp,endDate=timestamp},completionTimeRange={beginDate=timestamp,endDate=timestamp},stateChangeTimeRange={beginDate=timestamp,endDate=timestamp}

Синтаксис JSON:

{
  "namePattern": "string",
  "states": ["CREATED"|"START_DATA_COLLECTION_PENDING"|"START_DATA_COLLECTION_IN_PROGRESS"|"COLLECTING_DATA"|"STOP_DATA_COLLECTION_PENDING"|"DATA_COLLECTED"|"START_EVALUATING_RULES_PENDING"|"EVALUATING_RULES"|"FAILED"|"ERROR"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"CANCELED", ...],
  "durationRange": {
    "minSeconds": integer,
    "maxSeconds": integer
  },
  "rulesPackageArns": ["string", ...],
  "startTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  },
  "completionTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  },
  "stateChangeTimeRange": {
    "beginDate": timestamp,
    "endDate": timestamp
  }
}

--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
  • text
  • таблица
  • 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.

Примеры

Примечание

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

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

Для получения списка запусков оценок

Следующая list-assessment-runs команда выводит все существующие запуски оценок.

aws inspector list-assessment-runs

Вывод:

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

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

Вывод

assessmentRunArns -> (список)

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

(строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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