Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

get-aggregate-compliance-details-by-config-rule

Описание

Возвращает результаты оценки для указанного правила Config для определенного ресурса в правиле. Результаты показывают, какие ресурсы Amazon Web Services были оценены правилом, когда каждый ресурс был в последний раз оценен и соответствует ли каждый ресурс правилу.

Примечание

Результаты могут возвращать пустую страницу результатов. Но если у вас есть nextToken, результаты отображаются на следующей странице.

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

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

Синтаксис

  get-aggregate-compliance-details-by-config-rule
--configuration-aggregator-name <value>
--config-rule-name <value>
--account-id <value>
--aws-region <value>
[--compliance-type <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]

Параметры

--configuration-aggregator-name (строка)

Имя агрегатора конфигурации.

--config-rule-name (строка)

Имя правила Config, для которого требуется информация о соответствии.

--account-id (строка)

12-значный идентификатор учетной записи источника.

--aws-region (строка)

Источник региона, откуда агрегируются данные.

--compliance-type (строка)

Статус соответствия ресурса.

Примечание

Для типа данных GetAggregateComplianceDetailsByConfigRuleRequest Config поддерживает только значения COMPLIANT и NON_COMPLIANT. Config не поддерживает значения NOT_APPLICABLE и INSUFFICIENT_DATA.

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

  • COMPLIANT
  • NON_COMPLIANT
  • NOT_APPLICABLE
  • INSUFFICIENT_DATA

--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 Command Line Interface.

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или значение 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.

Вывод

AggregateEvaluationResults -> (список)

Возвращает объект AggregateEvaluationResults.

(структура)

Подробности оценки Config для идентификатора учетной записи и региона в агрегаторе. Предоставляет ресурс Amazon Web Services, который был оценен, соответствие ресурса, связанные временные метки и дополнительную информацию.

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

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

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

Идентифицирует правило Config, используемое для оценки ресурса Amazon Web Services, и предоставляет тип и идентификатор оцениваемого ресурса.

ConfigRuleName -> (строка)

Имя правила Config, которое использовалось в оценке.

ResourceType -> (строка)

Тип ресурса Amazon Web Services, который был оценен.

ResourceId -> (строка)

Идентификатор оцениваемого ресурса Amazon Web Services.

EvaluationMode -> (строка)

Режим оценки. Допустимые значения: Detective или Proactive.

OrderingTimestamp -> (временная метка)

Время события, которое инициировало оценку ресурсов Amazon Web Services. Время может указывать, когда Config передал уведомление об изменении конфигурации, или время может указывать, когда Config передал снимок конфигурации, в зависимости от события, которое инициировало оценку.

ResourceEvaluationId -> (строка)

Уникальный идентификатор для результата оценки.

ComplianceType -> (строка)

Статус соответствия ресурса.

Для типа данных AggregationEvaluationResult Config поддерживает только значения COMPLIANT и NON_COMPLIANT. Config не поддерживает значения NOT_APPLICABLE и INSUFFICIENT_DATA.

ResultRecordedTime -> (временная метка)

Время, когда Config записал результат агрегированной оценки.

ConfigRuleInvokedTime -> (временная метка)

Время, когда правило Config оценивало ресурс Amazon Web Services.

Annotation -> (строка)

Дополнительная информация о том, как агрегированная оценка определила соответствие.

AccountId -> (строка)

12-значный идентификатор учетной записи источника.

AwsRegion -> (строка)

Источник региона, откуда агрегируются данные.

NextToken -> (строка)

Строка nextToken, возвращенная на предыдущей странице, которую вы используете для получения следующей страницы результатов в ответе с постраничным выводом.

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

Spec-Zone.ru

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