- class ControlTower.Client#
A low-level client representing AWS Control Tower
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms “control” and “guardrail” are synonyms.
To call these APIs, you’ll need to know:
controlIdentifierfor the control–or guardrail–you are targeting.
the ARN associated with the target organizational unit (OU), which we call the
the ARN associated with a resource that you wish to tag or untag.
To get the
controlIdentifierfor your Amazon Web Services Control Tower control:
controlIdentifieris an ARN that is specified for each control. You can view the
controlIdentifierin the console on the Control details page, as well as in the documentation.
controlIdentifieris unique in each Amazon Web Services Region for each control. You can find the
controlIdentifierfor each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
To get the
targetIdentifieris the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
import boto3 client = boto3.client('controltower')
These are the available methods:
Paginators are available on a client instance via the
get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: