AWSControlTower (AWS SDK for Java

All Known Subinterfaces:

AWSControlTowerAsync

All Known Implementing Classes:

AbstractAWSControlTower, AbstractAWSControlTowerAsync, AWSControlTowerAsyncClient, AWSControlTowerClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSControlTower
```
Interface for accessing AWS Control Tower.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSControlTower instead.

These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In AWS 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 AWS 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 AWS Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata in the AWS Control Tower User Guide.

A quick-reference list of control identifers for the AWS 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 AWS 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 AWS 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

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DisableControlResult`	`disableControl(DisableControlRequest disableControlRequest)` This API call turns off a control.
`EnableControlResult`	`enableControl(EnableControlRequest enableControlRequest)` This API call activates a control.
`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 getControlOperationRequest)` Returns the status of a particular `EnableControl` or `DisableControl` operation.
`GetEnabledControlResult`	`getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)` Retrieves details about an enabled control.
`ListEnabledControlsResult`	`listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)` Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of tags associated with the resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Applies tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from a resource.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - disableControl
```
DisableControlResult disableControl(DisableControlRequest disableControlRequest)
```
    This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    disableControlRequest -
    
    Returns:
    
    Result of the DisableControl operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    ConflictException - Updating or deleting a resource can cause an inconsistent state.
    
    ServiceQuotaExceededException - Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
    
    InternalServerException - Unexpected error during processing of request.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - enableControl
```
EnableControlResult enableControl(EnableControlRequest enableControlRequest)
```
    This API call activates a control. It starts an asynchronous operation that creates AWS 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 AWS Control Tower User Guide .
    
    Parameters:
    
    enableControlRequest -
    
    Returns:
    
    Result of the EnableControl operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    ConflictException - Updating or deleting a resource can cause an inconsistent state.
    
    ServiceQuotaExceededException - Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
    
    InternalServerException - Unexpected error during processing of request.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - getControlOperation
```
GetControlOperationResult getControlOperation(GetControlOperationRequest getControlOperationRequest)
```
    Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    getControlOperationRequest -
    
    Returns:
    
    Result of the GetControlOperation operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - getEnabledControl
```
GetEnabledControlResult getEnabledControl(GetEnabledControlRequest getEnabledControlRequest)
```
    Retrieves details about an enabled control. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    getEnabledControlRequest -
    
    Returns:
    
    Result of the GetEnabledControl operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - listEnabledControls
```
ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest listEnabledControlsRequest)
```
    Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    listEnabledControlsRequest -
    
    Returns:
    
    Result of the ListEnabledControls operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    AccessDeniedException - User does not have sufficient access to perform this action.
    
    ThrottlingException - Request was denied due to request throttling.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of tags associated with the resource. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Applies tags to a resource. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from a resource. For usage examples, see the AWS Control Tower User Guide .
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - Unexpected error during processing of request.
    
    ResourceNotFoundException - Request references a resource which does not exist.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.595

Interface AWSControlTower

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

disableControl

enableControl

getControlOperation

getEnabledControl

listEnabledControls

listTagsForResource

tagResource

untagResource

shutdown

getCachedResponseMetadata