@aws-sdk/client-controltower 3.621.0 → 3.623.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 +125 -39
- package/dist-cjs/index.js +12 -18
- package/dist-es/ControlTowerClient.js +12 -18
- package/dist-types/ControlTower.d.ts +132 -46
- package/dist-types/ControlTowerClient.d.ts +134 -50
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +4 -4
- package/dist-types/index.d.ts +132 -46
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/ControlTowerClient.d.ts +6 -8
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
- package/dist-types/ts3.4/runtimeConfig.d.ts +5 -5
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +5 -5
- package/package.json +10 -10
|
@@ -198,7 +198,8 @@ export interface ControlTower {
|
|
|
198
198
|
updateLandingZone(args: UpdateLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLandingZoneCommandOutput) => void): void;
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* <p>Amazon Web Services Control Tower offers application programming interface (API)
|
|
201
|
+
* <p>Amazon Web Services Control Tower offers application programming interface (API)
|
|
202
|
+
* operations that support programmatic interaction with these types of resources:</p>
|
|
202
203
|
* <ul>
|
|
203
204
|
* <li>
|
|
204
205
|
* <p>
|
|
@@ -242,7 +243,8 @@ export interface ControlTower {
|
|
|
242
243
|
* <li>
|
|
243
244
|
* <p>
|
|
244
245
|
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
|
|
245
|
-
* <i>Landing
|
|
246
|
+
* <i>Landing
|
|
247
|
+
* zones</i>
|
|
246
248
|
* </a>
|
|
247
249
|
* </p>
|
|
248
250
|
* <ul>
|
|
@@ -273,6 +275,11 @@ export interface ControlTower {
|
|
|
273
275
|
* </li>
|
|
274
276
|
* <li>
|
|
275
277
|
* <p>
|
|
278
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZoneOperations.html">ListLandingZoneOperations</a>
|
|
279
|
+
* </p>
|
|
280
|
+
* </li>
|
|
281
|
+
* <li>
|
|
282
|
+
* <p>
|
|
276
283
|
* <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html">ResetLandingZone</a>
|
|
277
284
|
* </p>
|
|
278
285
|
* </li>
|
|
@@ -339,7 +346,9 @@ export interface ControlTower {
|
|
|
339
346
|
* </li>
|
|
340
347
|
* <li>
|
|
341
348
|
* <p>
|
|
342
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">
|
|
349
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">
|
|
350
|
+
* <i>Tagging</i>
|
|
351
|
+
* </a>
|
|
343
352
|
* </p>
|
|
344
353
|
* <ul>
|
|
345
354
|
* <li>
|
|
@@ -367,49 +376,84 @@ export interface ControlTower {
|
|
|
367
376
|
* <b>About control APIs</b>
|
|
368
377
|
* </p>
|
|
369
378
|
* <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
|
|
370
|
-
*
|
|
379
|
+
* <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
371
380
|
* <p>To call these APIs, you'll need to know:</p>
|
|
372
381
|
* <ul>
|
|
373
382
|
* <li>
|
|
374
|
-
* <p>the <code>controlIdentifier</code> for the control--or guardrail--you are
|
|
383
|
+
* <p>the <code>controlIdentifier</code> for the control--or guardrail--you are
|
|
384
|
+
* targeting.</p>
|
|
375
385
|
* </li>
|
|
376
386
|
* <li>
|
|
377
|
-
* <p>the ARN associated with the target organizational unit (OU), which we call the
|
|
387
|
+
* <p>the ARN associated with the target organizational unit (OU), which we call the
|
|
388
|
+
* <code>targetIdentifier</code>.</p>
|
|
378
389
|
* </li>
|
|
379
390
|
* <li>
|
|
380
391
|
* <p>the ARN associated with a resource that you wish to tag or untag.</p>
|
|
381
392
|
* </li>
|
|
382
393
|
* </ul>
|
|
383
394
|
* <p>
|
|
384
|
-
* <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower
|
|
385
|
-
* control:</b>
|
|
395
|
+
* <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower control:</b>
|
|
386
396
|
* </p>
|
|
387
|
-
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
*
|
|
397
|
+
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each control. You can
|
|
398
|
+
* view the <code>controlIdentifier</code> in the console on the <b>Control
|
|
399
|
+
* details</b> page, as well as in the documentation.</p>
|
|
400
|
+
* <p>
|
|
401
|
+
* <b>About identifiers for Amazon Web Services Control Tower</b>
|
|
402
|
+
* </p>
|
|
403
|
+
* <p>The Amazon Web Services Control Tower <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each
|
|
404
|
+
* control. You can find the <code>controlIdentifier</code> for each Region and control in the
|
|
405
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Tables of control metadata</a> or the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control
|
|
406
|
+
* availability by Region tables</a> in the <i>Amazon Web Services Control Tower
|
|
407
|
+
* Controls Reference Guide</i>.</p>
|
|
408
|
+
* <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower
|
|
409
|
+
* legacy <i>Strongly recommended</i> and <i>Elective</i> controls
|
|
410
|
+
* is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource
|
|
411
|
+
* identifiers for APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">
|
|
394
412
|
* <i>Amazon Web Services Control Tower Controls Reference Guide</i>
|
|
395
|
-
* </a>. Remember
|
|
413
|
+
* </a>. Remember
|
|
414
|
+
* that <i>Mandatory</i> controls cannot be added or removed.</p>
|
|
396
415
|
* <note>
|
|
397
416
|
* <p>
|
|
398
|
-
* <b>
|
|
399
|
-
* <code>arn:aws:controltower:\{REGION\}::control/\{CONTROL_NAME\}</code>
|
|
400
|
-
* </p>
|
|
401
|
-
* <p>
|
|
402
|
-
* <b>Example:</b>
|
|
403
|
-
* </p>
|
|
404
|
-
* <p>
|
|
405
|
-
* <code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
|
|
417
|
+
* <b>Some controls have two identifiers</b>
|
|
406
418
|
* </p>
|
|
419
|
+
* <ul>
|
|
420
|
+
* <li>
|
|
421
|
+
* <p>
|
|
422
|
+
* <b>ARN format for Amazon Web Services Control
|
|
423
|
+
* Tower:</b>
|
|
424
|
+
* <code>arn:aws:controltower:\{REGION\}::control/\{CONTROL_TOWER_OPAQUE_ID\}</code>
|
|
425
|
+
* </p>
|
|
426
|
+
* <p>
|
|
427
|
+
* <b>Example:</b>
|
|
428
|
+
* </p>
|
|
429
|
+
* <p>
|
|
430
|
+
* <code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
|
|
431
|
+
* </p>
|
|
432
|
+
* </li>
|
|
433
|
+
* <li>
|
|
434
|
+
* <p>
|
|
435
|
+
* <b>ARN format for Amazon Web Services Control
|
|
436
|
+
* Catalog:</b>
|
|
437
|
+
* <code>arn:\{PARTITION\}:controlcatalog:::control/\{CONTROL_CATALOG_OPAQUE_ID\}</code>
|
|
438
|
+
* </p>
|
|
439
|
+
* </li>
|
|
440
|
+
* </ul>
|
|
441
|
+
* <p>You can find the <code>\{CONTROL_CATALOG_OPAQUE_ID\}</code> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/all-global-identifiers.html">
|
|
442
|
+
* <i>Amazon Web Services Control Tower Controls Reference
|
|
443
|
+
* Guide</i>
|
|
444
|
+
* </a>, or in the Amazon Web Services Control Tower console, on the
|
|
445
|
+
* <b>Control details</b> page.</p>
|
|
446
|
+
* <p>The Amazon Web Services Control Tower APIs for enabled controls, such as
|
|
447
|
+
* <code>GetEnabledControl</code> and <code>ListEnabledControls</code> always return an
|
|
448
|
+
* ARN of the same type given when the control was enabled.</p>
|
|
407
449
|
* </note>
|
|
408
450
|
* <p>
|
|
409
451
|
* <b>To get the <code>targetIdentifier</code>:</b>
|
|
410
452
|
* </p>
|
|
411
453
|
* <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
|
|
412
|
-
* <p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the
|
|
454
|
+
* <p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the
|
|
455
|
+
* <b>Organizational unit details</b> page associated with that
|
|
456
|
+
* OU.</p>
|
|
413
457
|
* <note>
|
|
414
458
|
* <p>
|
|
415
459
|
* <b>OU ARN format:</b>
|
|
@@ -421,14 +465,46 @@ export interface ControlTower {
|
|
|
421
465
|
* <p>
|
|
422
466
|
* <b> About landing zone APIs</b>
|
|
423
467
|
* </p>
|
|
424
|
-
* <p>You can configure and launch an Amazon Web Services Control Tower landing zone with APIs.
|
|
425
|
-
*
|
|
468
|
+
* <p>You can configure and launch an Amazon Web Services Control Tower landing zone with APIs.
|
|
469
|
+
* For an introduction and steps, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-apis.html">Getting started with
|
|
470
|
+
* Amazon Web Services Control Tower using APIs</a>.</p>
|
|
471
|
+
* <p>For an overview of landing zone API operations, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/2023-all.html#landing-zone-apis">
|
|
472
|
+
* Amazon Web Services Control Tower supports landing zone APIs</a>. The individual API
|
|
473
|
+
* operations for landing zones are detailed in this document, the <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_Operations.html">API reference
|
|
474
|
+
* manual</a>, in the "Actions" section.</p>
|
|
426
475
|
* <p>
|
|
427
476
|
* <b>About baseline APIs</b>
|
|
428
477
|
* </p>
|
|
429
|
-
* <p>You can apply the <code>AWSControlTowerBaseline</code> baseline to an organizational
|
|
430
|
-
*
|
|
431
|
-
*
|
|
478
|
+
* <p>You can apply the <code>AWSControlTowerBaseline</code> baseline to an organizational
|
|
479
|
+
* unit (OU) as a way to register the OU with Amazon Web Services Control Tower,
|
|
480
|
+
* programmatically. For a general overview of this capability, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/2024-all.html#baseline-apis">Amazon Web Services Control Tower supports APIs for OU registration and configuration
|
|
481
|
+
* with baselines</a>.</p>
|
|
482
|
+
* <p>You can call the baseline API operations to view the baselines that Amazon Web Services
|
|
483
|
+
* Control Tower enables for your landing zone, on your behalf, when setting up the landing
|
|
484
|
+
* zone. These baselines are read-only baselines.</p>
|
|
485
|
+
* <p>The individual API operations for baselines are detailed in this document, the <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_Operations.html">API
|
|
486
|
+
* reference manual</a>, in the "Actions" section. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input and output examples with CLI</a>.</p>
|
|
487
|
+
* <p>
|
|
488
|
+
* <b> About Amazon Web Services Control Catalog identifiers</b>
|
|
489
|
+
* </p>
|
|
490
|
+
* <ul>
|
|
491
|
+
* <li>
|
|
492
|
+
* <p>The <code>EnableControl</code> and <code>DisableControl</code> API operations can
|
|
493
|
+
* be called by specifying either the Amazon Web Services Control Tower identifer or the
|
|
494
|
+
* Amazon Web Services Control Catalog identifier. The API response returns the same
|
|
495
|
+
* type of identifier that you specified when calling the API.</p>
|
|
496
|
+
* </li>
|
|
497
|
+
* <li>
|
|
498
|
+
* <p>If you use an Amazon Web Services Control Tower identifier to call the
|
|
499
|
+
* <code>EnableControl</code> API, and then call <code>EnableControl</code> again
|
|
500
|
+
* with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control
|
|
501
|
+
* Tower returns an error message stating that the control is already enabled. Similar
|
|
502
|
+
* behavior applies to the <code>DisableControl</code> API operation. </p>
|
|
503
|
+
* </li>
|
|
504
|
+
* <li>
|
|
505
|
+
* <p>Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.</p>
|
|
506
|
+
* </li>
|
|
507
|
+
* </ul>
|
|
432
508
|
* <p class="title">
|
|
433
509
|
* <b>Details and examples</b>
|
|
434
510
|
* </p>
|
|
@@ -440,47 +516,56 @@ export interface ControlTower {
|
|
|
440
516
|
* </li>
|
|
441
517
|
* <li>
|
|
442
518
|
* <p>
|
|
443
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input
|
|
519
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input
|
|
520
|
+
* and output examples with CLI</a>
|
|
444
521
|
* </p>
|
|
445
522
|
* </li>
|
|
446
523
|
* <li>
|
|
447
524
|
* <p>
|
|
448
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls
|
|
525
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls
|
|
526
|
+
* with CloudFormation</a>
|
|
449
527
|
* </p>
|
|
450
528
|
* </li>
|
|
451
529
|
* <li>
|
|
452
530
|
* <p>
|
|
453
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone
|
|
531
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone
|
|
532
|
+
* with CloudFormation</a>
|
|
454
533
|
* </p>
|
|
455
534
|
* </li>
|
|
456
535
|
* <li>
|
|
457
536
|
* <p>
|
|
458
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control
|
|
537
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control
|
|
538
|
+
* metadata tables (large page)</a>
|
|
459
539
|
* </p>
|
|
460
540
|
* </li>
|
|
461
541
|
* <li>
|
|
462
542
|
* <p>
|
|
463
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control
|
|
543
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control
|
|
544
|
+
* availability by Region tables (large page)</a>
|
|
464
545
|
* </p>
|
|
465
546
|
* </li>
|
|
466
547
|
* <li>
|
|
467
548
|
* <p>
|
|
468
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of
|
|
549
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of
|
|
550
|
+
* identifiers for legacy controls</a>
|
|
469
551
|
* </p>
|
|
470
552
|
* </li>
|
|
471
553
|
* <li>
|
|
472
554
|
* <p>
|
|
473
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference
|
|
555
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference
|
|
556
|
+
* guide</a>
|
|
474
557
|
* </p>
|
|
475
558
|
* </li>
|
|
476
559
|
* <li>
|
|
477
560
|
* <p>
|
|
478
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls
|
|
561
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls
|
|
562
|
+
* library groupings</a>
|
|
479
563
|
* </p>
|
|
480
564
|
* </li>
|
|
481
565
|
* <li>
|
|
482
566
|
* <p>
|
|
483
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating Amazon Web Services Control Tower resources with Amazon Web Services
|
|
567
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating Amazon Web Services Control Tower resources with Amazon Web Services
|
|
568
|
+
* CloudFormation</a>
|
|
484
569
|
* </p>
|
|
485
570
|
* </li>
|
|
486
571
|
* </ul>
|
|
@@ -489,13 +574,14 @@ export interface ControlTower {
|
|
|
489
574
|
* <p>
|
|
490
575
|
* <b>Recording API Requests</b>
|
|
491
576
|
* </p>
|
|
492
|
-
* <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that
|
|
493
|
-
* Amazon Web Services
|
|
494
|
-
*
|
|
495
|
-
*
|
|
496
|
-
*
|
|
497
|
-
*
|
|
498
|
-
*
|
|
577
|
+
* <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that
|
|
578
|
+
* records Amazon Web Services API calls for your Amazon Web Services account and delivers log
|
|
579
|
+
* files to an Amazon S3 bucket. By using information collected by CloudTrail, you can
|
|
580
|
+
* determine which requests the Amazon Web Services Control Tower service received, who made
|
|
581
|
+
* the request and when, and so on. For more about Amazon Web Services Control Tower and its
|
|
582
|
+
* support for CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail</a> in the
|
|
583
|
+
* Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including
|
|
584
|
+
* how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
|
|
499
585
|
* Guide.</p>
|
|
500
586
|
* @public
|
|
501
587
|
*/
|