com.amazonaws.services.controltower

Class AWSControlTowerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.controltower.AWSControlTowerClient

All Implemented Interfaces:

AWSControlTower

Direct Known Subclasses:

AWSControlTowerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSControlTowerClient
extends AmazonWebServiceClient
implements AWSControlTower

Client for accessing AWS Control Tower. All service calls made using this client are blocking, and will not return until the service call completes.

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 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

• Control API input and output examples with CLI

• Enable controls with CloudFormation

• Control metadata tables

• List of identifiers for legacy controls

• Controls reference guide

• Controls library groupings

• Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.controltower.AWSControlTower

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSControlTowerClientBuilder	builder()
DeleteLandingZoneResult	deleteLandingZone(DeleteLandingZoneRequest request) Decommissions a landing zone.
DisableControlResult	disableControl(DisableControlRequest request) This API call turns off a control.
EnableControlResult	enableControl(EnableControlRequest request) This API call activates a control.
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 request) Returns the status of a particular EnableControl or DisableControl operation.
GetEnabledControlResult	getEnabledControl(GetEnabledControlRequest request) Retrieves details about an enabled control.
GetLandingZoneOperationResult	getLandingZoneOperation(GetLandingZoneOperationRequest request) Returns the status of the specified landing zone operation.
ListEnabledControlsResult	listEnabledControls(ListEnabledControlsRequest request) Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
ListLandingZonesResult	listLandingZones(ListLandingZonesRequest request) Returns the landing zone ARN for the landing zone deployed in your managed account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags associated with the resource.
ResetLandingZoneResult	resetLandingZone(ResetLandingZoneRequest request) 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 request) Applies tags to a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from a resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSControlTowerClientBuilder builder()

deleteLandingZone

public DeleteLandingZoneResult deleteLandingZone(DeleteLandingZoneRequest request)

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.

Specified by:

deleteLandingZone in interface AWSControlTower

Parameters:

deleteLandingZoneRequest -

Returns:

Result of the DeleteLandingZone operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disableControl

public DisableControlResult disableControl(DisableControlRequest request)

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 Amazon Web Services Control Tower User Guide .

Specified by:

disableControl in interface AWSControlTower

Parameters:

disableControlRequest -

Returns:

Result of the DisableControl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

enableControl

public EnableControlResult enableControl(EnableControlRequest request)

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 .

Specified by:

enableControl in interface AWSControlTower

Parameters:

enableControlRequest -

Returns:

Result of the EnableControl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getControlOperation

public GetControlOperationResult getControlOperation(GetControlOperationRequest request)

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 .

Specified by:

getControlOperation in interface AWSControlTower

Parameters:

getControlOperationRequest -

Returns:

Result of the GetControlOperation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getEnabledControl

public GetEnabledControlResult getEnabledControl(GetEnabledControlRequest request)

Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .

Specified by:

getEnabledControl in interface AWSControlTower

Parameters:

getEnabledControlRequest -

Returns:

Result of the GetEnabledControl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getLandingZoneOperation

public GetLandingZoneOperationResult getLandingZoneOperation(GetLandingZoneOperationRequest request)

Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.

Specified by:

getLandingZoneOperation in interface AWSControlTower

Parameters:

getLandingZoneOperationRequest -

Returns:

Result of the GetLandingZoneOperation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listEnabledControls

public ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest request)

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 .

Specified by:

listEnabledControls in interface AWSControlTower

Parameters:

listEnabledControlsRequest -

Returns:

Result of the ListEnabledControls operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listLandingZones

public ListLandingZonesResult listLandingZones(ListLandingZonesRequest request)

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.

Specified by:

listLandingZones in interface AWSControlTower

Parameters:

listLandingZonesRequest -

Returns:

Result of the ListLandingZones operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Specified by:

listTagsForResource in interface AWSControlTower

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

resetLandingZone

public ResetLandingZoneResult resetLandingZone(ResetLandingZoneRequest request)

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.

Specified by:

resetLandingZone in interface AWSControlTower

Parameters:

resetLandingZoneRequest -

Returns:

Result of the ResetLandingZone operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Specified by:

tagResource in interface AWSControlTower

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

Specified by:

untagResource in interface AWSControlTower

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AWSControlTower

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSControlTower

Overrides:

shutdown in class AmazonWebServiceClient