ControlTowerAsyncClient (AWS Java SDK :: Services

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface ControlTowerAsyncClient
extends AwsClient
```
Service client for accessing AWS Control Tower asynchronously. This can be created using the static builder() method.
These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.

To call these APIs, you'll need to know:
- the ControlARN for the control--that is, the guardrail--you are targeting,
- and the ARN associated with the target organizational unit (OU).
To get the ControlARN for your AWS Control Tower guardrail:

The ControlARN contains the control name which is specified in each guardrail. For a list of control names for Strongly recommended and Elective guardrails, see Resource identifiers for APIs and guardrails in the Automating tasks section of the AWS Control Tower User Guide. Remember that Mandatory guardrails 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 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.

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_METADATA_ID
Value for looking up the service's metadata from the ServiceMetadataProvider.

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_METADATA_ID` Value for looking up the service's metadata from the `ServiceMetadataProvider`.
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static ControlTowerAsyncClientBuilder`	`builder()` Create a builder that can be used to configure and create a `ControlTowerAsyncClient`.
`static ControlTowerAsyncClient`	`create()` Create a `ControlTowerAsyncClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CompletableFuture<DisableControlResponse>`	`disableControl(Consumer<DisableControlRequest.Builder> disableControlRequest)` This API call turns off a control.
`default CompletableFuture<DisableControlResponse>`	`disableControl(DisableControlRequest disableControlRequest)` This API call turns off a control.
`default CompletableFuture<EnableControlResponse>`	`enableControl(Consumer<EnableControlRequest.Builder> enableControlRequest)` This API call activates a control.
`default CompletableFuture<EnableControlResponse>`	`enableControl(EnableControlRequest enableControlRequest)` This API call activates a control.
`default CompletableFuture<GetControlOperationResponse>`	`getControlOperation(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest)` Returns the status of a particular `EnableControl` or `DisableControl` operation.
`default CompletableFuture<GetControlOperationResponse>`	`getControlOperation(GetControlOperationRequest getControlOperationRequest)` Returns the status of a particular `EnableControl` or `DisableControl` operation.
`default CompletableFuture<ListEnabledControlsResponse>`	`listEnabledControls(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)` Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
`default CompletableFuture<ListEnabledControlsResponse>`	`listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)` Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
`default ListEnabledControlsPublisher`	`listEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)` Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
`default ListEnabledControlsPublisher`	`listEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest)` Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
`default ControlTowerServiceClientConfiguration`	`serviceClientConfiguration()`

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_METADATA_ID
```
static final String SERVICE_METADATA_ID
```
    Value for looking up the service's metadata from the ServiceMetadataProvider.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - disableControl
```
default CompletableFuture<DisableControlResponse> disableControl(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.
    Parameters:
    
    disableControlRequest -
    
    Returns:
    A Java Future containing the result of the DisableControl operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - disableControl
```
default CompletableFuture<DisableControlResponse> disableControl(Consumer<DisableControlRequest.Builder> 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.
    
    This is a convenience which creates an instance of the DisableControlRequest.Builder avoiding the need to create one manually via DisableControlRequest.builder()
    Parameters:
    
    disableControlRequest - A Consumer that will call methods on DisableControlRequest.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the DisableControl operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - enableControl
```
default CompletableFuture<EnableControlResponse> enableControl(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.
    Parameters:
    
    enableControlRequest -
    
    Returns:
    A Java Future containing the result of the EnableControl operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - enableControl
```
default CompletableFuture<EnableControlResponse> enableControl(Consumer<EnableControlRequest.Builder> 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.
    
    This is a convenience which creates an instance of the EnableControlRequest.Builder avoiding the need to create one manually via EnableControlRequest.builder()
    Parameters:
    
    enableControlRequest - A Consumer that will call methods on EnableControlRequest.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the EnableControl operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - getControlOperation
```
default CompletableFuture<GetControlOperationResponse> getControlOperation(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.
    Parameters:
    
    getControlOperationRequest -
    
    Returns:
    A Java Future containing the result of the GetControlOperation operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - getControlOperation
```
default CompletableFuture<GetControlOperationResponse> getControlOperation(Consumer<GetControlOperationRequest.Builder> 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.
    
    This is a convenience which creates an instance of the GetControlOperationRequest.Builder avoiding the need to create one manually via GetControlOperationRequest.builder()
    Parameters:
    
    getControlOperationRequest - A Consumer that will call methods on GetControlOperationRequest.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the GetControlOperation operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listEnabledControls
```
default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)
```
    Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
    Parameters:
    
    listEnabledControlsRequest -
    
    Returns:
    A Java Future containing the result of the ListEnabledControls operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listEnabledControls
```
default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)
```
    Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
    
    This is a convenience which creates an instance of the ListEnabledControlsRequest.Builder avoiding the need to create one manually via ListEnabledControlsRequest.builder()
    Parameters:
    
    listEnabledControlsRequest - A Consumer that will call methods on ListEnabledControlsRequest.Builder to create a request.
    
    Returns:
    A Java Future containing the result of the ListEnabledControls operation returned by the service.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listEnabledControlsPaginator
```
default ListEnabledControlsPublisher listEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest)
```
    Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
    
    This is a variant of listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.
    
    When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.
    
    The following are few ways to use the response class:
    1) Using the subscribe helper method
```
 
 software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 
```
    2) Using a custom subscriber
```
 
 software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse response) { //... };
 });
 
```
    As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
    Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
    
    Note: If you prefer to have control on service calls, use the listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest) operation.
    Parameters:
    
    listEnabledControlsRequest -
    
    Returns:
    A custom publisher that can be subscribed to request a stream of response pages.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - listEnabledControlsPaginator
```
default ListEnabledControlsPublisher listEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)
```
    Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
    
    This is a variant of listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.
    
    When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.
    
    The following are few ways to use the response class:
    1) Using the subscribe helper method
```
 
 software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 
```
    2) Using a custom subscriber
```
 
 software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse response) { //... };
 });
 
```
    As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
    Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
    
    Note: If you prefer to have control on service calls, use the listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest) operation.
    
    This is a convenience which creates an instance of the ListEnabledControlsRequest.Builder avoiding the need to create one manually via ListEnabledControlsRequest.builder()
    Parameters:
    
    listEnabledControlsRequest - A Consumer that will call methods on ListEnabledControlsRequest.Builder to create a request.
    
    Returns:
    A custom publisher that can be subscribed to request a stream of response pages.
    The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
    
    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.
    
    SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    See Also:
    
    AWS API Documentation
  - serviceClientConfiguration
```
default ControlTowerServiceClientConfiguration serviceClientConfiguration()
```
    Specified by:
    
    serviceClientConfiguration in interface AwsClient
    
    Specified by:
    
    serviceClientConfiguration in interface SdkClient
  - create
```
static ControlTowerAsyncClient create()
```
    Create a ControlTowerAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static ControlTowerAsyncClientBuilder builder()
```
    Create a builder that can be used to configure and create a ControlTowerAsyncClient.

Interface ControlTowerAsyncClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Field Detail

SERVICE_NAME

SERVICE_METADATA_ID

Method Detail

disableControl

disableControl

enableControl

enableControl

getControlOperation

getControlOperation

listEnabledControls

listEnabledControls

listEnabledControlsPaginator

listEnabledControlsPaginator

serviceClientConfiguration

create

builder