Spec-Zone.ru › AWS CLI v2

[ aws . resourcegroupstaggingapi ]

get-compliance-summary

Описание

Возвращает таблицу, отображающую количество ресурсов, которые не соответствуют политикам тегов.

Дополнительную информацию о политиках тегов см. в руководстве пользователя Организации в разделе Политики тегов.

Вы можете вызывать этот оператор только из учетной записи управления организацией и из региона us-east-1.

Этот оператор поддерживает постраничную навигацию, где ответ может быть отправлен на нескольких страницах. Вы должны проверить параметр ответа PaginationToken, чтобы определить, есть ли дополнительные результаты, которые можно вернуть. Повторите запрос, передав значение параметра ответа PaginationToken в качестве входных данных для следующего запроса, пока не получите значение null. Значение null для PaginationToken указывает, что больше результатов нет.

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

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

Синтаксис

  get-compliance-summary
[--target-id-filters <value>]
[--region-filters <value>]
[--resource-type-filters <value>]
[--tag-key-filters <value>]
[--group-by <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]

Параметры

--target-id-filters (список)

Определяет идентификаторы целевых объектов (обычно, конкретные идентификаторы учетных записей), чтобы ограничить выходные данные. Если вы используете этот параметр, количество возвращаемых несоответствующих ресурсов включает только ресурсы с указанными идентификаторами целевых объектов.

(строка)

Синтаксис:

"string" "string" ...

--region-filters (список)

Определяет список регионов Amazon Web Services, чтобы ограничить выходные данные. Если вы используете этот параметр, количество возвращаемых несоответствующих ресурсов включает только ресурсы в указанных регионах.

(строка)

Синтаксис:

"string" "string" ...

--resource-type-filters (список)

Указывает, что вы хотите, чтобы ответ включал информацию только для ресурсов указанных типов. Формат каждого типа ресурса — service[:resourceType]. Например, указание типа ресурса ec2 возвращает все ресурсы Amazon EC2 (включая экземпляры EC2). Указание типа ресурса ec2:instance возвращает только экземпляры EC2.

Строка для каждого имени службы и типа ресурса такая же, как и вложенная в Amazon Resource Name (ARN) ресурса. Обратитесь к * Общей справке Amazon Web Services *, чтобы получить следующее:

  • Список строк имен служб см. в разделах Пространства имен служб Amazon Web Services.
  • Строки типов ресурсов см. в примере ARN.
  • Дополнительную информацию об ARN см. в разделах Имена ресурсов Amazon (ARN) и Пространства имен служб Amazon Web Services.

Вы можете указать несколько типов ресурсов, используя массив, разделенный запятыми. Массив может содержать до 100 элементов. Обратите внимание, что требование ограничения длины относится к каждому фильтру типа ресурса.

(строка)

Синтаксис:

"string" "string" ...

--tag-key-filters (список)

Указывает, что вы хотите, чтобы ответ включал информацию только для ресурсов, которые имеют теги с указанными ключами тегов. Если вы используете этот параметр, количество возвращаемых несоответствующих ресурсов включает только ресурсы, которые имеют указанные ключи тегов.

(строка)

Синтаксис:

"string" "string" ...

--group-by (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TARGET_ID
  REGION
  RESOURCE_TYPE

--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 CLI.

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

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

Примеры использования см. в разделе Постраничная навигация в руководстве пользователя AWS CLI.

--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.

Вывод

SummaryList -> (список)

Таблица, отображающая количество несоответствующих ресурсов.

(структура)

Количество несоответствующих ресурсов.

LastUpdated -> (строка)

Маркер времени, показывающий, когда этот свод был сгенерирован в этом регионе.

TargetId -> (строка)

Идентификатор учетной записи или корневой идентификатор организации. Если вы не знаете корневой ID, вы можете вызвать API Organizations ListRoots.

TargetIdType -> (строка)

Тип целевого объекта — учетная запись, OU или корень организации.

Region -> (строка)

Регион Amazon Web Services, к которому относится сводка.

ResourceType -> (строка)

Тип ресурса Amazon Web Services.

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

Количество несоответствующих ресурсов.

PaginationToken -> (строка)

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

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

Spec-Zone.ru

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