@aws-sdk/client-controltower 3.808.0 → 3.809.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -385
- package/dist-cjs/index.js +7 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/ControlTower.d.ts +1 -385
- package/dist-types/ControlTowerClient.d.ts +1 -385
- package/dist-types/commands/CreateLandingZoneCommand.d.ts +1 -2
- package/dist-types/commands/DeleteLandingZoneCommand.d.ts +1 -2
- package/dist-types/commands/DisableBaselineCommand.d.ts +2 -4
- package/dist-types/commands/DisableControlCommand.d.ts +2 -6
- package/dist-types/commands/EnableBaselineCommand.d.ts +2 -4
- package/dist-types/commands/EnableControlCommand.d.ts +2 -6
- package/dist-types/commands/GetBaselineCommand.d.ts +1 -3
- package/dist-types/commands/GetBaselineOperationCommand.d.ts +1 -3
- package/dist-types/commands/GetControlOperationCommand.d.ts +1 -5
- package/dist-types/commands/GetEnabledBaselineCommand.d.ts +7 -0
- package/dist-types/commands/GetEnabledControlCommand.d.ts +1 -3
- package/dist-types/commands/GetLandingZoneOperationCommand.d.ts +1 -2
- package/dist-types/commands/ListBaselinesCommand.d.ts +1 -3
- package/dist-types/commands/ListEnabledBaselinesCommand.d.ts +14 -3
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +1 -4
- package/dist-types/commands/ListLandingZonesCommand.d.ts +1 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -3
- package/dist-types/commands/ResetEnabledBaselineCommand.d.ts +2 -4
- package/dist-types/commands/ResetEnabledControlCommand.d.ts +1 -1
- package/dist-types/commands/ResetLandingZoneCommand.d.ts +1 -5
- package/dist-types/commands/TagResourceCommand.d.ts +1 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -3
- package/dist-types/commands/UpdateEnabledBaselineCommand.d.ts +2 -4
- package/dist-types/commands/UpdateEnabledControlCommand.d.ts +2 -9
- package/dist-types/commands/UpdateLandingZoneCommand.d.ts +1 -3
- package/dist-types/index.d.ts +1 -385
- package/dist-types/models/models_0.d.ts +92 -139
- package/dist-types/ts3.4/models/models_0.d.ts +19 -0
- package/package.json +1 -1
|
@@ -27,8 +27,7 @@ declare const GetLandingZoneOperationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for
|
|
31
|
-
* 90 days.</p>
|
|
30
|
+
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const ListBaselinesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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">
|
|
31
|
-
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const ListEnabledBaselinesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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">
|
|
31
|
-
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -47,6 +45,12 @@ declare const ListEnabledBaselinesCommand_base: {
|
|
|
47
45
|
* parentIdentifiers: [ // EnabledBaselineParentIdentifiers
|
|
48
46
|
* "STRING_VALUE",
|
|
49
47
|
* ],
|
|
48
|
+
* statuses: [ // EnabledBaselineEnablementStatuses
|
|
49
|
+
* "SUCCEEDED" || "FAILED" || "UNDER_CHANGE",
|
|
50
|
+
* ],
|
|
51
|
+
* inheritanceDriftStatuses: [ // EnabledBaselineDriftStatuses
|
|
52
|
+
* "IN_SYNC" || "DRIFTED",
|
|
53
|
+
* ],
|
|
50
54
|
* },
|
|
51
55
|
* nextToken: "STRING_VALUE",
|
|
52
56
|
* maxResults: Number("int"),
|
|
@@ -60,6 +64,13 @@ declare const ListEnabledBaselinesCommand_base: {
|
|
|
60
64
|
* // arn: "STRING_VALUE", // required
|
|
61
65
|
* // baselineIdentifier: "STRING_VALUE", // required
|
|
62
66
|
* // baselineVersion: "STRING_VALUE",
|
|
67
|
+
* // driftStatusSummary: { // EnabledBaselineDriftStatusSummary
|
|
68
|
+
* // types: { // EnabledBaselineDriftTypes
|
|
69
|
+
* // inheritance: { // EnabledBaselineInheritanceDrift
|
|
70
|
+
* // status: "IN_SYNC" || "DRIFTED",
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
63
74
|
* // targetIdentifier: "STRING_VALUE", // required
|
|
64
75
|
* // parentIdentifier: "STRING_VALUE",
|
|
65
76
|
* // statusSummary: { // EnablementStatusSummary
|
|
@@ -27,10 +27,7 @@ declare const ListEnabledControlsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and
|
|
31
|
-
* the accounts it contains. 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>
|
|
30
|
+
* <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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const ListLandingZonesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the landing zone ARN for the landing zone deployed in your managed account. This API also
|
|
31
|
-
* creates an ARN for existing accounts that do not yet have a landing zone ARN. </p>
|
|
32
|
-
* <p>Returns one landing zone ARN.</p>
|
|
30
|
+
* <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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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">
|
|
31
|
-
* <i>Controls Reference Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const ResetEnabledBaselineCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Re-enables an <code>EnabledBaseline</code> resource. For example, this API can re-apply the existing <code>Baseline</code> after a new member account is moved to the target OU. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
31
|
-
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <p>Re-enables an <code>EnabledBaseline</code> resource. For example, this API can re-apply the existing <code>Baseline</code> after a new member account is moved to the target OU. 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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -66,7 +64,7 @@ declare const ResetEnabledBaselineCommand_base: {
|
|
|
66
64
|
* <p>The request references a resource that does not exist.</p>
|
|
67
65
|
*
|
|
68
66
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
69
|
-
* <p>The request would cause a service quota to be exceeded. The limit is
|
|
67
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
|
|
70
68
|
*
|
|
71
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
72
70
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -64,7 +64,7 @@ declare const ResetEnabledControlCommand_base: {
|
|
|
64
64
|
* <p>The request references a resource that does not exist.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
67
|
-
* <p>The request would cause a service quota to be exceeded. The limit is
|
|
67
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
70
70
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -27,11 +27,7 @@ declare const ResetLandingZoneCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This API call resets a landing zone. It starts an asynchronous operation that resets the
|
|
31
|
-
* landing zone to the parameters specified in the original configuration, which you specified
|
|
32
|
-
* in the manifest file. Nothing in the manifest file's original landing zone configuration is changed
|
|
33
|
-
* during the reset process, by default. This API is not the same as a rollback of a landing
|
|
34
|
-
* zone version, which is not a supported operation.</p>
|
|
30
|
+
* <p>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.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Applies tags to a resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
|
|
31
|
-
* <i>Controls Reference Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <p>Applies tags to a 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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Removes tags from a resource. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
|
|
31
|
-
* <i>Controls Reference Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <p>Removes tags from a 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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,9 +27,7 @@ declare const UpdateEnabledBaselineCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates an <code>EnabledBaseline</code> resource's applied parameters or version. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
31
|
-
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
32
|
-
* </a>.</p>
|
|
30
|
+
* <p>Updates an <code>EnabledBaseline</code> resource's applied parameters or version. 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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -73,7 +71,7 @@ declare const UpdateEnabledBaselineCommand_base: {
|
|
|
73
71
|
* <p>The request references a resource that does not exist.</p>
|
|
74
72
|
*
|
|
75
73
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
76
|
-
* <p>The request would cause a service quota to be exceeded. The limit is
|
|
74
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
|
|
77
75
|
*
|
|
78
76
|
* @throws {@link ThrottlingException} (client fault)
|
|
79
77
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -27,14 +27,7 @@ declare const UpdateEnabledControlCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
* Updates the configuration of an already enabled control.</p>
|
|
32
|
-
* <p>If the enabled control shows an <code>EnablementStatus</code> of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.</p>
|
|
33
|
-
* <p>If the enabled control shows an <code>EnablementStatus</code> of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.</p>
|
|
34
|
-
* <p>If the <code>DriftSummary</code> status for the control shows as <code>DRIFTED</code>, you cannot call this API. Instead, you can update the control by calling the <code>ResetEnabledControl</code> API. Alternatively, you can call <code>DisableControl</code> and then call <code>EnableControl</code> again. Also, you can run an extending governance operation to repair drift. For usage examples, see the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">
|
|
35
|
-
* <i>Controls Reference Guide</i>
|
|
36
|
-
* </a>.
|
|
37
|
-
* </p>
|
|
30
|
+
* <p> Updates the configuration of an already enabled control.</p> <p>If the enabled control shows an <code>EnablementStatus</code> of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.</p> <p>If the enabled control shows an <code>EnablementStatus</code> of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.</p> <p>If the <code>DriftSummary</code> status for the control shows as <code>DRIFTED</code>, you cannot call this API. Instead, you can update the control by calling the <code>ResetEnabledControl</code> API. Alternatively, you can call <code>DisableControl</code> and then call <code>EnableControl</code> again. Also, you can run an extending governance operation to repair drift. 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>
|
|
38
31
|
* @example
|
|
39
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
33
|
* ```javascript
|
|
@@ -77,7 +70,7 @@ declare const UpdateEnabledControlCommand_base: {
|
|
|
77
70
|
* <p>The request references a resource that does not exist.</p>
|
|
78
71
|
*
|
|
79
72
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
80
|
-
* <p>The request would cause a service quota to be exceeded. The limit is
|
|
73
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>
|
|
81
74
|
*
|
|
82
75
|
* @throws {@link ThrottlingException} (client fault)
|
|
83
76
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -27,9 +27,7 @@ declare const UpdateLandingZoneCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This API call updates the landing zone. It starts an asynchronous operation that updates the
|
|
31
|
-
* landing zone based on the new landing zone version, or on the changed parameters specified in the
|
|
32
|
-
* updated manifest file. </p>
|
|
30
|
+
* <p>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. </p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|