@aws-sdk/client-controltower 3.458.0 → 3.460.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 +11 -3
- package/dist-cjs/ControlTower.js +2 -0
- package/dist-cjs/commands/UpdateEnabledControlCommand.js +51 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +121 -2
- package/dist-es/ControlTower.js +2 -0
- package/dist-es/commands/UpdateEnabledControlCommand.js +47 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +118 -1
- package/dist-types/ControlTower.d.ts +10 -3
- package/dist-types/ControlTowerClient.d.ts +6 -5
- package/dist-types/commands/CreateLandingZoneCommand.d.ts +6 -6
- package/dist-types/commands/DeleteLandingZoneCommand.d.ts +7 -7
- package/dist-types/commands/DisableControlCommand.d.ts +6 -6
- package/dist-types/commands/EnableControlCommand.d.ts +12 -6
- package/dist-types/commands/GetControlOperationCommand.d.ts +4 -4
- package/dist-types/commands/GetEnabledControlCommand.d.ts +10 -4
- package/dist-types/commands/GetLandingZoneCommand.d.ts +5 -5
- package/dist-types/commands/GetLandingZoneOperationCommand.d.ts +5 -5
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +4 -4
- package/dist-types/commands/ListLandingZonesCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/ResetLandingZoneCommand.d.ts +6 -6
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateEnabledControlCommand.d.ts +107 -0
- package/dist-types/commands/UpdateLandingZoneCommand.d.ts +7 -7
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +129 -74
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/ControlTower.d.ts +17 -0
- package/dist-types/ts3.4/ControlTowerClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/UpdateEnabledControlCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +12 -12
|
@@ -15,7 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* @public
|
|
18
|
-
* <p>Updating or deleting
|
|
18
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
19
19
|
*/
|
|
20
20
|
export declare class ConflictException extends __BaseException {
|
|
21
21
|
readonly name: "ConflictException";
|
|
@@ -33,7 +33,7 @@ export interface DisableControlInput {
|
|
|
33
33
|
* @public
|
|
34
34
|
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
35
35
|
* <b>Elective</b> controls are permitted, with the exception of the
|
|
36
|
-
* <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
|
+
* <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>
|
|
37
37
|
*/
|
|
38
38
|
controlIdentifier: string | undefined;
|
|
39
39
|
/**
|
|
@@ -55,7 +55,7 @@ export interface DisableControlOutput {
|
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
57
|
* @public
|
|
58
|
-
* <p>
|
|
58
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
59
59
|
*/
|
|
60
60
|
export declare class InternalServerException extends __BaseException {
|
|
61
61
|
readonly name: "InternalServerException";
|
|
@@ -68,7 +68,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
70
|
* @public
|
|
71
|
-
* <p>
|
|
71
|
+
* <p>The request references a resource that does not exist.</p>
|
|
72
72
|
*/
|
|
73
73
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
74
74
|
readonly name: "ResourceNotFoundException";
|
|
@@ -80,7 +80,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
82
|
* @public
|
|
83
|
-
* <p>
|
|
83
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
|
|
84
84
|
*/
|
|
85
85
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
86
86
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -92,7 +92,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
94
|
* @public
|
|
95
|
-
* <p>
|
|
95
|
+
* <p>The request was denied due to request throttling.</p>
|
|
96
96
|
*/
|
|
97
97
|
export declare class ThrottlingException extends __BaseException {
|
|
98
98
|
readonly name: "ThrottlingException";
|
|
@@ -102,7 +102,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
102
102
|
};
|
|
103
103
|
/**
|
|
104
104
|
* @public
|
|
105
|
-
* <p>The ID of the service that is associated with the error
|
|
105
|
+
* <p>The ID of the service that is associated with the error.
|
|
106
|
+
* </p>
|
|
106
107
|
*/
|
|
107
108
|
serviceCode?: string;
|
|
108
109
|
/**
|
|
@@ -112,7 +113,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
112
113
|
quotaCode?: string;
|
|
113
114
|
/**
|
|
114
115
|
* @public
|
|
115
|
-
* <p>The number of seconds
|
|
116
|
+
* <p>The number of seconds to wait before retrying.</p>
|
|
116
117
|
*/
|
|
117
118
|
retryAfterSeconds?: number;
|
|
118
119
|
/**
|
|
@@ -122,7 +123,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
122
123
|
}
|
|
123
124
|
/**
|
|
124
125
|
* @public
|
|
125
|
-
* <p>The input
|
|
126
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
126
127
|
*/
|
|
127
128
|
export declare class ValidationException extends __BaseException {
|
|
128
129
|
readonly name: "ValidationException";
|
|
@@ -132,6 +133,23 @@ export declare class ValidationException extends __BaseException {
|
|
|
132
133
|
*/
|
|
133
134
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
134
135
|
}
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
* <p> A set of parameters that configure the behavior of the enabled control. 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
|
+
*/
|
|
140
|
+
export interface EnabledControlParameter {
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
* <p>The key of a key/value pair. It is of type <code>string</code>.</p>
|
|
144
|
+
*/
|
|
145
|
+
key: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* @public
|
|
148
|
+
* <p>The value of a key/value pair. It can be of type <code>array</code>
|
|
149
|
+
* <code>string</code>, <code>number</code>, <code>object</code>, or <code>boolean</code>. </p>
|
|
150
|
+
*/
|
|
151
|
+
value: __DocumentType | undefined;
|
|
152
|
+
}
|
|
135
153
|
/**
|
|
136
154
|
* @public
|
|
137
155
|
*/
|
|
@@ -140,7 +158,7 @@ export interface EnableControlInput {
|
|
|
140
158
|
* @public
|
|
141
159
|
* <p>The ARN of the control. Only <b>Strongly recommended</b> and
|
|
142
160
|
* <b>Elective</b> controls are permitted, with the exception of the
|
|
143
|
-
* <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>
|
|
161
|
+
* <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>
|
|
144
162
|
*/
|
|
145
163
|
controlIdentifier: string | undefined;
|
|
146
164
|
/**
|
|
@@ -153,6 +171,11 @@ export interface EnableControlInput {
|
|
|
153
171
|
* <p>Tags to be applied to the <code>EnabledControl</code> resource.</p>
|
|
154
172
|
*/
|
|
155
173
|
tags?: Record<string, string>;
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
* <p>An array of <code>EnabledControlParameter</code> objects</p>
|
|
177
|
+
*/
|
|
178
|
+
parameters?: EnabledControlParameter[];
|
|
156
179
|
}
|
|
157
180
|
/**
|
|
158
181
|
* @public
|
|
@@ -188,6 +211,7 @@ export interface GetControlOperationInput {
|
|
|
188
211
|
export declare const ControlOperationType: {
|
|
189
212
|
readonly DISABLE_CONTROL: "DISABLE_CONTROL";
|
|
190
213
|
readonly ENABLE_CONTROL: "ENABLE_CONTROL";
|
|
214
|
+
readonly UPDATE_ENABLED_CONTROL: "UPDATE_ENABLED_CONTROL";
|
|
191
215
|
};
|
|
192
216
|
/**
|
|
193
217
|
* @public
|
|
@@ -274,7 +298,7 @@ export declare const DriftStatus: {
|
|
|
274
298
|
export type DriftStatus = (typeof DriftStatus)[keyof typeof DriftStatus];
|
|
275
299
|
/**
|
|
276
300
|
* @public
|
|
277
|
-
* <p>
|
|
301
|
+
* <p>The drift summary of the enabled control.</p>
|
|
278
302
|
* <p>Amazon Web Services Control Tower expects the enabled control
|
|
279
303
|
* configuration to include all supported and governed Regions. If the enabled control differs
|
|
280
304
|
* 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>
|
|
@@ -288,27 +312,43 @@ export interface DriftStatusSummary {
|
|
|
288
312
|
* <li>
|
|
289
313
|
* <p>
|
|
290
314
|
* <code>DRIFTED</code>: The <code>enabledControl</code> deployed in this configuration
|
|
291
|
-
*
|
|
315
|
+
* doesn’t match the configuration that Amazon Web Services Control Tower expected. </p>
|
|
292
316
|
* </li>
|
|
293
317
|
* <li>
|
|
294
318
|
* <p>
|
|
295
319
|
* <code>IN_SYNC</code>: The <code>enabledControl</code> deployed in this configuration matches
|
|
296
|
-
*
|
|
320
|
+
* the configuration that Amazon Web Services Control Tower expected.</p>
|
|
297
321
|
* </li>
|
|
298
322
|
* <li>
|
|
299
323
|
* <p>
|
|
300
324
|
* <code>NOT_CHECKING</code>: Amazon Web Services Control Tower does not check drift for this enabled
|
|
301
|
-
*
|
|
325
|
+
* control. Drift is not supported for the control type.</p>
|
|
302
326
|
* </li>
|
|
303
327
|
* <li>
|
|
304
328
|
* <p>
|
|
305
329
|
* <code>UNKNOWN</code>: Amazon Web Services Control Tower is not able to check the drift status for the
|
|
306
|
-
*
|
|
330
|
+
* enabled control. </p>
|
|
307
331
|
* </li>
|
|
308
332
|
* </ul>
|
|
309
333
|
*/
|
|
310
334
|
driftStatus?: DriftStatus;
|
|
311
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* <p>Returns a summary of information about the parameters of an enabled control.</p>
|
|
339
|
+
*/
|
|
340
|
+
export interface EnabledControlParameterSummary {
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
* <p>The key of a key/value pair.</p>
|
|
344
|
+
*/
|
|
345
|
+
key: string | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
* <p>The value of a key/value pair.</p>
|
|
349
|
+
*/
|
|
350
|
+
value: __DocumentType | undefined;
|
|
351
|
+
}
|
|
312
352
|
/**
|
|
313
353
|
* @public
|
|
314
354
|
* @enum
|
|
@@ -355,10 +395,10 @@ export interface EnablementStatusSummary {
|
|
|
355
395
|
}
|
|
356
396
|
/**
|
|
357
397
|
* @public
|
|
358
|
-
* <p>An
|
|
398
|
+
* <p>An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed. </p>
|
|
359
399
|
* <p>The expected Regions are based on the Regions that are governed by the landing zone. In
|
|
360
|
-
*
|
|
361
|
-
*
|
|
400
|
+
* certain cases, a control is not actually enabled in the Region as expected, such as during
|
|
401
|
+
* drift, or <a href="https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance">mixed governance</a>.</p>
|
|
362
402
|
*/
|
|
363
403
|
export interface Region {
|
|
364
404
|
/**
|
|
@@ -402,6 +442,11 @@ export interface EnabledControlDetails {
|
|
|
402
442
|
* <p>The drift status of the enabled control.</p>
|
|
403
443
|
*/
|
|
404
444
|
driftStatusSummary?: DriftStatusSummary;
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
* <p>Array of <code>EnabledControlParameter</code> objects.</p>
|
|
448
|
+
*/
|
|
449
|
+
parameters?: EnabledControlParameterSummary[];
|
|
405
450
|
}
|
|
406
451
|
/**
|
|
407
452
|
* @public
|
|
@@ -419,7 +464,7 @@ export interface GetEnabledControlOutput {
|
|
|
419
464
|
export interface CreateLandingZoneInput {
|
|
420
465
|
/**
|
|
421
466
|
* @public
|
|
422
|
-
* <p>The landing zone version.
|
|
467
|
+
* <p>The landing zone version, for example, 3.0.</p>
|
|
423
468
|
*/
|
|
424
469
|
version: string | undefined;
|
|
425
470
|
/**
|
|
@@ -440,13 +485,13 @@ export interface CreateLandingZoneInput {
|
|
|
440
485
|
export interface CreateLandingZoneOutput {
|
|
441
486
|
/**
|
|
442
487
|
* @public
|
|
443
|
-
* <p>The ARN of the landing zone
|
|
488
|
+
* <p>The ARN of the landing zone resource.</p>
|
|
444
489
|
*/
|
|
445
490
|
arn: string | undefined;
|
|
446
491
|
/**
|
|
447
492
|
* @public
|
|
448
493
|
* <p>A unique identifier assigned to a <code>CreateLandingZone</code> operation. You can use this
|
|
449
|
-
*
|
|
494
|
+
* identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
|
|
450
495
|
*/
|
|
451
496
|
operationIdentifier: string | undefined;
|
|
452
497
|
}
|
|
@@ -456,7 +501,7 @@ export interface CreateLandingZoneOutput {
|
|
|
456
501
|
export interface DeleteLandingZoneInput {
|
|
457
502
|
/**
|
|
458
503
|
* @public
|
|
459
|
-
* <p>The unique identifier of the landing zone
|
|
504
|
+
* <p>The unique identifier of the landing zone.</p>
|
|
460
505
|
*/
|
|
461
506
|
landingZoneIdentifier: string | undefined;
|
|
462
507
|
}
|
|
@@ -466,8 +511,8 @@ export interface DeleteLandingZoneInput {
|
|
|
466
511
|
export interface DeleteLandingZoneOutput {
|
|
467
512
|
/**
|
|
468
513
|
* @public
|
|
469
|
-
* <p
|
|
470
|
-
* identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status
|
|
514
|
+
* <p>>A unique identifier assigned to a <code>DeleteLandingZone</code> operation. You can use this
|
|
515
|
+
* identifier as an input parameter of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
|
|
471
516
|
*/
|
|
472
517
|
operationIdentifier: string | undefined;
|
|
473
518
|
}
|
|
@@ -477,7 +522,7 @@ export interface DeleteLandingZoneOutput {
|
|
|
477
522
|
export interface GetLandingZoneInput {
|
|
478
523
|
/**
|
|
479
524
|
* @public
|
|
480
|
-
* <p>The unique identifier of the landing zone
|
|
525
|
+
* <p>The unique identifier of the landing zone.</p>
|
|
481
526
|
*/
|
|
482
527
|
landingZoneIdentifier: string | undefined;
|
|
483
528
|
}
|
|
@@ -497,7 +542,7 @@ export type LandingZoneDriftStatus = (typeof LandingZoneDriftStatus)[keyof typeo
|
|
|
497
542
|
* @public
|
|
498
543
|
* <p>The drift status summary of the landing zone. </p>
|
|
499
544
|
* <p>If the landing zone differs from the expected configuration, it is defined to be in a state of
|
|
500
|
-
*
|
|
545
|
+
* drift. You can repair this drift by resetting the landing zone.</p>
|
|
501
546
|
*/
|
|
502
547
|
export interface LandingZoneDriftStatusSummary {
|
|
503
548
|
/**
|
|
@@ -534,52 +579,37 @@ export declare const LandingZoneStatus: {
|
|
|
534
579
|
export type LandingZoneStatus = (typeof LandingZoneStatus)[keyof typeof LandingZoneStatus];
|
|
535
580
|
/**
|
|
536
581
|
* @public
|
|
537
|
-
* <p>Information about the landing zone
|
|
582
|
+
* <p>Information about the landing zone.</p>
|
|
538
583
|
*/
|
|
539
584
|
export interface LandingZoneDetail {
|
|
540
585
|
/**
|
|
541
586
|
* @public
|
|
542
|
-
* <p>The landing zone's current deployed version
|
|
587
|
+
* <p>The landing zone's current deployed version.</p>
|
|
543
588
|
*/
|
|
544
589
|
version: string | undefined;
|
|
545
590
|
/**
|
|
546
591
|
* @public
|
|
547
|
-
* <p>The landing zone manifest.yaml text file that specifies the landing zone configurations. </p>
|
|
592
|
+
* <p>The landing zone <code>manifest.yaml</code> text file that specifies the landing zone configurations. </p>
|
|
548
593
|
*/
|
|
549
594
|
manifest: __DocumentType | undefined;
|
|
550
595
|
/**
|
|
551
596
|
* @public
|
|
552
|
-
* <p>The ARN of the landing zone
|
|
597
|
+
* <p>The ARN of the landing zone.</p>
|
|
553
598
|
*/
|
|
554
599
|
arn?: string;
|
|
555
600
|
/**
|
|
556
601
|
* @public
|
|
557
|
-
* <p>The landing zone deployment status
|
|
558
|
-
* <p>Valid values:</p>
|
|
559
|
-
* <ul>
|
|
560
|
-
* <li>
|
|
561
|
-
* <p>
|
|
562
|
-
* <code>ACTIVE</code>: The landing zone is actively deployed. </p>
|
|
563
|
-
* </li>
|
|
564
|
-
* <li>
|
|
565
|
-
* <p>
|
|
566
|
-
* <code>PROCESSING</code>: The landing zone is processing deployment. </p>
|
|
567
|
-
* </li>
|
|
568
|
-
* <li>
|
|
569
|
-
* <p>
|
|
570
|
-
* <code>FAILED</code>: The landing zone failed deployment. </p>
|
|
571
|
-
* </li>
|
|
572
|
-
* </ul>
|
|
602
|
+
* <p>The landing zone deployment status.</p>
|
|
573
603
|
*/
|
|
574
604
|
status?: LandingZoneStatus;
|
|
575
605
|
/**
|
|
576
606
|
* @public
|
|
577
|
-
* <p>The latest available version of the landing zone
|
|
607
|
+
* <p>The latest available version of the landing zone.</p>
|
|
578
608
|
*/
|
|
579
609
|
latestAvailableVersion?: string;
|
|
580
610
|
/**
|
|
581
611
|
* @public
|
|
582
|
-
* <p>The drift status of the landing zone
|
|
612
|
+
* <p>The drift status of the landing zone.</p>
|
|
583
613
|
*/
|
|
584
614
|
driftStatus?: LandingZoneDriftStatusSummary;
|
|
585
615
|
}
|
|
@@ -589,7 +619,7 @@ export interface LandingZoneDetail {
|
|
|
589
619
|
export interface GetLandingZoneOutput {
|
|
590
620
|
/**
|
|
591
621
|
* @public
|
|
592
|
-
* <p>Information about the landing zone
|
|
622
|
+
* <p>Information about the landing zone.</p>
|
|
593
623
|
*/
|
|
594
624
|
landingZone: LandingZoneDetail | undefined;
|
|
595
625
|
}
|
|
@@ -599,7 +629,7 @@ export interface GetLandingZoneOutput {
|
|
|
599
629
|
export interface GetLandingZoneOperationInput {
|
|
600
630
|
/**
|
|
601
631
|
* @public
|
|
602
|
-
* <p>A unique identifier assigned to a landing zone operation
|
|
632
|
+
* <p>A unique identifier assigned to a landing zone operation.</p>
|
|
603
633
|
*/
|
|
604
634
|
operationIdentifier: string | undefined;
|
|
605
635
|
}
|
|
@@ -632,7 +662,7 @@ export declare const LandingZoneOperationStatus: {
|
|
|
632
662
|
export type LandingZoneOperationStatus = (typeof LandingZoneOperationStatus)[keyof typeof LandingZoneOperationStatus];
|
|
633
663
|
/**
|
|
634
664
|
* @public
|
|
635
|
-
* <p>Information about a landing zone operation
|
|
665
|
+
* <p>Information about a landing zone operation.</p>
|
|
636
666
|
*/
|
|
637
667
|
export interface LandingZoneOperationDetail {
|
|
638
668
|
/**
|
|
@@ -661,18 +691,17 @@ export interface LandingZoneOperationDetail {
|
|
|
661
691
|
operationType?: LandingZoneOperationType;
|
|
662
692
|
/**
|
|
663
693
|
* @public
|
|
664
|
-
* <p>The landing zone operation start time
|
|
694
|
+
* <p>The landing zone operation start time.</p>
|
|
665
695
|
*/
|
|
666
696
|
startTime?: Date;
|
|
667
697
|
/**
|
|
668
698
|
* @public
|
|
669
|
-
* <p>The landing zone operation end time
|
|
699
|
+
* <p>The landing zone operation end time.</p>
|
|
670
700
|
*/
|
|
671
701
|
endTime?: Date;
|
|
672
702
|
/**
|
|
673
703
|
* @public
|
|
674
|
-
* <p>
|
|
675
|
-
* <p>Valid values:</p>
|
|
704
|
+
* <p>Valid values:</p>
|
|
676
705
|
* <ul>
|
|
677
706
|
* <li>
|
|
678
707
|
* <p>
|
|
@@ -691,7 +720,7 @@ export interface LandingZoneOperationDetail {
|
|
|
691
720
|
status?: LandingZoneOperationStatus;
|
|
692
721
|
/**
|
|
693
722
|
* @public
|
|
694
|
-
* <p>If the operation result is FAILED, this string contains a message explaining why the operation failed
|
|
723
|
+
* <p>If the operation result is FAILED, this string contains a message explaining why the operation failed.</p>
|
|
695
724
|
*/
|
|
696
725
|
statusMessage?: string;
|
|
697
726
|
}
|
|
@@ -701,7 +730,7 @@ export interface LandingZoneOperationDetail {
|
|
|
701
730
|
export interface GetLandingZoneOperationOutput {
|
|
702
731
|
/**
|
|
703
732
|
* @public
|
|
704
|
-
* <p>
|
|
733
|
+
* <p>Details about a landing zone operation.</p>
|
|
705
734
|
*/
|
|
706
735
|
operationDetails: LandingZoneOperationDetail | undefined;
|
|
707
736
|
}
|
|
@@ -711,23 +740,23 @@ export interface GetLandingZoneOperationOutput {
|
|
|
711
740
|
export interface ListLandingZonesInput {
|
|
712
741
|
/**
|
|
713
742
|
* @public
|
|
714
|
-
* <p>The token to continue the list from a previous API call with the same parameters
|
|
743
|
+
* <p>The token to continue the list from a previous API call with the same parameters.</p>
|
|
715
744
|
*/
|
|
716
745
|
nextToken?: string;
|
|
717
746
|
/**
|
|
718
747
|
* @public
|
|
719
|
-
* <p>The maximum number of returned landing zone ARNs
|
|
748
|
+
* <p>The maximum number of returned landing zone ARNs, which is one.</p>
|
|
720
749
|
*/
|
|
721
750
|
maxResults?: number;
|
|
722
751
|
}
|
|
723
752
|
/**
|
|
724
753
|
* @public
|
|
725
|
-
* <p>Returns a summary of information about a landing zone
|
|
754
|
+
* <p>Returns a summary of information about a landing zone.</p>
|
|
726
755
|
*/
|
|
727
756
|
export interface LandingZoneSummary {
|
|
728
757
|
/**
|
|
729
758
|
* @public
|
|
730
|
-
* <p>The ARN of the landing zone
|
|
759
|
+
* <p>The ARN of the landing zone.</p>
|
|
731
760
|
*/
|
|
732
761
|
arn?: string;
|
|
733
762
|
}
|
|
@@ -737,12 +766,12 @@ export interface LandingZoneSummary {
|
|
|
737
766
|
export interface ListLandingZonesOutput {
|
|
738
767
|
/**
|
|
739
768
|
* @public
|
|
740
|
-
* <p>The ARN of the landing zone
|
|
769
|
+
* <p>The ARN of the landing zone.</p>
|
|
741
770
|
*/
|
|
742
771
|
landingZones: LandingZoneSummary[] | undefined;
|
|
743
772
|
/**
|
|
744
773
|
* @public
|
|
745
|
-
* <p>Retrieves the next page of results. If the string is empty, the
|
|
774
|
+
* <p>Retrieves the next page of results. If the string is empty, the response is the end of the results.</p>
|
|
746
775
|
*/
|
|
747
776
|
nextToken?: string;
|
|
748
777
|
}
|
|
@@ -752,7 +781,7 @@ export interface ListLandingZonesOutput {
|
|
|
752
781
|
export interface ResetLandingZoneInput {
|
|
753
782
|
/**
|
|
754
783
|
* @public
|
|
755
|
-
* <p>The unique identifier of the landing zone
|
|
784
|
+
* <p>The unique identifier of the landing zone.</p>
|
|
756
785
|
*/
|
|
757
786
|
landingZoneIdentifier: string | undefined;
|
|
758
787
|
}
|
|
@@ -763,7 +792,7 @@ export interface ResetLandingZoneOutput {
|
|
|
763
792
|
/**
|
|
764
793
|
* @public
|
|
765
794
|
* <p>A unique identifier assigned to a <code>ResetLandingZone</code> operation. You can use this
|
|
766
|
-
* identifier as an input of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
|
|
795
|
+
* identifier as an input parameter of <code>GetLandingZoneOperation</code> to check the operation's status.</p>
|
|
767
796
|
*/
|
|
768
797
|
operationIdentifier: string | undefined;
|
|
769
798
|
}
|
|
@@ -773,19 +802,18 @@ export interface ResetLandingZoneOutput {
|
|
|
773
802
|
export interface UpdateLandingZoneInput {
|
|
774
803
|
/**
|
|
775
804
|
* @public
|
|
776
|
-
* <p>The landing zone version.
|
|
805
|
+
* <p>The landing zone version, for example, 3.2.</p>
|
|
777
806
|
*/
|
|
778
807
|
version: string | undefined;
|
|
779
808
|
/**
|
|
780
809
|
* @public
|
|
781
|
-
* <p>The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review
|
|
782
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>
|
|
783
|
-
* </p>
|
|
810
|
+
* <p>The <code>manifest.yaml</code> file is a text file that describes your Amazon Web Services resources. For examples, review
|
|
811
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>.</p>
|
|
784
812
|
*/
|
|
785
813
|
manifest: __DocumentType | undefined;
|
|
786
814
|
/**
|
|
787
815
|
* @public
|
|
788
|
-
* <p>The unique identifier of the landing zone
|
|
816
|
+
* <p>The unique identifier of the landing zone.</p>
|
|
789
817
|
*/
|
|
790
818
|
landingZoneIdentifier: string | undefined;
|
|
791
819
|
}
|
|
@@ -837,9 +865,7 @@ export interface EnabledControlSummary {
|
|
|
837
865
|
arn?: string;
|
|
838
866
|
/**
|
|
839
867
|
* @public
|
|
840
|
-
* <p>
|
|
841
|
-
* The ARN of the organizational unit.
|
|
842
|
-
* </p>
|
|
868
|
+
* <p>The ARN of the organizational unit.</p>
|
|
843
869
|
*/
|
|
844
870
|
targetIdentifier?: string;
|
|
845
871
|
/**
|
|
@@ -865,7 +891,7 @@ export interface ListEnabledControlsOutput {
|
|
|
865
891
|
enabledControls: EnabledControlSummary[] | undefined;
|
|
866
892
|
/**
|
|
867
893
|
* @public
|
|
868
|
-
* <p>Retrieves the next page of results. If the string is empty, the
|
|
894
|
+
* <p>Retrieves the next page of results. If the string is empty, the response is the
|
|
869
895
|
* end of the results.</p>
|
|
870
896
|
*/
|
|
871
897
|
nextToken?: string;
|
|
@@ -930,3 +956,32 @@ export interface UntagResourceInput {
|
|
|
930
956
|
*/
|
|
931
957
|
export interface UntagResourceOutput {
|
|
932
958
|
}
|
|
959
|
+
/**
|
|
960
|
+
* @public
|
|
961
|
+
*/
|
|
962
|
+
export interface UpdateEnabledControlInput {
|
|
963
|
+
/**
|
|
964
|
+
* @public
|
|
965
|
+
* <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>
|
|
966
|
+
*/
|
|
967
|
+
parameters: EnabledControlParameter[] | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* @public
|
|
970
|
+
* <p>
|
|
971
|
+
* The ARN of the enabled control that will be updated.
|
|
972
|
+
* </p>
|
|
973
|
+
*/
|
|
974
|
+
enabledControlIdentifier: string | undefined;
|
|
975
|
+
}
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export interface UpdateEnabledControlOutput {
|
|
980
|
+
/**
|
|
981
|
+
* @public
|
|
982
|
+
* <p>
|
|
983
|
+
* The operation identifier for this <code>UpdateEnabledControl</code> operation.
|
|
984
|
+
* </p>
|
|
985
|
+
*/
|
|
986
|
+
operationIdentifier: string | undefined;
|
|
987
|
+
}
|
|
@@ -14,6 +14,7 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } fro
|
|
|
14
14
|
import { ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput } from "../commands/ResetLandingZoneCommand";
|
|
15
15
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
16
16
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
17
|
+
import { UpdateEnabledControlCommandInput, UpdateEnabledControlCommandOutput } from "../commands/UpdateEnabledControlCommand";
|
|
17
18
|
import { UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput } from "../commands/UpdateLandingZoneCommand";
|
|
18
19
|
/**
|
|
19
20
|
* serializeAws_restJson1CreateLandingZoneCommand
|
|
@@ -71,6 +72,10 @@ export declare const se_TagResourceCommand: (input: TagResourceCommandInput, con
|
|
|
71
72
|
* serializeAws_restJson1UntagResourceCommand
|
|
72
73
|
*/
|
|
73
74
|
export declare const se_UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
75
|
+
/**
|
|
76
|
+
* serializeAws_restJson1UpdateEnabledControlCommand
|
|
77
|
+
*/
|
|
78
|
+
export declare const se_UpdateEnabledControlCommand: (input: UpdateEnabledControlCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
74
79
|
/**
|
|
75
80
|
* serializeAws_restJson1UpdateLandingZoneCommand
|
|
76
81
|
*/
|
|
@@ -131,6 +136,10 @@ export declare const de_TagResourceCommand: (output: __HttpResponse, context: __
|
|
|
131
136
|
* deserializeAws_restJson1UntagResourceCommand
|
|
132
137
|
*/
|
|
133
138
|
export declare const de_UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|
|
139
|
+
/**
|
|
140
|
+
* deserializeAws_restJson1UpdateEnabledControlCommand
|
|
141
|
+
*/
|
|
142
|
+
export declare const de_UpdateEnabledControlCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateEnabledControlCommandOutput>;
|
|
134
143
|
/**
|
|
135
144
|
* deserializeAws_restJson1UpdateLandingZoneCommand
|
|
136
145
|
*/
|
|
@@ -55,6 +55,10 @@ import {
|
|
|
55
55
|
UntagResourceCommandInput,
|
|
56
56
|
UntagResourceCommandOutput,
|
|
57
57
|
} from "./commands/UntagResourceCommand";
|
|
58
|
+
import {
|
|
59
|
+
UpdateEnabledControlCommandInput,
|
|
60
|
+
UpdateEnabledControlCommandOutput,
|
|
61
|
+
} from "./commands/UpdateEnabledControlCommand";
|
|
58
62
|
import {
|
|
59
63
|
UpdateLandingZoneCommandInput,
|
|
60
64
|
UpdateLandingZoneCommandOutput,
|
|
@@ -243,6 +247,19 @@ export interface ControlTower {
|
|
|
243
247
|
options: __HttpHandlerOptions,
|
|
244
248
|
cb: (err: any, data?: UntagResourceCommandOutput) => void
|
|
245
249
|
): void;
|
|
250
|
+
updateEnabledControl(
|
|
251
|
+
args: UpdateEnabledControlCommandInput,
|
|
252
|
+
options?: __HttpHandlerOptions
|
|
253
|
+
): Promise<UpdateEnabledControlCommandOutput>;
|
|
254
|
+
updateEnabledControl(
|
|
255
|
+
args: UpdateEnabledControlCommandInput,
|
|
256
|
+
cb: (err: any, data?: UpdateEnabledControlCommandOutput) => void
|
|
257
|
+
): void;
|
|
258
|
+
updateEnabledControl(
|
|
259
|
+
args: UpdateEnabledControlCommandInput,
|
|
260
|
+
options: __HttpHandlerOptions,
|
|
261
|
+
cb: (err: any, data?: UpdateEnabledControlCommandOutput) => void
|
|
262
|
+
): void;
|
|
246
263
|
updateLandingZone(
|
|
247
264
|
args: UpdateLandingZoneCommandInput,
|
|
248
265
|
options?: __HttpHandlerOptions
|
|
@@ -101,6 +101,10 @@ import {
|
|
|
101
101
|
UntagResourceCommandInput,
|
|
102
102
|
UntagResourceCommandOutput,
|
|
103
103
|
} from "./commands/UntagResourceCommand";
|
|
104
|
+
import {
|
|
105
|
+
UpdateEnabledControlCommandInput,
|
|
106
|
+
UpdateEnabledControlCommandOutput,
|
|
107
|
+
} from "./commands/UpdateEnabledControlCommand";
|
|
104
108
|
import {
|
|
105
109
|
UpdateLandingZoneCommandInput,
|
|
106
110
|
UpdateLandingZoneCommandOutput,
|
|
@@ -127,6 +131,7 @@ export type ServiceInputTypes =
|
|
|
127
131
|
| ResetLandingZoneCommandInput
|
|
128
132
|
| TagResourceCommandInput
|
|
129
133
|
| UntagResourceCommandInput
|
|
134
|
+
| UpdateEnabledControlCommandInput
|
|
130
135
|
| UpdateLandingZoneCommandInput;
|
|
131
136
|
export type ServiceOutputTypes =
|
|
132
137
|
| CreateLandingZoneCommandOutput
|
|
@@ -143,6 +148,7 @@ export type ServiceOutputTypes =
|
|
|
143
148
|
| ResetLandingZoneCommandOutput
|
|
144
149
|
| TagResourceCommandOutput
|
|
145
150
|
| UntagResourceCommandOutput
|
|
151
|
+
| UpdateEnabledControlCommandOutput
|
|
146
152
|
| UpdateLandingZoneCommandOutput;
|
|
147
153
|
export interface ClientDefaults
|
|
148
154
|
extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@smithy/types";
|
|
9
|
+
import {
|
|
10
|
+
ControlTowerClientResolvedConfig,
|
|
11
|
+
ServiceInputTypes,
|
|
12
|
+
ServiceOutputTypes,
|
|
13
|
+
} from "../ControlTowerClient";
|
|
14
|
+
import {
|
|
15
|
+
UpdateEnabledControlInput,
|
|
16
|
+
UpdateEnabledControlOutput,
|
|
17
|
+
} from "../models/models_0";
|
|
18
|
+
export { __MetadataBearer, $Command };
|
|
19
|
+
export interface UpdateEnabledControlCommandInput
|
|
20
|
+
extends UpdateEnabledControlInput {}
|
|
21
|
+
export interface UpdateEnabledControlCommandOutput
|
|
22
|
+
extends UpdateEnabledControlOutput,
|
|
23
|
+
__MetadataBearer {}
|
|
24
|
+
export declare class UpdateEnabledControlCommand extends $Command<
|
|
25
|
+
UpdateEnabledControlCommandInput,
|
|
26
|
+
UpdateEnabledControlCommandOutput,
|
|
27
|
+
ControlTowerClientResolvedConfig
|
|
28
|
+
> {
|
|
29
|
+
readonly input: UpdateEnabledControlCommandInput;
|
|
30
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
31
|
+
constructor(input: UpdateEnabledControlCommandInput);
|
|
32
|
+
resolveMiddleware(
|
|
33
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
34
|
+
configuration: ControlTowerClientResolvedConfig,
|
|
35
|
+
options?: __HttpHandlerOptions
|
|
36
|
+
): Handler<
|
|
37
|
+
UpdateEnabledControlCommandInput,
|
|
38
|
+
UpdateEnabledControlCommandOutput
|
|
39
|
+
>;
|
|
40
|
+
private serialize;
|
|
41
|
+
private deserialize;
|
|
42
|
+
}
|
|
@@ -12,4 +12,5 @@ export * from "./ListTagsForResourceCommand";
|
|
|
12
12
|
export * from "./ResetLandingZoneCommand";
|
|
13
13
|
export * from "./TagResourceCommand";
|
|
14
14
|
export * from "./UntagResourceCommand";
|
|
15
|
+
export * from "./UpdateEnabledControlCommand";
|
|
15
16
|
export * from "./UpdateLandingZoneCommand";
|