controltower/aws.sdk.kotlin.services.controltower

Package-level declarations

Types

interface ControlTowerClient : SdkClient

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createLandingZone

inline suspend fun ControlTowerClient.createLandingZone(crossinline block: CreateLandingZoneRequest.Builder.() -> Unit): CreateLandingZoneResponse

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.

deleteLandingZone

inline suspend fun ControlTowerClient.deleteLandingZone(crossinline block: DeleteLandingZoneRequest.Builder.() -> Unit): DeleteLandingZoneResponse

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.

disableBaseline

inline suspend fun ControlTowerClient.disableBaseline(crossinline block: DisableBaselineRequest.Builder.() -> Unit): DisableBaselineResponse

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.

disableControl

inline suspend fun ControlTowerClient.disableControl(crossinline block: DisableControlRequest.Builder.() -> Unit): DisableControlResponse

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.

enableBaseline

inline suspend fun ControlTowerClient.enableBaseline(crossinline block: EnableBaselineRequest.Builder.() -> Unit): EnableBaselineResponse

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.

enableControl

inline suspend fun ControlTowerClient.enableControl(crossinline block: EnableControlRequest.Builder.() -> Unit): EnableControlResponse

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.

getBaseline

inline suspend fun ControlTowerClient.getBaseline(crossinline block: GetBaselineRequest.Builder.() -> Unit): GetBaselineResponse

Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide.

getBaselineOperation

inline suspend fun ControlTowerClient.getBaselineOperation(crossinline block: GetBaselineOperationRequest.Builder.() -> Unit): GetBaselineOperationResponse

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.

getControlOperation

inline suspend fun ControlTowerClient.getControlOperation(crossinline block: GetControlOperationRequest.Builder.() -> Unit): GetControlOperationResponse

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.

getEnabledBaseline

inline suspend fun ControlTowerClient.getEnabledBaseline(crossinline block: GetEnabledBaselineRequest.Builder.() -> Unit): GetEnabledBaselineResponse

Retrieve details of an EnabledBaseline resource by specifying its identifier.

getEnabledControl

inline suspend fun ControlTowerClient.getEnabledControl(crossinline block: GetEnabledControlRequest.Builder.() -> Unit): GetEnabledControlResponse

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

getLandingZone

inline suspend fun ControlTowerClient.getLandingZone(crossinline block: GetLandingZoneRequest.Builder.() -> Unit): GetLandingZoneResponse

Returns details about the landing zone. Displays a message in case of error.

getLandingZoneOperation

inline suspend fun ControlTowerClient.getLandingZoneOperation(crossinline block: GetLandingZoneOperationRequest.Builder.() -> Unit): GetLandingZoneOperationResponse

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

listBaselines

inline suspend fun ControlTowerClient.listBaselines(crossinline block: ListBaselinesRequest.Builder.() -> Unit): ListBaselinesResponse

Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide.

listControlOperations

inline suspend fun ControlTowerClient.listControlOperations(crossinline block: ListControlOperationsRequest.Builder.() -> Unit): ListControlOperationsResponse

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

listEnabledBaselines

inline suspend fun ControlTowerClient.listEnabledBaselines(crossinline block: ListEnabledBaselinesRequest.Builder.() -> Unit): ListEnabledBaselinesResponse

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.

listEnabledControls

inline suspend fun ControlTowerClient.listEnabledControls(crossinline block: ListEnabledControlsRequest.Builder.() -> Unit): ListEnabledControlsResponse

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.

listLandingZoneOperations

inline suspend fun ControlTowerClient.listLandingZoneOperations(crossinline block: ListLandingZoneOperationsRequest.Builder.() -> Unit): ListLandingZoneOperationsResponse

Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.

listLandingZones

inline suspend fun ControlTowerClient.listLandingZones(crossinline block: ListLandingZonesRequest.Builder.() -> Unit): ListLandingZonesResponse

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.

listTagsForResource

inline suspend fun ControlTowerClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

resetEnabledBaseline

inline suspend fun ControlTowerClient.resetEnabledBaseline(crossinline block: ResetEnabledBaselineRequest.Builder.() -> Unit): ResetEnabledBaselineResponse

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.

resetEnabledControl

inline suspend fun ControlTowerClient.resetEnabledControl(crossinline block: ResetEnabledControlRequest.Builder.() -> Unit): ResetEnabledControlResponse

Resets an enabled control.

resetLandingZone

inline suspend fun ControlTowerClient.resetLandingZone(crossinline block: ResetLandingZoneRequest.Builder.() -> Unit): ResetLandingZoneResponse

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.

tagResource

inline suspend fun ControlTowerClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun ControlTowerClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateEnabledBaseline

inline suspend fun ControlTowerClient.updateEnabledBaseline(crossinline block: UpdateEnabledBaselineRequest.Builder.() -> Unit): UpdateEnabledBaselineResponse

Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide.

updateEnabledControl

inline suspend fun ControlTowerClient.updateEnabledControl(crossinline block: UpdateEnabledControlRequest.Builder.() -> Unit): UpdateEnabledControlResponse

Updates the configuration of an already enabled control.

updateLandingZone

inline suspend fun ControlTowerClient.updateLandingZone(crossinline block: UpdateLandingZoneRequest.Builder.() -> Unit): UpdateLandingZoneResponse

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.

withConfig

fun ControlTowerClient.withConfig(block: ControlTowerClient.Config.Builder.() -> Unit): ControlTowerClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.