get-control

Описание

Возвращает подробности о конкретном контроле, в частности список регионов Amazon Web Services, где этот контроль поддерживается. Введите значение для параметра ControlArn в формате ARN. GetControl принимает controltower или controlcatalog арны контроля в качестве входных данных. Возвращает арн в формате controlcatalog.

В ответе API, контроллеры, у которых значение GLOBAL в поле Scope, не отображают поле DeployableRegions, так как оно не применимо. Контроллеры, у которых значение REGIONAL в поле Scope, возвращают значение для поля DeployableRegions, как показано в примере.

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

Синтаксис

  get-control
--control-arn <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]

Параметры

--control-arn (строка)

Amazon Resource Name (ARN) контроля. Он имеет один из следующих форматов:

Глобальный формат

arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}

Или региональный формат

arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}

Вот более общая схема, охватывающая ARN Amazon Web Services Control Tower и Control Catalog:

^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+$

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

Вывод

Arn -> (строка)

Amazon Resource Name (ARN) контроля.

Имя -> (строка)

Отображаемое имя контроля.

Описание -> (строка)

Описание того, что делает контроль.

Поведение -> (строка)

Термин, идентифицирующий функциональное поведение контроля. Один из Preventive , Detective , Proactive

Серьезность -> (строка)

Перечислимый тип со следующими возможными значениями:

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

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

Если вы применяете контроллеры через среду зоны высадки Amazon Web Services Control Tower, помните, что значения, возвращаемые операцией API RegionConfiguration, не связаны с управляемыми регионами в вашей зоне высадки. Например, если вы управляете регионами A ,``B`` и C, в то время как контроль доступен в регионах A , B , C``,`` и D, вы увидите ответ с DeployableRegions A , B , C и D для контроля с областью действия REGIONAL, даже если вы не намерены развертывать контроль в регионе D, так как вы им не управляете через свою зону высадки.

Область действия -> (строка)

Область действия контроля, если он развернут. Область действия — перечислимый тип со значением Regional или Global. Контроль с глобальным областью действия эффективен во всех регионах Amazon Web Services независимо от региона, в котором он включен или в который он развернут. Контроль, реализованный с помощью SCP, обычно имеет глобальную область действия. Контроль с региональной областью действия имеет операции, ограниченные конкретно регионом, в котором он включен, и в котором он развернут. Контроли, реализованные правилами Config и ссылками CloudFormation, обычно имеют региональную область действия. Контроли Security Hub обычно имеют региональную область действия.

DeployableRegions -> (список)

Регионы, в которых контроль доступен для развертывания.

(строка)

Реализация -> (структура)

Возвращает информацию о контроле как объекте ImplementationDetails, который показывает тип реализации контроля.

Тип -> (строка)

Строка, описывающая тип реализации контроля.

Идентификатор -> (строка)

Уникальный идентификатор службы для контроля, присвоенный службой, реализовавшей контроль. Например, этот идентификатор может быть идентификатором правила Amazon Web Services Config или идентификатором контроля Security Hub.

Параметры -> (список)

Возвращает массив объектов ControlParameter, которые указывают параметры, которые поддерживает контроль. Для контроллеров, которые не поддерживают параметры, возвращается пустой список.

(структура)

Поддерживаются пять типов параметров контроля.

AllowedRegions: Список регионов Amazon Web Services, исключенных из контроля. Каждая строка должна быть кодом региона Amazon Web Services. Этот параметр обязателен для управления регионами отключения OU, CT.MULTISERVICE.PV.1 . Пример: ["us-east-1","us-west-2"]
ExemptedActions: Список действий IAM Amazon Web Services, исключенных из контроля. Каждая строка должна быть действием IAM. Пример: ["logs:DescribeLogGroups","logs:StartQuery","logs:GetQueryResults"]
ExemptedPrincipalArns: Список ARN принципалов IAM Amazon Web Services, исключенных из контроля. Каждая строка должна быть принципалом IAM, следуя шаблону ^arn:(aws|aws-us-gov):(iam|sts)::.+:.+$ . Пример: ["arn:aws:iam::*:role/ReadOnly","arn:aws:sts::*:assumed-role/ReadOnly/*"]
ExemptedResourceArns: Список ARN ресурсов, исключенных из контроля. Каждая строка должна быть ARN ресурса. Пример: ["arn:aws:s3:::my-bucket-name"]
ExemptAssumeRoot: Параметр, позволяющий выбрать, нужно ли исключить запросы, выполненные с использованием AssumeRoot из этого контроля для этой организационной единицы. Для учетных записей-членов свойство AssumeRoot включено в запросы, инициированные IAM централизованным доступом к корневому пользователю. Этот параметр относится только к контролю AWS-GR_RESTRICT_ROOT_USER. Если вы добавите параметр при включении контроля, исключение AssumeRoot разрешено. Если вы опустите параметр, исключение AssumeRoot не разрешено. Параметр не принимает значение False. *Пример: Включение контроля и разрешение AssumeRoot * { "controlIdentifier": "arn:aws:controlcatalog:::control/5kvme4m5d2b4d7if2fs5yg2ui", "parameters": [ { "key": "ExemptAssumeRoot", "value": true } ], "targetIdentifier": "arn:aws:organizations::8633900XXXXX:ou/o-6jmn81636m/ou-qsah-jtiihcla" }

Имя -> (строка)

Имя параметра. Это имя параметра key, когда вы вызываете ` EnableControl https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html`__ или ` UpdateEnabledControl https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html`__.

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

Временная метка, отмечающая время, когда контроль был выпущен (начало его жизни) как управляющая возможность в Amazon Web Services.