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 staticbuilder()method.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
controlIdentifierfor 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
controlIdentifierfor your AWS Control Tower control:The
controlIdentifieris an ARN that is specified for each control. You can view thecontrolIdentifierin the console on the Control details page, as well as in the documentation.The
controlIdentifieris unique in each Amazon Web Services Region for each control. You can find thecontrolIdentifierfor 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_DISABLEDTo get the
targetIdentifier:The
targetIdentifieris 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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ControlTowerAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aControlTowerAsyncClient.static ControlTowerAsyncClientcreate()Create aControlTowerAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateLandingZoneResponse>createLandingZone(Consumer<CreateLandingZoneRequest.Builder> createLandingZoneRequest)Creates a new landing zone.default CompletableFuture<CreateLandingZoneResponse>createLandingZone(CreateLandingZoneRequest createLandingZoneRequest)Creates a new landing zone.default CompletableFuture<DeleteLandingZoneResponse>deleteLandingZone(Consumer<DeleteLandingZoneRequest.Builder> deleteLandingZoneRequest)This decommissions a landing zone.default CompletableFuture<DeleteLandingZoneResponse>deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest)This decommissions a landing zone.default CompletableFuture<DisableControlResponse>disableControl(Consumer<DisableControlRequest.Builder> disableControlRequest)This API call turns off a control.default CompletableFuture<DisableControlResponse>disableControl(DisableControlRequest disableControlRequest)This API call turns off a control.default CompletableFuture<EnableControlResponse>enableControl(Consumer<EnableControlRequest.Builder> enableControlRequest)This API call activates a control.default CompletableFuture<EnableControlResponse>enableControl(EnableControlRequest enableControlRequest)This API call activates a control.default CompletableFuture<GetControlOperationResponse>getControlOperation(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest)Returns the status of a particularEnableControlorDisableControloperation.default CompletableFuture<GetControlOperationResponse>getControlOperation(GetControlOperationRequest getControlOperationRequest)Returns the status of a particularEnableControlorDisableControloperation.default CompletableFuture<GetEnabledControlResponse>getEnabledControl(Consumer<GetEnabledControlRequest.Builder> getEnabledControlRequest)Retrieves details about an enabled control.default CompletableFuture<GetEnabledControlResponse>getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)Retrieves details about an enabled control.default CompletableFuture<GetLandingZoneResponse>getLandingZone(Consumer<GetLandingZoneRequest.Builder> getLandingZoneRequest)Returns details about the landing zone.default CompletableFuture<GetLandingZoneResponse>getLandingZone(GetLandingZoneRequest getLandingZoneRequest)Returns details about the landing zone.default CompletableFuture<GetLandingZoneOperationResponse>getLandingZoneOperation(Consumer<GetLandingZoneOperationRequest.Builder> getLandingZoneOperationRequest)Returns the status of the specified landing zone operation.default CompletableFuture<GetLandingZoneOperationResponse>getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest)Returns the status of the specified landing zone operation.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.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.default ListEnabledControlsPublisherlistEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.default ListEnabledControlsPublisherlistEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest)Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.default CompletableFuture<ListLandingZonesResponse>listLandingZones(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest)Returns the landing zone ARN for the landing zone deployed in your managed account.default CompletableFuture<ListLandingZonesResponse>listLandingZones(ListLandingZonesRequest listLandingZonesRequest)Returns the landing zone ARN for the landing zone deployed in your managed account.default ListLandingZonesPublisherlistLandingZonesPaginator(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest)Returns the landing zone ARN for the landing zone deployed in your managed account.default ListLandingZonesPublisherlistLandingZonesPaginator(ListLandingZonesRequest listLandingZonesRequest)Returns the landing zone ARN for the landing zone deployed in your managed account.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags associated with the resource.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags associated with the resource.default CompletableFuture<ResetLandingZoneResponse>resetLandingZone(Consumer<ResetLandingZoneRequest.Builder> resetLandingZoneRequest)This API call resets a landing zone.default CompletableFuture<ResetLandingZoneResponse>resetLandingZone(ResetLandingZoneRequest resetLandingZoneRequest)This API call resets a landing zone.default ControlTowerServiceClientConfigurationserviceClientConfiguration()default CompletableFuture<TagResourceResponse>tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Applies tags to a resource.default CompletableFuture<TagResourceResponse>tagResource(TagResourceRequest tagResourceRequest)Applies tags to a resource.default CompletableFuture<UntagResourceResponse>untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes tags from a resource.default CompletableFuture<UntagResourceResponse>untagResource(UntagResourceRequest untagResourceRequest)Removes tags from a resource.default CompletableFuture<UpdateLandingZoneResponse>updateLandingZone(Consumer<UpdateLandingZoneRequest.Builder> updateLandingZoneRequest)This API call updates the landing zone.default CompletableFuture<UpdateLandingZoneResponse>updateLandingZone(UpdateLandingZoneRequest updateLandingZoneRequest)This API call updates the landing zone.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createLandingZone
default CompletableFuture<CreateLandingZoneResponse> createLandingZone(CreateLandingZoneRequest createLandingZoneRequest)
Creates a new landing zone. This 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
createLandingZone
default CompletableFuture<CreateLandingZoneResponse> createLandingZone(Consumer<CreateLandingZoneRequest.Builder> createLandingZoneRequest)
Creates a new landing zone. This 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.Builderavoiding the need to create one manually viaCreateLandingZoneRequest.builder()- Parameters:
createLandingZoneRequest- AConsumerthat will call methods onCreateLandingZoneRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
deleteLandingZone
default CompletableFuture<DeleteLandingZoneResponse> deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest)
This decommissions a landing zone. This starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in Amazon Web Services Control Tower managed accounts.
- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteLandingZone
default CompletableFuture<DeleteLandingZoneResponse> deleteLandingZone(Consumer<DeleteLandingZoneRequest.Builder> deleteLandingZoneRequest)
This decommissions a landing zone. This starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in Amazon Web Services Control Tower managed accounts.
This is a convenience which creates an instance of the
DeleteLandingZoneRequest.Builderavoiding the need to create one manually viaDeleteLandingZoneRequest.builder()- Parameters:
deleteLandingZoneRequest- AConsumerthat will call methods onDeleteLandingZoneRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disableControl
default CompletableFuture<DisableControlResponse> disableControl(DisableControlRequest disableControlRequest)
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disableControl
default CompletableFuture<DisableControlResponse> disableControl(Consumer<DisableControlRequest.Builder> disableControlRequest)
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services 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.Builderavoiding the need to create one manually viaDisableControlRequest.builder()- Parameters:
disableControlRequest- AConsumerthat will call methods onDisableControlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableControl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableControl
default CompletableFuture<EnableControlResponse> enableControl(EnableControlRequest enableControlRequest)
This API call activates a control. It starts an asynchronous operation that creates 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
enableControl
default CompletableFuture<EnableControlResponse> enableControl(Consumer<EnableControlRequest.Builder> enableControlRequest)
This API call activates a control. It starts an asynchronous operation that creates 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.Builderavoiding the need to create one manually viaEnableControlRequest.builder()- Parameters:
enableControlRequest- AConsumerthat will call methods onEnableControlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableControl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getControlOperation
default CompletableFuture<GetControlOperationResponse> getControlOperation(GetControlOperationRequest getControlOperationRequest)
Returns the status of a particular
EnableControlorDisableControloperation. 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getControlOperation
default CompletableFuture<GetControlOperationResponse> getControlOperation(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest)
Returns the status of a particular
EnableControlorDisableControloperation. 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.Builderavoiding the need to create one manually viaGetControlOperationRequest.builder()- Parameters:
getControlOperationRequest- AConsumerthat will call methods onGetControlOperationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetControlOperation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetEnabledControlRequest.builder()- Parameters:
getEnabledControlRequest- AConsumerthat will call methods onGetEnabledControlRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetLandingZoneRequest.builder()- Parameters:
getLandingZoneRequest- AConsumerthat will call methods onGetLandingZoneRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getLandingZoneOperation
default CompletableFuture<GetLandingZoneOperationResponse> getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest)
Returns the status of the specified landing zone operation. Details for an operation are available for X 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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 X days.
This is a convenience which creates an instance of the
GetLandingZoneOperationRequest.Builderavoiding the need to create one manually viaGetLandingZoneOperationRequest.builder()- Parameters:
getLandingZoneOperationRequest- AConsumerthat will call methods onGetLandingZoneOperationRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEnabledControls
default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)
Lists the controls enabled by 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEnabledControls
default CompletableFuture<ListEnabledControlsResponse> listEnabledControls(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)
Lists the controls enabled by 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.Builderavoiding the need to create one manually viaListEnabledControlsRequest.builder()- Parameters:
listEnabledControlsRequest- AConsumerthat will call methods onListEnabledControlsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEnabledControls operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEnabledControlsPaginator
default ListEnabledControlsPublisher listEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest)
Lists the controls enabled by 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 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest)operation.- Parameters:
listEnabledControlsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEnabledControlsPaginator
default ListEnabledControlsPublisher listEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest)
Lists the controls enabled by 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 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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsPublisher publisher = client.listEnabledControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListEnabledControlsRequest.builder()- Parameters:
listEnabledControlsRequest- AConsumerthat will call methods onListEnabledControlsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.
The return limit is 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
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.
The return limit is one landing zone ARN.
This is a convenience which creates an instance of the
ListLandingZonesRequest.Builderavoiding the need to create one manually viaListLandingZonesRequest.builder()- Parameters:
listLandingZonesRequest- AConsumerthat will call methods onListLandingZonesRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
listLandingZonesPaginator
default ListLandingZonesPublisher listLandingZonesPaginator(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.
The return limit is one landing zone ARN.
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
listLandingZonesPaginator
default ListLandingZonesPublisher listLandingZonesPaginator(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.
The return limit is one landing zone ARN.
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesPublisher publisher = client.listLandingZonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListLandingZonesRequest.builder()- Parameters:
listLandingZonesRequest- AConsumerthat will call methods onListLandingZonesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException 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:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaResetLandingZoneRequest.builder()- Parameters:
resetLandingZoneRequest- AConsumerthat will call methods onResetLandingZoneRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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 the updated 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
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 the updated parameters specified in the updated manifest file.
This is a convenience which creates an instance of the
UpdateLandingZoneRequest.Builderavoiding the need to create one manually viaUpdateLandingZoneRequest.builder()- Parameters:
updateLandingZoneRequest- AConsumerthat will call methods onUpdateLandingZoneRequest.Builderto 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ControlTowerException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default ControlTowerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static ControlTowerAsyncClient create()
Create aControlTowerAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ControlTowerAsyncClientBuilder builder()
Create a builder that can be used to configure and create aControlTowerAsyncClient.
-
-