Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

получить сводку соответствия конфигурационных правил агрегатора

Описание

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

Примечание

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

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

Синтаксис

  get-aggregate-config-rule-compliance-summary
--configuration-aggregator-name <value>
[--filters <value>]
[--group-by-key <value>]
[--limit <value>]
[--next-token <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]

Параметры

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

Название конфигурационного агрегатора.

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

Фильтры результатов на основе объекта ConfigRuleComplianceSummaryFilters.

AccountId -> (строка)

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

AwsRegion -> (строка)

Область источника, где агрегируются данные.

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

AccountId=string,AwsRegion=string

Синтаксис JSON:

{
  "AccountId": "string",
  "AwsRegion": "string"
}

--group-by-key (строка)

Группирует результаты по ACCOUNT_ID или AWS_REGION.

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

  • ACCOUNT_ID
  • AWS_REGION

--limit (целое число)

Максимальное количество результатов оценки, возвращаемых на каждой странице. По умолчанию 1000. Вы не можете указать число больше 1000. Если вы укажете 0, Config использует значение по умолчанию.

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

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

--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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

GroupByKey -> (строка)

Группирует результаты по ACCOUNT_ID или AWS_REGION.

AggregateComplianceCounts -> (список)

Возвращает список объектов AggregateComplianceCounts.

(структура)

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

GroupName -> (строка)

12-значный идентификатор учетной записи или область на основе значения GroupByKey.

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

Количество правил конфигурации, соответствующих и не соответствующих требованиям.

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

Количество правил Config или ресурсов Amazon Web Services, соответствующих требованиям, максимум 25 для правил и 100 для ресурсов.

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

Количество ресурсов Amazon Web Services или правил Config, ответственных за текущее соответствие.

CapExceeded -> (логическое значение)

Указывает, достигнут ли максимальный лимит.

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

Количество правил Config или ресурсов Amazon Web Services, не соответствующих требованиям, максимум 25 для правил и 100 для ресурсов.

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

Количество ресурсов Amazon Web Services или правил Config, ответственных за текущее соответствие.

CapExceeded -> (логическое значение)

Указывает, достигнут ли максимальный лимит.

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

Время создания сводки соответствия Config.

NextToken -> (строка)

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

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

Spec-Zone.ru

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