@aws-sdk/client-controltower 3.441.0 → 3.449.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 +29 -2
- package/dist-cjs/ControlTower.js +6 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +178 -1
- package/dist-es/ControlTower.js +6 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +172 -1
- package/dist-types/ControlTower.d.ts +39 -15
- package/dist-types/ControlTowerClient.d.ts +23 -17
- package/dist-types/commands/DisableControlCommand.d.ts +2 -2
- package/dist-types/commands/EnableControlCommand.d.ts +7 -4
- package/dist-types/commands/GetControlOperationCommand.d.ts +3 -4
- package/dist-types/commands/GetEnabledControlCommand.d.ts +1 -16
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +2 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +86 -0
- package/dist-types/commands/TagResourceCommand.d.ts +85 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +85 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +20 -15
- package/dist-types/models/models_0.d.ts +106 -66
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/ControlTower.d.ts +51 -0
- package/dist-types/ts3.4/ControlTowerClient.d.ts +20 -2
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +13 -13
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
|
|
5
|
+
import { TagResourceInput, TagResourceOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link TagResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface TagResourceCommandInput extends TagResourceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link TagResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Applies tags to a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
+
* <i>the AWS Control Tower User Guide</i>
|
|
28
|
+
* </a>.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { ControlTowerClient, TagResourceCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
33
|
+
* // const { ControlTowerClient, TagResourceCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
34
|
+
* const client = new ControlTowerClient(config);
|
|
35
|
+
* const input = { // TagResourceInput
|
|
36
|
+
* resourceArn: "STRING_VALUE", // required
|
|
37
|
+
* tags: { // TagMap // required
|
|
38
|
+
* "<keys>": "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* };
|
|
41
|
+
* const command = new TagResourceCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
48
|
+
* @returns {@link TagResourceCommandOutput}
|
|
49
|
+
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InternalServerException} (server fault)
|
|
54
|
+
* <p>Unexpected error during processing of request.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
|
+
* <p>Request references a resource which does not exist.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ControlTowerServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ControlTowerClientResolvedConfig> {
|
|
67
|
+
readonly input: TagResourceCommandInput;
|
|
68
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
constructor(input: TagResourceCommandInput);
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
private serialize;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
private deserialize;
|
|
85
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
|
|
5
|
+
import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UntagResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UntagResourceCommandInput extends UntagResourceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UntagResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Removes tags from a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
+
* <i>the AWS Control Tower User Guide</i>
|
|
28
|
+
* </a>.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { ControlTowerClient, UntagResourceCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
33
|
+
* // const { ControlTowerClient, UntagResourceCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
34
|
+
* const client = new ControlTowerClient(config);
|
|
35
|
+
* const input = { // UntagResourceInput
|
|
36
|
+
* resourceArn: "STRING_VALUE", // required
|
|
37
|
+
* tagKeys: [ // TagKeys // required
|
|
38
|
+
* "STRING_VALUE",
|
|
39
|
+
* ],
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UntagResourceCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
|
|
48
|
+
* @returns {@link UntagResourceCommandOutput}
|
|
49
|
+
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InternalServerException} (server fault)
|
|
54
|
+
* <p>Unexpected error during processing of request.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
|
+
* <p>Request references a resource which does not exist.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ControlTowerServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ControlTowerClientResolvedConfig> {
|
|
67
|
+
readonly input: UntagResourceCommandInput;
|
|
68
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
constructor(input: UntagResourceCommandInput);
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
|
|
77
|
+
/**
|
|
78
|
+
* @internal
|
|
79
|
+
*/
|
|
80
|
+
private serialize;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
private deserialize;
|
|
85
|
+
}
|
|
@@ -3,3 +3,6 @@ export * from "./EnableControlCommand";
|
|
|
3
3
|
export * from "./GetControlOperationCommand";
|
|
4
4
|
export * from "./GetEnabledControlCommand";
|
|
5
5
|
export * from "./ListEnabledControlsCommand";
|
|
6
|
+
export * from "./ListTagsForResourceCommand";
|
|
7
|
+
export * from "./TagResourceCommand";
|
|
8
|
+
export * from "./UntagResourceCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <p>These interfaces allow you to apply the AWS library of pre-defined
|
|
3
|
-
*
|
|
3
|
+
* <i>controls</i> to your organizational units, programmatically. In AWS Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
4
4
|
* <p>To call these APIs, you'll need to know:</p>
|
|
5
5
|
* <ul>
|
|
6
6
|
* <li>
|
|
@@ -9,21 +9,24 @@
|
|
|
9
9
|
* <li>
|
|
10
10
|
* <p>the ARN associated with the target organizational unit (OU), which we call the <code>targetIdentifier</code>.</p>
|
|
11
11
|
* </li>
|
|
12
|
+
* <li>
|
|
13
|
+
* <p>the ARN associated with a resource that you wish to tag or untag.</p>
|
|
14
|
+
* </li>
|
|
12
15
|
* </ul>
|
|
13
16
|
* <p>
|
|
14
17
|
* <b>To get the <code>controlIdentifier</code> for your AWS Control Tower
|
|
15
|
-
*
|
|
18
|
+
* control:</b>
|
|
16
19
|
* </p>
|
|
17
20
|
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
18
|
-
*
|
|
21
|
+
* control. You can view the <code>controlIdentifier</code> in the console on the <b>Control details</b> page, as well as in the documentation.</p>
|
|
19
22
|
* <p>The <code>controlIdentifier</code> is unique in each AWS Region for each control. You can
|
|
20
|
-
*
|
|
23
|
+
* find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>AWS Control Tower User Guide.</i>
|
|
21
24
|
* </p>
|
|
22
25
|
* <p>A quick-reference list of control identifers for the AWS Control Tower legacy <i>Strongly recommended</i> and
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
26
|
+
* <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
|
|
27
|
+
* APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
|
|
28
|
+
* of the <i>AWS Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
|
|
29
|
+
* cannot be added or removed.</p>
|
|
27
30
|
* <note>
|
|
28
31
|
* <p>
|
|
29
32
|
* <b>ARN format:</b>
|
|
@@ -95,19 +98,21 @@
|
|
|
95
98
|
* <b>Recording API Requests</b>
|
|
96
99
|
* </p>
|
|
97
100
|
* <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
101
|
+
* AWS account and delivers log files to an Amazon S3 bucket. By using information collected by
|
|
102
|
+
* CloudTrail, you can determine which requests the AWS Control Tower service received, who made
|
|
103
|
+
* the request and when, and so on. For more about AWS Control Tower and its support for
|
|
104
|
+
* CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower
|
|
105
|
+
* Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about
|
|
106
|
+
* CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User
|
|
107
|
+
* Guide.</p>
|
|
105
108
|
*
|
|
106
109
|
* @packageDocumentation
|
|
107
110
|
*/
|
|
108
111
|
export * from "./ControlTowerClient";
|
|
109
112
|
export * from "./ControlTower";
|
|
110
113
|
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
114
|
+
export { RuntimeExtension } from "./runtimeExtensions";
|
|
115
|
+
export { ControlTowerExtensionConfiguration } from "./extensionConfiguration";
|
|
111
116
|
export * from "./commands";
|
|
112
117
|
export * from "./pagination";
|
|
113
118
|
export * from "./models";
|
|
@@ -31,8 +31,8 @@ export interface DisableControlInput {
|
|
|
31
31
|
/**
|
|
32
32
|
* @public
|
|
33
33
|
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <b>Elective</b> controls are permitted, with the exception of the
|
|
35
|
+
* <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
36
36
|
*/
|
|
37
37
|
controlIdentifier: string | undefined;
|
|
38
38
|
/**
|
|
@@ -48,7 +48,7 @@ export interface DisableControlOutput {
|
|
|
48
48
|
/**
|
|
49
49
|
* @public
|
|
50
50
|
* <p>The ID of the asynchronous operation, which is used to track status. The operation is
|
|
51
|
-
*
|
|
51
|
+
* available for 90 days.</p>
|
|
52
52
|
*/
|
|
53
53
|
operationIdentifier: string | undefined;
|
|
54
54
|
}
|
|
@@ -138,8 +138,8 @@ export interface EnableControlInput {
|
|
|
138
138
|
/**
|
|
139
139
|
* @public
|
|
140
140
|
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
141
|
-
*
|
|
142
|
-
*
|
|
141
|
+
* <b>Elective</b> controls are permitted, with the exception of the
|
|
142
|
+
* <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
143
143
|
*/
|
|
144
144
|
controlIdentifier: string | undefined;
|
|
145
145
|
/**
|
|
@@ -147,6 +147,11 @@ export interface EnableControlInput {
|
|
|
147
147
|
* <p>The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
148
148
|
*/
|
|
149
149
|
targetIdentifier: string | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* <p>Tags to be applied to the <code>EnabledControl</code> resource.</p>
|
|
153
|
+
*/
|
|
154
|
+
tags?: Record<string, string>;
|
|
150
155
|
}
|
|
151
156
|
/**
|
|
152
157
|
* @public
|
|
@@ -155,9 +160,14 @@ export interface EnableControlOutput {
|
|
|
155
160
|
/**
|
|
156
161
|
* @public
|
|
157
162
|
* <p>The ID of the asynchronous operation, which is used to track status. The operation is
|
|
158
|
-
*
|
|
163
|
+
* available for 90 days.</p>
|
|
159
164
|
*/
|
|
160
165
|
operationIdentifier: string | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
* <p>The ARN of the <code>EnabledControl</code> resource.</p>
|
|
169
|
+
*/
|
|
170
|
+
arn?: string;
|
|
161
171
|
}
|
|
162
172
|
/**
|
|
163
173
|
* @public
|
|
@@ -166,7 +176,7 @@ export interface GetControlOperationInput {
|
|
|
166
176
|
/**
|
|
167
177
|
* @public
|
|
168
178
|
* <p>The ID of the asynchronous operation, which is used to track status. The operation is
|
|
169
|
-
*
|
|
179
|
+
* available for 90 days.</p>
|
|
170
180
|
*/
|
|
171
181
|
operationIdentifier: string | undefined;
|
|
172
182
|
}
|
|
@@ -223,7 +233,7 @@ export interface ControlOperation {
|
|
|
223
233
|
/**
|
|
224
234
|
* @public
|
|
225
235
|
* <p>If the operation result is <code>FAILED</code>, this string contains a message explaining
|
|
226
|
-
*
|
|
236
|
+
* why the operation failed.</p>
|
|
227
237
|
*/
|
|
228
238
|
statusMessage?: string;
|
|
229
239
|
}
|
|
@@ -243,9 +253,7 @@ export interface GetControlOperationOutput {
|
|
|
243
253
|
export interface GetEnabledControlInput {
|
|
244
254
|
/**
|
|
245
255
|
* @public
|
|
246
|
-
* <p>
|
|
247
|
-
* The ARN of the enabled control.
|
|
248
|
-
* </p>
|
|
256
|
+
* <p>The <code>controlIdentifier</code> of the enabled control.</p>
|
|
249
257
|
*/
|
|
250
258
|
enabledControlIdentifier: string | undefined;
|
|
251
259
|
}
|
|
@@ -267,8 +275,8 @@ export type DriftStatus = (typeof DriftStatus)[keyof typeof DriftStatus];
|
|
|
267
275
|
* @public
|
|
268
276
|
* <p> The drift summary of the enabled control.</p>
|
|
269
277
|
* <p>AWS Control Tower expects the enabled control
|
|
270
|
-
*
|
|
271
|
-
*
|
|
278
|
+
* configuration to include all supported and governed Regions. If the enabled control differs
|
|
279
|
+
* from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.</p>
|
|
272
280
|
*/
|
|
273
281
|
export interface DriftStatusSummary {
|
|
274
282
|
/**
|
|
@@ -279,22 +287,22 @@ export interface DriftStatusSummary {
|
|
|
279
287
|
* <li>
|
|
280
288
|
* <p>
|
|
281
289
|
* <code>DRIFTED</code>: The <code>enabledControl</code> deployed in this configuration
|
|
282
|
-
*
|
|
290
|
+
* doesn’t match the configuration that AWS Control Tower expected. </p>
|
|
283
291
|
* </li>
|
|
284
292
|
* <li>
|
|
285
293
|
* <p>
|
|
286
294
|
* <code>IN_SYNC</code>: The <code>enabledControl</code> deployed in this configuration matches
|
|
287
|
-
*
|
|
295
|
+
* the configuration that AWS Control Tower expected.</p>
|
|
288
296
|
* </li>
|
|
289
297
|
* <li>
|
|
290
298
|
* <p>
|
|
291
299
|
* <code>NOT_CHECKING</code>: AWS Control Tower does not check drift for this enabled
|
|
292
|
-
*
|
|
300
|
+
* control. Drift is not supported for the control type.</p>
|
|
293
301
|
* </li>
|
|
294
302
|
* <li>
|
|
295
303
|
* <p>
|
|
296
304
|
* <code>UNKNOWN</code>: AWS Control Tower is not able to check the drift status for the
|
|
297
|
-
*
|
|
305
|
+
* enabled control. </p>
|
|
298
306
|
* </li>
|
|
299
307
|
* </ul>
|
|
300
308
|
*/
|
|
@@ -315,9 +323,7 @@ export declare const EnablementStatus: {
|
|
|
315
323
|
export type EnablementStatus = (typeof EnablementStatus)[keyof typeof EnablementStatus];
|
|
316
324
|
/**
|
|
317
325
|
* @public
|
|
318
|
-
* <p>
|
|
319
|
-
* The deployment summary of the enabled control.
|
|
320
|
-
* </p>
|
|
326
|
+
* <p>The deployment summary of the enabled control.</p>
|
|
321
327
|
*/
|
|
322
328
|
export interface EnablementStatusSummary {
|
|
323
329
|
/**
|
|
@@ -342,9 +348,7 @@ export interface EnablementStatusSummary {
|
|
|
342
348
|
status?: EnablementStatus;
|
|
343
349
|
/**
|
|
344
350
|
* @public
|
|
345
|
-
* <p>
|
|
346
|
-
* The last operation identifier for the enabled control.
|
|
347
|
-
* </p>
|
|
351
|
+
* <p>The last operation identifier for the enabled control.</p>
|
|
348
352
|
*/
|
|
349
353
|
lastOperationIdentifier?: string;
|
|
350
354
|
}
|
|
@@ -352,65 +356,49 @@ export interface EnablementStatusSummary {
|
|
|
352
356
|
* @public
|
|
353
357
|
* <p>An AWS Region in which AWS Control Tower expects to find the control deployed. </p>
|
|
354
358
|
* <p>The expected Regions are based on the Regions that are governed by the landing zone. In
|
|
355
|
-
*
|
|
356
|
-
*
|
|
359
|
+
* certain cases, a control is not actually enabled in the Region as expected, such as during
|
|
360
|
+
* drift, or <a href="https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance">mixed governance</a>.</p>
|
|
357
361
|
*/
|
|
358
362
|
export interface Region {
|
|
359
363
|
/**
|
|
360
364
|
* @public
|
|
361
|
-
* <p>
|
|
362
|
-
* The AWS Region name.
|
|
363
|
-
* </p>
|
|
365
|
+
* <p>The AWS Region name.</p>
|
|
364
366
|
*/
|
|
365
367
|
name?: string;
|
|
366
368
|
}
|
|
367
369
|
/**
|
|
368
370
|
* @public
|
|
369
|
-
* <p>
|
|
370
|
-
* Information about the enabled control.
|
|
371
|
-
* </p>
|
|
371
|
+
* <p>Information about the enabled control.</p>
|
|
372
372
|
*/
|
|
373
373
|
export interface EnabledControlDetails {
|
|
374
374
|
/**
|
|
375
375
|
* @public
|
|
376
|
-
* <p>
|
|
377
|
-
* The ARN of the enabled control.
|
|
378
|
-
* </p>
|
|
376
|
+
* <p>The ARN of the enabled control.</p>
|
|
379
377
|
*/
|
|
380
378
|
arn?: string;
|
|
381
379
|
/**
|
|
382
380
|
* @public
|
|
383
|
-
* <p>
|
|
384
|
-
* The control identifier of the enabled control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.
|
|
385
|
-
* </p>
|
|
381
|
+
* <p>The control identifier of the enabled control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
386
382
|
*/
|
|
387
383
|
controlIdentifier?: string;
|
|
388
384
|
/**
|
|
389
385
|
* @public
|
|
390
|
-
* <p>
|
|
391
|
-
* The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.
|
|
392
|
-
* </p>
|
|
386
|
+
* <p>The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
393
387
|
*/
|
|
394
388
|
targetIdentifier?: string;
|
|
395
389
|
/**
|
|
396
390
|
* @public
|
|
397
|
-
* <p>
|
|
398
|
-
* Target AWS Regions for the enabled control.
|
|
399
|
-
* </p>
|
|
391
|
+
* <p>Target AWS Regions for the enabled control.</p>
|
|
400
392
|
*/
|
|
401
393
|
targetRegions?: Region[];
|
|
402
394
|
/**
|
|
403
395
|
* @public
|
|
404
|
-
* <p>
|
|
405
|
-
* The deployment summary of the enabled control.
|
|
406
|
-
* </p>
|
|
396
|
+
* <p>The deployment summary of the enabled control.</p>
|
|
407
397
|
*/
|
|
408
398
|
statusSummary?: EnablementStatusSummary;
|
|
409
399
|
/**
|
|
410
400
|
* @public
|
|
411
|
-
* <p>
|
|
412
|
-
* The drift status of the enabled control.
|
|
413
|
-
* </p>
|
|
401
|
+
* <p>The drift status of the enabled control.</p>
|
|
414
402
|
*/
|
|
415
403
|
driftStatusSummary?: DriftStatusSummary;
|
|
416
404
|
}
|
|
@@ -420,9 +408,7 @@ export interface EnabledControlDetails {
|
|
|
420
408
|
export interface GetEnabledControlOutput {
|
|
421
409
|
/**
|
|
422
410
|
* @public
|
|
423
|
-
* <p>
|
|
424
|
-
* Information about the enabled control.
|
|
425
|
-
* </p>
|
|
411
|
+
* <p>Information about the enabled control.</p>
|
|
426
412
|
*/
|
|
427
413
|
enabledControlDetails: EnabledControlDetails | undefined;
|
|
428
414
|
}
|
|
@@ -448,40 +434,34 @@ export interface ListEnabledControlsInput {
|
|
|
448
434
|
}
|
|
449
435
|
/**
|
|
450
436
|
* @public
|
|
451
|
-
* <p>
|
|
437
|
+
* <p>Returns a summary of information about an enabled control.</p>
|
|
452
438
|
*/
|
|
453
439
|
export interface EnabledControlSummary {
|
|
454
440
|
/**
|
|
455
441
|
* @public
|
|
456
|
-
* <p>The
|
|
457
|
-
* <b>Elective</b> controls are permitted, with the exception of the
|
|
458
|
-
* <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</p>
|
|
442
|
+
* <p>The <code>controlIdentifier</code> of the enabled control.</p>
|
|
459
443
|
*/
|
|
460
444
|
controlIdentifier?: string;
|
|
461
445
|
/**
|
|
462
446
|
* @public
|
|
463
|
-
* <p>
|
|
464
|
-
* The ARN of the enabled control.
|
|
465
|
-
* </p>
|
|
447
|
+
* <p>The ARN of the enabled control.</p>
|
|
466
448
|
*/
|
|
467
449
|
arn?: string;
|
|
468
450
|
/**
|
|
469
451
|
* @public
|
|
470
452
|
* <p>
|
|
471
|
-
*
|
|
453
|
+
* The ARN of the organizational unit.
|
|
472
454
|
* </p>
|
|
473
455
|
*/
|
|
474
456
|
targetIdentifier?: string;
|
|
475
457
|
/**
|
|
476
458
|
* @public
|
|
477
|
-
*
|
|
459
|
+
* <p>A short description of the status of the enabled control.</p>
|
|
478
460
|
*/
|
|
479
461
|
statusSummary?: EnablementStatusSummary;
|
|
480
462
|
/**
|
|
481
463
|
* @public
|
|
482
|
-
* <p>
|
|
483
|
-
* The drift status of the enabled control.
|
|
484
|
-
* </p>
|
|
464
|
+
* <p>The drift status of the enabled control.</p>
|
|
485
465
|
*/
|
|
486
466
|
driftStatusSummary?: DriftStatusSummary;
|
|
487
467
|
}
|
|
@@ -492,13 +472,73 @@ export interface ListEnabledControlsOutput {
|
|
|
492
472
|
/**
|
|
493
473
|
* @public
|
|
494
474
|
* <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
|
|
495
|
-
*
|
|
475
|
+
* the accounts it contains.</p>
|
|
496
476
|
*/
|
|
497
477
|
enabledControls: EnabledControlSummary[] | undefined;
|
|
498
478
|
/**
|
|
499
479
|
* @public
|
|
500
480
|
* <p>Retrieves the next page of results. If the string is empty, the current response is the
|
|
501
|
-
*
|
|
481
|
+
* end of the results.</p>
|
|
502
482
|
*/
|
|
503
483
|
nextToken?: string;
|
|
504
484
|
}
|
|
485
|
+
/**
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
export interface ListTagsForResourceInput {
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
* <p> The ARN of the resource.</p>
|
|
492
|
+
*/
|
|
493
|
+
resourceArn: string | undefined;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
export interface ListTagsForResourceOutput {
|
|
499
|
+
/**
|
|
500
|
+
* @public
|
|
501
|
+
* <p>A list of tags, as <code>key:value</code> strings.</p>
|
|
502
|
+
*/
|
|
503
|
+
tags: Record<string, string> | undefined;
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
export interface TagResourceInput {
|
|
509
|
+
/**
|
|
510
|
+
* @public
|
|
511
|
+
* <p>The ARN of the resource to be tagged.</p>
|
|
512
|
+
*/
|
|
513
|
+
resourceArn: string | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
* <p>Tags to be applied to the resource.</p>
|
|
517
|
+
*/
|
|
518
|
+
tags: Record<string, string> | undefined;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
export interface TagResourceOutput {
|
|
524
|
+
}
|
|
525
|
+
/**
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
export interface UntagResourceInput {
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* <p>The ARN of the resource.</p>
|
|
532
|
+
*/
|
|
533
|
+
resourceArn: string | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
* <p>Tag keys to be removed from the resource.</p>
|
|
537
|
+
*/
|
|
538
|
+
tagKeys: string[] | undefined;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
export interface UntagResourceOutput {
|
|
544
|
+
}
|
|
@@ -5,6 +5,9 @@ import { EnableControlCommandInput, EnableControlCommandOutput } from "../comman
|
|
|
5
5
|
import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "../commands/GetControlOperationCommand";
|
|
6
6
|
import { GetEnabledControlCommandInput, GetEnabledControlCommandOutput } from "../commands/GetEnabledControlCommand";
|
|
7
7
|
import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "../commands/ListEnabledControlsCommand";
|
|
8
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
9
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
10
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
8
11
|
/**
|
|
9
12
|
* serializeAws_restJson1DisableControlCommand
|
|
10
13
|
*/
|
|
@@ -25,6 +28,18 @@ export declare const se_GetEnabledControlCommand: (input: GetEnabledControlComma
|
|
|
25
28
|
* serializeAws_restJson1ListEnabledControlsCommand
|
|
26
29
|
*/
|
|
27
30
|
export declare const se_ListEnabledControlsCommand: (input: ListEnabledControlsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
31
|
+
/**
|
|
32
|
+
* serializeAws_restJson1ListTagsForResourceCommand
|
|
33
|
+
*/
|
|
34
|
+
export declare const se_ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
35
|
+
/**
|
|
36
|
+
* serializeAws_restJson1TagResourceCommand
|
|
37
|
+
*/
|
|
38
|
+
export declare const se_TagResourceCommand: (input: TagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
39
|
+
/**
|
|
40
|
+
* serializeAws_restJson1UntagResourceCommand
|
|
41
|
+
*/
|
|
42
|
+
export declare const se_UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
28
43
|
/**
|
|
29
44
|
* deserializeAws_restJson1DisableControlCommand
|
|
30
45
|
*/
|
|
@@ -45,3 +60,15 @@ export declare const de_GetEnabledControlCommand: (output: __HttpResponse, conte
|
|
|
45
60
|
* deserializeAws_restJson1ListEnabledControlsCommand
|
|
46
61
|
*/
|
|
47
62
|
export declare const de_ListEnabledControlsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListEnabledControlsCommandOutput>;
|
|
63
|
+
/**
|
|
64
|
+
* deserializeAws_restJson1ListTagsForResourceCommand
|
|
65
|
+
*/
|
|
66
|
+
export declare const de_ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
|
|
67
|
+
/**
|
|
68
|
+
* deserializeAws_restJson1TagResourceCommand
|
|
69
|
+
*/
|
|
70
|
+
export declare const de_TagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TagResourceCommandOutput>;
|
|
71
|
+
/**
|
|
72
|
+
* deserializeAws_restJson1UntagResourceCommand
|
|
73
|
+
*/
|
|
74
|
+
export declare const de_UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|