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

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

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

Method Detail

deleteLandingZone

public DeleteLandingZoneResult deleteLandingZone(DeleteLandingZoneRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the DeleteLandingZone operation returned by the service.

See Also:

AWS API Documentation

disableBaseline

public DisableBaselineResult disableBaseline(DisableBaselineRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the DisableBaseline operation returned by the service.

See Also:

AWS API Documentation

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

Returns:

Result of the DisableControl operation returned by the service.

See Also:

AWS API Documentation

enableBaseline

public EnableBaselineResult enableBaseline(EnableBaselineRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the EnableBaseline 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 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

Returns:

Result of the EnableControl operation returned by the service.

See Also:

AWS API Documentation

getBaseline

public GetBaselineResult getBaseline(GetBaselineRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the GetBaseline operation returned by the service.

See Also:

AWS API Documentation

getBaselineOperation

public GetBaselineOperationResult getBaselineOperation(GetBaselineOperationRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the GetBaselineOperation 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 Controls Reference Guide .

Specified by:

getControlOperation in interface AWSControlTower

Returns:

Result of the GetControlOperation operation returned by the service.

See Also:

AWS API Documentation

getEnabledBaseline

public GetEnabledBaselineResult getEnabledBaseline(GetEnabledBaselineRequest request)

Description copied from interface: AWSControlTower

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Specified by:

getEnabledBaseline in interface AWSControlTower

Returns:

Result of the GetEnabledBaseline operation returned by the service.

See Also:

AWS API Documentation

getEnabledControl

public GetEnabledControlResult getEnabledControl(GetEnabledControlRequest request)

Description copied from interface: AWSControlTower

Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .

Specified by:

getEnabledControl in interface AWSControlTower

Returns:

Result of the GetEnabledControl operation returned by the service.

See Also:

AWS API Documentation

getLandingZoneOperation

public GetLandingZoneOperationResult getLandingZoneOperation(GetLandingZoneOperationRequest request)

Description copied from interface: AWSControlTower

Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.

Specified by:

getLandingZoneOperation in interface AWSControlTower

Returns:

Result of the GetLandingZoneOperation operation returned by the service.

See Also:

AWS API Documentation

listBaselines

public ListBaselinesResult listBaselines(ListBaselinesRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ListBaselines operation returned by the service.

See Also:

AWS API Documentation

listControlOperations

public ListControlOperationsResult listControlOperations(ListControlOperationsRequest request)

Description copied from interface: AWSControlTower

Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

Specified by:

listControlOperations in interface AWSControlTower

Returns:

Result of the ListControlOperations operation returned by the service.

See Also:

AWS API Documentation

listEnabledBaselines

public ListEnabledBaselinesResult listEnabledBaselines(ListEnabledBaselinesRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ListEnabledBaselines 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 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

Returns:

Result of the ListEnabledControls operation returned by the service.

See Also:

AWS API Documentation

listLandingZoneOperations

public ListLandingZoneOperationsResult listLandingZoneOperations(ListLandingZoneOperationsRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ListLandingZoneOperations operation returned by the service.

See Also:

AWS API Documentation

listLandingZones

public ListLandingZonesResult listLandingZones(ListLandingZonesRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ListLandingZones operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: AWSControlTower

Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .

Specified by:

listTagsForResource in interface AWSControlTower

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

resetEnabledBaseline

public ResetEnabledBaselineResult resetEnabledBaseline(ResetEnabledBaselineRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ResetEnabledBaseline operation returned by the service.

See Also:

AWS API Documentation

resetLandingZone

public ResetLandingZoneResult resetLandingZone(ResetLandingZoneRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the ResetLandingZone operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: AWSControlTower

Applies tags to a resource. For usage examples, see the Controls Reference Guide .

Specified by:

tagResource in interface AWSControlTower

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: AWSControlTower

Removes tags from a resource. For usage examples, see the Controls Reference Guide .

Specified by:

untagResource in interface AWSControlTower

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateEnabledBaseline

public UpdateEnabledBaselineResult updateEnabledBaseline(UpdateEnabledBaselineRequest request)

Description copied from interface: AWSControlTower

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

Returns:

Result of the UpdateEnabledBaseline 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.