controltower/aws.sdk.kotlin.services.controltower/ControlTowerClient

ControlTowerClient

interface ControlTowerClient : SdkClient

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 in the Amazon Web Services Control Tower User 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 Controls reference guide section of the Amazon Web Services 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 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}

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.

Properties

Link copied to clipboard
abstract override val config: ControlTowerClient.Config

ControlTowerClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createLandingZone(input: CreateLandingZoneRequest): 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.

Link copied to clipboard
abstract suspend fun deleteLandingZone(input: DeleteLandingZoneRequest): 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.

Link copied to clipboard
abstract suspend fun disableBaseline(input: DisableBaselineRequest): 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.

Link copied to clipboard
abstract suspend fun disableControl(input: DisableControlRequest): DisableControlResponse

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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun enableBaseline(input: EnableBaselineRequest): 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.

Link copied to clipboard
abstract suspend fun enableControl(input: EnableControlRequest): 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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun getBaseline(input: GetBaselineRequest): GetBaselineResponse

Retrieve details about an existing Baseline resource by specifying its identifier.

Link copied to clipboard
abstract suspend fun getBaselineOperation(input: GetBaselineOperationRequest): 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.

Link copied to clipboard
abstract suspend fun getControlOperation(input: GetControlOperationRequest): 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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun getEnabledBaseline(input: GetEnabledBaselineRequest): GetEnabledBaselineResponse

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Link copied to clipboard
abstract suspend fun getEnabledControl(input: GetEnabledControlRequest): GetEnabledControlResponse

Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun getLandingZone(input: GetLandingZoneRequest): GetLandingZoneResponse

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

Link copied to clipboard
abstract suspend fun getLandingZoneOperation(input: GetLandingZoneOperationRequest): GetLandingZoneOperationResponse

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

Link copied to clipboard
abstract suspend fun listBaselines(input: ListBaselinesRequest = ListBaselinesRequest { }): ListBaselinesResponse

Returns a summary list of all available baselines.

Link copied to clipboard
abstract suspend fun listEnabledBaselines(input: ListEnabledBaselinesRequest = ListEnabledBaselinesRequest { }): ListEnabledBaselinesResponse

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.

Link copied to clipboard
abstract suspend fun listEnabledControls(input: ListEnabledControlsRequest): 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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun listLandingZones(input: ListLandingZonesRequest = ListLandingZonesRequest { }): 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.

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun resetEnabledBaseline(input: ResetEnabledBaselineRequest): 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.

Link copied to clipboard
abstract suspend fun resetLandingZone(input: ResetLandingZoneRequest): ResetLandingZoneResponse

This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide.

Link copied to clipboard
abstract suspend fun updateEnabledBaseline(input: UpdateEnabledBaselineRequest): UpdateEnabledBaselineResponse

Updates an EnabledBaseline resource's applied parameters or version.

Link copied to clipboard
abstract suspend fun updateEnabledControl(input: UpdateEnabledControlRequest): UpdateEnabledControlResponse

Updates the configuration of an already enabled control.

Link copied to clipboard
abstract suspend fun updateLandingZone(input: UpdateLandingZoneRequest): 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.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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 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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
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.

Link copied to clipboard
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 Amazon Web Services Control Tower User Guide.

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

Retrieve details about an existing Baseline resource by specifying its identifier.

Link copied to clipboard
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.

Link copied to clipboard
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 Amazon Web Services Control Tower User Guide.

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

Retrieve details of an EnabledBaseline resource by specifying its identifier.

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

Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide.

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

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

Link copied to clipboard
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 60 days.

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

Returns a summary list of all available baselines.

Link copied to clipboard
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.

Link copied to clipboard
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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard
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 Amazon Web Services Control Tower User Guide.

Link copied to clipboard
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.

Link copied to clipboard
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 its original configuration.

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

Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide.

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

Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide.

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

Updates an EnabledBaseline resource's applied parameters or version.

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

Updates the configuration of an already enabled control.

Link copied to clipboard
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.

Link copied to clipboard
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.