controltower

Описание

Amazon Web Services Control Tower предоставляет операции с приложением программирования интерфейса (API), которые поддерживают программированное взаимодействие с этими типами ресурсов:

`*Контроли* https://docs.aws.amazon.com/controltower/latest/userguide/controls.html`__
- DisableControl
- EnableControl
- GetEnabledControl
- GetControlOperation
- ListControlOperations
- ListEnabledControls
- ResetEnabledControl
- UpdateEnabledControl
`*Зоны высадки* https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html`__
- CreateLandingZone
- DeleteLandingZone
- GetLandingZone
- GetLandingZoneOperation
- ListLandingZones
- ListLandingZoneOperations
- ResetLandingZone
- UpdateLandingZone
`*Базовые линии* https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html`__
- DisableBaseline
- EnableBaseline
- GetBaseline
- GetBaselineOperation
- GetEnabledBaseline
- ListBaselines
- ListEnabledBaselines
- ResetEnabledBaseline
- UpdateEnabledBaseline
`*Метки* https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html`__
- ListTagsForResource
- TagResource
- UntagResource

Для получения дополнительной информации об этих типах ресурсов, обратитесь к руководству пользователя Amazon Web Services Control Tower ` Руководство пользователя Amazon Web Services Control Tower https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html`__ .

О контрольных API

Эти интерфейсы позволяют применять библиотеку предварительно определённых контролей Amazon Web Services к вашим организационным подразделениям программно. В Amazon Web Services Control Tower термины «контроль» и «ограничение» являются синонимами.

Для вызова этих API вам потребуется знать:

controlIdentifier для контролируемого вами контроля.
ARN, связанный с целевым организационным подразделением (OU), который мы называем targetIdentifier.
ARN, связанный с ресурсом, который вы хотите пометить или снять метки.

Как получить ``controlIdentifier`` для вашего контроля Amazon Web Services Control Tower:

controlIdentifier — это ARN, который указывается для каждого контроля. Вы можете просмотреть controlIdentifier в консоли на странице Подробности о контроле, а также в документации.

Об идентификаторах Amazon Web Services Control Tower

Идентификатор Amazon Web Services Control Tower controlIdentifier уникален в каждой Регионе Amazon Web Services для каждого контроля. Вы можете найти controlIdentifier для каждой Регионе и контроля в таблицах метаданных контроля или таблицах доступности контроля по регионам в Руководстве по контролю Amazon Web Services Control Tower .

Быстрый список идентификаторов управления для устаревших сильно рекомендуемых и необязательных контролей Amazon Web Services Control Tower приведён в Идентификаторы ресурсов для API и контролей в ` Руководстве по контролю Amazon Web Services Control Tower https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html`__ . Помните, что обязательные элементы управления нельзя добавлять или удалять.

Примечание

Некоторые элементы управления имеют два идентификатора

Формат ARN для Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID} Пример: arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
Формат ARN для Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}

Вы можете найти {CONTROL_CATALOG_OPAQUE_ID} в ` Руководстве по контролю Amazon Web Services Control Tower https://docs.aws.amazon.com/controltower/latest/controlreference/all-global-identifiers.html`__ или в консоли Amazon Web Services Control Tower на странице Подробности о контроле.

API Amazon Web Services Control Tower для включённых контролей, таких как GetEnabledControl и ListEnabledControls, всегда возвращают ARN того же типа, что и при включении контроля.

Как получить ``targetIdentifier``:

targetIdentifier — это ARN для организационного подразделения.

В консоли Amazon Web Services Organizations вы можете найти ARN для OU на странице Подробности организационного подразделения, связанной с этим OU.

Примечание

Формат ARN OU:

arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}

О зонах высадки API

Вы можете настроить и запустить зону высадки Amazon Web Services Control Tower с помощью API. Для знакомства и шагов см. Начало работы с Amazon Web Services Control Tower с помощью API.

Для обзора операций с API зоны высадки см. Amazon Web Services Control Tower поддерживает API зон высадки. Отдельные операции с API для зон высадки подробно описаны в этом документе, в руководстве по API, в разделе «Действия».

О базовых линиях API

Вы можете применить AWSControlTowerBaseline базовые линии к организационному подразделению (OU), чтобы зарегистрировать OU в Amazon Web Services Control Tower программно. Для общего обзора этой возможности см. Amazon Web Services Control Tower поддерживает API для регистрации и настройки OU с помощью базовых линий.

Вы можете вызвать операции API базовых линий, чтобы просмотреть базовые линии, которые Amazon Web Services Control Tower включает для вашей зоны высадки от вашего имени при настройке зоны высадки. Эти базовые линии — это базовые линии только для чтения.

Отдельные операции с API базовых линий подробно описаны в этом документе, в руководстве по API, в разделе «Действия». Примеры использования см. в Примерах входных и выходных данных API базовых линий с CLI.

Об идентификаторах Amazon Web Services Control Catalog

Операции API EnableControl и DisableControl могут быть вызваны с указанием идентификатора Amazon Web Services Control Tower или идентификатора Amazon Web Services Control Catalog. Ответ API возвращает тот же тип идентификатора, что и вы указали при вызове API.
Если вы используете идентификатор Amazon Web Services Control Tower для вызова API EnableControl, а затем снова вызываете EnableControl с идентификатором Amazon Web Services Control Catalog, Amazon Web Services Control Tower вернёт сообщение об ошибке, что контроль уже включён. Аналогичное поведение применяется к операции API DisableControl.
Обязательные элементы управления и региональный запрещающий контроль уровня зоны высадки имеют только идентификаторы Amazon Web Services Control Tower.

Подробности и примеры

Примеры входных и выходных данных API управления с CLI
Примеры входных и выходных данных API базовых линий с CLI
Включение контролей с CloudFormation
Запуск зоны высадки с CloudFormation
Таблицы метаданных управления (большая страница)
Таблицы доступности управления по регионам (большая страница)
Список идентификаторов устаревших контролей
Руководство по управлению
Группировки библиотек управления
Создание ресурсов Amazon Web Services Control Tower с помощью Amazon Web Services CloudFormation

Чтобы просмотреть репозиторий открытых исходных кодов на GitHub, см. aws-cloudformation/aws-cloudformation-resource-providers-controltower

Запись запросов API

Amazon Web Services Control Tower поддерживает Amazon Web Services CloudTrail, службу, которая записывает вызовы API Amazon Web Services для вашей учетной записи Amazon Web Services и предоставляет файлы журналов в ведро Amazon S3. Используя информацию, собранную CloudTrail, вы можете определить, какие запросы получила служба Amazon Web Services Control Tower, кто и когда сделал запрос и так далее. Дополнительные сведения о Amazon Web Services Control Tower и его поддержке CloudTrail см. в Руководстве пользователя Amazon Web Services Control Tower в разделе «Ведение журнала действий Amazon Web Services Control Tower с помощью Amazon Web Services CloudTrail». Чтобы узнать больше о CloudTrail, включая то, как его включить и найти ваши файлы журналов, см. Руководство пользователя Amazon Web Services CloudTrail.

controltower

Описание

Примечание

Примечание

Доступные команды