Skip to content

Commit bb577d1

Browse files
author
awstools
committed
feat(client-controltower): Add APIs to create and manage a landing zone.
1 parent 548e686 commit bb577d1

25 files changed

+3611
-286
lines changed

clients/client-controltower/README.md

Lines changed: 78 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

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

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>
1111
<p>To call these APIs, you'll need to know:</p>
1212
<ul>
1313
<li>
@@ -26,13 +26,13 @@ control:</b>
2626
</p>
2727
<p>The <code>controlIdentifier</code> is an ARN that is specified for each
2828
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 <a href="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 <a href="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>
3131
</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
3333
<i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
3434
APIs and controls</a> in the <a href="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
3636
cannot be added or removed.</p>
3737
<note>
3838
<p>
@@ -50,7 +50,7 @@ cannot be added or removed.</p>
5050
<b>To get the <code>targetIdentifier</code>:</b>
5151
</p>
5252
<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>
5454
<note>
5555
<p>
5656
<b>OU ARN format:</b>
@@ -95,7 +95,7 @@ cannot be added or removed.</p>
9595
</li>
9696
<li>
9797
<p>
98-
<a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating AWS Control Tower resources with AWS CloudFormation</a>
98+
<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>
9999
</p>
100100
</li>
101101
</ul>
@@ -104,13 +104,13 @@ cannot be added or removed.</p>
104104
<p>
105105
<b>Recording API Requests</b>
106106
</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 <a href="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 <a href="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
114114
Guide.</p>
115115

116116
## Installing
@@ -128,16 +128,16 @@ using your favorite package manager:
128128

129129
The AWS SDK is modulized by clients and commands.
130130
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`:
132132

133133
```js
134134
// ES5 example
135-
const { ControlTowerClient, ListEnabledControlsCommand } = require("@aws-sdk/client-controltower");
135+
const { ControlTowerClient, ListLandingZonesCommand } = require("@aws-sdk/client-controltower");
136136
```
137137

138138
```ts
139139
// ES6+ example
140-
import { ControlTowerClient, ListEnabledControlsCommand } from "@aws-sdk/client-controltower";
140+
import { ControlTowerClient, ListLandingZonesCommand } from "@aws-sdk/client-controltower";
141141
```
142142

143143
### Usage
@@ -156,7 +156,7 @@ const client = new ControlTowerClient({ region: "REGION" });
156156
const params = {
157157
/** input parameters */
158158
};
159-
const command = new ListEnabledControlsCommand(params);
159+
const command = new ListLandingZonesCommand(params);
160160
```
161161

162162
#### Async/await
@@ -235,15 +235,15 @@ const client = new AWS.ControlTower({ region: "REGION" });
235235

236236
// async/await.
237237
try {
238-
const data = await client.listEnabledControls(params);
238+
const data = await client.listLandingZones(params);
239239
// process data.
240240
} catch (error) {
241241
// error handling.
242242
}
243243

244244
// Promises.
245245
client
246-
.listEnabledControls(params)
246+
.listLandingZones(params)
247247
.then((data) => {
248248
// process data.
249249
})
@@ -252,7 +252,7 @@ client
252252
});
253253

254254
// callbacks.
255-
client.listEnabledControls(params, (err, data) => {
255+
client.listLandingZones(params, (err, data) => {
256256
// process err and data.
257257
});
258258
```
@@ -308,6 +308,22 @@ see LICENSE for more information.
308308

309309
## Client Commands (Operations List)
310310

311+
<details>
312+
<summary>
313+
CreateLandingZone
314+
</summary>
315+
316+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/CreateLandingZoneCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/CreateLandingZoneCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/CreateLandingZoneCommandOutput/)
317+
318+
</details>
319+
<details>
320+
<summary>
321+
DeleteLandingZone
322+
</summary>
323+
324+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/DeleteLandingZoneCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/DeleteLandingZoneCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/DeleteLandingZoneCommandOutput/)
325+
326+
</details>
311327
<details>
312328
<summary>
313329
DisableControl
@@ -339,6 +355,22 @@ GetEnabledControl
339355

340356
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/GetEnabledControlCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetEnabledControlCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetEnabledControlCommandOutput/)
341357

358+
</details>
359+
<details>
360+
<summary>
361+
GetLandingZone
362+
</summary>
363+
364+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/GetLandingZoneCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetLandingZoneCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetLandingZoneCommandOutput/)
365+
366+
</details>
367+
<details>
368+
<summary>
369+
GetLandingZoneOperation
370+
</summary>
371+
372+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/GetLandingZoneOperationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetLandingZoneOperationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/GetLandingZoneOperationCommandOutput/)
373+
342374
</details>
343375
<details>
344376
<summary>
@@ -347,6 +379,14 @@ ListEnabledControls
347379

348380
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/ListEnabledControlsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListEnabledControlsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListEnabledControlsCommandOutput/)
349381

382+
</details>
383+
<details>
384+
<summary>
385+
ListLandingZones
386+
</summary>
387+
388+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/ListLandingZonesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListLandingZonesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListLandingZonesCommandOutput/)
389+
350390
</details>
351391
<details>
352392
<summary>
@@ -355,6 +395,14 @@ ListTagsForResource
355395

356396
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/ListTagsForResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListTagsForResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ListTagsForResourceCommandOutput/)
357397

398+
</details>
399+
<details>
400+
<summary>
401+
ResetLandingZone
402+
</summary>
403+
404+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/ResetLandingZoneCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ResetLandingZoneCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/ResetLandingZoneCommandOutput/)
405+
358406
</details>
359407
<details>
360408
<summary>
@@ -372,3 +420,11 @@ UntagResource
372420
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UntagResourceCommandOutput/)
373421

374422
</details>
423+
<details>
424+
<summary>
425+
UpdateLandingZone
426+
</summary>
427+
428+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controltower/command/UpdateLandingZoneCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UpdateLandingZoneCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controltower/Interface/UpdateLandingZoneCommandOutput/)
429+
430+
</details>

0 commit comments

Comments
 (0)