Skip to content

Commit

Permalink
docs(client-controltower): Updated Control Tower service documentatio…
Browse files Browse the repository at this point in the history 
…n for controlcatalog control ARN support with existing Control Tower public APIs
  • Loading branch information
awstools committed Aug 1, 2024
1 parent 245450e commit 2f7a965
Show file tree
Hide file tree
Showing 5 changed files with 522 additions and 178 deletions.
164 changes: 125 additions & 39 deletions clients/client-controltower/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

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>
<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>
Expand Down Expand Up @@ -50,7 +51,8 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
<li>
<p>
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
<i>Landing zones</i>
<i>Landing
zones</i>
</a>
</p>
<ul>
Expand Down Expand Up @@ -81,6 +83,11 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
</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>
Expand Down Expand Up @@ -147,7 +154,9 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
</li>
<li>
<p>
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">Tagging</a>
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">
<i>Tagging</i>
</a>
</p>
<ul>
<li>
Expand Down Expand Up @@ -179,45 +188,80 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
<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>
<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>
<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>
<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 <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>The <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">
<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>
</a>. Remember
that <i>Mandatory</i> controls cannot be added or removed.</p>
<note>
<p>
<b>ARN format:</b>
<code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
<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>
<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>
Expand All @@ -229,14 +273,46 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
<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>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>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>
Expand All @@ -248,47 +324,56 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
</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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
Expand All @@ -297,13 +382,14 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
<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
<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
Expand Down
Loading

0 comments on commit 2f7a965

Please sign in to comment.