@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSControlTower
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSControlTower instead.
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.
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 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.
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}
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.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
DeleteLandingZoneResult |
deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest)
Decommissions a landing zone.
|
DisableBaselineResult |
disableBaseline(DisableBaselineRequest disableBaselineRequest)
Disable an
EnabledBaseline resource on the specified Target. |
DisableControlResult |
disableControl(DisableControlRequest disableControlRequest)
This API call turns off a control.
|
EnableBaselineResult |
enableBaseline(EnableBaselineRequest enableBaselineRequest)
Enable (apply) a
Baseline to a Target. |
EnableControlResult |
enableControl(EnableControlRequest enableControlRequest)
This API call activates a control.
|
GetBaselineResult |
getBaseline(GetBaselineRequest getBaselineRequest)
Retrieve details about an existing
Baseline resource by specifying its identifier. |
GetBaselineOperationResult |
getBaselineOperation(GetBaselineOperationRequest getBaselineOperationRequest)
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs:
EnableBaseline, DisableBaseline, UpdateEnabledBaseline,
ResetEnabledBaseline. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetControlOperationResult |
getControlOperation(GetControlOperationRequest getControlOperationRequest)
Returns the status of a particular
EnableControl or DisableControl operation. |
GetEnabledBaselineResult |
getEnabledBaseline(GetEnabledBaselineRequest getEnabledBaselineRequest)
Retrieve details of an
EnabledBaseline resource by specifying its identifier. |
GetEnabledControlResult |
getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)
Retrieves details about an enabled control.
|
GetLandingZoneOperationResult |
getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest)
Returns the status of the specified landing zone operation.
|
ListBaselinesResult |
listBaselines(ListBaselinesRequest listBaselinesRequest)
Returns a summary list of all available baselines.
|
ListControlOperationsResult |
listControlOperations(ListControlOperationsRequest listControlOperationsRequest)
Provides a list of operations in progress or queued.
|
ListEnabledBaselinesResult |
listEnabledBaselines(ListEnabledBaselinesRequest listEnabledBaselinesRequest)
Returns a list of summaries describing
EnabledBaseline resources. |
ListEnabledControlsResult |
listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the
accounts it contains.
|
ListLandingZoneOperationsResult |
listLandingZoneOperations(ListLandingZoneOperationsRequest listLandingZoneOperationsRequest)
Lists all landing zone operations from the past 90 days.
|
ListLandingZonesResult |
listLandingZones(ListLandingZonesRequest listLandingZonesRequest)
Returns the landing zone ARN for the landing zone deployed in your managed account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the resource.
|
ResetEnabledBaselineResult |
resetEnabledBaseline(ResetEnabledBaselineRequest resetEnabledBaselineRequest)
Re-enables an
EnabledBaseline resource. |
ResetLandingZoneResult |
resetLandingZone(ResetLandingZoneRequest resetLandingZoneRequest)
This API call resets a landing zone.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Applies tags to a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
|
UpdateEnabledBaselineResult |
updateEnabledBaseline(UpdateEnabledBaselineRequest updateEnabledBaselineRequest)
Updates an
EnabledBaseline resource's applied parameters or version. |
static final String ENDPOINT_PREFIX
DeleteLandingZoneResult deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest)
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.
deleteLandingZoneRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.DisableBaselineResult disableBaseline(DisableBaselineRequest disableBaselineRequest)
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. For usage examples, see the Amazon Web
Services Control Tower User Guide .
disableBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.DisableControlResult disableControl(DisableControlRequest disableControlRequest)
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 .
disableControlRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.EnableBaselineResult enableBaseline(EnableBaselineRequest enableBaselineRequest)
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources
specified by the Baseline to the specified Target. For usage examples, see the Amazon Web
Services Control Tower User Guide .
enableBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.EnableControlResult enableControl(EnableControlRequest enableControlRequest)
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 .
enableControlRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetBaselineResult getBaseline(GetBaselineRequest getBaselineRequest)
Retrieve details about an existing Baseline resource by specifying its identifier. For usage
examples, see
the Amazon Web Services Control Tower User Guide .
getBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetBaselineOperationResult getBaselineOperation(GetBaselineOperationRequest getBaselineOperationRequest)
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. For usage
examples, see
the Amazon Web Services Control Tower User Guide .
getBaselineOperationRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetControlOperationResult getControlOperation(GetControlOperationRequest getControlOperationRequest)
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
Controls Reference Guide .
getControlOperationRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetEnabledBaselineResult getEnabledBaseline(GetEnabledBaselineRequest getEnabledBaselineRequest)
Retrieve details of an EnabledBaseline resource by specifying its identifier.
getEnabledBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetEnabledControlResult getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
getEnabledControlRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.GetLandingZoneOperationResult getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest)
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
getLandingZoneOperationRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.ListBaselinesResult listBaselines(ListBaselinesRequest listBaselinesRequest)
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
listBaselinesRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ListControlOperationsResult listControlOperations(ListControlOperationsRequest listControlOperationsRequest)
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
listControlOperationsRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ListEnabledBaselinesResult listEnabledBaselines(ListEnabledBaselinesRequest listEnabledBaselinesRequest)
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the
corresponding Baseline or Target of the EnabledBaseline resources. For
usage examples, see the Amazon Web
Services Control Tower User Guide .
listEnabledBaselinesRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)
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 .
listEnabledControlsRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.ListLandingZoneOperationsResult listLandingZoneOperations(ListLandingZoneOperationsRequest listLandingZoneOperationsRequest)
Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
listLandingZoneOperationsRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ListLandingZonesResult listLandingZones(ListLandingZonesRequest listLandingZonesRequest)
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.
listLandingZonesRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
listTagsForResourceRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.ResourceNotFoundException - The request references a resource that does not exist.ResetEnabledBaselineResult resetEnabledBaseline(ResetEnabledBaselineRequest resetEnabledBaselineRequest)
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. For usage examples, see the Amazon Web
Services Control Tower User Guide .
resetEnabledBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.ResetLandingZoneResult resetLandingZone(ResetLandingZoneRequest resetLandingZoneRequest)
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.
resetLandingZoneRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
tagResourceRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.ResourceNotFoundException - The request references a resource that does not exist.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
untagResourceRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InternalServerException - An unexpected error occurred during processing of a request.ResourceNotFoundException - The request references a resource that does not exist.UpdateEnabledBaselineResult updateEnabledBaseline(UpdateEnabledBaselineRequest updateEnabledBaselineRequest)
Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web
Services Control Tower User Guide .
updateEnabledBaselineRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting the resource can cause an inconsistent state.ServiceQuotaExceededException - The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.InternalServerException - An unexpected error occurred during processing of a request.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - The request was denied due to request throttling.ResourceNotFoundException - The request references a resource that does not exist.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.