@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 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
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, deleteLandingZone, disableBaseline, disableControl, enableBaseline, enableControl, getBaseline, getBaselineOperation, getCachedResponseMetadata, getControlOperation, getEnabledBaseline, getEnabledControl, getLandingZoneOperation, listBaselines, listEnabledBaselines, listEnabledControls, listLandingZones, listTagsForResource, resetEnabledBaseline, resetLandingZone, tagResource, untagResource, updateEnabledBaselineaddRequestHandler, 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, waitdeleteLandingZone, disableBaseline, disableControl, enableBaseline, enableControl, getBaseline, getBaselineOperation, getCachedResponseMetadata, getControlOperation, getEnabledBaseline, getEnabledControl, getLandingZoneOperation, listBaselines, listEnabledBaselines, listEnabledControls, listLandingZones, listTagsForResource, resetEnabledBaseline, resetLandingZone, tagResource, untagResource, updateEnabledBaselinepublic static AWSControlTowerAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<DeleteLandingZoneResult> deleteLandingZoneAsync(DeleteLandingZoneRequest request)
AWSControlTowerAsyncDecommissions 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.
deleteLandingZoneAsync in interface AWSControlTowerAsyncpublic Future<DeleteLandingZoneResult> deleteLandingZoneAsync(DeleteLandingZoneRequest request, AsyncHandler<DeleteLandingZoneRequest,DeleteLandingZoneResult> asyncHandler)
AWSControlTowerAsyncDecommissions 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.
deleteLandingZoneAsync 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<DisableBaselineResult> disableBaselineAsync(DisableBaselineRequest request)
AWSControlTowerAsync
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.
disableBaselineAsync in interface AWSControlTowerAsyncpublic Future<DisableBaselineResult> disableBaselineAsync(DisableBaselineRequest request, AsyncHandler<DisableBaselineRequest,DisableBaselineResult> asyncHandler)
AWSControlTowerAsync
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.
disableBaselineAsync 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<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 Amazon Web Services 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 Amazon Web Services 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<EnableBaselineResult> enableBaselineAsync(EnableBaselineRequest request)
AWSControlTowerAsync
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources
specified by the Baseline to the specified Target.
enableBaselineAsync in interface AWSControlTowerAsyncpublic Future<EnableBaselineResult> enableBaselineAsync(EnableBaselineRequest request, AsyncHandler<EnableBaselineRequest,EnableBaselineResult> asyncHandler)
AWSControlTowerAsync
Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources
specified by the Baseline to the specified Target.
enableBaselineAsync 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 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 .
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 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 .
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<GetBaselineResult> getBaselineAsync(GetBaselineRequest request)
AWSControlTowerAsync
Retrieve details about an existing Baseline resource by specifying its identifier.
getBaselineAsync in interface AWSControlTowerAsyncpublic Future<GetBaselineResult> getBaselineAsync(GetBaselineRequest request, AsyncHandler<GetBaselineRequest,GetBaselineResult> asyncHandler)
AWSControlTowerAsync
Retrieve details about an existing Baseline resource by specifying its identifier.
getBaselineAsync 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<GetBaselineOperationResult> getBaselineOperationAsync(GetBaselineOperationRequest request)
AWSControlTowerAsync
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.
getBaselineOperationAsync in interface AWSControlTowerAsyncpublic Future<GetBaselineOperationResult> getBaselineOperationAsync(GetBaselineOperationRequest request, AsyncHandler<GetBaselineOperationRequest,GetBaselineOperationResult> asyncHandler)
AWSControlTowerAsync
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.
getBaselineOperationAsync 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 Amazon
Web Services 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 Amazon
Web Services 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<GetEnabledBaselineResult> getEnabledBaselineAsync(GetEnabledBaselineRequest request)
AWSControlTowerAsync
Retrieve details of an EnabledBaseline resource by specifying its identifier.
getEnabledBaselineAsync in interface AWSControlTowerAsyncpublic Future<GetEnabledBaselineResult> getEnabledBaselineAsync(GetEnabledBaselineRequest request, AsyncHandler<GetEnabledBaselineRequest,GetEnabledBaselineResult> asyncHandler)
AWSControlTowerAsync
Retrieve details of an EnabledBaseline resource by specifying its identifier.
getEnabledBaselineAsync 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)
AWSControlTowerAsyncRetrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
getEnabledControlAsync in interface AWSControlTowerAsyncpublic Future<GetEnabledControlResult> getEnabledControlAsync(GetEnabledControlRequest request, AsyncHandler<GetEnabledControlRequest,GetEnabledControlResult> asyncHandler)
AWSControlTowerAsyncRetrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
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<GetLandingZoneOperationResult> getLandingZoneOperationAsync(GetLandingZoneOperationRequest request)
AWSControlTowerAsyncReturns the status of the specified landing zone operation. Details for an operation are available for 60 days.
getLandingZoneOperationAsync in interface AWSControlTowerAsyncpublic Future<GetLandingZoneOperationResult> getLandingZoneOperationAsync(GetLandingZoneOperationRequest request, AsyncHandler<GetLandingZoneOperationRequest,GetLandingZoneOperationResult> asyncHandler)
AWSControlTowerAsyncReturns the status of the specified landing zone operation. Details for an operation are available for 60 days.
getLandingZoneOperationAsync 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<ListBaselinesResult> listBaselinesAsync(ListBaselinesRequest request)
AWSControlTowerAsyncReturns a summary list of all available baselines.
listBaselinesAsync in interface AWSControlTowerAsyncpublic Future<ListBaselinesResult> listBaselinesAsync(ListBaselinesRequest request, AsyncHandler<ListBaselinesRequest,ListBaselinesResult> asyncHandler)
AWSControlTowerAsyncReturns a summary list of all available baselines.
listBaselinesAsync 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<ListEnabledBaselinesResult> listEnabledBaselinesAsync(ListEnabledBaselinesRequest request)
AWSControlTowerAsync
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the
corresponding Baseline or Target of the EnabledBaseline resources.
listEnabledBaselinesAsync in interface AWSControlTowerAsyncpublic Future<ListEnabledBaselinesResult> listEnabledBaselinesAsync(ListEnabledBaselinesRequest request, AsyncHandler<ListEnabledBaselinesRequest,ListEnabledBaselinesResult> asyncHandler)
AWSControlTowerAsync
Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the
corresponding Baseline or Target of the EnabledBaseline resources.
listEnabledBaselinesAsync 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 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 .
listEnabledControlsAsync in interface AWSControlTowerAsyncpublic Future<ListEnabledControlsResult> listEnabledControlsAsync(ListEnabledControlsRequest request, AsyncHandler<ListEnabledControlsRequest,ListEnabledControlsResult> asyncHandler)
AWSControlTowerAsyncLists 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 .
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 Future<ListLandingZonesResult> listLandingZonesAsync(ListLandingZonesRequest request)
AWSControlTowerAsyncReturns 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.
listLandingZonesAsync in interface AWSControlTowerAsyncpublic Future<ListLandingZonesResult> listLandingZonesAsync(ListLandingZonesRequest request, AsyncHandler<ListLandingZonesRequest,ListLandingZonesResult> asyncHandler)
AWSControlTowerAsyncReturns 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.
listLandingZonesAsync 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSControlTowerAsyncReturns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
listTagsForResourceAsync in interface AWSControlTowerAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSControlTowerAsyncReturns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
listTagsForResourceAsync 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<ResetEnabledBaselineResult> resetEnabledBaselineAsync(ResetEnabledBaselineRequest request)
AWSControlTowerAsync
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.
resetEnabledBaselineAsync in interface AWSControlTowerAsyncpublic Future<ResetEnabledBaselineResult> resetEnabledBaselineAsync(ResetEnabledBaselineRequest request, AsyncHandler<ResetEnabledBaselineRequest,ResetEnabledBaselineResult> asyncHandler)
AWSControlTowerAsync
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.
resetEnabledBaselineAsync 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<ResetLandingZoneResult> resetLandingZoneAsync(ResetLandingZoneRequest request)
AWSControlTowerAsyncThis API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
resetLandingZoneAsync in interface AWSControlTowerAsyncpublic Future<ResetLandingZoneResult> resetLandingZoneAsync(ResetLandingZoneRequest request, AsyncHandler<ResetLandingZoneRequest,ResetLandingZoneResult> asyncHandler)
AWSControlTowerAsyncThis API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
resetLandingZoneAsync 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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSControlTowerAsyncApplies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
tagResourceAsync in interface AWSControlTowerAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSControlTowerAsyncApplies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
tagResourceAsync 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSControlTowerAsyncRemoves tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
untagResourceAsync in interface AWSControlTowerAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSControlTowerAsyncRemoves tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
untagResourceAsync 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<UpdateEnabledBaselineResult> updateEnabledBaselineAsync(UpdateEnabledBaselineRequest request)
AWSControlTowerAsync
Updates an EnabledBaseline resource's applied parameters or version.
updateEnabledBaselineAsync in interface AWSControlTowerAsyncpublic Future<UpdateEnabledBaselineResult> updateEnabledBaselineAsync(UpdateEnabledBaselineRequest request, AsyncHandler<UpdateEnabledBaselineRequest,UpdateEnabledBaselineResult> asyncHandler)
AWSControlTowerAsync
Updates an EnabledBaseline resource's applied parameters or version.
updateEnabledBaselineAsync 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