@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSControlTowerAsyncClient extends AWSControlTowerClient implements AWSControlTowerAsync
AsyncHandler can be used to receive
notification when an asynchronous operation 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
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, disableControl, enableControl, getCachedResponseMetadata, getControlOperation, getEnabledControl, listEnabledControlsaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdisableControl, enableControl, getCachedResponseMetadata, getControlOperation, getEnabledControl, listEnabledControlspublic static AWSControlTowerAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<DisableControlResult> disableControlAsync(DisableControlRequest request)
AWSControlTowerAsyncThis 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 .
disableControlAsync in interface AWSControlTowerAsyncpublic Future<DisableControlResult> disableControlAsync(DisableControlRequest request, AsyncHandler<DisableControlRequest,DisableControlResult> asyncHandler)
AWSControlTowerAsyncThis 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 .
disableControlAsync in interface AWSControlTowerAsyncasyncHandler - 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.public Future<EnableControlResult> enableControlAsync(EnableControlRequest request)
AWSControlTowerAsyncThis 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
enableControlAsync in interface AWSControlTowerAsyncpublic Future<EnableControlResult> enableControlAsync(EnableControlRequest request, AsyncHandler<EnableControlRequest,EnableControlResult> asyncHandler)
AWSControlTowerAsyncThis 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
enableControlAsync in interface AWSControlTowerAsyncasyncHandler - 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.public Future<GetControlOperationResult> getControlOperationAsync(GetControlOperationRequest request)
AWSControlTowerAsync
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
getControlOperationAsync in interface AWSControlTowerAsyncpublic Future<GetControlOperationResult> getControlOperationAsync(GetControlOperationRequest request, AsyncHandler<GetControlOperationRequest,GetControlOperationResult> asyncHandler)
AWSControlTowerAsync
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
getControlOperationAsync in interface AWSControlTowerAsyncasyncHandler - 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.public Future<GetEnabledControlResult> getEnabledControlAsync(GetEnabledControlRequest request)
AWSControlTowerAsyncProvides 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.
getEnabledControlAsync in interface AWSControlTowerAsyncpublic Future<GetEnabledControlResult> getEnabledControlAsync(GetEnabledControlRequest request, AsyncHandler<GetEnabledControlRequest,GetEnabledControlResult> asyncHandler)
AWSControlTowerAsyncProvides 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.
getEnabledControlAsync in interface AWSControlTowerAsyncasyncHandler - 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.public Future<ListEnabledControlsResult> listEnabledControlsAsync(ListEnabledControlsRequest request)
AWSControlTowerAsyncLists 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
listEnabledControlsAsync in interface AWSControlTowerAsyncpublic Future<ListEnabledControlsResult> listEnabledControlsAsync(ListEnabledControlsRequest request, AsyncHandler<ListEnabledControlsRequest,ListEnabledControlsResult> asyncHandler)
AWSControlTowerAsyncLists 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
listEnabledControlsAsync in interface AWSControlTowerAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSControlTowershutdown in class AWSControlTowerClient