View Source AWS.ControlTower (aws-elixir v0.14.1)
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:
the
controlIdentifierfor the control--or guardrail--you are targeting.the ARN associated with the target organizational unit (OU), which we call the
targetIdentifier.the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower
control:
The controlIdentifier is an ARN that is specified for each control. You can
view the controlIdentifier in the console on the Control details page, as
well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each
control. You can find the controlIdentifier for 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.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is 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:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
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.
Summary
Functions
Decommissions a landing zone.
Disable an EnabledBaseline resource on the specified Target.
This API call turns off a control.
Enable (apply) a Baseline to a Target.
This API call activates a control.
Retrieve details about an existing Baseline resource by specifying its
identifier.
Returns the details of an asynchronous baseline operation, as initiated by any
of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline,
ResetEnabledBaseline.
Returns the status of a particular EnableControl or DisableControl
operation.
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control.
Returns the status of the specified landing zone operation.
Returns a summary list of all available baselines.
Returns a list of summaries describing EnabledBaseline resources.
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
Returns the landing zone ARN for the landing zone deployed in your managed account.
Returns a list of tags associated with the resource.
Re-enables an EnabledBaseline resource.
This API call resets a landing zone.
Applies tags to a resource.
Removes tags from a resource.
Updates an EnabledBaseline resource's applied parameters or version.
Functions
Decommissions a landing zone.
This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
Disable an EnabledBaseline resource on the specified Target.
This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
This API call turns off a control.
It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
Enable (apply) a Baseline to a Target.
This API starts an asynchronous operation to deploy resources specified by the
Baseline to the specified Target.
This API call activates a control.
It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details about an existing Baseline resource by specifying its
identifier.
Returns the details of an asynchronous baseline operation, as initiated by any
of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline,
ResetEnabledBaseline.
A status message is displayed in case of operation failure.
Returns the status of a particular EnableControl or DisableControl
operation.
Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control.
For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of the specified landing zone operation.
Details for an operation are available for 60 days.
Returns a summary list of all available baselines.
Returns a list of summaries describing EnabledBaseline resources.
You can filter the list by the corresponding Baseline or Target of the
EnabledBaseline resources.
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the landing zone ARN for the landing zone deployed in your managed account.
This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
Returns a list of tags associated with the resource.
For usage examples, see the Amazon Web Services Control Tower User Guide .
Re-enables an EnabledBaseline resource.
For example, this API can re-apply the existing Baseline after a new member
account is moved to the target OU.
This API call resets a landing zone.
It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
Applies tags to a resource.
For usage examples, see the Amazon Web Services Control Tower User Guide .
Removes tags from a resource.
For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates an EnabledBaseline resource's applied parameters or version.