[ aws . controltower ]
list-enabled-controls
Описание
Выводит список правил, включенных Amazon Web Services Control Tower в указанной организационной единице и содержащихся в ней учетных записях. Примеры использования см. в руководстве по справке по правилам ` Руководство по справке по правилам https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html`__.
См. также: Документация API AWS
list-enabled-controls — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: enabledControls
Синтаксис
list-enabled-controls
[--filter <value>]
[--target-identifier <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]
Параметры
--filter (структура)
Фильтр входных данных для API ListEnabledControls, позволяющий выбрать типы операций управления для просмотра.
controlIdentifiers -> (список)
Набор controlIdentifier, возвращаемый фильтром.
(строка)
driftStatuses -> (список)
Список элементов DriftStatus.
(строка)
statuses -> (список)
Список элементов EnablementStatus.
(строка)
Сокращенный синтаксис:
controlIdentifiers=string,string,driftStatuses=string,string,statuses=string,string
Синтаксис JSON:
{
"controlIdentifiers": ["string", ...],
"driftStatuses": ["DRIFTED"|"IN_SYNC"|"NOT_CHECKING"|"UNKNOWN", ...],
"statuses": ["SUCCEEDED"|"FAILED"|"UNDER_CHANGE", ...]
}
--target-identifier (строка)
targetIdentifier, см. на странице обзора.--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
- 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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
enabledControls -> (список)
Список правил, включенных Amazon Web Services Control Tower в указанной организационной единице и содержащихся в ней учетных записях.
(структура)
Возвращает сводку информации о включенном правиле.
arn -> (строка)
controlIdentifier -> (строка)
driftStatusSummary -> (структура)
Статус расхождения включенного правила.
driftStatus -> (строка)
Статус расхождения включенного правила.
Допустимые значения:
-
DRIFTED: Правила, развернутые в этой конфигурации, не соответствуют конфигурации, ожидаемой Amazon Web Services Control Tower. -
IN_SYNC: Правила, развернутые в этой конфигурации, соответствуют конфигурации, ожидаемой Amazon Web Services Control Tower. -
NOT_CHECKING: Amazon Web Services Control Tower не проверяет расхождение для этого включенного правила. Расхождение не поддерживается для типа правила. -
UNKNOWN: Amazon Web Services Control Tower не может проверить статус расхождения для включенного правила.
statusSummary -> (структура)
Краткое описание состояния включенного правила.
lastOperationIdentifier -> (строка)
status -> (строка)
Статус развертывания включенного ресурса.
Допустимые значения:
-
SUCCEEDED: КонфигурацияEnabledControlилиEnabledBaselineбыла успешно развернута. -
UNDER_CHANGE: КонфигурацияEnabledControlилиEnabledBaselineизменяется. -
FAILED: КонфигурацияEnabledControlилиEnabledBaselineне смогла быть развернута.
targetIdentifier -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.