Skip to content

Commit 2f7a965

Browse files
author
awstools
committed
docs(client-controltower): Updated Control Tower service documentation for controlcatalog control ARN support with existing Control Tower public APIs
1 parent 245450e commit 2f7a965

File tree

5 files changed

+522
-178
lines changed

5 files changed

+522
-178
lines changed

‎clients/client-controltower/README.md

Lines changed: 125 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native.
88

9-
<p>Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:</p>
9+
<p>Amazon Web Services Control Tower offers application programming interface (API)
10+
operations that support programmatic interaction with these types of resources:</p>
1011
<ul>
1112
<li>
1213
<p>
@@ -50,7 +51,8 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
5051
<li>
5152
<p>
5253
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
53-
<i>Landing zones</i>
54+
<i>Landing
55+
zones</i>
5456
</a>
5557
</p>
5658
<ul>
@@ -81,6 +83,11 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
8183
</li>
8284
<li>
8385
<p>
86+
<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZoneOperations.html">ListLandingZoneOperations</a>
87+
</p>
88+
</li>
89+
<li>
90+
<p>
8491
<a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html">ResetLandingZone</a>
8592
</p>
8693
</li>
@@ -147,7 +154,9 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
147154
</li>
148155
<li>
149156
<p>
150-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">Tagging</a>
157+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html">
158+
<i>Tagging</i>
159+
</a>
151160
</p>
152161
<ul>
153162
<li>
@@ -179,45 +188,80 @@ AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native
179188
<p>To call these APIs, you'll need to know:</p>
180189
<ul>
181190
<li>
182-
<p>the <code>controlIdentifier</code> for the control--or guardrail--you are targeting.</p>
191+
<p>the <code>controlIdentifier</code> for the control--or guardrail--you are
192+
targeting.</p>
183193
</li>
184194
<li>
185-
<p>the ARN associated with the target organizational unit (OU), which we call the <code>targetIdentifier</code>.</p>
195+
<p>the ARN associated with the target organizational unit (OU), which we call the
196+
<code>targetIdentifier</code>.</p>
186197
</li>
187198
<li>
188199
<p>the ARN associated with a resource that you wish to tag or untag.</p>
189200
</li>
190201
</ul>
191202
<p>
192-
<b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower
193-
control:</b>
203+
<b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower control:</b>
204+
</p>
205+
<p>The <code>controlIdentifier</code> is an ARN that is specified for each control. You can
206+
view the <code>controlIdentifier</code> in the console on the <b>Control
207+
details</b> page, as well as in the documentation.</p>
208+
<p>
209+
<b>About identifiers for Amazon Web Services Control Tower</b>
194210
</p>
195-
<p>The <code>controlIdentifier</code> is an ARN that is specified for each
196-
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>
197-
<p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
198-
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>
199-
<p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
200-
<i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource identifiers for
201-
APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">
211+
<p>The Amazon Web Services Control Tower <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each
212+
control. You can find the <code>controlIdentifier</code> for each Region and control in the
213+
<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
214+
availability by Region tables</a> in the <i>Amazon Web Services Control Tower
215+
Controls Reference Guide</i>.</p>
216+
<p>A quick-reference list of control identifers for the Amazon Web Services Control Tower
217+
legacy <i>Strongly recommended</i> and <i>Elective</i> controls
218+
is given in <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html">Resource
219+
identifiers for APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">
202220
<i>Amazon Web Services Control Tower Controls Reference Guide</i>
203-
</a>. Remember that <i>Mandatory</i> controls cannot be added or removed.</p>
221+
</a>. Remember
222+
that <i>Mandatory</i> controls cannot be added or removed.</p>
204223
<note>
205224
<p>
206-
<b>ARN format:</b>
207-
<code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
225+
<b>Some controls have two identifiers</b>
226+
</p>
227+
<ul>
228+
<li>
229+
<p>
230+
<b>ARN format for Amazon Web Services Control
231+
Tower:</b>
232+
<code>arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}</code>
208233
</p>
209234
<p>
210235
<b>Example:</b>
211236
</p>
212237
<p>
213238
<code>arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED</code>
214239
</p>
240+
</li>
241+
<li>
242+
<p>
243+
<b>ARN format for Amazon Web Services Control
244+
Catalog:</b>
245+
<code>arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}</code>
246+
</p>
247+
</li>
248+
</ul>
249+
<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">
250+
<i>Amazon Web Services Control Tower Controls Reference
251+
Guide</i>
252+
</a>, or in the Amazon Web Services Control Tower console, on the
253+
<b>Control details</b> page.</p>
254+
<p>The Amazon Web Services Control Tower APIs for enabled controls, such as
255+
<code>GetEnabledControl</code> and <code>ListEnabledControls</code> always return an
256+
ARN of the same type given when the control was enabled.</p>
215257
</note>
216258
<p>
217259
<b>To get the <code>targetIdentifier</code>:</b>
218260
</p>
219261
<p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
220-
<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>
262+
<p>In the Amazon Web Services Organizations console, you can find the ARN for the OU on the
263+
<b>Organizational unit details</b> page associated with that
264+
OU.</p>
221265
<note>
222266
<p>
223267
<b>OU ARN format:</b>
@@ -229,14 +273,46 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
229273
<p>
230274
<b> About landing zone APIs</b>
231275
</p>
232-
<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>
233-
<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>
276+
<p>You can configure and launch an Amazon Web Services Control Tower landing zone with APIs.
277+
For an introduction and steps, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-apis.html">Getting started with
278+
Amazon Web Services Control Tower using APIs</a>.</p>
279+
<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">
280+
Amazon Web Services Control Tower supports landing zone APIs</a>. The individual API
281+
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
282+
manual</a>, in the "Actions" section.</p>
234283
<p>
235284
<b>About baseline APIs</b>
236285
</p>
237-
<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>
238-
<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>
239-
<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>
286+
<p>You can apply the <code>AWSControlTowerBaseline</code> baseline to an organizational
287+
unit (OU) as a way to register the OU with Amazon Web Services Control Tower,
288+
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
289+
with baselines</a>.</p>
290+
<p>You can call the baseline API operations to view the baselines that Amazon Web Services
291+
Control Tower enables for your landing zone, on your behalf, when setting up the landing
292+
zone. These baselines are read-only baselines.</p>
293+
<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
294+
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>
295+
<p>
296+
<b> About Amazon Web Services Control Catalog identifiers</b>
297+
</p>
298+
<ul>
299+
<li>
300+
<p>The <code>EnableControl</code> and <code>DisableControl</code> API operations can
301+
be called by specifying either the Amazon Web Services Control Tower identifer or the
302+
Amazon Web Services Control Catalog identifier. The API response returns the same
303+
type of identifier that you specified when calling the API.</p>
304+
</li>
305+
<li>
306+
<p>If you use an Amazon Web Services Control Tower identifier to call the
307+
<code>EnableControl</code> API, and then call <code>EnableControl</code> again
308+
with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control
309+
Tower returns an error message stating that the control is already enabled. Similar
310+
behavior applies to the <code>DisableControl</code> API operation. </p>
311+
</li>
312+
<li>
313+
<p>Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.</p>
314+
</li>
315+
</ul>
240316
<p class="title">
241317
<b>Details and examples</b>
242318
</p>
@@ -248,47 +324,56 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
248324
</li>
249325
<li>
250326
<p>
251-
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input and output examples with CLI</a>
327+
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input
328+
and output examples with CLI</a>
252329
</p>
253330
</li>
254331
<li>
255332
<p>
256-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls with CloudFormation</a>
333+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html">Enable controls
334+
with CloudFormation</a>
257335
</p>
258336
</li>
259337
<li>
260338
<p>
261-
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone with CloudFormation</a>
339+
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone
340+
with CloudFormation</a>
262341
</p>
263342
</li>
264343
<li>
265344
<p>
266-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control metadata tables (large page)</a>
345+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html">Control
346+
metadata tables (large page)</a>
267347
</p>
268348
</li>
269349
<li>
270350
<p>
271-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control availability by Region tables (large page)</a>
351+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html">Control
352+
availability by Region tables (large page)</a>
272353
</p>
273354
</li>
274355
<li>
275356
<p>
276-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of identifiers for legacy controls</a>
357+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html">List of
358+
identifiers for legacy controls</a>
277359
</p>
278360
</li>
279361
<li>
280362
<p>
281-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference guide</a>
363+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html">Controls reference
364+
guide</a>
282365
</p>
283366
</li>
284367
<li>
285368
<p>
286-
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls library groupings</a>
369+
<a href="https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html">Controls
370+
library groupings</a>
287371
</p>
288372
</li>
289373
<li>
290374
<p>
291-
<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>
375+
<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
376+
CloudFormation</a>
292377
</p>
293378
</li>
294379
</ul>
@@ -297,13 +382,14 @@ APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/l
297382
<p>
298383
<b>Recording API Requests</b>
299384
</p>
300-
<p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your
301-
Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by
302-
CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made
303-
the request and when, and so on. For more about Amazon Web Services Control Tower and its support for
304-
CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower
305-
Actions with Amazon Web Services CloudTrail</a> in the Amazon Web Services Control Tower User Guide. To learn more about
306-
CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
385+
<p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that
386+
records Amazon Web Services API calls for your Amazon Web Services account and delivers log
387+
files to an Amazon S3 bucket. By using information collected by CloudTrail, you can
388+
determine which requests the Amazon Web Services Control Tower service received, who made
389+
the request and when, and so on. For more about Amazon Web Services Control Tower and its
390+
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
391+
Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including
392+
how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
307393
Guide.</p>
308394

309395
## Installing

0 commit comments

Comments
 (0)