Spec-Zone.ru › AWS CLI v2

[ aws . controltower ]

get-enabled-control

Описание

Получает данные об активированном контроле. Примеры использования см. в руководстве ` Руководство по контролю за ресурсами https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html`__ .

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

get-enabled-control использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая запись синтаксиса не поддерживает типы документов.

Синтаксис

  get-enabled-control
--enabled-control-identifier <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]

Опции

--enabled-control-identifier (строка)

Идентификатор активированного контроля.

--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
  • text
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Информация об активированном контроле.

arn -> (строка)

ARN активированного контроля.

controlIdentifier -> (строка)

Идентификатор контроля активированного контроля. Сведения о поиске controlIdentifier см. на странице обзора.

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

Статус отклонения активированного контроля.

driftStatus -> (строка)

Статус отклонения активированного контроля.

Допустимые значения:

  • DRIFTED : Развернутый enabledControl в этой конфигурации не соответствует конфигурации, ожидаемой Amazon Web Services Control Tower.
  • IN_SYNC : Развернутый enabledControl в этой конфигурации соответствует конфигурации, ожидаемой Amazon Web Services Control Tower.
  • NOT_CHECKING : Amazon Web Services Control Tower не проверяет отклонение для этого активированного контроля. Отклонение не поддерживается для типа контроля.
  • UNKNOWN : Amazon Web Services Control Tower не может проверить статус отклонения для активированного контроля.

parameters -> (список)

Массив объектов EnabledControlParameter.

(структура)

Возвращает сводку информации о параметрах активированного контроля.

key -> (строка)

Ключ пары «ключ-значение».

value -> (документ)

Значение пары «ключ-значение».

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

Сводка развертывания активированного контроля.

lastOperationIdentifier -> (строка)

Идентификатор последней операции для активированного ресурса.

status -> (строка)

Статус развертывания активированного ресурса.

Допустимые значения:

  • SUCCEEDED : EnabledControl или EnabledBaseline конфигурация была успешно развернута.
  • UNDER_CHANGE : EnabledControl или EnabledBaseline конфигурация изменяется.
  • FAILED : EnabledControl или EnabledBaseline конфигурация не смогла быть развернута.

targetIdentifier -> (строка)

ARN организационной единицы. Информацию о поиске targetIdentifier см. на странице обзора.

targetRegions -> (список)

Целевые Amazon Web Services Регионы для активированного контроля.

(структура)

Amazon Web Services Регион, в котором Amazon Web Services Control Tower ожидает найти развернутый контроль.

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

name -> (строка)

Имя Amazon Web Services Региона.

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

Spec-Zone.ru

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