Skip to content

Commit aa15d97

Browse files
author
awstools
committed
feat(client-controltower): AWS Control Tower now reports the inheritance drift status for EnabledBaselines through the GetEnabledBaseline and ListEnabledBaselines APIs. You can now filter EnabledBaselines by their enablement and drift status using the ListEnabledBaselines API to view accounts and OUs that require attention.
1 parent 909fadc commit aa15d97

32 files changed

+326
-1818
lines changed

clients/client-controltower/README.md

Lines changed: 1 addition & 385 deletions
Large diffs are not rendered by default.

clients/client-controltower/src/ControlTower.ts

Lines changed: 1 addition & 385 deletions
Large diffs are not rendered by default.

clients/client-controltower/src/ControlTowerClient.ts

Lines changed: 1 addition & 385 deletions
Large diffs are not rendered by default.

clients/client-controltower/src/commands/CreateLandingZoneCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface CreateLandingZoneCommandInput extends CreateLandingZoneInput {}
2828
export interface CreateLandingZoneCommandOutput extends CreateLandingZoneOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone,
32-
* based on the parameters specified in the manifest JSON file.</p>
31+
* <p>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.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-controltower/src/commands/DeleteLandingZoneCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface DeleteLandingZoneCommandInput extends DeleteLandingZoneInput {}
2828
export interface DeleteLandingZoneCommandOutput extends DeleteLandingZoneOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower
32-
* resources deployed in accounts managed by Amazon Web Services Control Tower.</p>
31+
* <p>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.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-controltower/src/commands/DisableBaselineCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface DisableBaselineCommandInput extends DisableBaselineInput {}
2828
export interface DisableBaselineCommandOutput extends DisableBaselineOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Disable an <code>EnabledBaseline</code> 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 <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Disable an <code>EnabledBaseline</code> 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 <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript
@@ -67,7 +65,7 @@ export interface DisableBaselineCommandOutput extends DisableBaselineOutput, __M
6765
* <p>The request references a resource that does not exist.</p>
6866
*
6967
* @throws {@link ServiceQuotaExceededException} (client fault)
70-
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
68+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
7169
*
7270
* @throws {@link ThrottlingException} (client fault)
7371
* <p>The request was denied due to request throttling.</p>

clients/client-controltower/src/commands/DisableControlCommand.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface DisableControlCommandInput extends DisableControlInput {}
2828
export interface DisableControlCommandOutput extends DisableControlOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services
32-
* resources on the specified organizational unit and the accounts it contains. The resources
33-
* will vary according to the control that you specify. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
34-
* <i>Controls Reference Guide</i>
35-
* </a>.</p>
31+
* <p>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 <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript
@@ -70,7 +66,7 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
7066
* <p>The request references a resource that does not exist.</p>
7167
*
7268
* @throws {@link ServiceQuotaExceededException} (client fault)
73-
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
69+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
7470
*
7571
* @throws {@link ThrottlingException} (client fault)
7672
* <p>The request was denied due to request throttling.</p>

clients/client-controltower/src/commands/EnableBaselineCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface EnableBaselineCommandInput extends EnableBaselineInput {}
2828
export interface EnableBaselineCommandOutput extends EnableBaselineOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Enable (apply) a <code>Baseline</code> to a Target. This API starts an asynchronous operation to deploy resources specified by the <code>Baseline</code> to the specified Target. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Enable (apply) a <code>Baseline</code> to a Target. This API starts an asynchronous operation to deploy resources specified by the <code>Baseline</code> to the specified Target. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript
@@ -79,7 +77,7 @@ export interface EnableBaselineCommandOutput extends EnableBaselineOutput, __Met
7977
* <p>The request references a resource that does not exist.</p>
8078
*
8179
* @throws {@link ServiceQuotaExceededException} (client fault)
82-
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
80+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
8381
*
8482
* @throws {@link ThrottlingException} (client fault)
8583
* <p>The request was denied due to request throttling.</p>

clients/client-controltower/src/commands/EnableControlCommand.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface EnableControlCommandInput extends EnableControlInput {}
2828
export interface EnableControlCommandOutput extends EnableControlOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services
32-
* resources on the specified organizational unit and the accounts it contains. The resources
33-
* created will vary according to the control that you specify. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
34-
* <i>Controls Reference Guide</i>
35-
* </a>.</p>
31+
* <p>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 <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript
@@ -80,7 +76,7 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
8076
* <p>The request references a resource that does not exist.</p>
8177
*
8278
* @throws {@link ServiceQuotaExceededException} (client fault)
83-
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
79+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
8480
*
8581
* @throws {@link ThrottlingException} (client fault)
8682
* <p>The request was denied due to request throttling.</p>

clients/client-controltower/src/commands/GetBaselineCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface GetBaselineCommandInput extends GetBaselineInput {}
2828
export interface GetBaselineCommandOutput extends GetBaselineOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieve details about an existing <code>Baseline</code> resource by specifying its identifier. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Retrieve details about an existing <code>Baseline</code> resource by specifying its identifier. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-controltower/src/commands/GetBaselineOperationCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface GetBaselineOperationCommandInput extends GetBaselineOperationIn
2828
export interface GetBaselineOperationCommandOutput extends GetBaselineOperationOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: <code>EnableBaseline</code>, <code>DisableBaseline</code>, <code>UpdateEnabledBaseline</code>, <code>ResetEnabledBaseline</code>. A status message is displayed in case of operation failure. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: <code>EnableBaseline</code>, <code>DisableBaseline</code>, <code>UpdateEnabledBaseline</code>, <code>ResetEnabledBaseline</code>. A status message is displayed in case of operation failure. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-controltower/src/commands/GetControlOperationCommand.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,7 @@ export interface GetControlOperationCommandInput extends GetControlOperationInpu
2828
export interface GetControlOperationCommandOutput extends GetControlOperationOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the status of a particular <code>EnableControl</code> or
32-
* <code>DisableControl</code> operation. Displays a message in case of error. Details for an
33-
* operation are available for 90 days. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
34-
* <i>Controls Reference Guide</i>
35-
* </a>.</p>
31+
* <p>Returns the status of a particular <code>EnableControl</code> or <code>DisableControl</code> operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3632
* @example
3733
* Use a bare-bones client and the command you need to make an API call.
3834
* ```javascript

clients/client-controltower/src/commands/GetEnabledBaselineCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ export interface GetEnabledBaselineCommandOutput extends GetEnabledBaselineOutpu
4545
* // arn: "STRING_VALUE", // required
4646
* // baselineIdentifier: "STRING_VALUE", // required
4747
* // baselineVersion: "STRING_VALUE",
48+
* // driftStatusSummary: { // EnabledBaselineDriftStatusSummary
49+
* // types: { // EnabledBaselineDriftTypes
50+
* // inheritance: { // EnabledBaselineInheritanceDrift
51+
* // status: "IN_SYNC" || "DRIFTED",
52+
* // },
53+
* // },
54+
* // },
4855
* // targetIdentifier: "STRING_VALUE", // required
4956
* // parentIdentifier: "STRING_VALUE",
5057
* // statusSummary: { // EnablementStatusSummary

clients/client-controltower/src/commands/GetEnabledControlCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface GetEnabledControlCommandInput extends GetEnabledControlInput {}
2828
export interface GetEnabledControlCommandOutput extends GetEnabledControlOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves details about an enabled control. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
32-
* <i>Controls Reference Guide</i>
33-
* </a>.</p>
31+
* <p>Retrieves details about an enabled control. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-controltower/src/commands/GetLandingZoneOperationCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface GetLandingZoneOperationCommandInput extends GetLandingZoneOpera
2828
export interface GetLandingZoneOperationCommandOutput extends GetLandingZoneOperationOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for
32-
* 90 days.</p>
31+
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

clients/client-controltower/src/commands/ListBaselinesCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface ListBaselinesCommandInput extends ListBaselinesInput {}
2828
export interface ListBaselinesCommandOutput extends ListBaselinesOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a summary list of all available baselines. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Returns a summary list of all available baselines. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-controltower/src/commands/ListEnabledBaselinesCommand.ts

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface ListEnabledBaselinesCommandInput extends ListEnabledBaselinesIn
2828
export interface ListEnabledBaselinesCommandOutput extends ListEnabledBaselinesOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a list of summaries describing <code>EnabledBaseline</code> resources. You can filter the list by the corresponding <code>Baseline</code> or <code>Target</code> of the <code>EnabledBaseline</code> resources. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
32-
* <i>the Amazon Web Services Control Tower User Guide</i>
33-
* </a>.</p>
31+
* <p>Returns a list of summaries describing <code>EnabledBaseline</code> resources. You can filter the list by the corresponding <code>Baseline</code> or <code>Target</code> of the <code>EnabledBaseline</code> resources. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html"> <i>the Amazon Web Services Control Tower User Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript
@@ -48,6 +46,12 @@ export interface ListEnabledBaselinesCommandOutput extends ListEnabledBaselinesO
4846
* parentIdentifiers: [ // EnabledBaselineParentIdentifiers
4947
* "STRING_VALUE",
5048
* ],
49+
* statuses: [ // EnabledBaselineEnablementStatuses
50+
* "SUCCEEDED" || "FAILED" || "UNDER_CHANGE",
51+
* ],
52+
* inheritanceDriftStatuses: [ // EnabledBaselineDriftStatuses
53+
* "IN_SYNC" || "DRIFTED",
54+
* ],
5155
* },
5256
* nextToken: "STRING_VALUE",
5357
* maxResults: Number("int"),
@@ -61,6 +65,13 @@ export interface ListEnabledBaselinesCommandOutput extends ListEnabledBaselinesO
6165
* // arn: "STRING_VALUE", // required
6266
* // baselineIdentifier: "STRING_VALUE", // required
6367
* // baselineVersion: "STRING_VALUE",
68+
* // driftStatusSummary: { // EnabledBaselineDriftStatusSummary
69+
* // types: { // EnabledBaselineDriftTypes
70+
* // inheritance: { // EnabledBaselineInheritanceDrift
71+
* // status: "IN_SYNC" || "DRIFTED",
72+
* // },
73+
* // },
74+
* // },
6475
* // targetIdentifier: "STRING_VALUE", // required
6576
* // parentIdentifier: "STRING_VALUE",
6677
* // statusSummary: { // EnablementStatusSummary

clients/client-controltower/src/commands/ListEnabledControlsCommand.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface ListEnabledControlsCommandInput extends ListEnabledControlsInpu
2828
export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and
32-
* the accounts it contains. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
33-
* <i>Controls Reference Guide</i>
34-
* </a>.</p>
31+
* <p>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 <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript

clients/client-controltower/src/commands/ListLandingZonesCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface ListLandingZonesCommandInput extends ListLandingZonesInput {}
2828
export interface ListLandingZonesCommandOutput extends ListLandingZonesOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns the landing zone ARN for the landing zone deployed in your managed account. This API also
32-
* creates an ARN for existing accounts that do not yet have a landing zone ARN. </p>
33-
* <p>Returns one landing zone ARN.</p>
31+
* <p>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. </p> <p>Returns one landing zone ARN.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

clients/client-controltower/src/commands/ListTagsForResourceCommand.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceInpu
2828
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a list of tags associated with the resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
32-
* <i>Controls Reference Guide</i>
33-
* </a>.</p>
31+
* <p>Returns a list of tags associated with the resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html"> <i>Controls Reference Guide</i> </a>.</p>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript

0 commit comments

Comments
 (0)