Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

описание-совокупного-соблюдения-по-наборам-совместимости

Описание

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

Примечание

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

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

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

Синтаксис

  describe-aggregate-compliance-by-conformance-packs
--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 (структура)

Фильтрует результаты по объекту AggregateConformancePackComplianceFilters.

ConformancePackName -> (строка)

Имя набора совместимости.

ComplianceType -> (строка)

Состояние соответствия набора совместимости.

AccountId -> (строка)

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

AwsRegion -> (строка)

Исходная Amazon Web Services область, откуда агрегируются данные.

Краткая синтаксическая запись:

ConformancePackName=string,ComplianceType=string,AccountId=string,AwsRegion=string

Синтаксис JSON:

{
  "ConformancePackName": "string",
  "ComplianceType": "COMPLIANT"|"NON_COMPLIANT"|"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.

Вывод

AggregateComplianceByConformancePacks -> (список)

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

(структура)

Предоставляет агрегированное состояние соответствия набора совместимости. Указывает, соответствует ли набор совместимости, основываясь на имени набора совместимости, идентификаторе учётной записи и регионе.

Набор совместимости соответствует, если все правила в наборе совместимости соответствуют. Он не соответствует, если какие-либо правила не соответствуют. Состояние соответствия набора совместимости — INSUFFICIENT_DATA только в том случае, если все правила в наборе совместимости не могут быть оценены из-за недостаточных данных. Если некоторые правила в наборе совместимости соответствуют, но состояние соответствия других правил в том же наборе совместимости — INSUFFICIENT_DATA, набор совместимости показывает соответствие.

ConformancePackName -> (строка)

Имя набора совместимости.

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

Состояние соответствия набора совместимости.

ComplianceType -> (строка)

Состояние соответствия набора совместимости.

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

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

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

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

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

Общее количество правил, соответствующих требованиям, не соответствующих требованиям и правил, для которых нет соответствующих ресурсов для оценки, что приводит к недостаточным данным.

AccountId -> (строка)

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

AwsRegion -> (строка)

Исходная Amazon Web Services область, откуда агрегируются данные.

NextToken -> (строка)

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

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

Spec-Zone.ru

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