@aws-sdk/client-controltower 3.454.0 → 3.459.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -31
- package/dist-cjs/ControlTower.js +16 -0
- package/dist-cjs/commands/CreateLandingZoneCommand.js +51 -0
- package/dist-cjs/commands/DeleteLandingZoneCommand.js +51 -0
- package/dist-cjs/commands/GetLandingZoneCommand.js +51 -0
- package/dist-cjs/commands/GetLandingZoneOperationCommand.js +51 -0
- package/dist-cjs/commands/ListLandingZonesCommand.js +51 -0
- package/dist-cjs/commands/ResetLandingZoneCommand.js +51 -0
- package/dist-cjs/commands/UpdateEnabledControlCommand.js +51 -0
- package/dist-cjs/commands/UpdateLandingZoneCommand.js +51 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/models/models_0.js +22 -1
- package/dist-cjs/pagination/ListLandingZonesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +682 -56
- package/dist-es/ControlTower.js +16 -0
- package/dist-es/commands/CreateLandingZoneCommand.js +47 -0
- package/dist-es/commands/DeleteLandingZoneCommand.js +47 -0
- package/dist-es/commands/GetLandingZoneCommand.js +47 -0
- package/dist-es/commands/GetLandingZoneOperationCommand.js +47 -0
- package/dist-es/commands/ListLandingZonesCommand.js +47 -0
- package/dist-es/commands/ResetLandingZoneCommand.js +47 -0
- package/dist-es/commands/UpdateEnabledControlCommand.js +47 -0
- package/dist-es/commands/UpdateLandingZoneCommand.js +47 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +21 -0
- package/dist-es/pagination/ListLandingZonesPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +659 -49
- package/dist-types/ControlTower.d.ts +72 -16
- package/dist-types/ControlTowerClient.d.ts +26 -18
- package/dist-types/commands/CreateLandingZoneCommand.d.ts +94 -0
- package/dist-types/commands/DeleteLandingZoneCommand.d.ts +92 -0
- package/dist-types/commands/DisableControlCommand.d.ts +9 -9
- package/dist-types/commands/EnableControlCommand.d.ts +15 -9
- package/dist-types/commands/GetControlOperationCommand.d.ts +6 -6
- package/dist-types/commands/GetEnabledControlCommand.d.ts +14 -8
- package/dist-types/commands/GetLandingZoneCommand.d.ts +97 -0
- package/dist-types/commands/GetLandingZoneOperationCommand.d.ts +95 -0
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +9 -9
- package/dist-types/commands/ListLandingZonesCommand.d.ts +93 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
- package/dist-types/commands/ResetLandingZoneCommand.d.ts +92 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UpdateEnabledControlCommand.d.ts +107 -0
- package/dist-types/commands/UpdateLandingZoneCommand.d.ts +95 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/index.d.ts +16 -16
- package/dist-types/models/models_0.d.ts +472 -29
- package/dist-types/pagination/ListLandingZonesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +72 -0
- package/dist-types/ts3.4/ControlTower.d.ts +136 -0
- package/dist-types/ts3.4/ControlTowerClient.d.ts +50 -2
- package/dist-types/ts3.4/commands/CreateLandingZoneCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteLandingZoneCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetLandingZoneCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetLandingZoneOperationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListLandingZonesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ResetLandingZoneCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateEnabledControlCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateLandingZoneCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +117 -0
- package/dist-types/ts3.4/pagination/ListLandingZonesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
- package/package.json +3 -3
|
@@ -1,14 +1,34 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
|
+
import { CreateLandingZoneCommandInput, CreateLandingZoneCommandOutput } from "./commands/CreateLandingZoneCommand";
|
|
3
|
+
import { DeleteLandingZoneCommandInput, DeleteLandingZoneCommandOutput } from "./commands/DeleteLandingZoneCommand";
|
|
2
4
|
import { DisableControlCommandInput, DisableControlCommandOutput } from "./commands/DisableControlCommand";
|
|
3
5
|
import { EnableControlCommandInput, EnableControlCommandOutput } from "./commands/EnableControlCommand";
|
|
4
6
|
import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
|
|
5
7
|
import { GetEnabledControlCommandInput, GetEnabledControlCommandOutput } from "./commands/GetEnabledControlCommand";
|
|
8
|
+
import { GetLandingZoneCommandInput, GetLandingZoneCommandOutput } from "./commands/GetLandingZoneCommand";
|
|
9
|
+
import { GetLandingZoneOperationCommandInput, GetLandingZoneOperationCommandOutput } from "./commands/GetLandingZoneOperationCommand";
|
|
6
10
|
import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
|
|
11
|
+
import { ListLandingZonesCommandInput, ListLandingZonesCommandOutput } from "./commands/ListLandingZonesCommand";
|
|
7
12
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
13
|
+
import { ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput } from "./commands/ResetLandingZoneCommand";
|
|
8
14
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
9
15
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
16
|
+
import { UpdateEnabledControlCommandInput, UpdateEnabledControlCommandOutput } from "./commands/UpdateEnabledControlCommand";
|
|
17
|
+
import { UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput } from "./commands/UpdateLandingZoneCommand";
|
|
10
18
|
import { ControlTowerClient } from "./ControlTowerClient";
|
|
11
19
|
export interface ControlTower {
|
|
20
|
+
/**
|
|
21
|
+
* @see {@link CreateLandingZoneCommand}
|
|
22
|
+
*/
|
|
23
|
+
createLandingZone(args: CreateLandingZoneCommandInput, options?: __HttpHandlerOptions): Promise<CreateLandingZoneCommandOutput>;
|
|
24
|
+
createLandingZone(args: CreateLandingZoneCommandInput, cb: (err: any, data?: CreateLandingZoneCommandOutput) => void): void;
|
|
25
|
+
createLandingZone(args: CreateLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLandingZoneCommandOutput) => void): void;
|
|
26
|
+
/**
|
|
27
|
+
* @see {@link DeleteLandingZoneCommand}
|
|
28
|
+
*/
|
|
29
|
+
deleteLandingZone(args: DeleteLandingZoneCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLandingZoneCommandOutput>;
|
|
30
|
+
deleteLandingZone(args: DeleteLandingZoneCommandInput, cb: (err: any, data?: DeleteLandingZoneCommandOutput) => void): void;
|
|
31
|
+
deleteLandingZone(args: DeleteLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLandingZoneCommandOutput) => void): void;
|
|
12
32
|
/**
|
|
13
33
|
* @see {@link DisableControlCommand}
|
|
14
34
|
*/
|
|
@@ -33,18 +53,42 @@ export interface ControlTower {
|
|
|
33
53
|
getEnabledControl(args: GetEnabledControlCommandInput, options?: __HttpHandlerOptions): Promise<GetEnabledControlCommandOutput>;
|
|
34
54
|
getEnabledControl(args: GetEnabledControlCommandInput, cb: (err: any, data?: GetEnabledControlCommandOutput) => void): void;
|
|
35
55
|
getEnabledControl(args: GetEnabledControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnabledControlCommandOutput) => void): void;
|
|
56
|
+
/**
|
|
57
|
+
* @see {@link GetLandingZoneCommand}
|
|
58
|
+
*/
|
|
59
|
+
getLandingZone(args: GetLandingZoneCommandInput, options?: __HttpHandlerOptions): Promise<GetLandingZoneCommandOutput>;
|
|
60
|
+
getLandingZone(args: GetLandingZoneCommandInput, cb: (err: any, data?: GetLandingZoneCommandOutput) => void): void;
|
|
61
|
+
getLandingZone(args: GetLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLandingZoneCommandOutput) => void): void;
|
|
62
|
+
/**
|
|
63
|
+
* @see {@link GetLandingZoneOperationCommand}
|
|
64
|
+
*/
|
|
65
|
+
getLandingZoneOperation(args: GetLandingZoneOperationCommandInput, options?: __HttpHandlerOptions): Promise<GetLandingZoneOperationCommandOutput>;
|
|
66
|
+
getLandingZoneOperation(args: GetLandingZoneOperationCommandInput, cb: (err: any, data?: GetLandingZoneOperationCommandOutput) => void): void;
|
|
67
|
+
getLandingZoneOperation(args: GetLandingZoneOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLandingZoneOperationCommandOutput) => void): void;
|
|
36
68
|
/**
|
|
37
69
|
* @see {@link ListEnabledControlsCommand}
|
|
38
70
|
*/
|
|
39
71
|
listEnabledControls(args: ListEnabledControlsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnabledControlsCommandOutput>;
|
|
40
72
|
listEnabledControls(args: ListEnabledControlsCommandInput, cb: (err: any, data?: ListEnabledControlsCommandOutput) => void): void;
|
|
41
73
|
listEnabledControls(args: ListEnabledControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnabledControlsCommandOutput) => void): void;
|
|
74
|
+
/**
|
|
75
|
+
* @see {@link ListLandingZonesCommand}
|
|
76
|
+
*/
|
|
77
|
+
listLandingZones(args: ListLandingZonesCommandInput, options?: __HttpHandlerOptions): Promise<ListLandingZonesCommandOutput>;
|
|
78
|
+
listLandingZones(args: ListLandingZonesCommandInput, cb: (err: any, data?: ListLandingZonesCommandOutput) => void): void;
|
|
79
|
+
listLandingZones(args: ListLandingZonesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLandingZonesCommandOutput) => void): void;
|
|
42
80
|
/**
|
|
43
81
|
* @see {@link ListTagsForResourceCommand}
|
|
44
82
|
*/
|
|
45
83
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
46
84
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
47
85
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
86
|
+
/**
|
|
87
|
+
* @see {@link ResetLandingZoneCommand}
|
|
88
|
+
*/
|
|
89
|
+
resetLandingZone(args: ResetLandingZoneCommandInput, options?: __HttpHandlerOptions): Promise<ResetLandingZoneCommandOutput>;
|
|
90
|
+
resetLandingZone(args: ResetLandingZoneCommandInput, cb: (err: any, data?: ResetLandingZoneCommandOutput) => void): void;
|
|
91
|
+
resetLandingZone(args: ResetLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetLandingZoneCommandOutput) => void): void;
|
|
48
92
|
/**
|
|
49
93
|
* @see {@link TagResourceCommand}
|
|
50
94
|
*/
|
|
@@ -57,11 +101,23 @@ export interface ControlTower {
|
|
|
57
101
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
58
102
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
59
103
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
104
|
+
/**
|
|
105
|
+
* @see {@link UpdateEnabledControlCommand}
|
|
106
|
+
*/
|
|
107
|
+
updateEnabledControl(args: UpdateEnabledControlCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnabledControlCommandOutput>;
|
|
108
|
+
updateEnabledControl(args: UpdateEnabledControlCommandInput, cb: (err: any, data?: UpdateEnabledControlCommandOutput) => void): void;
|
|
109
|
+
updateEnabledControl(args: UpdateEnabledControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnabledControlCommandOutput) => void): void;
|
|
110
|
+
/**
|
|
111
|
+
* @see {@link UpdateLandingZoneCommand}
|
|
112
|
+
*/
|
|
113
|
+
updateLandingZone(args: UpdateLandingZoneCommandInput, options?: __HttpHandlerOptions): Promise<UpdateLandingZoneCommandOutput>;
|
|
114
|
+
updateLandingZone(args: UpdateLandingZoneCommandInput, cb: (err: any, data?: UpdateLandingZoneCommandOutput) => void): void;
|
|
115
|
+
updateLandingZone(args: UpdateLandingZoneCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLandingZoneCommandOutput) => void): void;
|
|
60
116
|
}
|
|
61
117
|
/**
|
|
62
118
|
* @public
|
|
63
|
-
* <p>These interfaces allow you to apply the
|
|
64
|
-
* <i>controls</i> to your organizational units, programmatically. In
|
|
119
|
+
* <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
|
|
120
|
+
* <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
65
121
|
* <p>To call these APIs, you'll need to know:</p>
|
|
66
122
|
* <ul>
|
|
67
123
|
* <li>
|
|
@@ -75,18 +131,18 @@ export interface ControlTower {
|
|
|
75
131
|
* </li>
|
|
76
132
|
* </ul>
|
|
77
133
|
* <p>
|
|
78
|
-
* <b>To get the <code>controlIdentifier</code> for your
|
|
134
|
+
* <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower
|
|
79
135
|
* control:</b>
|
|
80
136
|
* </p>
|
|
81
137
|
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
82
138
|
* 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>
|
|
83
|
-
* <p>The <code>controlIdentifier</code> is unique in each
|
|
84
|
-
* 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>
|
|
139
|
+
* <p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
|
|
140
|
+
* 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>
|
|
85
141
|
* </p>
|
|
86
|
-
* <p>A quick-reference list of control identifers for the
|
|
142
|
+
* <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
|
|
87
143
|
* <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
|
|
88
144
|
* APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
|
|
89
|
-
* of the <i>
|
|
145
|
+
* of the <i>Amazon Web Services Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
|
|
90
146
|
* cannot be added or removed.</p>
|
|
91
147
|
* <note>
|
|
92
148
|
* <p>
|
|
@@ -104,7 +160,7 @@ export interface ControlTower {
|
|
|
104
160
|
* <b>To get the <code>targetIdentifier</code>:</b>
|
|
105
161
|
* </p>
|
|
106
162
|
* <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
|
|
107
|
-
* <p>In the
|
|
163
|
+
* <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>
|
|
108
164
|
* <note>
|
|
109
165
|
* <p>
|
|
110
166
|
* <b>OU ARN format:</b>
|
|
@@ -149,7 +205,7 @@ export interface ControlTower {
|
|
|
149
205
|
* </li>
|
|
150
206
|
* <li>
|
|
151
207
|
* <p>
|
|
152
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating
|
|
208
|
+
* <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>
|
|
153
209
|
* </p>
|
|
154
210
|
* </li>
|
|
155
211
|
* </ul>
|
|
@@ -158,13 +214,13 @@ export interface ControlTower {
|
|
|
158
214
|
* <p>
|
|
159
215
|
* <b>Recording API Requests</b>
|
|
160
216
|
* </p>
|
|
161
|
-
* <p>
|
|
162
|
-
*
|
|
163
|
-
* CloudTrail, you can determine which requests the
|
|
164
|
-
* the request and when, and so on. For more about
|
|
165
|
-
* CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging
|
|
166
|
-
* Actions with
|
|
167
|
-
* CloudTrail, including how to turn it on and find your log files, see the
|
|
217
|
+
* <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your
|
|
218
|
+
* Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by
|
|
219
|
+
* CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made
|
|
220
|
+
* the request and when, and so on. For more about Amazon Web Services Control Tower and its support for
|
|
221
|
+
* CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower
|
|
222
|
+
* Actions with Amazon Web Services CloudTrail</a> in the Amazon Web Services Control Tower User Guide. To learn more about
|
|
223
|
+
* CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
|
|
168
224
|
* Guide.</p>
|
|
169
225
|
*/
|
|
170
226
|
export declare class ControlTower extends ControlTowerClient implements ControlTower {
|
|
@@ -8,25 +8,33 @@ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"
|
|
|
8
8
|
import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
|
|
9
9
|
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
10
10
|
import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
11
|
+
import { CreateLandingZoneCommandInput, CreateLandingZoneCommandOutput } from "./commands/CreateLandingZoneCommand";
|
|
12
|
+
import { DeleteLandingZoneCommandInput, DeleteLandingZoneCommandOutput } from "./commands/DeleteLandingZoneCommand";
|
|
11
13
|
import { DisableControlCommandInput, DisableControlCommandOutput } from "./commands/DisableControlCommand";
|
|
12
14
|
import { EnableControlCommandInput, EnableControlCommandOutput } from "./commands/EnableControlCommand";
|
|
13
15
|
import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
|
|
14
16
|
import { GetEnabledControlCommandInput, GetEnabledControlCommandOutput } from "./commands/GetEnabledControlCommand";
|
|
17
|
+
import { GetLandingZoneCommandInput, GetLandingZoneCommandOutput } from "./commands/GetLandingZoneCommand";
|
|
18
|
+
import { GetLandingZoneOperationCommandInput, GetLandingZoneOperationCommandOutput } from "./commands/GetLandingZoneOperationCommand";
|
|
15
19
|
import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
|
|
20
|
+
import { ListLandingZonesCommandInput, ListLandingZonesCommandOutput } from "./commands/ListLandingZonesCommand";
|
|
16
21
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
22
|
+
import { ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput } from "./commands/ResetLandingZoneCommand";
|
|
17
23
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
18
24
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
25
|
+
import { UpdateEnabledControlCommandInput, UpdateEnabledControlCommandOutput } from "./commands/UpdateEnabledControlCommand";
|
|
26
|
+
import { UpdateLandingZoneCommandInput, UpdateLandingZoneCommandOutput } from "./commands/UpdateLandingZoneCommand";
|
|
19
27
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
20
28
|
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
21
29
|
export { __Client };
|
|
22
30
|
/**
|
|
23
31
|
* @public
|
|
24
32
|
*/
|
|
25
|
-
export type ServiceInputTypes = DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | GetEnabledControlCommandInput | ListEnabledControlsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
|
|
33
|
+
export type ServiceInputTypes = CreateLandingZoneCommandInput | DeleteLandingZoneCommandInput | DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | GetEnabledControlCommandInput | GetLandingZoneCommandInput | GetLandingZoneOperationCommandInput | ListEnabledControlsCommandInput | ListLandingZonesCommandInput | ListTagsForResourceCommandInput | ResetLandingZoneCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEnabledControlCommandInput | UpdateLandingZoneCommandInput;
|
|
26
34
|
/**
|
|
27
35
|
* @public
|
|
28
36
|
*/
|
|
29
|
-
export type ServiceOutputTypes = DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | GetEnabledControlCommandOutput | ListEnabledControlsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
|
|
37
|
+
export type ServiceOutputTypes = CreateLandingZoneCommandOutput | DeleteLandingZoneCommandOutput | DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | GetEnabledControlCommandOutput | GetLandingZoneCommandOutput | GetLandingZoneOperationCommandOutput | ListEnabledControlsCommandOutput | ListLandingZonesCommandOutput | ListTagsForResourceCommandOutput | ResetLandingZoneCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEnabledControlCommandOutput | UpdateLandingZoneCommandOutput;
|
|
30
38
|
/**
|
|
31
39
|
* @public
|
|
32
40
|
*/
|
|
@@ -160,8 +168,8 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
160
168
|
}
|
|
161
169
|
/**
|
|
162
170
|
* @public
|
|
163
|
-
* <p>These interfaces allow you to apply the
|
|
164
|
-
* <i>controls</i> to your organizational units, programmatically. In
|
|
171
|
+
* <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
|
|
172
|
+
* <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
165
173
|
* <p>To call these APIs, you'll need to know:</p>
|
|
166
174
|
* <ul>
|
|
167
175
|
* <li>
|
|
@@ -175,18 +183,18 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
175
183
|
* </li>
|
|
176
184
|
* </ul>
|
|
177
185
|
* <p>
|
|
178
|
-
* <b>To get the <code>controlIdentifier</code> for your
|
|
186
|
+
* <b>To get the <code>controlIdentifier</code> for your Amazon Web Services Control Tower
|
|
179
187
|
* control:</b>
|
|
180
188
|
* </p>
|
|
181
189
|
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
182
190
|
* 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>
|
|
183
|
-
* <p>The <code>controlIdentifier</code> is unique in each
|
|
184
|
-
* 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>
|
|
191
|
+
* <p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
|
|
192
|
+
* 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>
|
|
185
193
|
* </p>
|
|
186
|
-
* <p>A quick-reference list of control identifers for the
|
|
194
|
+
* <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
|
|
187
195
|
* <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
|
|
188
196
|
* APIs and controls</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
|
|
189
|
-
* of the <i>
|
|
197
|
+
* of the <i>Amazon Web Services Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
|
|
190
198
|
* cannot be added or removed.</p>
|
|
191
199
|
* <note>
|
|
192
200
|
* <p>
|
|
@@ -204,7 +212,7 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
204
212
|
* <b>To get the <code>targetIdentifier</code>:</b>
|
|
205
213
|
* </p>
|
|
206
214
|
* <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
|
|
207
|
-
* <p>In the
|
|
215
|
+
* <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>
|
|
208
216
|
* <note>
|
|
209
217
|
* <p>
|
|
210
218
|
* <b>OU ARN format:</b>
|
|
@@ -249,7 +257,7 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
249
257
|
* </li>
|
|
250
258
|
* <li>
|
|
251
259
|
* <p>
|
|
252
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html">Creating
|
|
260
|
+
* <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>
|
|
253
261
|
* </p>
|
|
254
262
|
* </li>
|
|
255
263
|
* </ul>
|
|
@@ -258,13 +266,13 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
258
266
|
* <p>
|
|
259
267
|
* <b>Recording API Requests</b>
|
|
260
268
|
* </p>
|
|
261
|
-
* <p>
|
|
262
|
-
*
|
|
263
|
-
* CloudTrail, you can determine which requests the
|
|
264
|
-
* the request and when, and so on. For more about
|
|
265
|
-
* CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging
|
|
266
|
-
* Actions with
|
|
267
|
-
* CloudTrail, including how to turn it on and find your log files, see the
|
|
269
|
+
* <p>Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your
|
|
270
|
+
* Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by
|
|
271
|
+
* CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made
|
|
272
|
+
* the request and when, and so on. For more about Amazon Web Services Control Tower and its support for
|
|
273
|
+
* CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging Amazon Web Services Control Tower
|
|
274
|
+
* Actions with Amazon Web Services CloudTrail</a> in the Amazon Web Services Control Tower User Guide. To learn more about
|
|
275
|
+
* CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User
|
|
268
276
|
* Guide.</p>
|
|
269
277
|
*/
|
|
270
278
|
export declare class ControlTowerClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ControlTowerClientResolvedConfig> {
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
|
|
5
|
+
import { CreateLandingZoneInput, CreateLandingZoneOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateLandingZoneCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateLandingZoneCommandInput extends CreateLandingZoneInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateLandingZoneCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateLandingZoneCommandOutput extends CreateLandingZoneOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone,
|
|
27
|
+
* based on the parameters specified in the manifest JSON file.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ControlTowerClient, CreateLandingZoneCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
32
|
+
* // const { ControlTowerClient, CreateLandingZoneCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
33
|
+
* const client = new ControlTowerClient(config);
|
|
34
|
+
* const input = { // CreateLandingZoneInput
|
|
35
|
+
* version: "STRING_VALUE", // required
|
|
36
|
+
* manifest: "DOCUMENT_VALUE", // required
|
|
37
|
+
* tags: { // TagMap
|
|
38
|
+
* "<keys>": "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* };
|
|
41
|
+
* const command = new CreateLandingZoneCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // CreateLandingZoneOutput
|
|
44
|
+
* // arn: "STRING_VALUE", // required
|
|
45
|
+
* // operationIdentifier: "STRING_VALUE", // required
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param CreateLandingZoneCommandInput - {@link CreateLandingZoneCommandInput}
|
|
51
|
+
* @returns {@link CreateLandingZoneCommandOutput}
|
|
52
|
+
* @see {@link CreateLandingZoneCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link CreateLandingZoneCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ConflictException} (client fault)
|
|
60
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
+
* <p>The request was denied due to request throttling.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ControlTowerServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
export declare class CreateLandingZoneCommand extends $Command<CreateLandingZoneCommandInput, CreateLandingZoneCommandOutput, ControlTowerClientResolvedConfig> {
|
|
76
|
+
readonly input: CreateLandingZoneCommandInput;
|
|
77
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
constructor(input: CreateLandingZoneCommandInput);
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLandingZoneCommandInput, CreateLandingZoneCommandOutput>;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private serialize;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
private deserialize;
|
|
94
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
|
|
5
|
+
import { DeleteLandingZoneInput, DeleteLandingZoneOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteLandingZoneCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteLandingZoneCommandInput extends DeleteLandingZoneInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteLandingZoneCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteLandingZoneCommandOutput extends DeleteLandingZoneOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower
|
|
27
|
+
* resources deployed in accounts managed by Amazon Web Services Control Tower.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ControlTowerClient, DeleteLandingZoneCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
32
|
+
* // const { ControlTowerClient, DeleteLandingZoneCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
33
|
+
* const client = new ControlTowerClient(config);
|
|
34
|
+
* const input = { // DeleteLandingZoneInput
|
|
35
|
+
* landingZoneIdentifier: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new DeleteLandingZoneCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // DeleteLandingZoneOutput
|
|
40
|
+
* // operationIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param DeleteLandingZoneCommandInput - {@link DeleteLandingZoneCommandInput}
|
|
46
|
+
* @returns {@link DeleteLandingZoneCommandOutput}
|
|
47
|
+
* @see {@link DeleteLandingZoneCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link DeleteLandingZoneCommandOutput} for command's `response` shape.
|
|
49
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
52
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ConflictException} (client fault)
|
|
55
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* <p>The request references a resource that does not exist.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
+
* <p>The request was denied due to request throttling.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ControlTowerServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
71
|
+
*
|
|
72
|
+
*/
|
|
73
|
+
export declare class DeleteLandingZoneCommand extends $Command<DeleteLandingZoneCommandInput, DeleteLandingZoneCommandOutput, ControlTowerClientResolvedConfig> {
|
|
74
|
+
readonly input: DeleteLandingZoneCommandInput;
|
|
75
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
constructor(input: DeleteLandingZoneCommandInput);
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteLandingZoneCommandInput, DeleteLandingZoneCommandOutput>;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
87
|
+
private serialize;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
private deserialize;
|
|
92
|
+
}
|
|
@@ -23,10 +23,10 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>This API call turns off a control. It starts an asynchronous operation that deletes
|
|
26
|
+
* <p>This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services
|
|
27
27
|
* resources on the specified organizational unit and the accounts it contains. The resources
|
|
28
28
|
* will vary according to the control that you specify. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
29
|
-
* <i>the
|
|
29
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
30
30
|
* </a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,25 +53,25 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
|
|
|
53
53
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
-
* <p>
|
|
56
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>Updating or deleting
|
|
59
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
* <p>
|
|
62
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
* <p>
|
|
65
|
+
* <p>The request references a resource that does not exist.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
68
|
-
* <p>
|
|
68
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
-
* <p>
|
|
71
|
+
* <p>The request was denied due to request throttling.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link ValidationException} (client fault)
|
|
74
|
-
* <p>The input
|
|
74
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ControlTowerServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -23,10 +23,10 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>This API call activates a control. It starts an asynchronous operation that creates
|
|
26
|
+
* <p>This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services
|
|
27
27
|
* resources on the specified organizational unit and the accounts it contains. The resources
|
|
28
28
|
* created will vary according to the control that you specify. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
29
|
-
* <i>the
|
|
29
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
30
30
|
* </a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -40,6 +40,12 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
|
|
|
40
40
|
* tags: { // TagMap
|
|
41
41
|
* "<keys>": "STRING_VALUE",
|
|
42
42
|
* },
|
|
43
|
+
* parameters: [ // EnabledControlParameters
|
|
44
|
+
* { // EnabledControlParameter
|
|
45
|
+
* key: "STRING_VALUE", // required
|
|
46
|
+
* value: "DOCUMENT_VALUE", // required
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
43
49
|
* };
|
|
44
50
|
* const command = new EnableControlCommand(input);
|
|
45
51
|
* const response = await client.send(command);
|
|
@@ -57,25 +63,25 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
|
|
|
57
63
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
58
64
|
*
|
|
59
65
|
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
-
* <p>
|
|
66
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
61
67
|
*
|
|
62
68
|
* @throws {@link ConflictException} (client fault)
|
|
63
|
-
* <p>Updating or deleting
|
|
69
|
+
* <p>Updating or deleting the resource can cause an inconsistent state.</p>
|
|
64
70
|
*
|
|
65
71
|
* @throws {@link InternalServerException} (server fault)
|
|
66
|
-
* <p>
|
|
72
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
67
73
|
*
|
|
68
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
-
* <p>
|
|
75
|
+
* <p>The request references a resource that does not exist.</p>
|
|
70
76
|
*
|
|
71
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
72
|
-
* <p>
|
|
78
|
+
* <p>The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
|
|
73
79
|
*
|
|
74
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
-
* <p>
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
76
82
|
*
|
|
77
83
|
* @throws {@link ValidationException} (client fault)
|
|
78
|
-
* <p>The input
|
|
84
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
79
85
|
*
|
|
80
86
|
* @throws {@link ControlTowerServiceException}
|
|
81
87
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -26,7 +26,7 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
|
|
|
26
26
|
* <p>Returns the status of a particular <code>EnableControl</code> or
|
|
27
27
|
* <code>DisableControl</code> operation. Displays a message in case of error. Details for an
|
|
28
28
|
* operation are available for 90 days. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
29
|
-
* <i>the
|
|
29
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
30
30
|
* </a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -58,19 +58,19 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
|
|
|
58
58
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
-
* <p>
|
|
61
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link InternalServerException} (server fault)
|
|
64
|
-
* <p>
|
|
64
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
-
* <p>
|
|
67
|
+
* <p>The request references a resource that does not exist.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
-
* <p>
|
|
70
|
+
* <p>The request was denied due to request throttling.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ValidationException} (client fault)
|
|
73
|
-
* <p>The input
|
|
73
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ControlTowerServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|