- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ControlTowerClient
Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
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
controlIdentifier
for 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.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower 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 or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference 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 Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
-
ARN format for Amazon Web Services Control Tower:
arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
-
ARN format for Amazon Web Services Control Catalog:
arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID}
in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl
and ListEnabledControls
always return an ARN of the same type given when the control was enabled.
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}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs .
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs . The individual API operations for landing zones are detailed in this document, the API reference manual , in the "Actions" section.
About baseline APIs
You can apply the AWSControlTowerBaseline
baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines .
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual , in the "Actions" section. For usage examples, see Baseline API input and output examples with CLI .
About Amazon Web Services Control Catalog identifiers
-
The
EnableControl
andDisableControl
API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API. -
If you use an Amazon Web Services Control Tower identifier to call the
EnableControl
API, and then callEnableControl
again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to theDisableControl
API operation. -
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
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.
Installation
npm install @aws-sdk/client-controltower
yarn add @aws-sdk/client-controltower
pnpm add @aws-sdk/client-controltower
ControlTowerClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateLandingZoneCommand | Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file. |
DeleteLandingZoneCommand | 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. |
DisableBaselineCommand | Disable an |
DisableControlCommand | This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services 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 Controls Reference Guide . |
EnableBaselineCommand | Enable (apply) a |
EnableControlCommand | 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 Controls Reference Guide . |
GetBaselineCommand | Retrieve details about an existing |
GetBaselineOperationCommand | Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: |
GetControlOperationCommand | Returns the status of a particular |
GetEnabledBaselineCommand | Retrieve details of an |
GetEnabledControlCommand | Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide . |
GetLandingZoneCommand | Returns details about the landing zone. Displays a message in case of error. |
GetLandingZoneOperationCommand | Returns the status of the specified landing zone operation. Details for an operation are available for 90 days. |
ListBaselinesCommand | Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide . |
ListControlOperationsCommand | Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples . |
ListEnabledBaselinesCommand | Returns a list of summaries describing |
ListEnabledControlsCommand | 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 Controls Reference Guide . |
ListLandingZoneOperationsCommand | Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first. |
ListLandingZonesCommand | 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. |
ListTagsForResourceCommand | Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide . |
ResetEnabledBaselineCommand | Re-enables an |
ResetEnabledControlCommand | Resets an enabled control. |
ResetLandingZoneCommand | This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation. |
TagResourceCommand | Applies tags to a resource. For usage examples, see the Controls Reference Guide . |
UntagResourceCommand | Removes tags from a resource. For usage examples, see the Controls Reference Guide . |
UpdateEnabledBaselineCommand | Updates an |
UpdateEnabledControlCommand | Updates the configuration of an already enabled control. If the enabled control shows an If the enabled control shows an If the |
UpdateLandingZoneCommand | This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file. |
ControlTowerClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ControlTowerClientConfig