@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
|
@@ -24,7 +24,7 @@ export interface GetEnabledControlCommandOutput extends GetEnabledControlOutput,
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Retrieves details about an enabled control. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
-
* <i>the
|
|
27
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
28
28
|
* </a>.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -48,12 +48,18 @@ export interface GetEnabledControlCommandOutput extends GetEnabledControlOutput,
|
|
|
48
48
|
* // },
|
|
49
49
|
* // ],
|
|
50
50
|
* // statusSummary: { // EnablementStatusSummary
|
|
51
|
-
* // status: "
|
|
51
|
+
* // status: "SUCCEEDED" || "FAILED" || "UNDER_CHANGE",
|
|
52
52
|
* // lastOperationIdentifier: "STRING_VALUE",
|
|
53
53
|
* // },
|
|
54
54
|
* // driftStatusSummary: { // DriftStatusSummary
|
|
55
|
-
* // driftStatus: "
|
|
55
|
+
* // driftStatus: "DRIFTED" || "IN_SYNC" || "NOT_CHECKING" || "UNKNOWN",
|
|
56
56
|
* // },
|
|
57
|
+
* // parameters: [ // EnabledControlParameterSummaries
|
|
58
|
+
* // { // EnabledControlParameterSummary
|
|
59
|
+
* // key: "STRING_VALUE", // required
|
|
60
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
57
63
|
* // },
|
|
58
64
|
* // };
|
|
59
65
|
*
|
|
@@ -66,19 +72,19 @@ export interface GetEnabledControlCommandOutput extends GetEnabledControlOutput,
|
|
|
66
72
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
67
73
|
*
|
|
68
74
|
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
-
* <p>
|
|
75
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
70
76
|
*
|
|
71
77
|
* @throws {@link InternalServerException} (server fault)
|
|
72
|
-
* <p>
|
|
78
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
73
79
|
*
|
|
74
80
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
-
* <p>
|
|
81
|
+
* <p>The request references a resource that does not exist.</p>
|
|
76
82
|
*
|
|
77
83
|
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
-
* <p>
|
|
84
|
+
* <p>The request was denied due to request throttling.</p>
|
|
79
85
|
*
|
|
80
86
|
* @throws {@link ValidationException} (client fault)
|
|
81
|
-
* <p>The input
|
|
87
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
82
88
|
*
|
|
83
89
|
* @throws {@link ControlTowerServiceException}
|
|
84
90
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -0,0 +1,97 @@
|
|
|
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 { GetLandingZoneInput, GetLandingZoneOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetLandingZoneCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetLandingZoneCommandInput extends GetLandingZoneInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetLandingZoneCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetLandingZoneCommandOutput extends GetLandingZoneOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns details about the landing zone. Displays a message in case of error.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { ControlTowerClient, GetLandingZoneCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
31
|
+
* // const { ControlTowerClient, GetLandingZoneCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
32
|
+
* const client = new ControlTowerClient(config);
|
|
33
|
+
* const input = { // GetLandingZoneInput
|
|
34
|
+
* landingZoneIdentifier: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetLandingZoneCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetLandingZoneOutput
|
|
39
|
+
* // landingZone: { // LandingZoneDetail
|
|
40
|
+
* // version: "STRING_VALUE", // required
|
|
41
|
+
* // manifest: "DOCUMENT_VALUE", // required
|
|
42
|
+
* // arn: "STRING_VALUE",
|
|
43
|
+
* // status: "ACTIVE" || "PROCESSING" || "FAILED",
|
|
44
|
+
* // latestAvailableVersion: "STRING_VALUE",
|
|
45
|
+
* // driftStatus: { // LandingZoneDriftStatusSummary
|
|
46
|
+
* // status: "DRIFTED" || "IN_SYNC",
|
|
47
|
+
* // },
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param GetLandingZoneCommandInput - {@link GetLandingZoneCommandInput}
|
|
54
|
+
* @returns {@link GetLandingZoneCommandOutput}
|
|
55
|
+
* @see {@link GetLandingZoneCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link GetLandingZoneCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The request references a resource that does not exist.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ControlTowerServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
76
|
+
*
|
|
77
|
+
*/
|
|
78
|
+
export declare class GetLandingZoneCommand extends $Command<GetLandingZoneCommandInput, GetLandingZoneCommandOutput, ControlTowerClientResolvedConfig> {
|
|
79
|
+
readonly input: GetLandingZoneCommandInput;
|
|
80
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
constructor(input: GetLandingZoneCommandInput);
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLandingZoneCommandInput, GetLandingZoneCommandOutput>;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
private serialize;
|
|
93
|
+
/**
|
|
94
|
+
* @internal
|
|
95
|
+
*/
|
|
96
|
+
private deserialize;
|
|
97
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
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 { GetLandingZoneOperationInput, GetLandingZoneOperationOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetLandingZoneOperationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetLandingZoneOperationCommandInput extends GetLandingZoneOperationInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetLandingZoneOperationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetLandingZoneOperationCommandOutput extends GetLandingZoneOperationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns the status of the specified landing zone operation. Details for an operation are available for
|
|
27
|
+
* 60 days.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ControlTowerClient, GetLandingZoneOperationCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
32
|
+
* // const { ControlTowerClient, GetLandingZoneOperationCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
33
|
+
* const client = new ControlTowerClient(config);
|
|
34
|
+
* const input = { // GetLandingZoneOperationInput
|
|
35
|
+
* operationIdentifier: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new GetLandingZoneOperationCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // GetLandingZoneOperationOutput
|
|
40
|
+
* // operationDetails: { // LandingZoneOperationDetail
|
|
41
|
+
* // operationType: "DELETE" || "CREATE" || "UPDATE" || "RESET",
|
|
42
|
+
* // startTime: new Date("TIMESTAMP"),
|
|
43
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
44
|
+
* // status: "SUCCEEDED" || "FAILED" || "IN_PROGRESS",
|
|
45
|
+
* // statusMessage: "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetLandingZoneOperationCommandInput - {@link GetLandingZoneOperationCommandInput}
|
|
52
|
+
* @returns {@link GetLandingZoneOperationCommandOutput}
|
|
53
|
+
* @see {@link GetLandingZoneOperationCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetLandingZoneOperationCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalServerException} (server fault)
|
|
61
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>The request references a resource that does not exist.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
67
|
+
* <p>The request was denied due to request throttling.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ValidationException} (client fault)
|
|
70
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ControlTowerServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
74
|
+
*
|
|
75
|
+
*/
|
|
76
|
+
export declare class GetLandingZoneOperationCommand extends $Command<GetLandingZoneOperationCommandInput, GetLandingZoneOperationCommandOutput, ControlTowerClientResolvedConfig> {
|
|
77
|
+
readonly input: GetLandingZoneOperationCommandInput;
|
|
78
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
constructor(input: GetLandingZoneOperationCommandInput);
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLandingZoneOperationCommandInput, GetLandingZoneOperationCommandOutput>;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
private serialize;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
private deserialize;
|
|
95
|
+
}
|
|
@@ -23,9 +23,9 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists the controls enabled by
|
|
26
|
+
* <p>Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and
|
|
27
27
|
* the accounts it contains. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
28
|
-
* <i>the
|
|
28
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
29
29
|
* </a>.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -47,11 +47,11 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
|
|
|
47
47
|
* // arn: "STRING_VALUE",
|
|
48
48
|
* // targetIdentifier: "STRING_VALUE",
|
|
49
49
|
* // statusSummary: { // EnablementStatusSummary
|
|
50
|
-
* // status: "
|
|
50
|
+
* // status: "SUCCEEDED" || "FAILED" || "UNDER_CHANGE",
|
|
51
51
|
* // lastOperationIdentifier: "STRING_VALUE",
|
|
52
52
|
* // },
|
|
53
53
|
* // driftStatusSummary: { // DriftStatusSummary
|
|
54
|
-
* // driftStatus: "
|
|
54
|
+
* // driftStatus: "DRIFTED" || "IN_SYNC" || "NOT_CHECKING" || "UNKNOWN",
|
|
55
55
|
* // },
|
|
56
56
|
* // },
|
|
57
57
|
* // ],
|
|
@@ -67,19 +67,19 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
|
|
|
67
67
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
-
* <p>
|
|
70
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InternalServerException} (server fault)
|
|
73
|
-
* <p>
|
|
73
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
-
* <p>
|
|
76
|
+
* <p>The request references a resource that does not exist.</p>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link ThrottlingException} (client fault)
|
|
79
|
-
* <p>
|
|
79
|
+
* <p>The request was denied due to request throttling.</p>
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link ValidationException} (client fault)
|
|
82
|
-
* <p>The input
|
|
82
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link ControlTowerServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { ListLandingZonesInput, ListLandingZonesOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListLandingZonesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListLandingZonesCommandInput extends ListLandingZonesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListLandingZonesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListLandingZonesCommandOutput extends ListLandingZonesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns the landing zone ARN for the landing zone deployed in your managed account. This API also
|
|
27
|
+
* creates an ARN for existing accounts that do not yet have a landing zone ARN. </p>
|
|
28
|
+
* <p>Returns one landing zone ARN.</p>
|
|
29
|
+
* @example
|
|
30
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
31
|
+
* ```javascript
|
|
32
|
+
* import { ControlTowerClient, ListLandingZonesCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
33
|
+
* // const { ControlTowerClient, ListLandingZonesCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
34
|
+
* const client = new ControlTowerClient(config);
|
|
35
|
+
* const input = { // ListLandingZonesInput
|
|
36
|
+
* nextToken: "STRING_VALUE",
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ListLandingZonesCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ListLandingZonesOutput
|
|
42
|
+
* // landingZones: [ // LandingZoneSummaries // required
|
|
43
|
+
* // { // LandingZoneSummary
|
|
44
|
+
* // arn: "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // ],
|
|
47
|
+
* // nextToken: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param ListLandingZonesCommandInput - {@link ListLandingZonesCommandInput}
|
|
53
|
+
* @returns {@link ListLandingZonesCommandOutput}
|
|
54
|
+
* @see {@link ListLandingZonesCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link ListLandingZonesCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerException} (server fault)
|
|
62
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
+
* <p>The request was denied due to request throttling.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ValidationException} (client fault)
|
|
68
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ControlTowerServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
export declare class ListLandingZonesCommand extends $Command<ListLandingZonesCommandInput, ListLandingZonesCommandOutput, ControlTowerClientResolvedConfig> {
|
|
75
|
+
readonly input: ListLandingZonesCommandInput;
|
|
76
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
constructor(input: ListLandingZonesCommandInput);
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
*/
|
|
84
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListLandingZonesCommandInput, ListLandingZonesCommandOutput>;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
private serialize;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
private deserialize;
|
|
93
|
+
}
|
|
@@ -24,7 +24,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a list of tags associated with the resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
-
* <i>the
|
|
27
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
28
28
|
* </a>.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -52,13 +52,13 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
|
|
|
52
52
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link InternalServerException} (server fault)
|
|
55
|
-
* <p>
|
|
55
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
58
|
-
* <p>
|
|
58
|
+
* <p>The request references a resource that does not exist.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ValidationException} (client fault)
|
|
61
|
-
* <p>The input
|
|
61
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ControlTowerServiceException}
|
|
64
64
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -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 { ResetLandingZoneInput, ResetLandingZoneOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ResetLandingZoneCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ResetLandingZoneCommandInput extends ResetLandingZoneInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ResetLandingZoneCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ResetLandingZoneCommandOutput extends ResetLandingZoneOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>This API call resets a landing zone. It starts an asynchronous operation that resets the
|
|
27
|
+
* landing zone to the parameters specified in its original configuration.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ControlTowerClient, ResetLandingZoneCommand } from "@aws-sdk/client-controltower"; // ES Modules import
|
|
32
|
+
* // const { ControlTowerClient, ResetLandingZoneCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
|
|
33
|
+
* const client = new ControlTowerClient(config);
|
|
34
|
+
* const input = { // ResetLandingZoneInput
|
|
35
|
+
* landingZoneIdentifier: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new ResetLandingZoneCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // ResetLandingZoneOutput
|
|
40
|
+
* // operationIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param ResetLandingZoneCommandInput - {@link ResetLandingZoneCommandInput}
|
|
46
|
+
* @returns {@link ResetLandingZoneCommandOutput}
|
|
47
|
+
* @see {@link ResetLandingZoneCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link ResetLandingZoneCommandOutput} 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 ResetLandingZoneCommand extends $Command<ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput, ControlTowerClientResolvedConfig> {
|
|
74
|
+
readonly input: ResetLandingZoneCommandInput;
|
|
75
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
constructor(input: ResetLandingZoneCommandInput);
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ResetLandingZoneCommandInput, ResetLandingZoneCommandOutput>;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
87
|
+
private serialize;
|
|
88
|
+
/**
|
|
89
|
+
* @internal
|
|
90
|
+
*/
|
|
91
|
+
private deserialize;
|
|
92
|
+
}
|
|
@@ -24,7 +24,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Applies tags to a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
-
* <i>the
|
|
27
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
28
28
|
* </a>.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -51,13 +51,13 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
51
51
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
52
52
|
*
|
|
53
53
|
* @throws {@link InternalServerException} (server fault)
|
|
54
|
-
* <p>
|
|
54
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
|
-
* <p>
|
|
57
|
+
* <p>The request references a resource that does not exist.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ValidationException} (client fault)
|
|
60
|
-
* <p>The input
|
|
60
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ControlTowerServiceException}
|
|
63
63
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|
|
@@ -24,7 +24,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Removes tags from a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
|
|
27
|
-
* <i>the
|
|
27
|
+
* <i>the Amazon Web Services Control Tower User Guide</i>
|
|
28
28
|
* </a>.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -51,13 +51,13 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
|
|
|
51
51
|
* @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
|
|
52
52
|
*
|
|
53
53
|
* @throws {@link InternalServerException} (server fault)
|
|
54
|
-
* <p>
|
|
54
|
+
* <p>An unexpected error occurred during processing of a request.</p>
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
57
|
-
* <p>
|
|
57
|
+
* <p>The request references a resource that does not exist.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ValidationException} (client fault)
|
|
60
|
-
* <p>The input
|
|
60
|
+
* <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ControlTowerServiceException}
|
|
63
63
|
* <p>Base exception class for all service exceptions from ControlTower service.</p>
|