@aws-sdk/client-controltower 3.577.0 → 3.580.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 +66 -2
- package/dist-cjs/index.js +95 -13
- package/dist-es/ControlTower.js +2 -0
- package/dist-es/commands/ListControlOperationsCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +10 -10
- package/dist-es/pagination/ListControlOperationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +56 -0
- package/dist-types/ControlTower.d.ts +68 -3
- package/dist-types/ControlTowerClient.d.ts +62 -5
- package/dist-types/commands/DisableBaselineCommand.d.ts +3 -1
- package/dist-types/commands/EnableBaselineCommand.d.ts +3 -1
- package/dist-types/commands/GetBaselineCommand.d.ts +3 -1
- package/dist-types/commands/GetBaselineOperationCommand.d.ts +3 -1
- package/dist-types/commands/GetControlOperationCommand.d.ts +6 -2
- package/dist-types/commands/GetLandingZoneOperationCommand.d.ts +1 -1
- package/dist-types/commands/ListBaselinesCommand.d.ts +3 -1
- package/dist-types/commands/ListControlOperationsCommand.d.ts +102 -0
- package/dist-types/commands/ListEnabledBaselinesCommand.d.ts +3 -1
- package/dist-types/commands/ListEnabledControlsCommand.d.ts +13 -2
- package/dist-types/commands/ResetEnabledBaselineCommand.d.ts +3 -1
- package/dist-types/commands/UpdateEnabledBaselineCommand.d.ts +3 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +59 -3
- package/dist-types/models/models_0.d.ts +358 -195
- package/dist-types/pagination/ListControlOperationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/ControlTower.d.ts +19 -0
- package/dist-types/ts3.4/ControlTowerClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListControlOperationsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListEnabledControlsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +98 -61
- package/dist-types/ts3.4/pagination/ListControlOperationsPaginator.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 +12 -0
- package/package.json +1 -1
|
@@ -21,6 +21,7 @@ import { GetEnabledControlCommandInput, GetEnabledControlCommandOutput } from ".
|
|
|
21
21
|
import { GetLandingZoneCommandInput, GetLandingZoneCommandOutput } from "./commands/GetLandingZoneCommand";
|
|
22
22
|
import { GetLandingZoneOperationCommandInput, GetLandingZoneOperationCommandOutput } from "./commands/GetLandingZoneOperationCommand";
|
|
23
23
|
import { ListBaselinesCommandInput, ListBaselinesCommandOutput } from "./commands/ListBaselinesCommand";
|
|
24
|
+
import { ListControlOperationsCommandInput, ListControlOperationsCommandOutput } from "./commands/ListControlOperationsCommand";
|
|
24
25
|
import { ListEnabledBaselinesCommandInput, ListEnabledBaselinesCommandOutput } from "./commands/ListEnabledBaselinesCommand";
|
|
25
26
|
import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
|
|
26
27
|
import { ListLandingZonesCommandInput, ListLandingZonesCommandOutput } from "./commands/ListLandingZonesCommand";
|
|
@@ -38,11 +39,11 @@ export { __Client };
|
|
|
38
39
|
/**
|
|
39
40
|
* @public
|
|
40
41
|
*/
|
|
41
|
-
export type ServiceInputTypes = CreateLandingZoneCommandInput | DeleteLandingZoneCommandInput | DisableBaselineCommandInput | DisableControlCommandInput | EnableBaselineCommandInput | EnableControlCommandInput | GetBaselineCommandInput | GetBaselineOperationCommandInput | GetControlOperationCommandInput | GetEnabledBaselineCommandInput | GetEnabledControlCommandInput | GetLandingZoneCommandInput | GetLandingZoneOperationCommandInput | ListBaselinesCommandInput | ListEnabledBaselinesCommandInput | ListEnabledControlsCommandInput | ListLandingZonesCommandInput | ListTagsForResourceCommandInput | ResetEnabledBaselineCommandInput | ResetLandingZoneCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEnabledBaselineCommandInput | UpdateEnabledControlCommandInput | UpdateLandingZoneCommandInput;
|
|
42
|
+
export type ServiceInputTypes = CreateLandingZoneCommandInput | DeleteLandingZoneCommandInput | DisableBaselineCommandInput | DisableControlCommandInput | EnableBaselineCommandInput | EnableControlCommandInput | GetBaselineCommandInput | GetBaselineOperationCommandInput | GetControlOperationCommandInput | GetEnabledBaselineCommandInput | GetEnabledControlCommandInput | GetLandingZoneCommandInput | GetLandingZoneOperationCommandInput | ListBaselinesCommandInput | ListControlOperationsCommandInput | ListEnabledBaselinesCommandInput | ListEnabledControlsCommandInput | ListLandingZonesCommandInput | ListTagsForResourceCommandInput | ResetEnabledBaselineCommandInput | ResetLandingZoneCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEnabledBaselineCommandInput | UpdateEnabledControlCommandInput | UpdateLandingZoneCommandInput;
|
|
42
43
|
/**
|
|
43
44
|
* @public
|
|
44
45
|
*/
|
|
45
|
-
export type ServiceOutputTypes = CreateLandingZoneCommandOutput | DeleteLandingZoneCommandOutput | DisableBaselineCommandOutput | DisableControlCommandOutput | EnableBaselineCommandOutput | EnableControlCommandOutput | GetBaselineCommandOutput | GetBaselineOperationCommandOutput | GetControlOperationCommandOutput | GetEnabledBaselineCommandOutput | GetEnabledControlCommandOutput | GetLandingZoneCommandOutput | GetLandingZoneOperationCommandOutput | ListBaselinesCommandOutput | ListEnabledBaselinesCommandOutput | ListEnabledControlsCommandOutput | ListLandingZonesCommandOutput | ListTagsForResourceCommandOutput | ResetEnabledBaselineCommandOutput | ResetLandingZoneCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEnabledBaselineCommandOutput | UpdateEnabledControlCommandOutput | UpdateLandingZoneCommandOutput;
|
|
46
|
+
export type ServiceOutputTypes = CreateLandingZoneCommandOutput | DeleteLandingZoneCommandOutput | DisableBaselineCommandOutput | DisableControlCommandOutput | EnableBaselineCommandOutput | EnableControlCommandOutput | GetBaselineCommandOutput | GetBaselineOperationCommandOutput | GetControlOperationCommandOutput | GetEnabledBaselineCommandOutput | GetEnabledControlCommandOutput | GetLandingZoneCommandOutput | GetLandingZoneOperationCommandOutput | ListBaselinesCommandOutput | ListControlOperationsCommandOutput | ListEnabledBaselinesCommandOutput | ListEnabledControlsCommandOutput | ListLandingZonesCommandOutput | ListTagsForResourceCommandOutput | ResetEnabledBaselineCommandOutput | ResetLandingZoneCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEnabledBaselineCommandOutput | UpdateEnabledControlCommandOutput | UpdateLandingZoneCommandOutput;
|
|
46
47
|
/**
|
|
47
48
|
* @public
|
|
48
49
|
*/
|
|
@@ -176,7 +177,37 @@ export type ControlTowerClientResolvedConfigType = __SmithyResolvedConfiguration
|
|
|
176
177
|
export interface ControlTowerClientResolvedConfig extends ControlTowerClientResolvedConfigType {
|
|
177
178
|
}
|
|
178
179
|
/**
|
|
179
|
-
* <p>
|
|
180
|
+
* <p>Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:</p>
|
|
181
|
+
* <ul>
|
|
182
|
+
* <li>
|
|
183
|
+
* <p>
|
|
184
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">
|
|
185
|
+
* <i>controls</i>
|
|
186
|
+
* </a>
|
|
187
|
+
* </p>
|
|
188
|
+
* </li>
|
|
189
|
+
* <li>
|
|
190
|
+
* <p>
|
|
191
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
|
|
192
|
+
* <i>landing zones</i>
|
|
193
|
+
* </a>
|
|
194
|
+
* </p>
|
|
195
|
+
* </li>
|
|
196
|
+
* <li>
|
|
197
|
+
* <p>
|
|
198
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html">
|
|
199
|
+
* <i>baselines</i>
|
|
200
|
+
* </a>
|
|
201
|
+
* </p>
|
|
202
|
+
* </li>
|
|
203
|
+
* </ul>
|
|
204
|
+
* <p>For more information about these types of resources, see the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html">
|
|
205
|
+
* <i>Amazon Web Services Control Tower User Guide</i>
|
|
206
|
+
* </a>.</p>
|
|
207
|
+
* <p>
|
|
208
|
+
* <b>About control APIs</b>
|
|
209
|
+
* </p>
|
|
210
|
+
* <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
|
|
180
211
|
* <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
181
212
|
* <p>To call these APIs, you'll need to know:</p>
|
|
182
213
|
* <ul>
|
|
@@ -197,7 +228,7 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
197
228
|
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
198
229
|
* 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>
|
|
199
230
|
* <p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
|
|
200
|
-
* 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>
|
|
231
|
+
* 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> or the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables</a> in the <i>Amazon Web Services Control Tower User Guide.</i>
|
|
201
232
|
* </p>
|
|
202
233
|
* <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
|
|
203
234
|
* <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
|
|
@@ -229,6 +260,17 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
229
260
|
* <code>arn:$\{Partition\}:organizations::$\{MasterAccountId\}:ou/o-$\{OrganizationId\}/ou-$\{OrganizationalUnitId\}</code>
|
|
230
261
|
* </p>
|
|
231
262
|
* </note>
|
|
263
|
+
* <p>
|
|
264
|
+
* <b> About landing zone APIs</b>
|
|
265
|
+
* </p>
|
|
266
|
+
* <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>
|
|
267
|
+
* <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>
|
|
268
|
+
* <p>
|
|
269
|
+
* <b>About baseline APIs</b>
|
|
270
|
+
* </p>
|
|
271
|
+
* <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>
|
|
272
|
+
* <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>
|
|
273
|
+
* <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>
|
|
232
274
|
* <p class="title">
|
|
233
275
|
* <b>Details and examples</b>
|
|
234
276
|
* </p>
|
|
@@ -240,12 +282,27 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
|
|
|
240
282
|
* </li>
|
|
241
283
|
* <li>
|
|
242
284
|
* <p>
|
|
285
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input and output examples with CLI</a>
|
|
286
|
+
* </p>
|
|
287
|
+
* </li>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>
|
|
243
290
|
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with CloudFormation</a>
|
|
244
291
|
* </p>
|
|
245
292
|
* </li>
|
|
246
293
|
* <li>
|
|
247
294
|
* <p>
|
|
248
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/
|
|
295
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone with CloudFormation</a>
|
|
296
|
+
* </p>
|
|
297
|
+
* </li>
|
|
298
|
+
* <li>
|
|
299
|
+
* <p>
|
|
300
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Control metadata tables (large page)</a>
|
|
301
|
+
* </p>
|
|
302
|
+
* </li>
|
|
303
|
+
* <li>
|
|
304
|
+
* <p>
|
|
305
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables (large page)</a>
|
|
249
306
|
* </p>
|
|
250
307
|
* </li>
|
|
251
308
|
* <li>
|
|
@@ -26,7 +26,9 @@ declare const DisableBaselineCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Disable an <code>EnabledBaseline</code> resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline
|
|
29
|
+
* <p>Disable an <code>EnabledBaseline</code> resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -26,7 +26,9 @@ declare const EnableBaselineCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Enable (apply) a <code>Baseline</code> to a Target. This API starts an asynchronous operation to deploy resources specified by the <code>Baseline</code> to the specified Target
|
|
29
|
+
* <p>Enable (apply) a <code>Baseline</code> to a Target. This API starts an asynchronous operation to deploy resources specified by the <code>Baseline</code> to the specified Target. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -26,7 +26,9 @@ declare const GetBaselineCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Retrieve details about an existing <code>Baseline</code> resource by specifying its identifier
|
|
29
|
+
* <p>Retrieve details about an existing <code>Baseline</code> resource by specifying its identifier. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -26,7 +26,9 @@ declare const GetBaselineOperationCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: <code>EnableBaseline</code>, <code>DisableBaseline</code>, <code>UpdateEnabledBaseline</code>, <code>ResetEnabledBaseline</code>. A status message is displayed in case of operation failure
|
|
29
|
+
* <p>Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: <code>EnableBaseline</code>, <code>DisableBaseline</code>, <code>UpdateEnabledBaseline</code>, <code>ResetEnabledBaseline</code>. A status message is displayed in case of operation failure. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -44,11 +44,15 @@ declare const GetControlOperationCommand_base: {
|
|
|
44
44
|
* const response = await client.send(command);
|
|
45
45
|
* // { // GetControlOperationOutput
|
|
46
46
|
* // controlOperation: { // ControlOperation
|
|
47
|
-
* // operationType: "
|
|
47
|
+
* // operationType: "ENABLE_CONTROL" || "DISABLE_CONTROL" || "UPDATE_ENABLED_CONTROL",
|
|
48
48
|
* // startTime: new Date("TIMESTAMP"),
|
|
49
49
|
* // endTime: new Date("TIMESTAMP"),
|
|
50
|
-
* // status: "
|
|
50
|
+
* // status: "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
|
|
51
51
|
* // statusMessage: "STRING_VALUE",
|
|
52
|
+
* // operationIdentifier: "STRING_VALUE",
|
|
53
|
+
* // controlIdentifier: "STRING_VALUE",
|
|
54
|
+
* // targetIdentifier: "STRING_VALUE",
|
|
55
|
+
* // enabledControlIdentifier: "STRING_VALUE",
|
|
52
56
|
* // },
|
|
53
57
|
* // };
|
|
54
58
|
*
|
|
@@ -27,7 +27,7 @@ declare const GetLandingZoneOperationCommand_base: {
|
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
29
|
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for
|
|
30
|
-
*
|
|
30
|
+
* 90 days.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -26,7 +26,9 @@ declare const ListBaselinesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns a summary list of all available baselines
|
|
29
|
+
* <p>Returns a summary list of all available baselines. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
|
|
4
|
+
import { ListControlOperationsInput, ListControlOperationsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link ListControlOperationsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface ListControlOperationsCommandInput extends ListControlOperationsInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link ListControlOperationsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface ListControlOperationsCommandOutput extends ListControlOperationsOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const ListControlOperationsCommand_base: {
|
|
24
|
+
new (input: ListControlOperationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListControlOperationsCommandInput, ListControlOperationsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [ListControlOperationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListControlOperationsCommandInput, ListControlOperationsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>Provides a list of operations in progress or queued.</p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { ControlTowerClient, ListControlOperationsCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
34
|
+
* // const { ControlTowerClient, ListControlOperationsCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
35
|
+
* const client = new ControlTowerClient(config);
|
|
36
|
+
* const input = { // ListControlOperationsInput
|
|
37
|
+
* filter: { // ControlOperationFilter
|
|
38
|
+
* controlIdentifiers: [ // ControlIdentifiers
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* targetIdentifiers: [ // TargetIdentifiers
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* enabledControlIdentifiers: [ // EnabledControlIdentifiers
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* statuses: [ // ControlOperationStatuses
|
|
48
|
+
* "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
|
|
49
|
+
* ],
|
|
50
|
+
* controlOperationTypes: [ // ControlOperationTypes
|
|
51
|
+
* "ENABLE_CONTROL" || "DISABLE_CONTROL" || "UPDATE_ENABLED_CONTROL",
|
|
52
|
+
* ],
|
|
53
|
+
* },
|
|
54
|
+
* nextToken: "STRING_VALUE",
|
|
55
|
+
* maxResults: Number("int"),
|
|
56
|
+
* };
|
|
57
|
+
* const command = new ListControlOperationsCommand(input);
|
|
58
|
+
* const response = await client.send(command);
|
|
59
|
+
* // { // ListControlOperationsOutput
|
|
60
|
+
* // controlOperations: [ // ControlOperations // required
|
|
61
|
+
* // { // ControlOperationSummary
|
|
62
|
+
* // operationType: "ENABLE_CONTROL" || "DISABLE_CONTROL" || "UPDATE_ENABLED_CONTROL",
|
|
63
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
64
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
65
|
+
* // status: "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
|
|
66
|
+
* // statusMessage: "STRING_VALUE",
|
|
67
|
+
* // operationIdentifier: "STRING_VALUE",
|
|
68
|
+
* // controlIdentifier: "STRING_VALUE",
|
|
69
|
+
* // targetIdentifier: "STRING_VALUE",
|
|
70
|
+
* // enabledControlIdentifier: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // nextToken: "STRING_VALUE",
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @param ListControlOperationsCommandInput - {@link ListControlOperationsCommandInput}
|
|
79
|
+
* @returns {@link ListControlOperationsCommandOutput}
|
|
80
|
+
* @see {@link ListControlOperationsCommandInput} for command's `input` shape.
|
|
81
|
+
* @see {@link ListControlOperationsCommandOutput} for command's `response` shape.
|
|
82
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
85
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InternalServerException} (server fault)
|
|
88
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
91
|
+
* <p>The request was denied due to request throttling.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ValidationException} (client fault)
|
|
94
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ControlTowerServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class ListControlOperationsCommand extends ListControlOperationsCommand_base {
|
|
102
|
+
}
|
|
@@ -26,7 +26,9 @@ declare const ListEnabledBaselinesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns a list of summaries describing <code>EnabledBaseline</code> resources. You can filter the list by the corresponding <code>Baseline</code> or <code>Target</code> of the <code>EnabledBaseline</code> resources
|
|
29
|
+
* <p>Returns a list of summaries describing <code>EnabledBaseline</code> resources. You can filter the list by the corresponding <code>Baseline</code> or <code>Target</code> of the <code>EnabledBaseline</code> resources. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -22,7 +22,7 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
|
|
|
22
22
|
}
|
|
23
23
|
declare const ListEnabledControlsCommand_base: {
|
|
24
24
|
new (input: ListEnabledControlsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
-
new (
|
|
25
|
+
new (...[input]: [] | [ListEnabledControlsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput, ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
@@ -37,9 +37,20 @@ declare const ListEnabledControlsCommand_base: {
|
|
|
37
37
|
* // const { ControlTowerClient, ListEnabledControlsCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
38
38
|
* const client = new ControlTowerClient(config);
|
|
39
39
|
* const input = { // ListEnabledControlsInput
|
|
40
|
-
* targetIdentifier: "STRING_VALUE",
|
|
40
|
+
* targetIdentifier: "STRING_VALUE",
|
|
41
41
|
* nextToken: "STRING_VALUE",
|
|
42
42
|
* maxResults: Number("int"),
|
|
43
|
+
* filter: { // EnabledControlFilter
|
|
44
|
+
* controlIdentifiers: [ // ControlIdentifiers
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* statuses: [ // EnablementStatuses
|
|
48
|
+
* "SUCCEEDED" || "FAILED" || "UNDER_CHANGE",
|
|
49
|
+
* ],
|
|
50
|
+
* driftStatuses: [ // DriftStatuses
|
|
51
|
+
* "DRIFTED" || "IN_SYNC" || "NOT_CHECKING" || "UNKNOWN",
|
|
52
|
+
* ],
|
|
53
|
+
* },
|
|
43
54
|
* };
|
|
44
55
|
* const command = new ListEnabledControlsCommand(input);
|
|
45
56
|
* const response = await client.send(command);
|
|
@@ -26,7 +26,9 @@ declare const ResetEnabledBaselineCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Re-enables an <code>EnabledBaseline</code> resource. For example, this API can re-apply the existing <code>Baseline</code> after a new member account is moved to the target OU
|
|
29
|
+
* <p>Re-enables an <code>EnabledBaseline</code> resource. For example, this API can re-apply the existing <code>Baseline</code> after a new member account is moved to the target OU. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -26,7 +26,9 @@ declare const UpdateEnabledBaselineCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Updates an <code>EnabledBaseline</code> resource's applied parameters or version
|
|
29
|
+
* <p>Updates an <code>EnabledBaseline</code> resource's applied parameters or version. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">
|
|
30
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
31
|
+
* </a>.</p>
|
|
30
32
|
* @example
|
|
31
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
34
|
* ```javascript
|
|
@@ -12,6 +12,7 @@ export * from "./GetEnabledControlCommand";
|
|
|
12
12
|
export * from "./GetLandingZoneCommand";
|
|
13
13
|
export * from "./GetLandingZoneOperationCommand";
|
|
14
14
|
export * from "./ListBaselinesCommand";
|
|
15
|
+
export * from "./ListControlOperationsCommand";
|
|
15
16
|
export * from "./ListEnabledBaselinesCommand";
|
|
16
17
|
export * from "./ListEnabledControlsCommand";
|
|
17
18
|
export * from "./ListLandingZonesCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>
|
|
2
|
+
* <p>Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:</p>
|
|
3
|
+
* <ul>
|
|
4
|
+
* <li>
|
|
5
|
+
* <p>
|
|
6
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">
|
|
7
|
+
* <i>controls</i>
|
|
8
|
+
* </a>
|
|
9
|
+
* </p>
|
|
10
|
+
* </li>
|
|
11
|
+
* <li>
|
|
12
|
+
* <p>
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html">
|
|
14
|
+
* <i>landing zones</i>
|
|
15
|
+
* </a>
|
|
16
|
+
* </p>
|
|
17
|
+
* </li>
|
|
18
|
+
* <li>
|
|
19
|
+
* <p>
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html">
|
|
21
|
+
* <i>baselines</i>
|
|
22
|
+
* </a>
|
|
23
|
+
* </p>
|
|
24
|
+
* </li>
|
|
25
|
+
* </ul>
|
|
26
|
+
* <p>For more information about these types of resources, see the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html">
|
|
27
|
+
* <i>Amazon Web Services Control Tower User Guide</i>
|
|
28
|
+
* </a>.</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>About control APIs</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>These interfaces allow you to apply the Amazon Web Services library of pre-defined
|
|
3
33
|
* <i>controls</i> to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.</p>
|
|
4
34
|
* <p>To call these APIs, you'll need to know:</p>
|
|
5
35
|
* <ul>
|
|
@@ -20,7 +50,7 @@
|
|
|
20
50
|
* <p>The <code>controlIdentifier</code> is an ARN that is specified for each
|
|
21
51
|
* 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>
|
|
22
52
|
* <p>The <code>controlIdentifier</code> is unique in each Amazon Web Services Region for each control. You can
|
|
23
|
-
* 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>
|
|
53
|
+
* 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> or the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables</a> in the <i>Amazon Web Services Control Tower User Guide.</i>
|
|
24
54
|
* </p>
|
|
25
55
|
* <p>A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy <i>Strongly recommended</i> and
|
|
26
56
|
* <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
|
|
@@ -52,6 +82,17 @@
|
|
|
52
82
|
* <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
|
|
53
83
|
* </p>
|
|
54
84
|
* </note>
|
|
85
|
+
* <p>
|
|
86
|
+
* <b> About landing zone APIs</b>
|
|
87
|
+
* </p>
|
|
88
|
+
* <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>
|
|
89
|
+
* <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>
|
|
90
|
+
* <p>
|
|
91
|
+
* <b>About baseline APIs</b>
|
|
92
|
+
* </p>
|
|
93
|
+
* <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>
|
|
94
|
+
* <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>
|
|
95
|
+
* <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>
|
|
55
96
|
* <p class="title">
|
|
56
97
|
* <b>Details and examples</b>
|
|
57
98
|
* </p>
|
|
@@ -63,12 +104,27 @@
|
|
|
63
104
|
* </li>
|
|
64
105
|
* <li>
|
|
65
106
|
* <p>
|
|
107
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html">Baseline API input and output examples with CLI</a>
|
|
108
|
+
* </p>
|
|
109
|
+
* </li>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>
|
|
66
112
|
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with CloudFormation</a>
|
|
67
113
|
* </p>
|
|
68
114
|
* </li>
|
|
69
115
|
* <li>
|
|
70
116
|
* <p>
|
|
71
|
-
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/
|
|
117
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html">Launch a landing zone with CloudFormation</a>
|
|
118
|
+
* </p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>
|
|
122
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Control metadata tables (large page)</a>
|
|
123
|
+
* </p>
|
|
124
|
+
* </li>
|
|
125
|
+
* <li>
|
|
126
|
+
* <p>
|
|
127
|
+
* <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html">Control availability by Region tables (large page)</a>
|
|
72
128
|
* </p>
|
|
73
129
|
* </li>
|
|
74
130
|
* <li>
|