[ aws . configservice ]
describe-aggregate-compliance-by-config-rules
Описание
Возвращает список соответсвующих и несоответствующих правил с количеством ресурсов для соответсвующих и несоответсвующих правил. Не отображает правила, для которых нет результатов соответствия.
Примечание
Результаты могут возвращать пустую страницу результатов, но если у вас естьnextToken , результаты отображаются на следующей странице.См. также: Документацию AWS API
describe-aggregate-compliance-by-config-rules является страницированной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить страницирование, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ со страницированием, аргумент --query должен извлечь данные из результатов следующих выражений запроса: AggregateComplianceByConfigRules
Синтаксис
describe-aggregate-compliance-by-config-rules
--configuration-aggregator-name <value>
[--filters <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 (строка)
--filters (структура)
Фильтрует результаты по объекту ConfigRuleComplianceFilters.
ConfigRuleName -> (строка)
ComplianceType -> (строка)
Статус соответствия правила.
Для типа данных ConfigRuleComplianceFilters, Config поддерживает только COMPLIANT и NON_COMPLIANT. Config не поддерживает значения NOT_APPLICABLE и INSUFFICIENT_DATA.
AccountId -> (строка)
AwsRegion -> (строка)
Упрощенный синтаксис:
ConfigRuleName=string,ComplianceType=string,AccountId=string,AwsRegion=string
Синтаксис JSON:
{
"ConfigRuleName": "string",
"ComplianceType": "COMPLIANT"|"NON_COMPLIANT"|"NOT_APPLICABLE"|"INSUFFICIENT_DATA",
"AccountId": "string",
"AwsRegion": "string"
}
--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.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров CLI.
Вывод
AggregateComplianceByConfigRules -> (список)
Возвращает список объектов AggregateComplianceByConfigRule.
(структура)
Указывает, соответствует ли правило Config по идентификатору учетной записи, региону, статусу соответствия и имени правила.
Правило соответствует, если все ресурсы, на которые оно распространялось, соответствуют ему. Оно не соответствует, если любой из этих ресурсов не соответствует.
ConfigRuleName -> (строка)
Compliance -> (структура)
Указывает, соответствует ли ресурс Amazon Web Services или правило Config, и предоставляет количество участников, которые влияют на соответствие.
ComplianceType -> (строка)
Указывает, соответствует ли ресурс Amazon Web Services или правило Config.
Ресурс соответствует, если он соответствует всем правилам Config, которые его оценивают. Ресурс не соответствует, если он не соответствует одному или нескольким из этих правил.
Правило соответствует, если все ресурсы, на которые оно распространялось, соответствуют ему. Правило не соответствует, если какой-либо из этих ресурсов не соответствует.
Config возвращает значение INSUFFICIENT_DATA, если результаты оценки недоступны для ресурса Amazon Web Services или правила Config.
Для типа данных Compliance, Config поддерживает только значения COMPLIANT, NON_COMPLIANT и INSUFFICIENT_DATA. Config не поддерживает значение NOT_APPLICABLE для типа данных Compliance.
ComplianceContributorCount -> (структура)
Количество ресурсов Amazon Web Services или правил Config, которые приводят к результату NON_COMPLIANT, до максимального количества.
CappedCount -> (целое число)
CapExceeded -> (булево)
AccountId -> (строка)
AwsRegion -> (строка)
NextToken -> (строка)
nextToken, возвращенная на предыдущей странице, которую вы используете для получения следующей страницы результатов в ответ со страницированием.
© Copyright 2025, Amazon Web Services. Created using Sphinx.