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 AWS library of pre-defined controls to your organizational units, programmatically. In AWS 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.

To get the controlIdentifier for your AWS 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 AWS Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata in the AWS Control Tower User Guide.

A quick-reference list of control identifers for the AWS Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and guardrails in the Controls reference guide section of the AWS 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 AWS 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 AWS Control Tower resources with AWS CloudFormation

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower

Recording API Requests

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS 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()
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) Provides details about the enabled control.
ListEnabledControlsResult	listEnabledControls(ListEnabledControlsRequest request) Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

disableControl

public DisableControlResult disableControl(DisableControlRequest request)

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 AWS 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 fails to satisfy the constraints specified by an AWS service.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

InternalServerException - Unexpected error during processing of request.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which 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 AWS 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 AWS 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 fails to satisfy the constraints specified by an AWS service.

ConflictException - Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

InternalServerException - Unexpected error during processing of request.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which 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 AWS 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 fails to satisfy the constraints specified by an AWS service.

InternalServerException - Unexpected error during processing of request.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

getEnabledControl

public GetEnabledControlResult getEnabledControl(GetEnabledControlRequest request)

Provides details about the enabled control. For usage examples, see the AWS Control Tower User Guide .

Returned values

• TargetRegions: Shows target AWS Regions where the enabled control is available to be deployed.

• StatusSummary: Provides a detailed summary of the deployment status.

• DriftSummary: Provides a detailed summary of the drifted status.

Specified by:

getEnabledControl in interface AWSControlTower

Parameters:

getEnabledControlRequest -

Returns:

Result of the GetEnabledControl operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

InternalServerException - Unexpected error during processing of request.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which does not exist.

See Also:

AWS API Documentation

listEnabledControls

public ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest request)

Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the AWS 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 fails to satisfy the constraints specified by an AWS service.

InternalServerException - Unexpected error during processing of request.

AccessDeniedException - User does not have sufficient access to perform this action.

ThrottlingException - Request was denied due to request throttling.

ResourceNotFoundException - Request references a resource which 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