@aws-sdk/client-controltower 3.511.0 → 3.514.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 +81 -9
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/DisableBaselineCommand.js +1 -0
- package/dist-cjs/commands/EnableBaselineCommand.js +1 -0
- package/dist-cjs/commands/GetBaselineCommand.js +1 -0
- package/dist-cjs/commands/GetBaselineOperationCommand.js +1 -0
- package/dist-cjs/commands/GetEnabledBaselineCommand.js +1 -0
- package/dist-cjs/commands/ListBaselinesCommand.js +1 -0
- package/dist-cjs/commands/ListEnabledBaselinesCommand.js +1 -0
- package/dist-cjs/commands/ResetEnabledBaselineCommand.js +1 -0
- package/dist-cjs/commands/UpdateEnabledBaselineCommand.js +1 -0
- package/dist-cjs/index.js +638 -49
- package/dist-cjs/pagination/ListBaselinesPaginator.js +1 -0
- package/dist-cjs/pagination/ListEnabledBaselinesPaginator.js +1 -0
- package/dist-cjs/runtimeConfig.shared.js +10 -0
- package/dist-es/ControlTower.js +18 -0
- package/dist-es/ControlTowerClient.js +17 -4
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/DisableBaselineCommand.js +24 -0
- package/dist-es/commands/EnableBaselineCommand.js +24 -0
- package/dist-es/commands/GetBaselineCommand.js +24 -0
- package/dist-es/commands/GetBaselineOperationCommand.js +24 -0
- package/dist-es/commands/GetEnabledBaselineCommand.js +24 -0
- package/dist-es/commands/ListBaselinesCommand.js +24 -0
- package/dist-es/commands/ListEnabledBaselinesCommand.js +24 -0
- package/dist-es/commands/ResetEnabledBaselineCommand.js +24 -0
- package/dist-es/commands/UpdateEnabledBaselineCommand.js +24 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +40 -29
- package/dist-es/pagination/ListBaselinesPaginator.js +4 -0
- package/dist-es/pagination/ListEnabledBaselinesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +310 -0
- package/dist-es/runtimeConfig.shared.js +10 -0
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/ControlTower.d.ts +65 -2
- package/dist-types/ControlTowerClient.d.ts +26 -15
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateLandingZoneCommand.d.ts +1 -1
- package/dist-types/commands/DeleteLandingZoneCommand.d.ts +1 -1
- package/dist-types/commands/DisableBaselineCommand.d.ts +79 -0
- package/dist-types/commands/DisableControlCommand.d.ts +2 -2
- package/dist-types/commands/EnableBaselineCommand.d.ts +91 -0
- package/dist-types/commands/EnableControlCommand.d.ts +1 -1
- package/dist-types/commands/GetBaselineCommand.d.ts +75 -0
- package/dist-types/commands/GetBaselineOperationCommand.d.ts +80 -0
- package/dist-types/commands/GetControlOperationCommand.d.ts +1 -1
- package/dist-types/commands/GetEnabledBaselineCommand.d.ts +88 -0
- package/dist-types/commands/GetEnabledControlCommand.d.ts +1 -1
- package/dist-types/commands/GetLandingZoneCommand.d.ts +1 -1
- package/dist-types/commands/GetLandingZoneOperationCommand.d.ts +1 -1
- package/dist-types/commands/ListBaselinesCommand.d.ts +78 -0
- package/dist-types/commands/ListEnabledBaselinesCommand.d.ts +91 -0
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +1 -1
- package/dist-types/commands/ListLandingZonesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetEnabledBaselineCommand.d.ts +79 -0
- package/dist-types/commands/ResetLandingZoneCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnabledBaselineCommand.d.ts +86 -0
- package/dist-types/commands/UpdateEnabledControlCommand.d.ts +1 -1
- package/dist-types/commands/UpdateLandingZoneCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +541 -94
- package/dist-types/pagination/ListBaselinesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEnabledBaselinesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +81 -0
- package/dist-types/runtimeConfig.browser.d.ts +5 -3
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +6 -4
- package/dist-types/runtimeConfig.shared.d.ts +2 -0
- package/dist-types/ts3.4/ControlTower.d.ts +153 -0
- package/dist-types/ts3.4/ControlTowerClient.d.ts +65 -9
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/DisableBaselineCommand.d.ts +29 -0
- package/dist-types/ts3.4/commands/EnableBaselineCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/GetBaselineCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/GetBaselineOperationCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/GetEnabledBaselineCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/ListBaselinesCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/ListEnabledBaselinesCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/ResetEnabledBaselineCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/UpdateEnabledBaselineCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +151 -28
- package/dist-types/ts3.4/pagination/ListBaselinesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEnabledBaselinesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +108 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
- package/package.json +7 -7
|
@@ -15,43 +15,33 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* @public
|
|
18
|
-
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
19
18
|
*/
|
|
20
|
-
export
|
|
21
|
-
readonly name: "ConflictException";
|
|
22
|
-
readonly $fault: "client";
|
|
19
|
+
export interface GetBaselineInput {
|
|
23
20
|
/**
|
|
24
|
-
* @
|
|
21
|
+
* @public
|
|
22
|
+
* <p>The ARN of the <code>Baseline</code> resource to be retrieved.</p>
|
|
25
23
|
*/
|
|
26
|
-
|
|
24
|
+
baselineIdentifier: string | undefined;
|
|
27
25
|
}
|
|
28
26
|
/**
|
|
29
27
|
* @public
|
|
30
28
|
*/
|
|
31
|
-
export interface
|
|
29
|
+
export interface GetBaselineOutput {
|
|
32
30
|
/**
|
|
33
31
|
* @public
|
|
34
|
-
* <p>The ARN
|
|
35
|
-
* <b>Elective</b> controls are permitted, with the exception of the
|
|
36
|
-
* <b>landing zone 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>
|
|
32
|
+
* <p>The baseline ARN.</p>
|
|
37
33
|
*/
|
|
38
|
-
|
|
34
|
+
arn: string | undefined;
|
|
39
35
|
/**
|
|
40
36
|
* @public
|
|
41
|
-
* <p>
|
|
37
|
+
* <p>A user-friendly name for the baseline.</p>
|
|
42
38
|
*/
|
|
43
|
-
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
|
-
export interface DisableControlOutput {
|
|
39
|
+
name: string | undefined;
|
|
49
40
|
/**
|
|
50
41
|
* @public
|
|
51
|
-
* <p>
|
|
52
|
-
* available for 90 days.</p>
|
|
42
|
+
* <p>A description of the baseline.</p>
|
|
53
43
|
*/
|
|
54
|
-
|
|
44
|
+
description?: string;
|
|
55
45
|
}
|
|
56
46
|
/**
|
|
57
47
|
* @public
|
|
@@ -78,18 +68,6 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
78
68
|
*/
|
|
79
69
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
80
70
|
}
|
|
81
|
-
/**
|
|
82
|
-
* @public
|
|
83
|
-
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
|
|
84
|
-
*/
|
|
85
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
86
|
-
readonly name: "ServiceQuotaExceededException";
|
|
87
|
-
readonly $fault: "client";
|
|
88
|
-
/**
|
|
89
|
-
* @internal
|
|
90
|
-
*/
|
|
91
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
92
|
-
}
|
|
93
71
|
/**
|
|
94
72
|
* @public
|
|
95
73
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -102,8 +80,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
102
80
|
};
|
|
103
81
|
/**
|
|
104
82
|
* @public
|
|
105
|
-
* <p>The ID of the service that is associated with the error
|
|
106
|
-
* </p>
|
|
83
|
+
* <p>The ID of the service that is associated with the error.</p>
|
|
107
84
|
*/
|
|
108
85
|
serviceCode?: string;
|
|
109
86
|
/**
|
|
@@ -113,7 +90,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
113
90
|
quotaCode?: string;
|
|
114
91
|
/**
|
|
115
92
|
* @public
|
|
116
|
-
* <p>The number of seconds
|
|
93
|
+
* <p>The number of seconds the caller should wait before retrying.</p>
|
|
117
94
|
*/
|
|
118
95
|
retryAfterSeconds?: number;
|
|
119
96
|
/**
|
|
@@ -123,7 +100,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
123
100
|
}
|
|
124
101
|
/**
|
|
125
102
|
* @public
|
|
126
|
-
* <p>The input does not satisfy the constraints specified by an
|
|
103
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
127
104
|
*/
|
|
128
105
|
export declare class ValidationException extends __BaseException {
|
|
129
106
|
readonly name: "ValidationException";
|
|
@@ -135,18 +112,120 @@ export declare class ValidationException extends __BaseException {
|
|
|
135
112
|
}
|
|
136
113
|
/**
|
|
137
114
|
* @public
|
|
138
|
-
|
|
115
|
+
*/
|
|
116
|
+
export interface ListBaselinesInput {
|
|
117
|
+
/**
|
|
118
|
+
* @public
|
|
119
|
+
* <p>A pagination token.</p>
|
|
120
|
+
*/
|
|
121
|
+
nextToken?: string;
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
* <p>The maximum number of results to be shown.</p>
|
|
125
|
+
*/
|
|
126
|
+
maxResults?: number;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
* <p>Returns a summary of information about a <code>Baseline</code> object.</p>
|
|
131
|
+
*/
|
|
132
|
+
export interface BaselineSummary {
|
|
133
|
+
/**
|
|
134
|
+
* @public
|
|
135
|
+
* <p>The full ARN of a Baseline.</p>
|
|
136
|
+
*/
|
|
137
|
+
arn: string | undefined;
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>The human-readable name of a Baseline.</p>
|
|
141
|
+
*/
|
|
142
|
+
name: string | undefined;
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>A summary description of a Baseline.</p>
|
|
146
|
+
*/
|
|
147
|
+
description?: string;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
export interface ListBaselinesOutput {
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>A list of <code>Baseline</code> object details.</p>
|
|
156
|
+
*/
|
|
157
|
+
baselines: BaselineSummary[] | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* <p>A pagination token.</p>
|
|
161
|
+
*/
|
|
162
|
+
nextToken?: string;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
167
|
+
*/
|
|
168
|
+
export declare class ConflictException extends __BaseException {
|
|
169
|
+
readonly name: "ConflictException";
|
|
170
|
+
readonly $fault: "client";
|
|
171
|
+
/**
|
|
172
|
+
* @internal
|
|
173
|
+
*/
|
|
174
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export interface DisableControlInput {
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
183
|
+
* <b>Elective</b> controls are permitted, with the exception of the
|
|
184
|
+
* <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>
|
|
185
|
+
*/
|
|
186
|
+
controlIdentifier: string | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
* <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>
|
|
190
|
+
*/
|
|
191
|
+
targetIdentifier: string | undefined;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export interface DisableControlOutput {
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
* <p>The ID of the asynchronous operation, which is used to track status. The operation is
|
|
200
|
+
* available for 90 days.</p>
|
|
201
|
+
*/
|
|
202
|
+
operationIdentifier: string | undefined;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* @public
|
|
206
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
|
|
207
|
+
*/
|
|
208
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
209
|
+
readonly name: "ServiceQuotaExceededException";
|
|
210
|
+
readonly $fault: "client";
|
|
211
|
+
/**
|
|
212
|
+
* @internal
|
|
213
|
+
*/
|
|
214
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* <p>A key/value pair, where <code>Key</code> is of type <code>String</code> and <code>Value</code> is of type <code>Document</code>.</p>
|
|
139
219
|
*/
|
|
140
220
|
export interface EnabledControlParameter {
|
|
141
221
|
/**
|
|
142
222
|
* @public
|
|
143
|
-
* <p>The key of a key/value pair
|
|
223
|
+
* <p>The key of a key/value pair.</p>
|
|
144
224
|
*/
|
|
145
225
|
key: string | undefined;
|
|
146
226
|
/**
|
|
147
227
|
* @public
|
|
148
|
-
* <p>The value of a key/value pair
|
|
149
|
-
* <code>string</code>, <code>number</code>, <code>object</code>, or <code>boolean</code>. </p>
|
|
228
|
+
* <p>The value of a key/value pair.</p>
|
|
150
229
|
*/
|
|
151
230
|
value: __DocumentType | undefined;
|
|
152
231
|
}
|
|
@@ -158,7 +237,7 @@ export interface EnableControlInput {
|
|
|
158
237
|
* @public
|
|
159
238
|
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
160
239
|
* <b>Elective</b> controls are permitted, with the exception of the
|
|
161
|
-
* <b>
|
|
240
|
+
* <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>
|
|
162
241
|
*/
|
|
163
242
|
controlIdentifier: string | undefined;
|
|
164
243
|
/**
|
|
@@ -173,7 +252,7 @@ export interface EnableControlInput {
|
|
|
173
252
|
tags?: Record<string, string>;
|
|
174
253
|
/**
|
|
175
254
|
* @public
|
|
176
|
-
* <p>
|
|
255
|
+
* <p>A list of input parameter values, which are specified to configure the control when you enable it.</p>
|
|
177
256
|
*/
|
|
178
257
|
parameters?: EnabledControlParameter[];
|
|
179
258
|
}
|
|
@@ -193,6 +272,418 @@ export interface EnableControlOutput {
|
|
|
193
272
|
*/
|
|
194
273
|
arn?: string;
|
|
195
274
|
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export interface DisableBaselineInput {
|
|
279
|
+
/**
|
|
280
|
+
* @public
|
|
281
|
+
* <p>Identifier of the <code>EnabledBaseline</code> resource to be deactivated, in ARN format.</p>
|
|
282
|
+
*/
|
|
283
|
+
enabledBaselineIdentifier: string | undefined;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export interface DisableBaselineOutput {
|
|
289
|
+
/**
|
|
290
|
+
* @public
|
|
291
|
+
* <p>The ID (in UUID format) of the asynchronous <code>DisableBaseline</code> operation. This <code>operationIdentifier</code> is used to track status through calls to the <code>GetBaselineOperation</code> API.</p>
|
|
292
|
+
*/
|
|
293
|
+
operationIdentifier: string | undefined;
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* @public
|
|
297
|
+
* <p>A key-value parameter to an <code>EnabledBaseline</code> resource.</p>
|
|
298
|
+
*/
|
|
299
|
+
export interface EnabledBaselineParameter {
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
* <p>A string denoting the parameter key.</p>
|
|
303
|
+
*/
|
|
304
|
+
key: string | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
* <p>A low-level <code>Document</code> object of any type (for example, a Java Object).</p>
|
|
308
|
+
*/
|
|
309
|
+
value: __DocumentType | undefined;
|
|
310
|
+
}
|
|
311
|
+
/**
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
export interface EnableBaselineInput {
|
|
315
|
+
/**
|
|
316
|
+
* @public
|
|
317
|
+
* <p>The specific version to be enabled of the specified baseline.</p>
|
|
318
|
+
*/
|
|
319
|
+
baselineVersion: string | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* @public
|
|
322
|
+
* <p>A list of <code>key-value</code> objects that specify enablement parameters, where <code>key</code> is a string and <code>value</code> is a document of any type.</p>
|
|
323
|
+
*/
|
|
324
|
+
parameters?: EnabledBaselineParameter[];
|
|
325
|
+
/**
|
|
326
|
+
* @public
|
|
327
|
+
* <p>The ARN of the baseline to be enabled.</p>
|
|
328
|
+
*/
|
|
329
|
+
baselineIdentifier: string | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
* <p>The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.</p>
|
|
333
|
+
*/
|
|
334
|
+
targetIdentifier: string | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* @public
|
|
337
|
+
* <p>Tags associated with input to <code>EnableBaseline</code>.</p>
|
|
338
|
+
*/
|
|
339
|
+
tags?: Record<string, string>;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export interface EnableBaselineOutput {
|
|
345
|
+
/**
|
|
346
|
+
* @public
|
|
347
|
+
* <p>The ID (in UUID format) of the asynchronous <code>EnableBaseline</code> operation. This <code>operationIdentifier</code> is used to track status through calls to the <code>GetBaselineOperation</code> API.</p>
|
|
348
|
+
*/
|
|
349
|
+
operationIdentifier: string | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* @public
|
|
352
|
+
* <p>The ARN of the <code>EnabledBaseline</code> resource.</p>
|
|
353
|
+
*/
|
|
354
|
+
arn: string | undefined;
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export interface GetBaselineOperationInput {
|
|
360
|
+
/**
|
|
361
|
+
* @public
|
|
362
|
+
* <p>The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).</p>
|
|
363
|
+
*/
|
|
364
|
+
operationIdentifier: string | undefined;
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* @public
|
|
368
|
+
* @enum
|
|
369
|
+
*/
|
|
370
|
+
export declare const BaselineOperationType: {
|
|
371
|
+
readonly DISABLE_BASELINE: "DISABLE_BASELINE";
|
|
372
|
+
readonly ENABLE_BASELINE: "ENABLE_BASELINE";
|
|
373
|
+
readonly RESET_ENABLED_BASELINE: "RESET_ENABLED_BASELINE";
|
|
374
|
+
readonly UPDATE_ENABLED_BASELINE: "UPDATE_ENABLED_BASELINE";
|
|
375
|
+
};
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
export type BaselineOperationType = (typeof BaselineOperationType)[keyof typeof BaselineOperationType];
|
|
380
|
+
/**
|
|
381
|
+
* @public
|
|
382
|
+
* @enum
|
|
383
|
+
*/
|
|
384
|
+
export declare const BaselineOperationStatus: {
|
|
385
|
+
readonly FAILED: "FAILED";
|
|
386
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
387
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
388
|
+
};
|
|
389
|
+
/**
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
export type BaselineOperationStatus = (typeof BaselineOperationStatus)[keyof typeof BaselineOperationStatus];
|
|
393
|
+
/**
|
|
394
|
+
* @public
|
|
395
|
+
* <p>An object of shape <code>BaselineOperation</code>, returning details about the specified <code>Baseline</code> operation ID.</p>
|
|
396
|
+
*/
|
|
397
|
+
export interface BaselineOperation {
|
|
398
|
+
/**
|
|
399
|
+
* @public
|
|
400
|
+
* <p>The identifier of the specified operation.</p>
|
|
401
|
+
*/
|
|
402
|
+
operationIdentifier?: string;
|
|
403
|
+
/**
|
|
404
|
+
* @public
|
|
405
|
+
* <p>An enumerated type (<code>enum</code>) with possible values of <code>ENABLE_BASELINE</code>, <code>DISABLE_BASELINE</code>, <code>UPDATE_ENABLED_BASELINE</code>, or <code>RESET_ENABLED_BASELINE</code>.</p>
|
|
406
|
+
*/
|
|
407
|
+
operationType?: BaselineOperationType;
|
|
408
|
+
/**
|
|
409
|
+
* @public
|
|
410
|
+
* <p>An enumerated type (<code>enum</code>) with possible values of <code>SUCCEEDED</code>, <code>FAILED</code>, or <code>IN_PROGRESS</code>.</p>
|
|
411
|
+
*/
|
|
412
|
+
status?: BaselineOperationStatus;
|
|
413
|
+
/**
|
|
414
|
+
* @public
|
|
415
|
+
* <p>The start time of the operation, in ISO 8601 format.</p>
|
|
416
|
+
*/
|
|
417
|
+
startTime?: Date;
|
|
418
|
+
/**
|
|
419
|
+
* @public
|
|
420
|
+
* <p>The end time of the operation (if applicable), in ISO 8601 format.</p>
|
|
421
|
+
*/
|
|
422
|
+
endTime?: Date;
|
|
423
|
+
/**
|
|
424
|
+
* @public
|
|
425
|
+
* <p>A status message that gives more information about the operation's status, if applicable.</p>
|
|
426
|
+
*/
|
|
427
|
+
statusMessage?: string;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
export interface GetBaselineOperationOutput {
|
|
433
|
+
/**
|
|
434
|
+
* @public
|
|
435
|
+
* <p>A <code>baselineOperation</code> object that shows information about the specified operation ID.</p>
|
|
436
|
+
*/
|
|
437
|
+
baselineOperation: BaselineOperation | undefined;
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
export interface GetEnabledBaselineInput {
|
|
443
|
+
/**
|
|
444
|
+
* @public
|
|
445
|
+
* <p>Identifier of the <code>EnabledBaseline</code> resource to be retrieved, in ARN format.</p>
|
|
446
|
+
*/
|
|
447
|
+
enabledBaselineIdentifier: string | undefined;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* @public
|
|
451
|
+
* <p>Summary of an applied parameter to an <code>EnabledBaseline</code> resource. </p>
|
|
452
|
+
*/
|
|
453
|
+
export interface EnabledBaselineParameterSummary {
|
|
454
|
+
/**
|
|
455
|
+
* @public
|
|
456
|
+
* <p>A string denoting the parameter key.</p>
|
|
457
|
+
*/
|
|
458
|
+
key: string | undefined;
|
|
459
|
+
/**
|
|
460
|
+
* @public
|
|
461
|
+
* <p>A low-level document object of any type (for example, a Java Object).</p>
|
|
462
|
+
*/
|
|
463
|
+
value: __DocumentType | undefined;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* @public
|
|
467
|
+
* @enum
|
|
468
|
+
*/
|
|
469
|
+
export declare const EnablementStatus: {
|
|
470
|
+
readonly FAILED: "FAILED";
|
|
471
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
472
|
+
readonly UNDER_CHANGE: "UNDER_CHANGE";
|
|
473
|
+
};
|
|
474
|
+
/**
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
export type EnablementStatus = (typeof EnablementStatus)[keyof typeof EnablementStatus];
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
* <p>The deployment summary of the enabled control.</p>
|
|
481
|
+
*/
|
|
482
|
+
export interface EnablementStatusSummary {
|
|
483
|
+
/**
|
|
484
|
+
* @public
|
|
485
|
+
* <p> The deployment status of the enabled control.</p>
|
|
486
|
+
* <p>Valid values:</p>
|
|
487
|
+
* <ul>
|
|
488
|
+
* <li>
|
|
489
|
+
* <p>
|
|
490
|
+
* <code>SUCCEEDED</code>: The <code>enabledControl</code> configuration was deployed successfully.</p>
|
|
491
|
+
* </li>
|
|
492
|
+
* <li>
|
|
493
|
+
* <p>
|
|
494
|
+
* <code>UNDER_CHANGE</code>: The <code>enabledControl</code> configuration is changing. </p>
|
|
495
|
+
* </li>
|
|
496
|
+
* <li>
|
|
497
|
+
* <p>
|
|
498
|
+
* <code>FAILED</code>: The <code>enabledControl</code> configuration failed to deploy.</p>
|
|
499
|
+
* </li>
|
|
500
|
+
* </ul>
|
|
501
|
+
*/
|
|
502
|
+
status?: EnablementStatus;
|
|
503
|
+
/**
|
|
504
|
+
* @public
|
|
505
|
+
* <p>The last operation identifier for the enabled control.</p>
|
|
506
|
+
*/
|
|
507
|
+
lastOperationIdentifier?: string;
|
|
508
|
+
}
|
|
509
|
+
/**
|
|
510
|
+
* @public
|
|
511
|
+
* <p>Details of the <code>EnabledBaseline</code> resource.</p>
|
|
512
|
+
*/
|
|
513
|
+
export interface EnabledBaselineDetails {
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
* <p>The ARN of the <code>EnabledBaseline</code> resource.</p>
|
|
517
|
+
*/
|
|
518
|
+
arn: string | undefined;
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
* <p>The specific <code>Baseline</code> enabled as part of the <code>EnabledBaseline</code> resource.</p>
|
|
522
|
+
*/
|
|
523
|
+
baselineIdentifier: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* @public
|
|
526
|
+
* <p>The enabled version of the <code>Baseline</code>.</p>
|
|
527
|
+
*/
|
|
528
|
+
baselineVersion?: string;
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* <p>The target on which to enable the <code>Baseline</code>.</p>
|
|
532
|
+
*/
|
|
533
|
+
targetIdentifier: string | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
* <p>The deployment summary of the enabled control.</p>
|
|
537
|
+
*/
|
|
538
|
+
statusSummary: EnablementStatusSummary | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* @public
|
|
541
|
+
* <p>Shows the parameters that are applied when enabling this <code>Baseline</code>.</p>
|
|
542
|
+
*/
|
|
543
|
+
parameters?: EnabledBaselineParameterSummary[];
|
|
544
|
+
}
|
|
545
|
+
/**
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
export interface GetEnabledBaselineOutput {
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
* <p>Details of the <code>EnabledBaseline</code> resource.</p>
|
|
552
|
+
*/
|
|
553
|
+
enabledBaselineDetails?: EnabledBaselineDetails;
|
|
554
|
+
}
|
|
555
|
+
/**
|
|
556
|
+
* @public
|
|
557
|
+
* <p>A filter applied on the <code>ListEnabledBaseline</code> operation. Allowed filters are <code>baselineIdentifiers</code> and <code>targetIdentifiers</code>. The filter can be applied for either, or both.</p>
|
|
558
|
+
*/
|
|
559
|
+
export interface EnabledBaselineFilter {
|
|
560
|
+
/**
|
|
561
|
+
* @public
|
|
562
|
+
* <p>Identifiers for the targets of the <code>Baseline</code> filter operation.</p>
|
|
563
|
+
*/
|
|
564
|
+
targetIdentifiers?: string[];
|
|
565
|
+
/**
|
|
566
|
+
* @public
|
|
567
|
+
* <p>Identifiers for the <code>Baseline</code> objects returned as part of the filter operation.</p>
|
|
568
|
+
*/
|
|
569
|
+
baselineIdentifiers?: string[];
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
export interface ListEnabledBaselinesInput {
|
|
575
|
+
/**
|
|
576
|
+
* @public
|
|
577
|
+
* <p>A filter applied on the <code>ListEnabledBaseline</code> operation. Allowed filters are <code>baselineIdentifiers</code> and <code>targetIdentifiers</code>. The filter can be applied for either, or both.</p>
|
|
578
|
+
*/
|
|
579
|
+
filter?: EnabledBaselineFilter;
|
|
580
|
+
/**
|
|
581
|
+
* @public
|
|
582
|
+
* <p>A pagination token.</p>
|
|
583
|
+
*/
|
|
584
|
+
nextToken?: string;
|
|
585
|
+
/**
|
|
586
|
+
* @public
|
|
587
|
+
* <p>The maximum number of results to be shown.</p>
|
|
588
|
+
*/
|
|
589
|
+
maxResults?: number;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* @public
|
|
593
|
+
* <p>Returns a summary of information about an <code>EnabledBaseline</code> object.</p>
|
|
594
|
+
*/
|
|
595
|
+
export interface EnabledBaselineSummary {
|
|
596
|
+
/**
|
|
597
|
+
* @public
|
|
598
|
+
* <p>The ARN of the <code>EnabledBaseline</code> resource</p>
|
|
599
|
+
*/
|
|
600
|
+
arn: string | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* @public
|
|
603
|
+
* <p>The specific baseline that is enabled as part of the <code>EnabledBaseline</code> resource.</p>
|
|
604
|
+
*/
|
|
605
|
+
baselineIdentifier: string | undefined;
|
|
606
|
+
/**
|
|
607
|
+
* @public
|
|
608
|
+
* <p>The enabled version of the baseline.</p>
|
|
609
|
+
*/
|
|
610
|
+
baselineVersion?: string;
|
|
611
|
+
/**
|
|
612
|
+
* @public
|
|
613
|
+
* <p>The target upon which the baseline is enabled.</p>
|
|
614
|
+
*/
|
|
615
|
+
targetIdentifier: string | undefined;
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
* <p>The deployment summary of the enabled control.</p>
|
|
619
|
+
*/
|
|
620
|
+
statusSummary: EnablementStatusSummary | undefined;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
export interface ListEnabledBaselinesOutput {
|
|
626
|
+
/**
|
|
627
|
+
* @public
|
|
628
|
+
* <p>Retuens a list of summaries of <code>EnabledBaseline</code> resources.</p>
|
|
629
|
+
*/
|
|
630
|
+
enabledBaselines: EnabledBaselineSummary[] | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* @public
|
|
633
|
+
* <p>A pagination token.</p>
|
|
634
|
+
*/
|
|
635
|
+
nextToken?: string;
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
export interface ResetEnabledBaselineInput {
|
|
641
|
+
/**
|
|
642
|
+
* @public
|
|
643
|
+
* <p>Specifies the ID of the <code>EnabledBaseline</code> resource to be re-enabled, in ARN format.</p>
|
|
644
|
+
*/
|
|
645
|
+
enabledBaselineIdentifier: string | undefined;
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
export interface ResetEnabledBaselineOutput {
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
* <p>The ID (in UUID format) of the asynchronous <code>ResetEnabledBaseline</code> operation. This <code>operationIdentifier</code> is used to track status through calls to the <code>GetBaselineOperation</code> API.</p>
|
|
654
|
+
*/
|
|
655
|
+
operationIdentifier: string | undefined;
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
export interface UpdateEnabledBaselineInput {
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
* <p>Specifies the new <code>Baseline</code> version, to which the <code>EnabledBaseline</code> should be updated.</p>
|
|
664
|
+
*/
|
|
665
|
+
baselineVersion: string | undefined;
|
|
666
|
+
/**
|
|
667
|
+
* @public
|
|
668
|
+
* <p>Parameters to apply when making an update.</p>
|
|
669
|
+
*/
|
|
670
|
+
parameters?: EnabledBaselineParameter[];
|
|
671
|
+
/**
|
|
672
|
+
* @public
|
|
673
|
+
* <p>Specifies the <code>EnabledBaseline</code> resource to be updated.</p>
|
|
674
|
+
*/
|
|
675
|
+
enabledBaselineIdentifier: string | undefined;
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
export interface UpdateEnabledBaselineOutput {
|
|
681
|
+
/**
|
|
682
|
+
* @public
|
|
683
|
+
* <p>The ID (in UUID format) of the asynchronous <code>UpdateEnabledBaseline</code> operation. This <code>operationIdentifier</code> is used to track status through calls to the <code>GetBaselineOperation</code> API.</p>
|
|
684
|
+
*/
|
|
685
|
+
operationIdentifier: string | undefined;
|
|
686
|
+
}
|
|
196
687
|
/**
|
|
197
688
|
* @public
|
|
198
689
|
*/
|
|
@@ -351,51 +842,7 @@ export interface EnabledControlParameterSummary {
|
|
|
351
842
|
}
|
|
352
843
|
/**
|
|
353
844
|
* @public
|
|
354
|
-
*
|
|
355
|
-
*/
|
|
356
|
-
export declare const EnablementStatus: {
|
|
357
|
-
readonly FAILED: "FAILED";
|
|
358
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
359
|
-
readonly UNDER_CHANGE: "UNDER_CHANGE";
|
|
360
|
-
};
|
|
361
|
-
/**
|
|
362
|
-
* @public
|
|
363
|
-
*/
|
|
364
|
-
export type EnablementStatus = (typeof EnablementStatus)[keyof typeof EnablementStatus];
|
|
365
|
-
/**
|
|
366
|
-
* @public
|
|
367
|
-
* <p>The deployment summary of the enabled control.</p>
|
|
368
|
-
*/
|
|
369
|
-
export interface EnablementStatusSummary {
|
|
370
|
-
/**
|
|
371
|
-
* @public
|
|
372
|
-
* <p> The deployment status of the enabled control.</p>
|
|
373
|
-
* <p>Valid values:</p>
|
|
374
|
-
* <ul>
|
|
375
|
-
* <li>
|
|
376
|
-
* <p>
|
|
377
|
-
* <code>SUCCEEDED</code>: The <code>enabledControl</code> configuration was deployed successfully.</p>
|
|
378
|
-
* </li>
|
|
379
|
-
* <li>
|
|
380
|
-
* <p>
|
|
381
|
-
* <code>UNDER_CHANGE</code>: The <code>enabledControl</code> configuration is changing. </p>
|
|
382
|
-
* </li>
|
|
383
|
-
* <li>
|
|
384
|
-
* <p>
|
|
385
|
-
* <code>FAILED</code>: The <code>enabledControl</code> configuration failed to deploy.</p>
|
|
386
|
-
* </li>
|
|
387
|
-
* </ul>
|
|
388
|
-
*/
|
|
389
|
-
status?: EnablementStatus;
|
|
390
|
-
/**
|
|
391
|
-
* @public
|
|
392
|
-
* <p>The last operation identifier for the enabled control.</p>
|
|
393
|
-
*/
|
|
394
|
-
lastOperationIdentifier?: string;
|
|
395
|
-
}
|
|
396
|
-
/**
|
|
397
|
-
* @public
|
|
398
|
-
* <p>An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed. </p>
|
|
845
|
+
* <p>An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed. </p>
|
|
399
846
|
* <p>The expected Regions are based on the Regions that are governed by the landing zone. In
|
|
400
847
|
* certain cases, a control is not actually enabled in the Region as expected, such as during
|
|
401
848
|
* drift, or <a href="https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance">mixed governance</a>.</p>
|
|
@@ -469,8 +916,8 @@ export interface CreateLandingZoneInput {
|
|
|
469
916
|
version: string | undefined;
|
|
470
917
|
/**
|
|
471
918
|
* @public
|
|
472
|
-
* <p>The manifest
|
|
473
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/
|
|
919
|
+
* <p>The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
|
|
920
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>. </p>
|
|
474
921
|
*/
|
|
475
922
|
manifest: __DocumentType | undefined;
|
|
476
923
|
/**
|
|
@@ -589,7 +1036,7 @@ export interface LandingZoneDetail {
|
|
|
589
1036
|
version: string | undefined;
|
|
590
1037
|
/**
|
|
591
1038
|
* @public
|
|
592
|
-
* <p>The landing zone manifest
|
|
1039
|
+
* <p>The landing zone <code>manifest.yaml</code> text file that specifies the landing zone configurations. </p>
|
|
593
1040
|
*/
|
|
594
1041
|
manifest: __DocumentType | undefined;
|
|
595
1042
|
/**
|
|
@@ -599,7 +1046,7 @@ export interface LandingZoneDetail {
|
|
|
599
1046
|
arn?: string;
|
|
600
1047
|
/**
|
|
601
1048
|
* @public
|
|
602
|
-
* <p>The landing zone deployment status
|
|
1049
|
+
* <p>The landing zone deployment status. One of <code>ACTIVE</code>, <code>PROCESSING</code>, <code>FAILED</code>.</p>
|
|
603
1050
|
*/
|
|
604
1051
|
status?: LandingZoneStatus;
|
|
605
1052
|
/**
|
|
@@ -807,8 +1254,8 @@ export interface UpdateLandingZoneInput {
|
|
|
807
1254
|
version: string | undefined;
|
|
808
1255
|
/**
|
|
809
1256
|
* @public
|
|
810
|
-
* <p>The manifest
|
|
811
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/
|
|
1257
|
+
* <p>The <code>manifest.yaml</code> file is a text file that describes your Amazon Web Services resources. For examples, review
|
|
1258
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>.</p>
|
|
812
1259
|
*/
|
|
813
1260
|
manifest: __DocumentType | undefined;
|
|
814
1261
|
/**
|