You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-controltower/README.md
+78-22Lines changed: 78 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@
6
6
7
7
AWS SDK for JavaScript ControlTower Client for Node.js, Browser and React Native.
8
8
9
-
<p>These interfaces allow you to apply the AWS library of pre-defined
10
-
<i>controls</i> to your organizational units, programmatically. In AWS Control Tower, the terms "control" and "guardrail" are synonyms.</p>
9
+
<p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
10
+
<i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
11
11
<p>To call these APIs, you'll need to know:</p>
12
12
<ul>
13
13
<li>
@@ -26,13 +26,13 @@ control:</b>
26
26
</p>
27
27
<p>The <code>controlIdentifier</code> is an ARN that is specified for each
28
28
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>
29
-
<p>The <code>controlIdentifier</code> is unique in each AWS Region for each control. You can
30
-
find the <code>controlIdentifier</code> for each Region and control in the <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>AWS Control Tower User Guide.</i>
29
+
<p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
30
+
find the <code>controlIdentifier</code> for each Region and control in the <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>Amazon Web Services Control Tower User Guide.</i>
31
31
</p>
32
-
<p>A quick-reference list of control identifers for the AWS Control Tower legacy <i>Strongly recommended</i> and
32
+
<p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
33
33
<i>Elective</i> controls is given in <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
34
34
APIs and controls</a> in the <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
35
-
of the <i>AWS Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
35
+
of the <i>Amazon Web Services Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
36
36
cannot be added or removed.</p>
37
37
<note>
38
38
<p>
@@ -50,7 +50,7 @@ cannot be added or removed.</p>
50
50
<b>To get the <code>targetIdentifier</code>:</b>
51
51
</p>
52
52
<p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
53
-
<p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
53
+
<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>
54
54
<note>
55
55
<p>
56
56
<b>OU ARN format:</b>
@@ -95,7 +95,7 @@ cannot be added or removed.</p>
95
95
</li>
96
96
<li>
97
97
<p>
98
-
<ahref="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating AWS Control Tower resources with AWS CloudFormation</a>
98
+
<ahref="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>
99
99
</p>
100
100
</li>
101
101
</ul>
@@ -104,13 +104,13 @@ cannot be added or removed.</p>
104
104
<p>
105
105
<b>Recording API Requests</b>
106
106
</p>
107
-
<p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your
108
-
AWS account and delivers log files to an Amazon S3 bucket. By using information collected by
109
-
CloudTrail, you can determine which requests the AWS Control Tower service received, who made
110
-
the request and when, and so on. For more about AWS Control Tower and its support for
111
-
CloudTrail, see <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower
112
-
Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about
113
-
CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User
107
+
<p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your
108
+
Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by
109
+
CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made
110
+
the request and when, and so on. For more about Amazon Web Services Control Tower and its support for
111
+
CloudTrail, see <ahref="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower
112
+
Actions with Amazon Web Services CloudTrail</a> in the Amazon Web Services Control Tower User Guide. To learn more about
113
+
CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
114
114
Guide.</p>
115
115
116
116
## Installing
@@ -128,16 +128,16 @@ using your favorite package manager:
128
128
129
129
The AWS SDK is modulized by clients and commands.
130
130
To send a request, you only need to import the `ControlTowerClient` and
131
-
the commands you need, for example `ListEnabledControlsCommand`:
131
+
the commands you need, for example `ListLandingZonesCommand`:
0 commit comments