AWSControlTowerClient (AWS Java SDK for AWS Control Tower 1.12.788 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.controltower.AWSControlTowerClient

All Implemented Interfaces:

AWSControlTower

Direct Known Subclasses:

AWSControlTowerAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSControlTowerClient
extends AmazonWebServiceClient
implements AWSControlTower
```
Client for accessing AWS Control Tower. All service calls made using this client are blocking, and will not return until the service call completes.

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 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 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_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}

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 AWSControlTowerBaseline baseline 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 and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.controltower.AWSControlTower
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSControlTowerClientBuilder`	`builder()`
`DeleteLandingZoneResult`	`deleteLandingZone(DeleteLandingZoneRequest request)` Decommissions a landing zone.
`DisableBaselineResult`	`disableBaseline(DisableBaselineRequest request)` Disable an `EnabledBaseline` resource on the specified Target.
`DisableControlResult`	`disableControl(DisableControlRequest request)` This API call turns off a control.
`EnableBaselineResult`	`enableBaseline(EnableBaselineRequest request)` Enable (apply) a `Baseline` to a Target.
`EnableControlResult`	`enableControl(EnableControlRequest request)` This API call activates a control.
`GetBaselineResult`	`getBaseline(GetBaselineRequest request)` Retrieve details about an existing `Baseline` resource by specifying its identifier.
`GetBaselineOperationResult`	`getBaselineOperation(GetBaselineOperationRequest request)` Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: `EnableBaseline`, `DisableBaseline`, `UpdateEnabledBaseline`, `ResetEnabledBaseline`.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetControlOperationResult`	`getControlOperation(GetControlOperationRequest request)` Returns the status of a particular `EnableControl` or `DisableControl` operation.
`GetEnabledBaselineResult`	`getEnabledBaseline(GetEnabledBaselineRequest request)` Retrieve details of an `EnabledBaseline` resource by specifying its identifier.
`GetEnabledControlResult`	`getEnabledControl(GetEnabledControlRequest request)` Retrieves details about an enabled control.
`GetLandingZoneOperationResult`	`getLandingZoneOperation(GetLandingZoneOperationRequest request)` Returns the status of the specified landing zone operation.
`ListBaselinesResult`	`listBaselines(ListBaselinesRequest request)` Returns a summary list of all available baselines.
`ListControlOperationsResult`	`listControlOperations(ListControlOperationsRequest request)` Provides a list of operations in progress or queued.
`ListEnabledBaselinesResult`	`listEnabledBaselines(ListEnabledBaselinesRequest request)` Returns a list of summaries describing `EnabledBaseline` resources.
`ListEnabledControlsResult`	`listEnabledControls(ListEnabledControlsRequest request)` Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
`ListLandingZoneOperationsResult`	`listLandingZoneOperations(ListLandingZoneOperationsRequest request)` Lists all landing zone operations from the past 90 days.
`ListLandingZonesResult`	`listLandingZones(ListLandingZonesRequest request)` Returns the landing zone ARN for the landing zone deployed in your managed account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags associated with the resource.
`ResetEnabledBaselineResult`	`resetEnabledBaseline(ResetEnabledBaselineRequest request)` Re-enables an `EnabledBaseline` resource.
`ResetLandingZoneResult`	`resetLandingZone(ResetLandingZoneRequest request)` This API call resets a landing zone.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a resource.
`UpdateEnabledBaselineResult`	`updateEnabledBaseline(UpdateEnabledBaselineRequest request)` Updates an `EnabledBaseline` resource's applied parameters or version.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AWSControlTowerClientBuilder builder()
```
  - deleteLandingZone
```
public DeleteLandingZoneResult deleteLandingZone(DeleteLandingZoneRequest request)
```
    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.
    
    Specified by:
    
    deleteLandingZone in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disableBaseline
```
public DisableBaselineResult disableBaseline(DisableBaselineRequest request)
```
    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. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    disableBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - disableControl
```
public DisableControlResult disableControl(DisableControlRequest request)
```
    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 .
    
    Specified by:
    
    disableControl in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - enableBaseline
```
public EnableBaselineResult enableBaseline(EnableBaselineRequest request)
```
    Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    enableBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - enableControl
```
public EnableControlResult enableControl(EnableControlRequest request)
```
    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 .
    
    Specified by:
    
    enableControl in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBaseline
```
public GetBaselineResult getBaseline(GetBaselineRequest request)
```
    Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    getBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getBaselineOperation
```
public GetBaselineOperationResult getBaselineOperation(GetBaselineOperationRequest request)
```
    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 .
    
    Specified by:
    
    getBaselineOperation in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getControlOperation
```
public GetControlOperationResult getControlOperation(GetControlOperationRequest request)
```
    Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
    
    Specified by:
    
    getControlOperation in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnabledBaseline
```
public GetEnabledBaselineResult getEnabledBaseline(GetEnabledBaselineRequest request)
```
    Retrieve details of an EnabledBaseline resource by specifying its identifier.
    
    Specified by:
    
    getEnabledBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnabledControl
```
public GetEnabledControlResult getEnabledControl(GetEnabledControlRequest request)
```
    Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
    
    Specified by:
    
    getEnabledControl in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getLandingZoneOperation
```
public GetLandingZoneOperationResult getLandingZoneOperation(GetLandingZoneOperationRequest request)
```
    Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
    
    Specified by:
    
    getLandingZoneOperation in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listBaselines
```
public ListBaselinesResult listBaselines(ListBaselinesRequest request)
```
    Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    listBaselines in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listControlOperations
```
public ListControlOperationsResult listControlOperations(ListControlOperationsRequest request)
```
    Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
    
    Specified by:
    
    listControlOperations in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnabledBaselines
```
public ListEnabledBaselinesResult listEnabledBaselines(ListEnabledBaselinesRequest request)
```
    Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    listEnabledBaselines in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnabledControls
```
public ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest request)
```
    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 .
    
    Specified by:
    
    listEnabledControls in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listLandingZoneOperations
```
public ListLandingZoneOperationsResult listLandingZoneOperations(ListLandingZoneOperationsRequest request)
```
    Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
    
    Specified by:
    
    listLandingZoneOperations in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listLandingZones
```
public ListLandingZonesResult listLandingZones(ListLandingZonesRequest request)
```
    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.
    
    Specified by:
    
    listLandingZones in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
    
    Specified by:
    
    listTagsForResource in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - resetEnabledBaseline
```
public ResetEnabledBaselineResult resetEnabledBaseline(ResetEnabledBaselineRequest request)
```
    Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    resetEnabledBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - resetLandingZone
```
public ResetLandingZoneResult resetLandingZone(ResetLandingZoneRequest request)
```
    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.
    
    Specified by:
    
    resetLandingZone in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies tags to a resource. For usage examples, see the Controls Reference Guide .
    
    Specified by:
    
    tagResource in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from a resource. For usage examples, see the Controls Reference Guide .
    
    Specified by:
    
    untagResource in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnabledBaseline
```
public UpdateEnabledBaselineResult updateEnabledBaseline(UpdateEnabledBaselineRequest request)
```
    Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
    
    Specified by:
    
    updateEnabledBaseline in interface AWSControlTower
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSControlTower
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSControlTower
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSControlTower
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSControlTowerClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.controltower.AWSControlTower

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

deleteLandingZone

disableBaseline

disableControl

enableBaseline

enableControl

getBaseline

getBaselineOperation

getControlOperation

getEnabledBaseline

getEnabledControl

getLandingZoneOperation

listBaselines

listControlOperations

listEnabledBaselines

listEnabledControls

listLandingZoneOperations

listLandingZones

listTagsForResource

resetEnabledBaseline

resetLandingZone

tagResource

untagResource

updateEnabledBaseline

getCachedResponseMetadata

shutdown