Interface ControlTowerClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ControlTowerClient extends AwsClient
Service client for accessing AWS Control Tower. This can be created using the staticbuilder()method.Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
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 Amazon Web Services 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 or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference 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 Amazon Web Services Control Tower Controls Reference 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}About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the "Actions" section.
About baseline APIs
You can apply the
AWSControlTowerBaselinebaseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the "Actions" section. For usage examples, see Baseline API input and output examples with CLI.
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
-
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 CreateLandingZoneResponse createLandingZone(CreateLandingZoneRequest createLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
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:
- Result of the CreateLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createLandingZone
default CreateLandingZoneResponse createLandingZone(Consumer<CreateLandingZoneRequest.Builder> createLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
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.Builderavoiding the need to create one manually viaCreateLandingZoneRequest.builder()- Parameters:
createLandingZoneRequest- AConsumerthat will call methods onCreateLandingZoneRequest.Builderto create a request.- Returns:
- Result of the CreateLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLandingZone
default DeleteLandingZoneResponse deleteLandingZone(DeleteLandingZoneRequest deleteLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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:
- Result of the DeleteLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLandingZone
default DeleteLandingZoneResponse deleteLandingZone(Consumer<DeleteLandingZoneRequest.Builder> deleteLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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.Builderavoiding the need to create one manually viaDeleteLandingZoneRequest.builder()- Parameters:
deleteLandingZoneRequest- AConsumerthat will call methods onDeleteLandingZoneRequest.Builderto create a request.- Returns:
- Result of the DeleteLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disableBaseline
default DisableBaselineResponse disableBaseline(DisableBaselineRequest disableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Disable an
EnabledBaselineresource 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. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
disableBaselineRequest-- Returns:
- Result of the DisableBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disableBaseline
default DisableBaselineResponse disableBaseline(Consumer<DisableBaselineRequest.Builder> disableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Disable an
EnabledBaselineresource 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. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
DisableBaselineRequest.Builderavoiding the need to create one manually viaDisableBaselineRequest.builder()- Parameters:
disableBaselineRequest- AConsumerthat will call methods onDisableBaselineRequest.Builderto create a request.- Returns:
- Result of the DisableBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disableControl
default DisableControlResponse disableControl(DisableControlRequest disableControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference Guide .
- Parameters:
disableControlRequest-- Returns:
- Result of the DisableControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disableControl
default DisableControlResponse disableControl(Consumer<DisableControlRequest.Builder> disableControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference 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:
- Result of the DisableControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableBaseline
default EnableBaselineResponse enableBaseline(EnableBaselineRequest enableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Enable (apply) a
Baselineto a Target. This API starts an asynchronous operation to deploy resources specified by theBaselineto the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
enableBaselineRequest-- Returns:
- Result of the EnableBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableBaseline
default EnableBaselineResponse enableBaseline(Consumer<EnableBaselineRequest.Builder> enableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Enable (apply) a
Baselineto a Target. This API starts an asynchronous operation to deploy resources specified by theBaselineto the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
EnableBaselineRequest.Builderavoiding the need to create one manually viaEnableBaselineRequest.builder()- Parameters:
enableBaselineRequest- AConsumerthat will call methods onEnableBaselineRequest.Builderto create a request.- Returns:
- Result of the EnableBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableControl
default EnableControlResponse enableControl(EnableControlRequest enableControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference Guide .
- Parameters:
enableControlRequest-- Returns:
- Result of the EnableControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableControl
default EnableControlResponse enableControl(Consumer<EnableControlRequest.Builder> enableControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference 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:
- Result of the EnableControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getBaseline
default GetBaselineResponse getBaseline(GetBaselineRequest getBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieve details about an existing
Baselineresource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
getBaselineRequest-- Returns:
- Result of the GetBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getBaseline
default GetBaselineResponse getBaseline(Consumer<GetBaselineRequest.Builder> getBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieve details about an existing
Baselineresource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
GetBaselineRequest.Builderavoiding the need to create one manually viaGetBaselineRequest.builder()- Parameters:
getBaselineRequest- AConsumerthat will call methods onGetBaselineRequest.Builderto create a request.- Returns:
- Result of the GetBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getBaselineOperation
default GetBaselineOperationResponse getBaselineOperation(GetBaselineOperationRequest getBaselineOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
getBaselineOperationRequest-- Returns:
- Result of the GetBaselineOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getBaselineOperation
default GetBaselineOperationResponse getBaselineOperation(Consumer<GetBaselineOperationRequest.Builder> getBaselineOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
GetBaselineOperationRequest.Builderavoiding the need to create one manually viaGetBaselineOperationRequest.builder()- Parameters:
getBaselineOperationRequest- AConsumerthat will call methods onGetBaselineOperationRequest.Builderto create a request.- Returns:
- Result of the GetBaselineOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getControlOperation
default GetControlOperationResponse getControlOperation(GetControlOperationRequest getControlOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference Guide .- Parameters:
getControlOperationRequest-- Returns:
- Result of the GetControlOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getControlOperation
default GetControlOperationResponse getControlOperation(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference 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:
- Result of the GetControlOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnabledBaseline
default GetEnabledBaselineResponse getEnabledBaseline(GetEnabledBaselineRequest getEnabledBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieve details of an
EnabledBaselineresource by specifying its identifier.- Parameters:
getEnabledBaselineRequest-- Returns:
- Result of the GetEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnabledBaseline
default GetEnabledBaselineResponse getEnabledBaseline(Consumer<GetEnabledBaselineRequest.Builder> getEnabledBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieve details of an
EnabledBaselineresource by specifying its identifier.
This is a convenience which creates an instance of the
GetEnabledBaselineRequest.Builderavoiding the need to create one manually viaGetEnabledBaselineRequest.builder()- Parameters:
getEnabledBaselineRequest- AConsumerthat will call methods onGetEnabledBaselineRequest.Builderto create a request.- Returns:
- Result of the GetEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnabledControl
default GetEnabledControlResponse getEnabledControl(GetEnabledControlRequest getEnabledControlRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
- Parameters:
getEnabledControlRequest-- Returns:
- Result of the GetEnabledControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEnabledControl
default GetEnabledControlResponse getEnabledControl(Consumer<GetEnabledControlRequest.Builder> getEnabledControlRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Retrieves details about an enabled control. For usage examples, see the Controls Reference 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:
- Result of the GetEnabledControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLandingZone
default GetLandingZoneResponse getLandingZone(GetLandingZoneRequest getLandingZoneRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Returns details about the landing zone. Displays a message in case of error.
- Parameters:
getLandingZoneRequest-- Returns:
- Result of the GetLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLandingZone
default GetLandingZoneResponse getLandingZone(Consumer<GetLandingZoneRequest.Builder> getLandingZoneRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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:
- Result of the GetLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLandingZoneOperation
default GetLandingZoneOperationResponse getLandingZoneOperation(GetLandingZoneOperationRequest getLandingZoneOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
- Parameters:
getLandingZoneOperationRequest-- Returns:
- Result of the GetLandingZoneOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getLandingZoneOperation
default GetLandingZoneOperationResponse getLandingZoneOperation(Consumer<GetLandingZoneOperationRequest.Builder> getLandingZoneOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Returns the status of the specified landing zone operation. Details for an operation are available for 90 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:
- Result of the GetLandingZoneOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBaselines
default ListBaselinesResponse listBaselines(ListBaselinesRequest listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
- Parameters:
listBaselinesRequest-- Returns:
- Result of the ListBaselines operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBaselines
default ListBaselinesResponse listBaselines(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
ListBaselinesRequest.Builderavoiding the need to create one manually viaListBaselinesRequest.builder()- Parameters:
listBaselinesRequest- AConsumerthat will call methods onListBaselinesRequest.Builderto create a request.- Returns:
- Result of the ListBaselines operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBaselinesPaginator
default ListBaselinesIterable listBaselinesPaginator(ListBaselinesRequest listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client.listBaselinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client .listBaselinesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListBaselinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client.listBaselinesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listBaselinesPaginator
default ListBaselinesIterable listBaselinesPaginator(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client.listBaselinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client .listBaselinesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListBaselinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListBaselinesIterable responses = client.listBaselinesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListBaselinesRequest.builder()- Parameters:
listBaselinesRequest- AConsumerthat will call methods onListBaselinesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listControlOperations
default ListControlOperationsResponse listControlOperations(ListControlOperationsRequest listControlOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
- Parameters:
listControlOperationsRequest-- Returns:
- Result of the ListControlOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listControlOperations
default ListControlOperationsResponse listControlOperations(Consumer<ListControlOperationsRequest.Builder> listControlOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
This is a convenience which creates an instance of the
ListControlOperationsRequest.Builderavoiding the need to create one manually viaListControlOperationsRequest.builder()- Parameters:
listControlOperationsRequest- AConsumerthat will call methods onListControlOperationsRequest.Builderto create a request.- Returns:
- Result of the ListControlOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listControlOperationsPaginator
default ListControlOperationsIterable listControlOperationsPaginator(ListControlOperationsRequest listControlOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listControlOperations(software.amazon.awssdk.services.controltower.model.ListControlOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client.listControlOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client .listControlOperationsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListControlOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client.listControlOperationsPaginator(request); responses.iterator().forEachRemaining(....);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
listControlOperations(software.amazon.awssdk.services.controltower.model.ListControlOperationsRequest)operation.- Parameters:
listControlOperationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listControlOperationsPaginator
default ListControlOperationsIterable listControlOperationsPaginator(Consumer<ListControlOperationsRequest.Builder> listControlOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listControlOperations(software.amazon.awssdk.services.controltower.model.ListControlOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client.listControlOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client .listControlOperationsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListControlOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListControlOperationsIterable responses = client.listControlOperationsPaginator(request); responses.iterator().forEachRemaining(....);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
listControlOperations(software.amazon.awssdk.services.controltower.model.ListControlOperationsRequest)operation.
This is a convenience which creates an instance of the
ListControlOperationsRequest.Builderavoiding the need to create one manually viaListControlOperationsRequest.builder()- Parameters:
listControlOperationsRequest- AConsumerthat will call methods onListControlOperationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledBaselines
default ListEnabledBaselinesResponse listEnabledBaselines(ListEnabledBaselinesRequest listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Returns a list of summaries describing
EnabledBaselineresources. You can filter the list by the correspondingBaselineorTargetof theEnabledBaselineresources. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
listEnabledBaselinesRequest-- Returns:
- Result of the ListEnabledBaselines operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledBaselines
default ListEnabledBaselinesResponse listEnabledBaselines(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Returns a list of summaries describing
EnabledBaselineresources. You can filter the list by the correspondingBaselineorTargetof theEnabledBaselineresources. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
ListEnabledBaselinesRequest.Builderavoiding the need to create one manually viaListEnabledBaselinesRequest.builder()- Parameters:
listEnabledBaselinesRequest- AConsumerthat will call methods onListEnabledBaselinesRequest.Builderto create a request.- Returns:
- Result of the ListEnabledBaselines operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledBaselinesPaginator
default ListEnabledBaselinesIterable listEnabledBaselinesPaginator(ListEnabledBaselinesRequest listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client.listEnabledBaselinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client .listEnabledBaselinesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client.listEnabledBaselinesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledBaselinesPaginator
default ListEnabledBaselinesIterable listEnabledBaselinesPaginator(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client.listEnabledBaselinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client .listEnabledBaselinesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListEnabledBaselinesIterable responses = client.listEnabledBaselinesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListEnabledBaselinesRequest.builder()- Parameters:
listEnabledBaselinesRequest- AConsumerthat will call methods onListEnabledBaselinesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledControls
default ListEnabledControlsResponse listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference Guide .
- Parameters:
listEnabledControlsRequest-- Returns:
- Result of the ListEnabledControls operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledControls
default ListEnabledControlsResponse listEnabledControls(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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 Controls Reference 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:
- Result of the ListEnabledControls operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledControlsPaginator
default ListEnabledControlsIterable listEnabledControlsPaginator(ListEnabledControlsRequest listEnabledControlsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client.listEnabledControlsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client .listEnabledControlsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client.listEnabledControlsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEnabledControlsPaginator
default ListEnabledControlsIterable listEnabledControlsPaginator(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client.listEnabledControlsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client .listEnabledControlsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListEnabledControlsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListEnabledControlsIterable responses = client.listEnabledControlsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZoneOperations
default ListLandingZoneOperationsResponse listLandingZoneOperations(ListLandingZoneOperationsRequest listLandingZoneOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
- Parameters:
listLandingZoneOperationsRequest-- Returns:
- Result of the ListLandingZoneOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZoneOperations
default ListLandingZoneOperationsResponse listLandingZoneOperations(Consumer<ListLandingZoneOperationsRequest.Builder> listLandingZoneOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
This is a convenience which creates an instance of the
ListLandingZoneOperationsRequest.Builderavoiding the need to create one manually viaListLandingZoneOperationsRequest.builder()- Parameters:
listLandingZoneOperationsRequest- AConsumerthat will call methods onListLandingZoneOperationsRequest.Builderto create a request.- Returns:
- Result of the ListLandingZoneOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZoneOperationsPaginator
default ListLandingZoneOperationsIterable listLandingZoneOperationsPaginator(ListLandingZoneOperationsRequest listLandingZoneOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listLandingZoneOperations(software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client.listLandingZoneOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client .listLandingZoneOperationsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client.listLandingZoneOperationsPaginator(request); responses.iterator().forEachRemaining(....);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
listLandingZoneOperations(software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsRequest)operation.- Parameters:
listLandingZoneOperationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZoneOperationsPaginator
default ListLandingZoneOperationsIterable listLandingZoneOperationsPaginator(Consumer<ListLandingZoneOperationsRequest.Builder> listLandingZoneOperationsRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listLandingZoneOperations(software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client.listLandingZoneOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client .listLandingZoneOperationsPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListLandingZoneOperationsIterable responses = client.listLandingZoneOperationsPaginator(request); responses.iterator().forEachRemaining(....);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
listLandingZoneOperations(software.amazon.awssdk.services.controltower.model.ListLandingZoneOperationsRequest)operation.
This is a convenience which creates an instance of the
ListLandingZoneOperationsRequest.Builderavoiding the need to create one manually viaListLandingZoneOperationsRequest.builder()- Parameters:
listLandingZoneOperationsRequest- AConsumerthat will call methods onListLandingZoneOperationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZones
default ListLandingZonesResponse listLandingZones(ListLandingZonesRequest listLandingZonesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
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:
- Result of the ListLandingZones operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZones
default ListLandingZonesResponse listLandingZones(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
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.Builderavoiding the need to create one manually viaListLandingZonesRequest.builder()- Parameters:
listLandingZonesRequest- AConsumerthat will call methods onListLandingZonesRequest.Builderto create a request.- Returns:
- Result of the ListLandingZones operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZonesPaginator
default ListLandingZonesIterable listLandingZonesPaginator(ListLandingZonesRequest listLandingZonesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client.listLandingZonesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client .listLandingZonesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client.listLandingZonesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listLandingZonesPaginator
default ListLandingZonesIterable listLandingZonesPaginator(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException
This is a variant of
listLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client.listLandingZonesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client .listLandingZonesPaginator(request); for (software.amazon.awssdk.services.controltower.model.ListLandingZonesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.controltower.paginators.ListLandingZonesIterable responses = client.listLandingZonesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference 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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
resetEnabledBaseline
default ResetEnabledBaselineResponse resetEnabledBaseline(ResetEnabledBaselineRequest resetEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Re-enables an
EnabledBaselineresource. For example, this API can re-apply the existingBaselineafter a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
resetEnabledBaselineRequest-- Returns:
- Result of the ResetEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
resetEnabledBaseline
default ResetEnabledBaselineResponse resetEnabledBaseline(Consumer<ResetEnabledBaselineRequest.Builder> resetEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Re-enables an
EnabledBaselineresource. For example, this API can re-apply the existingBaselineafter a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
ResetEnabledBaselineRequest.Builderavoiding the need to create one manually viaResetEnabledBaselineRequest.builder()- Parameters:
resetEnabledBaselineRequest- AConsumerthat will call methods onResetEnabledBaselineRequest.Builderto create a request.- Returns:
- Result of the ResetEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
resetLandingZone
default ResetLandingZoneResponse resetLandingZone(ResetLandingZoneRequest resetLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
- Parameters:
resetLandingZoneRequest-- Returns:
- Result of the ResetLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
resetLandingZone
default ResetLandingZoneResponse resetLandingZone(Consumer<ResetLandingZoneRequest.Builder> resetLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
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:
- Result of the ResetLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Applies tags to a resource. For usage examples, see the Controls Reference 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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Removes tags from a resource. For usage examples, see the Controls Reference 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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnabledBaseline
default UpdateEnabledBaselineResponse updateEnabledBaseline(UpdateEnabledBaselineRequest updateEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Updates an
EnabledBaselineresource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
updateEnabledBaselineRequest-- Returns:
- Result of the UpdateEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnabledBaseline
default UpdateEnabledBaselineResponse updateEnabledBaseline(Consumer<UpdateEnabledBaselineRequest.Builder> updateEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Updates an
EnabledBaselineresource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
UpdateEnabledBaselineRequest.Builderavoiding the need to create one manually viaUpdateEnabledBaselineRequest.builder()- Parameters:
updateEnabledBaselineRequest- AConsumerthat will call methods onUpdateEnabledBaselineRequest.Builderto create a request.- Returns:
- Result of the UpdateEnabledBaseline operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnabledControl
default UpdateEnabledControlResponse updateEnabledControl(UpdateEnabledControlRequest updateEnabledControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Updates the configuration of an already enabled control.
If the enabled control shows an
EnablementStatusof 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
EnablementStatusof FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.If the
DriftSummarystatus for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by callingDisableControland again callingEnableControl, or you can run an extending governance operation. For usage examples, see the Controls Reference Guide .- Parameters:
updateEnabledControlRequest-- Returns:
- Result of the UpdateEnabledControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEnabledControl
default UpdateEnabledControlResponse updateEnabledControl(Consumer<UpdateEnabledControlRequest.Builder> updateEnabledControlRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
Updates the configuration of an already enabled control.
If the enabled control shows an
EnablementStatusof 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
EnablementStatusof FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.If the
DriftSummarystatus for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by callingDisableControland again callingEnableControl, or you can run an extending governance operation. For usage examples, see the Controls Reference Guide .
This is a convenience which creates an instance of the
UpdateEnabledControlRequest.Builderavoiding the need to create one manually viaUpdateEnabledControlRequest.builder()- Parameters:
updateEnabledControlRequest- AConsumerthat will call methods onUpdateEnabledControlRequest.Builderto create a request.- Returns:
- Result of the UpdateEnabledControl operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLandingZone
default UpdateLandingZoneResponse updateLandingZone(UpdateLandingZoneRequest updateLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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:
- Result of the UpdateLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateLandingZone
default UpdateLandingZoneResponse updateLandingZone(Consumer<UpdateLandingZoneRequest.Builder> updateLandingZoneRequest) throws ValidationException, ConflictException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException
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.Builderavoiding the need to create one manually viaUpdateLandingZoneRequest.builder()- Parameters:
updateLandingZoneRequest- AConsumerthat will call methods onUpdateLandingZoneRequest.Builderto create a request.- Returns:
- Result of the UpdateLandingZone operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ControlTowerClient create()
Create aControlTowerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ControlTowerClientBuilder builder()
Create a builder that can be used to configure and create aControlTowerClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ControlTowerServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-