Amazon Web Services, Inc.

AWS Control Tower

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources: Controls DisableControl EnableControl GetEnabledControl GetControlOperation ListControlOperations ListEnabledControls ResetEnabledControl UpdateEnabledControl Landing zones CreateLandingZone DeleteLandingZone GetLandingZone GetLandingZoneOperation ListLandingZones ListLandingZoneOperations ResetLandingZone UpdateLandingZone Baselines DisableBaseline EnableBaseline GetBaseline GetBaselineOperation GetEnabledBaseline ListBaselines ListEnabledBaselines ResetEnabledBaseline UpdateEnabledBaseline Tagging ListTagsForResource TagResource UntagResource 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…

Endpoints 28

Landing zone

  • POSTCreate landing zone/create-landingzoneCreates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in…
  • POSTDelete landing zone/delete-landingzoneDecommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts…
  • POSTGet landing zone/get-landingzoneReturns details about the landing zone. Displays a message in case of error.
  • POSTList landing zones/list-landingzonesReturns 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…
  • POSTReset landing zone/reset-landingzoneThis API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original…
  • POSTUpdate landing zone/update-landingzoneThis 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…

Enabled baseline

  • POSTDisable baseline/disable-baselineDisable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the…
  • POSTEnable baseline/enable-baselineEnable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For…
  • POSTGet enabled baseline/get-enabled-baselineRetrieve details of an EnabledBaseline resource by specifying its identifier.
  • POSTList enabled baselines/list-enabled-baselinesReturns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline…
  • POSTReset enabled baseline/reset-enabled-baselineRe-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. For…
  • POSTUpdate enabled baseline/update-enabled-baselineUpdates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .

Enabled control

  • POSTEnable control/enable-controlThis API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the…
  • POSTGet enabled control/get-enabled-controlRetrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
  • POSTList enabled controls/list-enabled-controlsLists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the…
  • POSTReset enabled control/reset-enabled-controlResets an enabled control. Does not work for controls implemented with SCPs.
  • POSTUpdate enabled control/update-enabled-controlUpdates the configuration of an already enabled control. If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different…

Baseline

  • POSTGet baseline/get-baselineRetrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
  • POSTList baselines/list-baselinesReturns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .

Baseline operation

  • POSTGet baseline operation/get-baseline-operationReturns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline , DisableBaseline , UpdateEnabledBaseline ,…

Control operation

  • POSTGet control operation/get-control-operationReturns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for…
  • POSTList control operations/list-control-operationsProvides a list of operations in progress or queued. For usage examples, see ListControlOperation examples .

Landing zone operation

  • POSTGet landing zone operation/get-landingzone-operationReturns the status of the specified landing zone operation. Details for an operation are available for 90 days.
  • POSTList landing zone operations/list-landingzone-operationsLists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.

Tagging

  • GETList tags for resource/tags/:resourceArnReturns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
  • POSTTag resource/tags/:resourceArnApplies tags to a resource. For usage examples, see the Controls Reference Guide .
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes tags from a resource. For usage examples, see the Controls Reference Guide .
  • POSTDisable control/disable-controlThis API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the…

API details

Base URL
https://controltower.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
28 operations on 26 pathsPOST 26GET 1DELETE 1
Main resources
Enabled baseline 6Landing zone 6Enabled control 5Tagging 3Baseline 2Control operation 2Landing zone operation 2Baseline operation 1
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS Control Tower in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Control Tower collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create landing zone” (POST /create-landingzone), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Control Tower?

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of… It is listed under Developer tools and has 28 endpoints.

Who publishes the AWS Control Tower?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Control Tower?

Requests go to https://controltower.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Control Tower?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Control Tower have?

28 operations on 26 paths (26 POST, 1 GET, 1 DELETE). The largest groups are Enabled baseline, Landing zone, Enabled control, Tagging.

Is forking the AWS Control Tower free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.