Interface ControlTowerClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
To call these APIs, you'll need to know:
-
the
controlIdentifier
for the control--or guardrail--you are targeting. -
the ARN associated with the target organizational unit (OU), which we call the
targetIdentifier
. -
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier
for your Amazon Web Services Control Tower control:
The controlIdentifier
is an ARN that is specified for each control. You can view the
controlIdentifier
in the console on the Control details page, as well as in the documentation.
The controlIdentifier
is unique in each Amazon Web Services Region for each control. You can find the
controlIdentifier
for each Region and control in the Tables of control
metadata in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier
:
The targetIdentifier
is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic ControlTowerClientBuilder
builder()
Create a builder that can be used to configure and create aControlTowerClient
.static ControlTowerClient
create()
Create aControlTowerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateLandingZoneResponse
createLandingZone
(Consumer<CreateLandingZoneRequest.Builder> createLandingZoneRequest) Creates a new landing zone.default CreateLandingZoneResponse
createLandingZone
(CreateLandingZoneRequest createLandingZoneRequest) Creates a new landing zone.default DeleteLandingZoneResponse
deleteLandingZone
(Consumer<DeleteLandingZoneRequest.Builder> deleteLandingZoneRequest) Decommissions a landing zone.default DeleteLandingZoneResponse
deleteLandingZone
(DeleteLandingZoneRequest deleteLandingZoneRequest) Decommissions a landing zone.default DisableBaselineResponse
disableBaseline
(Consumer<DisableBaselineRequest.Builder> disableBaselineRequest) Disable anEnabledBaseline
resource on the specified Target.default DisableBaselineResponse
disableBaseline
(DisableBaselineRequest disableBaselineRequest) Disable anEnabledBaseline
resource on the specified Target.default DisableControlResponse
disableControl
(Consumer<DisableControlRequest.Builder> disableControlRequest) This API call turns off a control.default DisableControlResponse
disableControl
(DisableControlRequest disableControlRequest) This API call turns off a control.default EnableBaselineResponse
enableBaseline
(Consumer<EnableBaselineRequest.Builder> enableBaselineRequest) Enable (apply) aBaseline
to a Target.default EnableBaselineResponse
enableBaseline
(EnableBaselineRequest enableBaselineRequest) Enable (apply) aBaseline
to a Target.default EnableControlResponse
enableControl
(Consumer<EnableControlRequest.Builder> enableControlRequest) This API call activates a control.default EnableControlResponse
enableControl
(EnableControlRequest enableControlRequest) This API call activates a control.default GetBaselineResponse
getBaseline
(Consumer<GetBaselineRequest.Builder> getBaselineRequest) Retrieve details about an existingBaseline
resource by specifying its identifier.default GetBaselineResponse
getBaseline
(GetBaselineRequest getBaselineRequest) Retrieve details about an existingBaseline
resource by specifying its identifier.default GetBaselineOperationResponse
getBaselineOperation
(Consumer<GetBaselineOperationRequest.Builder> getBaselineOperationRequest) Returns the details of an asynchronous baseline operation, as initiated by any of these APIs:EnableBaseline
,DisableBaseline
,UpdateEnabledBaseline
,ResetEnabledBaseline
.default GetBaselineOperationResponse
getBaselineOperation
(GetBaselineOperationRequest getBaselineOperationRequest) Returns the details of an asynchronous baseline operation, as initiated by any of these APIs:EnableBaseline
,DisableBaseline
,UpdateEnabledBaseline
,ResetEnabledBaseline
.default GetControlOperationResponse
getControlOperation
(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest) Returns the status of a particularEnableControl
orDisableControl
operation.default GetControlOperationResponse
getControlOperation
(GetControlOperationRequest getControlOperationRequest) Returns the status of a particularEnableControl
orDisableControl
operation.default GetEnabledBaselineResponse
getEnabledBaseline
(Consumer<GetEnabledBaselineRequest.Builder> getEnabledBaselineRequest) Retrieve details of anEnabledBaseline
resource by specifying its identifier.default GetEnabledBaselineResponse
getEnabledBaseline
(GetEnabledBaselineRequest getEnabledBaselineRequest) Retrieve details of anEnabledBaseline
resource by specifying its identifier.default GetEnabledControlResponse
getEnabledControl
(Consumer<GetEnabledControlRequest.Builder> getEnabledControlRequest) Retrieves details about an enabled control.default GetEnabledControlResponse
getEnabledControl
(GetEnabledControlRequest getEnabledControlRequest) Retrieves details about an enabled control.default GetLandingZoneResponse
getLandingZone
(Consumer<GetLandingZoneRequest.Builder> getLandingZoneRequest) Returns details about the landing zone.default GetLandingZoneResponse
getLandingZone
(GetLandingZoneRequest getLandingZoneRequest) Returns details about the landing zone.default GetLandingZoneOperationResponse
getLandingZoneOperation
(Consumer<GetLandingZoneOperationRequest.Builder> getLandingZoneOperationRequest) Returns the status of the specified landing zone operation.default GetLandingZoneOperationResponse
getLandingZoneOperation
(GetLandingZoneOperationRequest getLandingZoneOperationRequest) Returns the status of the specified landing zone operation.default ListBaselinesResponse
listBaselines
(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest) Returns a summary list of all available baselines.default ListBaselinesResponse
listBaselines
(ListBaselinesRequest listBaselinesRequest) Returns a summary list of all available baselines.default ListBaselinesIterable
listBaselinesPaginator
(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest) This is a variant oflistBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest)
operation.default ListBaselinesIterable
listBaselinesPaginator
(ListBaselinesRequest listBaselinesRequest) This is a variant oflistBaselines(software.amazon.awssdk.services.controltower.model.ListBaselinesRequest)
operation.default ListEnabledBaselinesResponse
listEnabledBaselines
(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest) Returns a list of summaries describingEnabledBaseline
resources.default ListEnabledBaselinesResponse
listEnabledBaselines
(ListEnabledBaselinesRequest listEnabledBaselinesRequest) Returns a list of summaries describingEnabledBaseline
resources.default ListEnabledBaselinesIterable
listEnabledBaselinesPaginator
(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest) This is a variant oflistEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest)
operation.default ListEnabledBaselinesIterable
listEnabledBaselinesPaginator
(ListEnabledBaselinesRequest listEnabledBaselinesRequest) This is a variant oflistEnabledBaselines(software.amazon.awssdk.services.controltower.model.ListEnabledBaselinesRequest)
operation.default ListEnabledControlsResponse
listEnabledControls
(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest) Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.default ListEnabledControlsResponse
listEnabledControls
(ListEnabledControlsRequest listEnabledControlsRequest) Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.default ListEnabledControlsIterable
listEnabledControlsPaginator
(Consumer<ListEnabledControlsRequest.Builder> listEnabledControlsRequest) This is a variant oflistEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest)
operation.default ListEnabledControlsIterable
listEnabledControlsPaginator
(ListEnabledControlsRequest listEnabledControlsRequest) This is a variant oflistEnabledControls(software.amazon.awssdk.services.controltower.model.ListEnabledControlsRequest)
operation.default ListLandingZonesResponse
listLandingZones
(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest) Returns the landing zone ARN for the landing zone deployed in your managed account.default ListLandingZonesResponse
listLandingZones
(ListLandingZonesRequest listLandingZonesRequest) Returns the landing zone ARN for the landing zone deployed in your managed account.default ListLandingZonesIterable
listLandingZonesPaginator
(Consumer<ListLandingZonesRequest.Builder> listLandingZonesRequest) This is a variant oflistLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest)
operation.default ListLandingZonesIterable
listLandingZonesPaginator
(ListLandingZonesRequest listLandingZonesRequest) This is a variant oflistLandingZones(software.amazon.awssdk.services.controltower.model.ListLandingZonesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags associated with the resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags associated with the resource.default ResetEnabledBaselineResponse
resetEnabledBaseline
(Consumer<ResetEnabledBaselineRequest.Builder> resetEnabledBaselineRequest) Re-enables anEnabledBaseline
resource.default ResetEnabledBaselineResponse
resetEnabledBaseline
(ResetEnabledBaselineRequest resetEnabledBaselineRequest) Re-enables anEnabledBaseline
resource.default ResetLandingZoneResponse
resetLandingZone
(Consumer<ResetLandingZoneRequest.Builder> resetLandingZoneRequest) This API call resets a landing zone.default ResetLandingZoneResponse
resetLandingZone
(ResetLandingZoneRequest resetLandingZoneRequest) This API call resets a landing zone.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies tags to a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from a resource.default UpdateEnabledBaselineResponse
updateEnabledBaseline
(Consumer<UpdateEnabledBaselineRequest.Builder> updateEnabledBaselineRequest) Updates anEnabledBaseline
resource's applied parameters or version.default UpdateEnabledBaselineResponse
updateEnabledBaseline
(UpdateEnabledBaselineRequest updateEnabledBaselineRequest) Updates anEnabledBaseline
resource's applied parameters or version.default UpdateEnabledControlResponse
updateEnabledControl
(Consumer<UpdateEnabledControlRequest.Builder> updateEnabledControlRequest) Updates the configuration of an already enabled control.default UpdateEnabledControlResponse
updateEnabledControl
(UpdateEnabledControlRequest updateEnabledControlRequest) Updates the configuration of an already enabled control.default UpdateLandingZoneResponse
updateLandingZone
(Consumer<UpdateLandingZoneRequest.Builder> updateLandingZoneRequest) This API call updates the landing zone.default UpdateLandingZoneResponse
updateLandingZone
(UpdateLandingZoneRequest updateLandingZoneRequest) This API call updates the landing zone.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateLandingZoneRequest.builder()
- Parameters:
createLandingZoneRequest
- AConsumer
that will call methods onCreateLandingZoneRequest.Builder
to create a request.- Returns:
- Result of the CreateLandingZone operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteLandingZoneRequest.builder()
- Parameters:
deleteLandingZoneRequest
- AConsumer
that will call methods onDeleteLandingZoneRequest.Builder
to create a request.- Returns:
- Result of the DeleteLandingZone operation returned by the service.
- See Also:
-
disableBaseline
default DisableBaselineResponse disableBaseline(DisableBaselineRequest disableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Disable an
EnabledBaseline
resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.- Parameters:
disableBaselineRequest
-- Returns:
- Result of the DisableBaseline operation returned by the service.
- See Also:
-
disableBaseline
default DisableBaselineResponse disableBaseline(Consumer<DisableBaselineRequest.Builder> disableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Disable an
EnabledBaseline
resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
This is a convenience which creates an instance of the
DisableBaselineRequest.Builder
avoiding the need to create one manually viaDisableBaselineRequest.builder()
- Parameters:
disableBaselineRequest
- AConsumer
that will call methods onDisableBaselineRequest.Builder
to create a request.- Returns:
- Result of the DisableBaseline operation returned by the service.
- See Also:
-
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 AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
- Parameters:
disableControlRequest
-- Returns:
- Result of the DisableControl operation returned by the service.
- See Also:
-
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 AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
DisableControlRequest.Builder
avoiding the need to create one manually viaDisableControlRequest.builder()
- Parameters:
disableControlRequest
- AConsumer
that will call methods onDisableControlRequest.Builder
to create a request.- Returns:
- Result of the DisableControl operation returned by the service.
- See Also:
-
enableBaseline
default EnableBaselineResponse enableBaseline(EnableBaselineRequest enableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Enable (apply) a
Baseline
to a Target. This API starts an asynchronous operation to deploy resources specified by theBaseline
to the specified Target.- Parameters:
enableBaselineRequest
-- Returns:
- Result of the EnableBaseline operation returned by the service.
- See Also:
-
enableBaseline
default EnableBaselineResponse enableBaseline(Consumer<EnableBaselineRequest.Builder> enableBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Enable (apply) a
Baseline
to a Target. This API starts an asynchronous operation to deploy resources specified by theBaseline
to the specified Target.
This is a convenience which creates an instance of the
EnableBaselineRequest.Builder
avoiding the need to create one manually viaEnableBaselineRequest.builder()
- Parameters:
enableBaselineRequest
- AConsumer
that will call methods onEnableBaselineRequest.Builder
to create a request.- Returns:
- Result of the EnableBaseline operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
- Parameters:
enableControlRequest
-- Returns:
- Result of the EnableControl operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
EnableControlRequest.Builder
avoiding the need to create one manually viaEnableControlRequest.builder()
- Parameters:
enableControlRequest
- AConsumer
that will call methods onEnableControlRequest.Builder
to create a request.- Returns:
- Result of the EnableControl operation returned by the service.
- See Also:
-
getBaseline
default GetBaselineResponse getBaseline(GetBaselineRequest getBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Retrieve details about an existing
Baseline
resource by specifying its identifier.- Parameters:
getBaselineRequest
-- Returns:
- Result of the GetBaseline operation returned by the service.
- See Also:
-
getBaseline
default GetBaselineResponse getBaseline(Consumer<GetBaselineRequest.Builder> getBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Retrieve details about an existing
Baseline
resource by specifying its identifier.
This is a convenience which creates an instance of the
GetBaselineRequest.Builder
avoiding the need to create one manually viaGetBaselineRequest.builder()
- Parameters:
getBaselineRequest
- AConsumer
that will call methods onGetBaselineRequest.Builder
to create a request.- Returns:
- Result of the GetBaseline operation returned by the service.
- See Also:
-
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.- Parameters:
getBaselineOperationRequest
-- Returns:
- Result of the GetBaselineOperation operation returned by the service.
- See Also:
-
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.
This is a convenience which creates an instance of the
GetBaselineOperationRequest.Builder
avoiding the need to create one manually viaGetBaselineOperationRequest.builder()
- Parameters:
getBaselineOperationRequest
- AConsumer
that will call methods onGetBaselineOperationRequest.Builder
to create a request.- Returns:
- Result of the GetBaselineOperation operation returned by the service.
- See Also:
-
getControlOperation
default GetControlOperationResponse getControlOperation(GetControlOperationRequest getControlOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Returns the status of a particular
EnableControl
orDisableControl
operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .- Parameters:
getControlOperationRequest
-- Returns:
- Result of the GetControlOperation operation returned by the service.
- See Also:
-
getControlOperation
default GetControlOperationResponse getControlOperation(Consumer<GetControlOperationRequest.Builder> getControlOperationRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Returns the status of a particular
EnableControl
orDisableControl
operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
GetControlOperationRequest.Builder
avoiding the need to create one manually viaGetControlOperationRequest.builder()
- Parameters:
getControlOperationRequest
- AConsumer
that will call methods onGetControlOperationRequest.Builder
to create a request.- Returns:
- Result of the GetControlOperation operation returned by the service.
- See Also:
-
getEnabledBaseline
default GetEnabledBaselineResponse getEnabledBaseline(GetEnabledBaselineRequest getEnabledBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Retrieve details of an
EnabledBaseline
resource by specifying its identifier.- Parameters:
getEnabledBaselineRequest
-- Returns:
- Result of the GetEnabledBaseline operation returned by the service.
- See Also:
-
getEnabledBaseline
default GetEnabledBaselineResponse getEnabledBaseline(Consumer<GetEnabledBaselineRequest.Builder> getEnabledBaselineRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Retrieve details of an
EnabledBaseline
resource by specifying its identifier.
This is a convenience which creates an instance of the
GetEnabledBaselineRequest.Builder
avoiding the need to create one manually viaGetEnabledBaselineRequest.builder()
- Parameters:
getEnabledBaselineRequest
- AConsumer
that will call methods onGetEnabledBaselineRequest.Builder
to create a request.- Returns:
- Result of the GetEnabledBaseline operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
- Parameters:
getEnabledControlRequest
-- Returns:
- Result of the GetEnabledControl operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
GetEnabledControlRequest.Builder
avoiding the need to create one manually viaGetEnabledControlRequest.builder()
- Parameters:
getEnabledControlRequest
- AConsumer
that will call methods onGetEnabledControlRequest.Builder
to create a request.- Returns:
- Result of the GetEnabledControl operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetLandingZoneRequest.builder()
- Parameters:
getLandingZoneRequest
- AConsumer
that will call methods onGetLandingZoneRequest.Builder
to create a request.- Returns:
- Result of the GetLandingZone operation returned by the service.
- See Also:
-
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 60 days.
- Parameters:
getLandingZoneOperationRequest
-- Returns:
- Result of the GetLandingZoneOperation operation returned by the service.
- See Also:
-
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 60 days.
This is a convenience which creates an instance of the
GetLandingZoneOperationRequest.Builder
avoiding the need to create one manually viaGetLandingZoneOperationRequest.builder()
- Parameters:
getLandingZoneOperationRequest
- AConsumer
that will call methods onGetLandingZoneOperationRequest.Builder
to create a request.- Returns:
- Result of the GetLandingZoneOperation operation returned by the service.
- See Also:
-
listBaselines
default ListBaselinesResponse listBaselines(ListBaselinesRequest listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException Returns a summary list of all available baselines.
- Parameters:
listBaselinesRequest
-- Returns:
- Result of the ListBaselines operation returned by the service.
- See Also:
-
listBaselines
default ListBaselinesResponse listBaselines(Consumer<ListBaselinesRequest.Builder> listBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException Returns a summary list of all available baselines.
This is a convenience which creates an instance of the
ListBaselinesRequest.Builder
avoiding the need to create one manually viaListBaselinesRequest.builder()
- Parameters:
listBaselinesRequest
- AConsumer
that will call methods onListBaselinesRequest.Builder
to create a request.- Returns:
- Result of the ListBaselines operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListBaselinesRequest.builder()
- Parameters:
listBaselinesRequest
- AConsumer
that will call methods onListBaselinesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnabledBaselines
default ListEnabledBaselinesResponse listEnabledBaselines(ListEnabledBaselinesRequest listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException Returns a list of summaries describing
EnabledBaseline
resources. You can filter the list by the correspondingBaseline
orTarget
of theEnabledBaseline
resources.- Parameters:
listEnabledBaselinesRequest
-- Returns:
- Result of the ListEnabledBaselines operation returned by the service.
- See Also:
-
listEnabledBaselines
default ListEnabledBaselinesResponse listEnabledBaselines(Consumer<ListEnabledBaselinesRequest.Builder> listEnabledBaselinesRequest) throws ValidationException, InternalServerException, AccessDeniedException, ThrottlingException, AwsServiceException, SdkClientException, ControlTowerException Returns a list of summaries describing
EnabledBaseline
resources. You can filter the list by the correspondingBaseline
orTarget
of theEnabledBaseline
resources.
This is a convenience which creates an instance of the
ListEnabledBaselinesRequest.Builder
avoiding the need to create one manually viaListEnabledBaselinesRequest.builder()
- Parameters:
listEnabledBaselinesRequest
- AConsumer
that will call methods onListEnabledBaselinesRequest.Builder
to create a request.- Returns:
- Result of the ListEnabledBaselines operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListEnabledBaselinesRequest.builder()
- Parameters:
listEnabledBaselinesRequest
- AConsumer
that will call methods onListEnabledBaselinesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
- Parameters:
listEnabledControlsRequest
-- Returns:
- Result of the ListEnabledControls operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
ListEnabledControlsRequest.Builder
avoiding the need to create one manually viaListEnabledControlsRequest.builder()
- Parameters:
listEnabledControlsRequest
- AConsumer
that will call methods onListEnabledControlsRequest.Builder
to create a request.- Returns:
- Result of the ListEnabledControls operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListEnabledControlsRequest.builder()
- Parameters:
listEnabledControlsRequest
- AConsumer
that will call methods onListEnabledControlsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListLandingZonesRequest.builder()
- Parameters:
listLandingZonesRequest
- AConsumer
that will call methods onListLandingZonesRequest.Builder
to create a request.- Returns:
- Result of the ListLandingZones operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListLandingZonesRequest.builder()
- Parameters:
listLandingZonesRequest
- AConsumer
that will call methods onListLandingZonesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
resetEnabledBaseline
default ResetEnabledBaselineResponse resetEnabledBaseline(ResetEnabledBaselineRequest resetEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Re-enables an
EnabledBaseline
resource. For example, this API can re-apply the existingBaseline
after a new member account is moved to the target OU.- Parameters:
resetEnabledBaselineRequest
-- Returns:
- Result of the ResetEnabledBaseline operation returned by the service.
- See Also:
-
resetEnabledBaseline
default ResetEnabledBaselineResponse resetEnabledBaseline(Consumer<ResetEnabledBaselineRequest.Builder> resetEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Re-enables an
EnabledBaseline
resource. For example, this API can re-apply the existingBaseline
after a new member account is moved to the target OU.
This is a convenience which creates an instance of the
ResetEnabledBaselineRequest.Builder
avoiding the need to create one manually viaResetEnabledBaselineRequest.builder()
- Parameters:
resetEnabledBaselineRequest
- AConsumer
that will call methods onResetEnabledBaselineRequest.Builder
to create a request.- Returns:
- Result of the ResetEnabledBaseline operation returned by the service.
- See Also:
-
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 its original configuration.
- Parameters:
resetLandingZoneRequest
-- Returns:
- Result of the ResetLandingZone operation returned by the service.
- See Also:
-
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 its original configuration.
This is a convenience which creates an instance of the
ResetLandingZoneRequest.Builder
avoiding the need to create one manually viaResetLandingZoneRequest.builder()
- Parameters:
resetLandingZoneRequest
- AConsumer
that will call methods onResetLandingZoneRequest.Builder
to create a request.- Returns:
- Result of the ResetLandingZone operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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 Amazon Web Services Control Tower User Guide .
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateEnabledBaseline
default UpdateEnabledBaselineResponse updateEnabledBaseline(UpdateEnabledBaselineRequest updateEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Updates an
EnabledBaseline
resource's applied parameters or version.- Parameters:
updateEnabledBaselineRequest
-- Returns:
- Result of the UpdateEnabledBaseline operation returned by the service.
- See Also:
-
updateEnabledBaseline
default UpdateEnabledBaselineResponse updateEnabledBaseline(Consumer<UpdateEnabledBaselineRequest.Builder> updateEnabledBaselineRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, InternalServerException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, ControlTowerException Updates an
EnabledBaseline
resource's applied parameters or version.
This is a convenience which creates an instance of the
UpdateEnabledBaselineRequest.Builder
avoiding the need to create one manually viaUpdateEnabledBaselineRequest.builder()
- Parameters:
updateEnabledBaselineRequest
- AConsumer
that will call methods onUpdateEnabledBaselineRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnabledBaseline operation returned by the service.
- See Also:
-
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
EnablementStatus
of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.If the enabled control shows an
EnablementStatus
of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.If the
DriftSummary
status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by callingDisableControl
and again callingEnableControl
, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide- Parameters:
updateEnabledControlRequest
-- Returns:
- Result of the UpdateEnabledControl operation returned by the service.
- See Also:
-
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
EnablementStatus
of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.If the enabled control shows an
EnablementStatus
of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.If the
DriftSummary
status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by callingDisableControl
and again callingEnableControl
, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide
This is a convenience which creates an instance of the
UpdateEnabledControlRequest.Builder
avoiding the need to create one manually viaUpdateEnabledControlRequest.builder()
- Parameters:
updateEnabledControlRequest
- AConsumer
that will call methods onUpdateEnabledControlRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnabledControl operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateLandingZoneRequest.builder()
- Parameters:
updateLandingZoneRequest
- AConsumer
that will call methods onUpdateLandingZoneRequest.Builder
to create a request.- Returns:
- Result of the UpdateLandingZone operation returned by the service.
- See Also:
-
create
Create aControlTowerClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aControlTowerClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-