@aws-sdk/client-controltower 3.806.0 → 3.809.0

package/README.md

@@ -6,391 +6,7 @@
 
 AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native.
 
-<p>Amazon Web Services Control Tower offers application programming interface (API)
-operations that support programmatic interaction with these types of resources:</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">
-<i>Controls</i>
-</a>
-</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableControl.html">DisableControl</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html">EnableControl</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledControl.html">GetEnabledControl</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListControlOperations.html">ListControlOperations</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledControls.html">ListEnabledControls</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html">UpdateEnabledControl</a>
-</p>
-</li>
-</ul>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
-<i>Landing
-zones</i>
-</a>
-</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_CreateLandingZone.html">CreateLandingZone</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DeleteLandingZone.html">DeleteLandingZone</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZone.html">GetLandingZone</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZoneOperation.html">GetLandingZoneOperation</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZones.html">ListLandingZones</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZoneOperations.html">ListLandingZoneOperations</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html">ResetLandingZone</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateLandingZone.html">UpdateLandingZone</a>
-</p>
-</li>
-</ul>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html">
-<i>Baselines</i>
-</a>
-</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableBaseline.html">DisableBaseline</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableBaseline.html">EnableBaseline</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaseline.html">GetBaseline</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaselineOperation.html">GetBaselineOperation</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledBaseline.html">GetEnabledBaseline</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListBaselines.html">ListBaselines</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledBaselines.html">ListEnabledBaselines</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledBaseline.html">ResetEnabledBaseline</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledBaseline.html">UpdateEnabledBaseline</a>
-</p>
-</li>
-</ul>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">
-<i>Tagging</i>
-</a>
-</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_TagResource.html">TagResource</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UntagResource.html">UntagResource</a>
-</p>
-</li>
-</ul>
-</li>
-</ul>
-<p>For more information about these types of resources, see the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html">
-<i>Amazon Web Services Control Tower User Guide</i>
-</a>.</p>
-<p>
-<b>About control APIs</b>
-</p>
-<p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
-<i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
-<p>To call these APIs, you'll need to know:</p>
-<ul>
-<li>
-<p>the <code>controlIdentifier</code> for the control--or guardrail--you are
-targeting.</p>
-</li>
-<li>
-<p>the ARN associated with the target organizational unit (OU), which we call the
-<code>targetIdentifier</code>.</p>
-</li>
-<li>
-<p>the ARN associated with a resource that you wish to tag or untag.</p>
-</li>
-</ul>
-<p>
-<b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower control:</b>
-</p>
-<p>The <code>controlIdentifier</code> is an ARN that is specified for each 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>
-<p>
-<b>About identifiers for Amazon Web Services Control Tower</b>
-</p>
-<p>The Amazon Web Services Control Tower <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each
-control. You can find the <code>controlIdentifier</code> for each Region and control in the
-<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
-availability by Region tables</a> in the <i>Amazon Web Services Control Tower
-Controls Reference Guide</i>.</p>
-<p>A quick-reference list of control identifers for the Amazon Web Services Control Tower
-legacy <i>Strongly recommended</i> and <i>Elective</i> controls
-is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource
-identifiers for APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">
-<i>Amazon Web Services Control Tower Controls Reference Guide</i>
-</a>. Remember
-that <i>Mandatory</i> controls cannot be added or removed.</p>
-<note>
-<p>
-<b>Some controls have two identifiers</b>
-</p>
-<ul>
-<li>
-<p>
-<b>ARN format for Amazon Web Services Control
-Tower:</b>
-<code>arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}</code>
-</p>
-<p>
-<b>Example:</b>
-</p>
-<p>
-<code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
-</p>
-</li>
-<li>
-<p>
-<b>ARN format for Amazon Web Services Control
-Catalog:</b>
-<code>arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}</code>
-</p>
-</li>
-</ul>
-<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">
-<i>Amazon Web Services Control Tower Controls Reference
-Guide</i>
-</a>, or in the Amazon Web Services Control Tower console, on the
-<b>Control details</b> page.</p>
-<p>The Amazon Web Services Control Tower APIs for enabled controls, such as
-<code>GetEnabledControl</code> and <code>ListEnabledControls</code> always return an
-ARN of the same type given when the control was enabled.</p>
-</note>
-<p>
-<b>To get the <code>targetIdentifier</code>:</b>
-</p>
-<p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
-<p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the
-<b>Organizational unit details</b> page associated with that
-OU.</p>
-<note>
-<p>
-<b>OU ARN format:</b>
-</p>
-<p>
-<code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
-</p>
-</note>
-<p>
-<b> About landing zone APIs</b>
-</p>
-<p>You can configure and launch an Amazon Web Services Control Tower landing zone with APIs.
-For an introduction and steps, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-apis.html">Getting started with
-Amazon Web Services Control Tower using APIs</a>.</p>
-<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">
-Amazon Web Services Control Tower supports landing zone APIs</a>. The individual API
-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
-manual</a>, in the "Actions" section.</p>
-<p>
-<b>About baseline APIs</b>
-</p>
-<p>You can apply the <code>AWSControlTowerBaseline</code> baseline to an organizational
-unit (OU) as a way to register the OU with Amazon Web Services Control Tower,
-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
-with baselines</a>.</p>
-<p>You can call the baseline API operations to view the baselines that Amazon Web Services
-Control Tower enables for your landing zone, on your behalf, when setting up the landing
-zone. These baselines are read-only baselines.</p>
-<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
-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>
-<p>
-<b> About Amazon Web Services Control Catalog identifiers</b>
-</p>
-<ul>
-<li>
-<p>The <code>EnableControl</code> and <code>DisableControl</code> API operations can
-be called by specifying either the Amazon Web Services Control Tower identifer or the
-Amazon Web Services Control Catalog identifier. The API response returns the same
-type of identifier that you specified when calling the API.</p>
-</li>
-<li>
-<p>If you use an Amazon Web Services Control Tower identifier to call the
-<code>EnableControl</code> API, and then call <code>EnableControl</code> again
-with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control
-Tower returns an error message stating that the control is already enabled. Similar
-behavior applies to the <code>DisableControl</code> API operation. </p>
-</li>
-<li>
-<p>Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.</p>
-</li>
-</ul>
-<p class="title">
-<b>Details and examples</b>
-</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">Control API input and output examples with CLI</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input
-and output examples with CLI</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls
-with CloudFormation</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone
-with CloudFormation</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control
-metadata tables (large page)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control
-availability by Region tables (large page)</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of
-identifiers for legacy controls</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference
-guide</a>
-</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls
-library groupings</a>
-</p>
-</li>
-<li>
-<p>
-<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
-CloudFormation</a>
-</p>
-</li>
-</ul>
-<p>To view the open source resource repository on GitHub, see <a href="https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower">aws-cloudformation/aws-cloudformation-resource-providers-controltower</a>
-</p>
-<p>
-<b>Recording API Requests</b>
-</p>
-<p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that
-records Amazon Web Services API calls for your Amazon Web Services account and delivers log
-files to an Amazon S3 bucket. By using information collected by CloudTrail, you can
-determine which requests the Amazon Web Services Control Tower service received, who made
-the request and when, and so on. For more about Amazon Web Services Control Tower and its
-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
-Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including
-how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
-Guide.</p>
+<p>Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html"> <i>Controls</i> </a> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableControl.html">DisableControl</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html">EnableControl</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledControl.html">GetEnabledControl</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetControlOperation.html">GetControlOperation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListControlOperations.html">ListControlOperations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledControls.html">ListEnabledControls</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledControl.html">ResetEnabledControl</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html">UpdateEnabledControl</a> </p> </li> </ul> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html"> <i>Landing zones</i> </a> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_CreateLandingZone.html">CreateLandingZone</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DeleteLandingZone.html">DeleteLandingZone</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZone.html">GetLandingZone</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZoneOperation.html">GetLandingZoneOperation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZones.html">ListLandingZones</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZoneOperations.html">ListLandingZoneOperations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html">ResetLandingZone</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateLandingZone.html">UpdateLandingZone</a> </p> </li> </ul> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html"> <i>Baselines</i> </a> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableBaseline.html">DisableBaseline</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableBaseline.html">EnableBaseline</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaseline.html">GetBaseline</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaselineOperation.html">GetBaselineOperation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledBaseline.html">GetEnabledBaseline</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListBaselines.html">ListBaselines</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledBaselines.html">ListEnabledBaselines</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledBaseline.html">ResetEnabledBaseline</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledBaseline.html">UpdateEnabledBaseline</a> </p> </li> </ul> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html"> <i>Tagging</i> </a> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_TagResource.html">TagResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UntagResource.html">UntagResource</a> </p> </li> </ul> </li> </ul> <p>For more information about these types of resources, see the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html"> <i>Amazon Web Services Control Tower User Guide</i> </a>.</p> <p> <b>About control APIs</b> </p> <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p> <p>To call these APIs, you'll need to know:</p> <ul> <li> <p>the <code>controlIdentifier</code> for the control--or guardrail--you are targeting.</p> </li> <li> <p>the ARN associated with the target organizational unit (OU), which we call the <code>targetIdentifier</code>.</p> </li> <li> <p>the ARN associated with a resource that you wish to tag or untag.</p> </li> </ul> <p> <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower control:</b> </p> <p>The <code>controlIdentifier</code> is an ARN that is specified for each 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> <p> <b>About identifiers for Amazon Web Services Control Tower</b> </p> <p>The Amazon Web Services Control Tower <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can find the <code>controlIdentifier</code> for each Region and control in the <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 availability by Region tables</a> in the <i>Amazon Web Services Control Tower Controls Reference Guide</i>.</p> <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource identifiers for APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html"> <i>Amazon Web Services Control Tower Controls Reference Guide</i> </a>. Remember that <i>Mandatory</i> controls cannot be added or removed.</p> <note> <p> <b>Some controls have two identifiers</b> </p> <ul> <li> <p> <b>ARN format for Amazon Web Services Control Tower:</b> <code>arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}</code> </p> <p> <b>Example:</b> </p> <p> <code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code> </p> </li> <li> <p> <b>ARN format for Amazon Web Services Control Catalog:</b> <code>arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}</code> </p> </li> </ul> <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"> <i>Amazon Web Services Control Tower Controls Reference Guide</i> </a>, or in the Amazon Web Services Control Tower console, on the <b>Control details</b> page.</p> <p>The Amazon Web Services Control Tower APIs for enabled controls, such as <code>GetEnabledControl</code> and <code>ListEnabledControls</code> always return an ARN of the same type given when the control was enabled.</p> </note> <p> <b>To get the <code>targetIdentifier</code>:</b> </p> <p>The <code>targetIdentifier</code> is the ARN for an OU.</p> <p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p> <note> <p> <b>OU ARN format:</b> </p> <p> <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code> </p> </note> <p> <b> About landing zone APIs</b> </p> <p>You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-apis.html">Getting started with Amazon Web Services Control Tower using APIs</a>.</p> <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"> Amazon Web Services Control Tower supports landing zone APIs</a>. The individual API 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 manual</a>, in the "Actions" section.</p> <p> <b>About baseline APIs</b> </p> <p>You can apply the <code>AWSControlTowerBaseline</code> baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, 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 with baselines</a>.</p> <p>You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.</p> <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 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> <p> <b> About Amazon Web Services Control Catalog identifiers</b> </p> <ul> <li> <p>The <code>EnableControl</code> and <code>DisableControl</code> API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.</p> </li> <li> <p>If you use an Amazon Web Services Control Tower identifier to call the <code>EnableControl</code> API, and then call <code>EnableControl</code> again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the <code>DisableControl</code> API operation. </p> </li> <li> <p>Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.</p> </li> </ul> <p class="title"> <b>Details and examples</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html">Control API input and output examples with CLI</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input and output examples with CLI</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls with CloudFormation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone with CloudFormation</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control metadata tables (large page)</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control availability by Region tables (large page)</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of identifiers for legacy controls</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference guide</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls library groupings</a> </p> </li> <li> <p> <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 CloudFormation</a> </p> </li> </ul> <p>To view the open source resource repository on GitHub, see <a href="https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower">aws-cloudformation/aws-cloudformation-resource-providers-controltower</a> </p> <p> <b>Recording API Requests</b> </p> <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its 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 Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.</p>
 
 ## Installing
 

package/dist-cjs/index.js

@@ -37,6 +37,7 @@ __export(index_exports, {
   DriftStatus: () => DriftStatus,
   EnableBaselineCommand: () => EnableBaselineCommand,
   EnableControlCommand: () => EnableControlCommand,
+  EnabledBaselineDriftStatus: () => EnabledBaselineDriftStatus,
   EnablementStatus: () => EnablementStatus,
   GetBaselineCommand: () => GetBaselineCommand,
   GetBaselineOperationCommand: () => GetBaselineOperationCommand,
@@ -419,6 +420,10 @@ var ServiceQuotaExceededException = class _ServiceQuotaExceededException extends
     Object.setPrototypeOf(this, _ServiceQuotaExceededException.prototype);
   }
 };
+var EnabledBaselineDriftStatus = {
+  DRIFTED: "DRIFTED",
+  IN_SYNC: "IN_SYNC"
+};
 var EnablementStatus = {
   FAILED: "FAILED",
   SUCCEEDED: "SUCCEEDED",
@@ -1497,6 +1502,7 @@ var de_EnabledBaselineDetails = /* @__PURE__ */ __name((output, context) => {
     arn: import_smithy_client.expectString,
     baselineIdentifier: import_smithy_client.expectString,
     baselineVersion: import_smithy_client.expectString,
+    driftStatusSummary: import_smithy_client._json,
     parameters: /* @__PURE__ */ __name((_) => de_EnabledBaselineParameterSummaries(_, context), "parameters"),
     parentIdentifier: import_smithy_client.expectString,
     statusSummary: import_smithy_client._json,
@@ -2108,6 +2114,7 @@ var paginateListLandingZones = (0, import_core.createPaginator)(ControlTowerClie
   ControlOperationStatus,
   ConflictException,
   ServiceQuotaExceededException,
+  EnabledBaselineDriftStatus,
   EnablementStatus,
   DriftStatus,
   LandingZoneOperationType,

package/dist-es/models/models_0.js

@@ -115,6 +115,10 @@ export class ServiceQuotaExceededException extends __BaseException {
         Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
     }
 }
+export const EnabledBaselineDriftStatus = {
+    DRIFTED: "DRIFTED",
+    IN_SYNC: "IN_SYNC",
+};
 export const EnablementStatus = {
     FAILED: "FAILED",
     SUCCEEDED: "SUCCEEDED",

package/dist-es/protocols/Aws_restJson1.js

@@ -1002,6 +1002,7 @@ const de_EnabledBaselineDetails = (output, context) => {
         arn: __expectString,
         baselineIdentifier: __expectString,
         baselineVersion: __expectString,
+        driftStatusSummary: _json,
         parameters: (_) => de_EnabledBaselineParameterSummaries(_, context),
         parentIdentifier: __expectString,
         statusSummary: _json,