com.amazonaws.services.controltower

Interface AWSControlTowerAsync

All Superinterfaces:

AWSControlTower

All Known Implementing Classes:

AbstractAWSControlTowerAsync, AWSControlTowerAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSControlTowerAsync
extends AWSControlTower

Interface for accessing AWS Control Tower asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSControlTowerAsync instead.

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 interface com.amazonaws.services.controltower.AWSControlTower

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DisableControlResult>	disableControlAsync(DisableControlRequest disableControlRequest) This API call turns off a control.
Future<DisableControlResult>	disableControlAsync(DisableControlRequest disableControlRequest, AsyncHandler<DisableControlRequest,DisableControlResult> asyncHandler) This API call turns off a control.
Future<EnableControlResult>	enableControlAsync(EnableControlRequest enableControlRequest) This API call activates a control.
Future<EnableControlResult>	enableControlAsync(EnableControlRequest enableControlRequest, AsyncHandler<EnableControlRequest,EnableControlResult> asyncHandler) This API call activates a control.
Future<GetControlOperationResult>	getControlOperationAsync(GetControlOperationRequest getControlOperationRequest) Returns the status of a particular EnableControl or DisableControl operation.
Future<GetControlOperationResult>	getControlOperationAsync(GetControlOperationRequest getControlOperationRequest, AsyncHandler<GetControlOperationRequest,GetControlOperationResult> asyncHandler) Returns the status of a particular EnableControl or DisableControl operation.
Future<GetEnabledControlResult>	getEnabledControlAsync(GetEnabledControlRequest getEnabledControlRequest) Provides details about the enabled control.
Future<GetEnabledControlResult>	getEnabledControlAsync(GetEnabledControlRequest getEnabledControlRequest, AsyncHandler<GetEnabledControlRequest,GetEnabledControlResult> asyncHandler) Provides details about the enabled control.
Future<ListEnabledControlsResult>	listEnabledControlsAsync(ListEnabledControlsRequest listEnabledControlsRequest) Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
Future<ListEnabledControlsResult>	listEnabledControlsAsync(ListEnabledControlsRequest listEnabledControlsRequest, AsyncHandler<ListEnabledControlsRequest,ListEnabledControlsResult> asyncHandler) Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.

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

disableControl, enableControl, getCachedResponseMetadata, getControlOperation, getEnabledControl, listEnabledControls, shutdown

Method Detail

disableControlAsync

Future<DisableControlResult> disableControlAsync(DisableControlRequest disableControlRequest)

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 .

Parameters:

disableControlRequest -

Returns:

A Java Future containing the result of the DisableControl operation returned by the service.

See Also:

AWS API Documentation

disableControlAsync

Future<DisableControlResult> disableControlAsync(DisableControlRequest disableControlRequest,
                                                 AsyncHandler<DisableControlRequest,DisableControlResult> asyncHandler)

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 .

Parameters:

disableControlRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DisableControl operation returned by the service.

See Also:

AWS API Documentation

enableControlAsync

Future<EnableControlResult> enableControlAsync(EnableControlRequest enableControlRequest)

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

Parameters:

enableControlRequest -

Returns:

A Java Future containing the result of the EnableControl operation returned by the service.

See Also:

AWS API Documentation

enableControlAsync

Future<EnableControlResult> enableControlAsync(EnableControlRequest enableControlRequest,
                                               AsyncHandler<EnableControlRequest,EnableControlResult> asyncHandler)

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

Parameters:

enableControlRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the EnableControl operation returned by the service.

See Also:

AWS API Documentation

getControlOperationAsync

Future<GetControlOperationResult> getControlOperationAsync(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 AWS Control Tower User Guide

Parameters:

getControlOperationRequest -

Returns:

A Java Future containing the result of the GetControlOperation operation returned by the service.

See Also:

AWS API Documentation

getControlOperationAsync

Future<GetControlOperationResult> getControlOperationAsync(GetControlOperationRequest getControlOperationRequest,
                                                           AsyncHandler<GetControlOperationRequest,GetControlOperationResult> asyncHandler)

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

Parameters:

getControlOperationRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetControlOperation operation returned by the service.

See Also:

AWS API Documentation

getEnabledControlAsync

Future<GetEnabledControlResult> getEnabledControlAsync(GetEnabledControlRequest getEnabledControlRequest)

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.

Parameters:

getEnabledControlRequest -

Returns:

A Java Future containing the result of the GetEnabledControl operation returned by the service.

See Also:

AWS API Documentation

getEnabledControlAsync

Future<GetEnabledControlResult> getEnabledControlAsync(GetEnabledControlRequest getEnabledControlRequest,
                                                       AsyncHandler<GetEnabledControlRequest,GetEnabledControlResult> asyncHandler)

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.

Parameters:

getEnabledControlRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetEnabledControl operation returned by the service.

See Also:

AWS API Documentation

listEnabledControlsAsync

Future<ListEnabledControlsResult> listEnabledControlsAsync(ListEnabledControlsRequest listEnabledControlsRequest)

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

Parameters:

listEnabledControlsRequest -

Returns:

A Java Future containing the result of the ListEnabledControls operation returned by the service.

See Also:

AWS API Documentation

listEnabledControlsAsync

Future<ListEnabledControlsResult> listEnabledControlsAsync(ListEnabledControlsRequest listEnabledControlsRequest,
                                                           AsyncHandler<ListEnabledControlsRequest,ListEnabledControlsResult> asyncHandler)

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

Parameters:

listEnabledControlsRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListEnabledControls operation returned by the service.

See Also:

AWS API Documentation