Package software.amazon.awssdk.services.controltower

Interface ControlTowerAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("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.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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.

  • Field Details

  • Method Details

    • createLandingZone

      default CompletableFuture<CreateLandingZoneResponse> createLandingZone(CreateLandingZoneRequest createLandingZoneRequest)

      Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.

      Parameters:
      createLandingZoneRequest -
      Returns:
      A Java Future containing the result of the CreateLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • createLandingZone

      default CompletableFuture<CreateLandingZoneResponse> createLandingZone(Consumer<CreateLandingZoneRequest.Builder> createLandingZoneRequest)

      Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.


      This is a convenience which creates an instance of the CreateLandingZoneRequest.Builder avoiding the need to create one manually via CreateLandingZoneRequest.builder()

      Parameters:
      createLandingZoneRequest - A Consumer that will call methods on CreateLandingZoneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • deleteLandingZone

      default CompletableFuture<DeleteLandingZoneResponse> deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest)

      Decommissions 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.

      Parameters:
      deleteLandingZoneRequest -
      Returns:
      A Java Future containing the result of the DeleteLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • deleteLandingZone

      default CompletableFuture<DeleteLandingZoneResponse> deleteLandingZone(Consumer<DeleteLandingZoneRequest.Builder> deleteLandingZoneRequest)

      Decommissions 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.


      This is a convenience which creates an instance of the DeleteLandingZoneRequest.Builder avoiding the need to create one manually via DeleteLandingZoneRequest.builder()

      Parameters:
      deleteLandingZoneRequest - A Consumer that will call methods on DeleteLandingZoneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • disableBaseline

      default CompletableFuture<DisableBaselineResponse> disableBaseline(DisableBaselineRequest disableBaselineRequest)

      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.

      Parameters:
      disableBaselineRequest -
      Returns:
      A Java Future containing the result of the DisableBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • disableBaseline

      default CompletableFuture<DisableBaselineResponse> disableBaseline(Consumer<DisableBaselineRequest.Builder> disableBaselineRequest)

      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.


      This is a convenience which creates an instance of the DisableBaselineRequest.Builder avoiding the need to create one manually via DisableBaselineRequest.builder()

      Parameters:
      disableBaselineRequest - A Consumer that will call methods on DisableBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • 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. For usage examples, see the Amazon Web Services Control Tower User Guide .

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • 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. For usage examples, see the Amazon Web Services Control Tower User Guide .


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • enableBaseline

      default CompletableFuture<EnableBaselineResponse> enableBaseline(EnableBaselineRequest enableBaselineRequest)

      Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.

      Parameters:
      enableBaselineRequest -
      Returns:
      A Java Future containing the result of the EnableBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • enableBaseline

      default CompletableFuture<EnableBaselineResponse> enableBaseline(Consumer<EnableBaselineRequest.Builder> enableBaselineRequest)

      Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.


      This is a convenience which creates an instance of the EnableBaselineRequest.Builder avoiding the need to create one manually via EnableBaselineRequest.builder()

      Parameters:
      enableBaselineRequest - A Consumer that will call methods on EnableBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • enableControl

      default CompletableFuture<EnableControlResponse> enableControl(EnableControlRequest enableControlRequest)

      This 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 .

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • enableControl

      default CompletableFuture<EnableControlResponse> enableControl(Consumer<EnableControlRequest.Builder> enableControlRequest)

      This 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 .


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getBaseline

      default CompletableFuture<GetBaselineResponse> getBaseline(GetBaselineRequest getBaselineRequest)

      Retrieve details about an existing Baseline resource by specifying its identifier.

      Parameters:
      getBaselineRequest -
      Returns:
      A Java Future containing the result of the GetBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getBaseline

      default CompletableFuture<GetBaselineResponse> getBaseline(Consumer<GetBaselineRequest.Builder> getBaselineRequest)

      Retrieve details about an existing Baseline resource by specifying its identifier.


      This is a convenience which creates an instance of the GetBaselineRequest.Builder avoiding the need to create one manually via GetBaselineRequest.builder()

      Parameters:
      getBaselineRequest - A Consumer that will call methods on GetBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getBaselineOperation

      default CompletableFuture<GetBaselineOperationResponse> getBaselineOperation(GetBaselineOperationRequest getBaselineOperationRequest)

      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.

      Parameters:
      getBaselineOperationRequest -
      Returns:
      A Java Future containing the result of the GetBaselineOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getBaselineOperation

      default CompletableFuture<GetBaselineOperationResponse> getBaselineOperation(Consumer<GetBaselineOperationRequest.Builder> getBaselineOperationRequest)

      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.


      This is a convenience which creates an instance of the GetBaselineOperationRequest.Builder avoiding the need to create one manually via GetBaselineOperationRequest.builder()

      Parameters:
      getBaselineOperationRequest - A Consumer that will call methods on GetBaselineOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBaselineOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • 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. For usage examples, see the Amazon Web Services Control Tower User Guide .

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • 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. For usage examples, see the Amazon Web Services Control Tower User Guide .


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getEnabledBaseline

      default CompletableFuture<GetEnabledBaselineResponse> getEnabledBaseline(GetEnabledBaselineRequest getEnabledBaselineRequest)

      Retrieve details of an EnabledBaseline resource by specifying its identifier.

      Parameters:
      getEnabledBaselineRequest -
      Returns:
      A Java Future containing the result of the GetEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getEnabledBaseline

      default CompletableFuture<GetEnabledBaselineResponse> getEnabledBaseline(Consumer<GetEnabledBaselineRequest.Builder> getEnabledBaselineRequest)

      Retrieve details of an EnabledBaseline resource by specifying its identifier.


      This is a convenience which creates an instance of the GetEnabledBaselineRequest.Builder avoiding the need to create one manually via GetEnabledBaselineRequest.builder()

      Parameters:
      getEnabledBaselineRequest - A Consumer that will call methods on GetEnabledBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getEnabledControl

      default CompletableFuture<GetEnabledControlResponse> getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)

      Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .

      Parameters:
      getEnabledControlRequest -
      Returns:
      A Java Future containing the result of the GetEnabledControl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getEnabledControl

      default CompletableFuture<GetEnabledControlResponse> getEnabledControl(Consumer<GetEnabledControlRequest.Builder> getEnabledControlRequest)

      Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .


      This is a convenience which creates an instance of the GetEnabledControlRequest.Builder avoiding the need to create one manually via GetEnabledControlRequest.builder()

      Parameters:
      getEnabledControlRequest - A Consumer that will call methods on GetEnabledControlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEnabledControl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getLandingZone

      default CompletableFuture<GetLandingZoneResponse> getLandingZone(GetLandingZoneRequest getLandingZoneRequest)

      Returns details about the landing zone. Displays a message in case of error.

      Parameters:
      getLandingZoneRequest -
      Returns:
      A Java Future containing the result of the GetLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getLandingZone

      default CompletableFuture<GetLandingZoneResponse> getLandingZone(Consumer<GetLandingZoneRequest.Builder> getLandingZoneRequest)

      Returns details about the landing zone. Displays a message in case of error.


      This is a convenience which creates an instance of the GetLandingZoneRequest.Builder avoiding the need to create one manually via GetLandingZoneRequest.builder()

      Parameters:
      getLandingZoneRequest - A Consumer that will call methods on GetLandingZoneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getLandingZoneOperation

      default CompletableFuture<GetLandingZoneOperationResponse> getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest)

      Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.

      Parameters:
      getLandingZoneOperationRequest -
      Returns:
      A Java Future containing the result of the GetLandingZoneOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • getLandingZoneOperation

      default CompletableFuture<GetLandingZoneOperationResponse> getLandingZoneOperation(Consumer<GetLandingZoneOperationRequest.Builder> getLandingZoneOperationRequest)

      Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.


      This is a convenience which creates an instance of the GetLandingZoneOperationRequest.Builder avoiding the need to create one manually via GetLandingZoneOperationRequest.builder()

      Parameters:
      getLandingZoneOperationRequest - A Consumer that will call methods on GetLandingZoneOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLandingZoneOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • listBaselines

      default CompletableFuture<ListBaselinesResponse> listBaselines(ListBaselinesRequest listBaselinesRequest)

      Returns a summary list of all available baselines.

      Parameters:
      listBaselinesRequest -
      Returns:
      A Java Future containing the result of the ListBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listBaselines

      default CompletableFuture<ListBaselinesResponse> listBaselines(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest)

      Returns a summary list of all available baselines.


      This is a convenience which creates an instance of the ListBaselinesRequest.Builder avoiding the need to create one manually via ListBaselinesRequest.builder()

      Parameters:
      listBaselinesRequest - A Consumer that will call methods on ListBaselinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listBaselinesPaginator

      default ListBaselinesPublisher listBaselinesPaginator(ListBaselinesRequest listBaselinesRequest)

      This is a variant of listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest) 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.ListBaselinesPublisher publisher = client.listBaselinesPaginator(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.ListBaselinesPublisher publisher = client.listBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListBaselinesResponse 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 listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest) operation.

      Parameters:
      listBaselinesRequest -
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listBaselinesPaginator

      default ListBaselinesPublisher listBaselinesPaginator(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest)

      This is a variant of listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest) 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.ListBaselinesPublisher publisher = client.listBaselinesPaginator(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.ListBaselinesPublisher publisher = client.listBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListBaselinesResponse 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 listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest) operation.


      This is a convenience which creates an instance of the ListBaselinesRequest.Builder avoiding the need to create one manually via ListBaselinesRequest.builder()

      Parameters:
      listBaselinesRequest - A Consumer that will call methods on ListBaselinesRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listEnabledBaselines

      default CompletableFuture<ListEnabledBaselinesResponse> listEnabledBaselines(ListEnabledBaselinesRequest listEnabledBaselinesRequest)

      Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.

      Parameters:
      listEnabledBaselinesRequest -
      Returns:
      A Java Future containing the result of the ListEnabledBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listEnabledBaselines

      default CompletableFuture<ListEnabledBaselinesResponse> listEnabledBaselines(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest)

      Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.


      This is a convenience which creates an instance of the ListEnabledBaselinesRequest.Builder avoiding the need to create one manually via ListEnabledBaselinesRequest.builder()

      Parameters:
      listEnabledBaselinesRequest - A Consumer that will call methods on ListEnabledBaselinesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEnabledBaselines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listEnabledBaselinesPaginator

      default ListEnabledBaselinesPublisher listEnabledBaselinesPaginator(ListEnabledBaselinesRequest listEnabledBaselinesRequest)

      This is a variant of listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest) 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.ListEnabledBaselinesPublisher publisher = client.listEnabledBaselinesPaginator(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.ListEnabledBaselinesPublisher publisher = client.listEnabledBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse 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 listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest) operation.

      Parameters:
      listEnabledBaselinesRequest -
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listEnabledBaselinesPaginator

      default ListEnabledBaselinesPublisher listEnabledBaselinesPaginator(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest)

      This is a variant of listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest) 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.ListEnabledBaselinesPublisher publisher = client.listEnabledBaselinesPaginator(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.ListEnabledBaselinesPublisher publisher = client.listEnabledBaselinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse 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 listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest) operation.


      This is a convenience which creates an instance of the ListEnabledBaselinesRequest.Builder avoiding the need to create one manually via ListEnabledBaselinesRequest.builder()

      Parameters:
      listEnabledBaselinesRequest - A Consumer that will call methods on ListEnabledBaselinesRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listEnabledControls

      default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)

      Lists 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 .

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • listEnabledControls

      default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)

      Lists 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 .


      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • listEnabledControlsPaginator

      default ListEnabledControlsPublisher listEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest)

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • listEnabledControlsPaginator

      default ListEnabledControlsPublisher listEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • listLandingZones

      default CompletableFuture<ListLandingZonesResponse> listLandingZones(ListLandingZonesRequest listLandingZonesRequest)

      Returns 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.

      Parameters:
      listLandingZonesRequest -
      Returns:
      A Java Future containing the result of the ListLandingZones operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listLandingZones

      default CompletableFuture<ListLandingZonesResponse> listLandingZones(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest)

      Returns 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.


      This is a convenience which creates an instance of the ListLandingZonesRequest.Builder avoiding the need to create one manually via ListLandingZonesRequest.builder()

      Parameters:
      listLandingZonesRequest - A Consumer that will call methods on ListLandingZonesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLandingZones operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listLandingZonesPaginator

      default ListLandingZonesPublisher listLandingZonesPaginator(ListLandingZonesRequest listLandingZonesRequest)

      This is a variant of listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest) 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.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(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.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse 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 listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest) operation.

      Parameters:
      listLandingZonesRequest -
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listLandingZonesPaginator

      default ListLandingZonesPublisher listLandingZonesPaginator(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest)

      This is a variant of listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest) 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.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(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.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse 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 listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest) operation.


      This is a convenience which creates an instance of the ListLandingZonesRequest.Builder avoiding the need to create one manually via ListLandingZonesRequest.builder()

      Parameters:
      listLandingZonesRequest - A Consumer that will call methods on ListLandingZonesRequest.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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • 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:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • resetEnabledBaseline

      default CompletableFuture<ResetEnabledBaselineResponse> resetEnabledBaseline(ResetEnabledBaselineRequest resetEnabledBaselineRequest)

      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.

      Parameters:
      resetEnabledBaselineRequest -
      Returns:
      A Java Future containing the result of the ResetEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • resetEnabledBaseline

      default CompletableFuture<ResetEnabledBaselineResponse> resetEnabledBaseline(Consumer<ResetEnabledBaselineRequest.Builder> resetEnabledBaselineRequest)

      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.


      This is a convenience which creates an instance of the ResetEnabledBaselineRequest.Builder avoiding the need to create one manually via ResetEnabledBaselineRequest.builder()

      Parameters:
      resetEnabledBaselineRequest - A Consumer that will call methods on ResetEnabledBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • resetLandingZone

      default CompletableFuture<ResetLandingZoneResponse> resetLandingZone(ResetLandingZoneRequest resetLandingZoneRequest)

      This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.

      Parameters:
      resetLandingZoneRequest -
      Returns:
      A Java Future containing the result of the ResetLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • resetLandingZone

      default CompletableFuture<ResetLandingZoneResponse> resetLandingZone(Consumer<ResetLandingZoneRequest.Builder> resetLandingZoneRequest)

      This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.


      This is a convenience which creates an instance of the ResetLandingZoneRequest.Builder avoiding the need to create one manually via ResetLandingZoneRequest.builder()

      Parameters:
      resetLandingZoneRequest - A Consumer that will call methods on ResetLandingZoneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InternalServerException An unexpected error occurred during processing of a request.
      • ResourceNotFoundException The request references a resource that 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:

    • updateEnabledBaseline

      default CompletableFuture<UpdateEnabledBaselineResponse> updateEnabledBaseline(UpdateEnabledBaselineRequest updateEnabledBaselineRequest)

      Updates an EnabledBaseline resource's applied parameters or version.

      Parameters:
      updateEnabledBaselineRequest -
      Returns:
      A Java Future containing the result of the UpdateEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • updateEnabledBaseline

      default CompletableFuture<UpdateEnabledBaselineResponse> updateEnabledBaseline(Consumer<UpdateEnabledBaselineRequest.Builder> updateEnabledBaselineRequest)

      Updates an EnabledBaseline resource's applied parameters or version.


      This is a convenience which creates an instance of the UpdateEnabledBaselineRequest.Builder avoiding the need to create one manually via UpdateEnabledBaselineRequest.builder()

      Parameters:
      updateEnabledBaselineRequest - A Consumer that will call methods on UpdateEnabledBaselineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEnabledBaseline operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • updateEnabledControl

      default CompletableFuture<UpdateEnabledControlResponse> updateEnabledControl(UpdateEnabledControlRequest updateEnabledControlRequest)

      Updates the configuration of an already enabled control.

      If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

      If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.

      If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide

      Parameters:
      updateEnabledControlRequest -
      Returns:
      A Java Future containing the result of the UpdateEnabledControl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • updateEnabledControl

      default CompletableFuture<UpdateEnabledControlResponse> updateEnabledControl(Consumer<UpdateEnabledControlRequest.Builder> updateEnabledControlRequest)

      Updates the configuration of an already enabled control.

      If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

      If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.

      If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide


      This is a convenience which creates an instance of the UpdateEnabledControlRequest.Builder avoiding the need to create one manually via UpdateEnabledControlRequest.builder()

      Parameters:
      updateEnabledControlRequest - A Consumer that will call methods on UpdateEnabledControlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEnabledControl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • updateLandingZone

      default CompletableFuture<UpdateLandingZoneResponse> updateLandingZone(UpdateLandingZoneRequest updateLandingZoneRequest)

      This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.

      Parameters:
      updateLandingZoneRequest -
      Returns:
      A Java Future containing the result of the UpdateLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • updateLandingZone

      default CompletableFuture<UpdateLandingZoneResponse> updateLandingZone(Consumer<UpdateLandingZoneRequest.Builder> updateLandingZoneRequest)

      This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.


      This is a convenience which creates an instance of the UpdateLandingZoneRequest.Builder avoiding the need to create one manually via UpdateLandingZoneRequest.builder()

      Parameters:
      updateLandingZoneRequest - A Consumer that will call methods on UpdateLandingZoneRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLandingZone operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting the resource can cause an inconsistent state.
      • InternalServerException An unexpected error occurred during processing of a request.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The request was denied due to request throttling.
      • ResourceNotFoundException The request references a resource that 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:

    • serviceClientConfiguration

      default ControlTowerServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • 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.