com.amazonaws.services.controltower

Class AbstractAWSControlTower

java.lang.Object

com.amazonaws.services.controltower.AbstractAWSControlTower

All Implemented Interfaces:

AWSControlTower

Direct Known Subclasses:

AbstractAWSControlTowerAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSControlTower
extends Object
implements AWSControlTower

Abstract implementation of AWSControlTower. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSControlTower()

Method Summary

Modifier and Type	Method and Description
DisableControlResult	disableControl(DisableControlRequest request) This API call turns off a control.
EnableControlResult	enableControl(EnableControlRequest request) 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 request) Returns the status of a particular EnableControl or DisableControl operation.
GetEnabledControlResult	getEnabledControl(GetEnabledControlRequest request) Provides details about the enabled control.
ListEnabledControlsResult	listEnabledControls(ListEnabledControlsRequest request) Lists the controls enabled by AWS Control Tower on the specified organizational unit and the accounts it contains.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAWSControlTower

protected AbstractAWSControlTower()

Method Detail

disableControl

public DisableControlResult disableControl(DisableControlRequest request)

Description copied from interface: AWSControlTower

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 .

Specified by:

disableControl in interface AWSControlTower

Returns:

Result of the DisableControl operation returned by the service.

See Also:

AWS API Documentation

enableControl

public EnableControlResult enableControl(EnableControlRequest request)

Description copied from interface: AWSControlTower

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

Specified by:

enableControl in interface AWSControlTower

Returns:

Result of the EnableControl operation returned by the service.

See Also:

AWS API Documentation

getControlOperation

public GetControlOperationResult getControlOperation(GetControlOperationRequest request)

Description copied from interface: AWSControlTower

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

Specified by:

getControlOperation in interface AWSControlTower

Returns:

Result of the GetControlOperation operation returned by the service.

See Also:

AWS API Documentation

getEnabledControl

public GetEnabledControlResult getEnabledControl(GetEnabledControlRequest request)

Description copied from interface: AWSControlTower

Provides details about the enabled control. For usage examples, see the AWS Control Tower User Guide .

Returned values

• TargetRegions: Shows target AWS Regions where the enabled control is available to be deployed.

• StatusSummary: Provides a detailed summary of the deployment status.

• DriftSummary: Provides a detailed summary of the drifted status.

Specified by:

getEnabledControl in interface AWSControlTower

Returns:

Result of the GetEnabledControl operation returned by the service.

See Also:

AWS API Documentation

listEnabledControls

public ListEnabledControlsResult listEnabledControls(ListEnabledControlsRequest request)

Description copied from interface: AWSControlTower

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

Specified by:

listEnabledControls in interface AWSControlTower

Returns:

Result of the ListEnabledControls operation returned by the service.

See Also:

AWS API Documentation

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

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSControlTower

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.

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.