ControlTower

import { ControlTower } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/controltower.ts?docs=full";

class ControlTower {

constructor(apiFactory: client.ApiFactory);

async createLandingZone(params: CreateLandingZoneInput, opts?: client.RequestOptions): Promise<CreateLandingZoneOutput>;

async deleteLandingZone(params: DeleteLandingZoneInput, opts?: client.RequestOptions): Promise<DeleteLandingZoneOutput>;

async disableBaseline(params: DisableBaselineInput, opts?: client.RequestOptions): Promise<DisableBaselineOutput>;

async disableControl(params: DisableControlInput, opts?: client.RequestOptions): Promise<DisableControlOutput>;

async enableBaseline(params: EnableBaselineInput, opts?: client.RequestOptions): Promise<EnableBaselineOutput>;

async enableControl(params: EnableControlInput, opts?: client.RequestOptions): Promise<EnableControlOutput>;

async getBaseline(params: GetBaselineInput, opts?: client.RequestOptions): Promise<GetBaselineOutput>;

async getBaselineOperation(params: GetBaselineOperationInput, opts?: client.RequestOptions): Promise<GetBaselineOperationOutput>;

async getControlOperation(params: GetControlOperationInput, opts?: client.RequestOptions): Promise<GetControlOperationOutput>;

async getEnabledBaseline(params: GetEnabledBaselineInput, opts?: client.RequestOptions): Promise<GetEnabledBaselineOutput>;

async getEnabledControl(params: GetEnabledControlInput, opts?: client.RequestOptions): Promise<GetEnabledControlOutput>;

async getLandingZone(params: GetLandingZoneInput, opts?: client.RequestOptions): Promise<GetLandingZoneOutput>;

async getLandingZoneOperation(params: GetLandingZoneOperationInput, opts?: client.RequestOptions): Promise<GetLandingZoneOperationOutput>;

async listBaselines(params?: ListBaselinesInput, opts?: client.RequestOptions): Promise<ListBaselinesOutput>;

async listControlOperations(params?: ListControlOperationsInput, opts?: client.RequestOptions): Promise<ListControlOperationsOutput>;

async listEnabledBaselines(params?: ListEnabledBaselinesInput, opts?: client.RequestOptions): Promise<ListEnabledBaselinesOutput>;

async listEnabledControls(params?: ListEnabledControlsInput, opts?: client.RequestOptions): Promise<ListEnabledControlsOutput>;

async listLandingZoneOperations(params?: ListLandingZoneOperationsInput, opts?: client.RequestOptions): Promise<ListLandingZoneOperationsOutput>;

async listLandingZones(params?: ListLandingZonesInput, opts?: client.RequestOptions): Promise<ListLandingZonesOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async resetEnabledBaseline(params: ResetEnabledBaselineInput, opts?: client.RequestOptions): Promise<ResetEnabledBaselineOutput>;

async resetLandingZone(params: ResetLandingZoneInput, opts?: client.RequestOptions): Promise<ResetLandingZoneOutput>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

async updateEnabledBaseline(params: UpdateEnabledBaselineInput, opts?: client.RequestOptions): Promise<UpdateEnabledBaselineOutput>;

async updateEnabledControl(params: UpdateEnabledControlInput, opts?: client.RequestOptions): Promise<UpdateEnabledControlOutput>;

async updateLandingZone(params: UpdateLandingZoneInput, opts?: client.RequestOptions): Promise<UpdateLandingZoneOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new ControlTower(apiFactory: client.ApiFactory)

[src]

§Methods

createLandingZone(params: CreateLandingZoneInput, opts?: client.RequestOptions): Promise<CreateLandingZoneOutput>

[src]

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(params: DeleteLandingZoneInput, opts?: client.RequestOptions): Promise<DeleteLandingZoneOutput>

[src]

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(params: DisableBaselineInput, opts?: client.RequestOptions): Promise<DisableBaselineOutput>

[src]

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(params: DisableControlInput, opts?: client.RequestOptions): Promise<DisableControlOutput>

[src]

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(params: EnableBaselineInput, opts?: client.RequestOptions): Promise<EnableBaselineOutput>

[src]

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(params: EnableControlInput, opts?: client.RequestOptions): Promise<EnableControlOutput>

[src]

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(params: GetBaselineInput, opts?: client.RequestOptions): Promise<GetBaselineOutput>

[src]

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

getBaselineOperation(params: GetBaselineOperationInput, opts?: client.RequestOptions): Promise<GetBaselineOperationOutput>

[src]

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(params: GetControlOperationInput, opts?: client.RequestOptions): Promise<GetControlOperationOutput>

[src]

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(params: GetEnabledBaselineInput, opts?: client.RequestOptions): Promise<GetEnabledBaselineOutput>

[src]

Retrieve details of an EnabledBaseline resource by specifying its identifier.

getEnabledControl(params: GetEnabledControlInput, opts?: client.RequestOptions): Promise<GetEnabledControlOutput>

[src]

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

getLandingZone(params: GetLandingZoneInput, opts?: client.RequestOptions): Promise<GetLandingZoneOutput>

[src]

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

getLandingZoneOperation(params: GetLandingZoneOperationInput, opts?: client.RequestOptions): Promise<GetLandingZoneOperationOutput>

[src]

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

listBaselines(params?: ListBaselinesInput, opts?: client.RequestOptions): Promise<ListBaselinesOutput>

[src]

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

listControlOperations(params?: ListControlOperationsInput, opts?: client.RequestOptions): Promise<ListControlOperationsOutput>

[src]

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

listEnabledBaselines(params?: ListEnabledBaselinesInput, opts?: client.RequestOptions): Promise<ListEnabledBaselinesOutput>

[src]

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(params?: ListEnabledControlsInput, opts?: client.RequestOptions): Promise<ListEnabledControlsOutput>

[src]

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(params?: ListLandingZoneOperationsInput, opts?: client.RequestOptions): Promise<ListLandingZoneOperationsOutput>

[src]

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

listLandingZones(params?: ListLandingZonesInput, opts?: client.RequestOptions): Promise<ListLandingZonesOutput>

[src]

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.

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

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

resetEnabledBaseline(params: ResetEnabledBaselineInput, opts?: client.RequestOptions): Promise<ResetEnabledBaselineOutput>

[src]

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.

resetLandingZone(params: ResetLandingZoneInput, opts?: client.RequestOptions): Promise<ResetLandingZoneOutput>

[src]

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(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateEnabledBaseline(params: UpdateEnabledBaselineInput, opts?: client.RequestOptions): Promise<UpdateEnabledBaselineOutput>

[src]

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

updateEnabledControl(params: UpdateEnabledControlInput, opts?: client.RequestOptions): Promise<UpdateEnabledControlOutput>

[src]

Updates the configuration of an already enabled control.

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the Controls Reference Guide.

updateLandingZone(params: UpdateLandingZoneInput, opts?: client.RequestOptions): Promise<UpdateLandingZoneOutput>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]