@aws-sdk/client-controltower 3.295.0 → 3.297.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.
@@ -5,6 +5,7 @@ import { GetControlOperationCommandInput, GetControlOperationCommandOutput } fro
5
5
  import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
6
6
  import { ControlTowerClient } from "./ControlTowerClient";
7
7
  /**
8
+ * @public
8
9
  * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
9
10
  * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
10
11
  * <p>To call these APIs, you'll need to know:</p>
@@ -24,7 +25,7 @@ import { ControlTowerClient } from "./ControlTowerClient";
24
25
  * <note>
25
26
  * <p>
26
27
  * <b>ARN format:</b>
27
- * <code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
28
+ * <code>arn:aws:controltower:\{REGION\}::control/\{CONTROL_NAME\}</code>
28
29
  * </p>
29
30
  * <p>
30
31
  * <b>Example:</b>
@@ -42,7 +43,7 @@ import { ControlTowerClient } from "./ControlTowerClient";
42
43
  * <b>OU ARN format:</b>
43
44
  * </p>
44
45
  * <p>
45
- * <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
46
+ * <code>arn:$\{Partition\}:organizations::$\{MasterAccountId\}:ou/o-$\{OrganizationId\}/ou-$\{OrganizationalUnitId\}</code>
46
47
  * </p>
47
48
  * </note>
48
49
  * <p class="title">
@@ -79,6 +80,7 @@ import { ControlTowerClient } from "./ControlTowerClient";
79
80
  */
80
81
  export declare class ControlTower extends ControlTowerClient {
81
82
  /**
83
+ * @public
82
84
  * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified
83
85
  * organizational unit and the accounts it contains. The resources will vary according to the
84
86
  * control that you specify.</p>
@@ -87,6 +89,7 @@ export declare class ControlTower extends ControlTowerClient {
87
89
  disableControl(args: DisableControlCommandInput, cb: (err: any, data?: DisableControlCommandOutput) => void): void;
88
90
  disableControl(args: DisableControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableControlCommandOutput) => void): void;
89
91
  /**
92
+ * @public
90
93
  * <p>This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified
91
94
  * organizational unit and the accounts it contains. The resources created will vary according to
92
95
  * the control that you specify.</p>
@@ -95,6 +98,7 @@ export declare class ControlTower extends ControlTowerClient {
95
98
  enableControl(args: EnableControlCommandInput, cb: (err: any, data?: EnableControlCommandOutput) => void): void;
96
99
  enableControl(args: EnableControlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableControlCommandOutput) => void): void;
97
100
  /**
101
+ * @public
98
102
  * <p>Returns the status of a particular <code>EnableControl</code> or
99
103
  * <code>DisableControl</code> operation. Displays a message in case of error.
100
104
  * Details for an operation are available for 90 days.</p>
@@ -103,6 +107,7 @@ export declare class ControlTower extends ControlTowerClient {
103
107
  getControlOperation(args: GetControlOperationCommandInput, cb: (err: any, data?: GetControlOperationCommandOutput) => void): void;
104
108
  getControlOperation(args: GetControlOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetControlOperationCommandOutput) => void): void;
105
109
  /**
110
+ * @public
106
111
  * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
107
112
  * the accounts it contains.</p>
108
113
  */
@@ -12,15 +12,24 @@ import { EnableControlCommandInput, EnableControlCommandOutput } from "./command
12
12
  import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
13
13
  import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
14
14
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
15
+ /**
16
+ * @public
17
+ */
15
18
  export type ServiceInputTypes = DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | ListEnabledControlsCommandInput;
19
+ /**
20
+ * @public
21
+ */
16
22
  export type ServiceOutputTypes = DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | ListEnabledControlsCommandOutput;
23
+ /**
24
+ * @public
25
+ */
17
26
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
18
27
  /**
19
28
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
20
29
  */
21
30
  requestHandler?: __HttpHandler;
22
31
  /**
23
- * A constructor for a class implementing the {@link __Checksum} interface
32
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
24
33
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
25
34
  * @internal
26
35
  */
@@ -110,23 +119,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
110
119
  */
111
120
  logger?: __Logger;
112
121
  /**
113
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
114
123
  */
115
124
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
116
125
  }
126
+ /**
127
+ * @public
128
+ */
117
129
  type ControlTowerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
118
130
  /**
119
- * The configuration interface of ControlTowerClient class constructor that set the region, credentials and other options.
131
+ * @public
132
+ *
133
+ * The configuration interface of ControlTowerClient class constructor that set the region, credentials and other options.
120
134
  */
121
135
  export interface ControlTowerClientConfig extends ControlTowerClientConfigType {
122
136
  }
137
+ /**
138
+ * @public
139
+ */
123
140
  type ControlTowerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
124
141
  /**
125
- * The resolved configuration interface of ControlTowerClient class. This is resolved and normalized from the {@link ControlTowerClientConfig | constructor configuration interface}.
142
+ * @public
143
+ *
144
+ * The resolved configuration interface of ControlTowerClient class. This is resolved and normalized from the {@link ControlTowerClientConfig | constructor configuration interface}.
126
145
  */
127
146
  export interface ControlTowerClientResolvedConfig extends ControlTowerClientResolvedConfigType {
128
147
  }
129
148
  /**
149
+ * @public
130
150
  * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
131
151
  * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
132
152
  * <p>To call these APIs, you'll need to know:</p>
@@ -146,7 +166,7 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
146
166
  * <note>
147
167
  * <p>
148
168
  * <b>ARN format:</b>
149
- * <code>arn:aws:controltower:{REGION}::control/{CONTROL_NAME}</code>
169
+ * <code>arn:aws:controltower:\{REGION\}::control/\{CONTROL_NAME\}</code>
150
170
  * </p>
151
171
  * <p>
152
172
  * <b>Example:</b>
@@ -164,7 +184,7 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
164
184
  * <b>OU ARN format:</b>
165
185
  * </p>
166
186
  * <p>
167
- * <code>arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}</code>
187
+ * <code>arn:$\{Partition\}:organizations::$\{MasterAccountId\}:ou/o-$\{OrganizationId\}/ou-$\{OrganizationalUnitId\}</code>
168
188
  * </p>
169
189
  * </note>
170
190
  * <p class="title">
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
5
5
  import { DisableControlInput, DisableControlOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisableControlCommand}.
8
10
  */
9
11
  export interface DisableControlCommandInput extends DisableControlInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisableControlCommand}.
13
17
  */
14
18
  export interface DisableControlCommandOutput extends DisableControlOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified
18
23
  * organizational unit and the accounts it contains. The resources will vary according to the
19
24
  * control that you specify.</p>
@@ -27,6 +32,8 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DisableControlCommandInput - {@link DisableControlCommandInput}
36
+ * @returns {@link DisableControlCommandOutput}
30
37
  * @see {@link DisableControlCommandInput} for command's `input` shape.
31
38
  * @see {@link DisableControlCommandOutput} for command's `response` shape.
32
39
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
58
65
  export declare class DisableControlCommand extends $Command<DisableControlCommandInput, DisableControlCommandOutput, ControlTowerClientResolvedConfig> {
59
66
  readonly input: DisableControlCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DisableControlCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableControlCommandInput, DisableControlCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
5
5
  import { EnableControlInput, EnableControlOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link EnableControlCommand}.
8
10
  */
9
11
  export interface EnableControlCommandInput extends EnableControlInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link EnableControlCommand}.
13
17
  */
14
18
  export interface EnableControlCommandOutput extends EnableControlOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified
18
23
  * organizational unit and the accounts it contains. The resources created will vary according to
19
24
  * the control that you specify.</p>
@@ -27,6 +32,8 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param EnableControlCommandInput - {@link EnableControlCommandInput}
36
+ * @returns {@link EnableControlCommandOutput}
30
37
  * @see {@link EnableControlCommandInput} for command's `input` shape.
31
38
  * @see {@link EnableControlCommandOutput} for command's `response` shape.
32
39
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
@@ -58,11 +65,20 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
58
65
  export declare class EnableControlCommand extends $Command<EnableControlCommandInput, EnableControlCommandOutput, ControlTowerClientResolvedConfig> {
59
66
  readonly input: EnableControlCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: EnableControlCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableControlCommandInput, EnableControlCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
5
5
  import { GetControlOperationInput, GetControlOperationOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetControlOperationCommand}.
8
10
  */
9
11
  export interface GetControlOperationCommandInput extends GetControlOperationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetControlOperationCommand}.
13
17
  */
14
18
  export interface GetControlOperationCommandOutput extends GetControlOperationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the status of a particular <code>EnableControl</code> or
18
23
  * <code>DisableControl</code> operation. Displays a message in case of error.
19
24
  * Details for an operation are available for 90 days.</p>
@@ -27,6 +32,8 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetControlOperationCommandInput - {@link GetControlOperationCommandInput}
36
+ * @returns {@link GetControlOperationCommandOutput}
30
37
  * @see {@link GetControlOperationCommandInput} for command's `input` shape.
31
38
  * @see {@link GetControlOperationCommandOutput} for command's `response` shape.
32
39
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
52
59
  export declare class GetControlOperationCommand extends $Command<GetControlOperationCommandInput, GetControlOperationCommandOutput, ControlTowerClientResolvedConfig> {
53
60
  readonly input: GetControlOperationCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetControlOperationCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetControlOperationCommandInput, GetControlOperationCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ControlTowerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlTowerClient";
5
5
  import { ListEnabledControlsInput, ListEnabledControlsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEnabledControlsCommand}.
8
10
  */
9
11
  export interface ListEnabledControlsCommandInput extends ListEnabledControlsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEnabledControlsCommand}.
13
17
  */
14
18
  export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
18
23
  * the accounts it contains.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListEnabledControlsCommandInput - {@link ListEnabledControlsCommandInput}
35
+ * @returns {@link ListEnabledControlsCommandOutput}
29
36
  * @see {@link ListEnabledControlsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListEnabledControlsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
51
58
  export declare class ListEnabledControlsCommand extends $Command<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput, ControlTowerClientResolvedConfig> {
52
59
  readonly input: ListEnabledControlsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListEnabledControlsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ControlTower service.
4
6
  */
5
7
  export declare class ControlTowerServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ControlTowerServiceException as __BaseException } from "./ControlTowerServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>User does not have sufficient access to perform this action.
5
6
  * </p>
6
7
  */
@@ -13,6 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
15
16
  /**
17
+ * @public
16
18
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
17
19
  */
18
20
  export declare class ConflictException extends __BaseException {
@@ -23,6 +25,9 @@ export declare class ConflictException extends __BaseException {
23
25
  */
24
26
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
25
27
  }
28
+ /**
29
+ * @public
30
+ */
26
31
  export interface DisableControlInput {
27
32
  /**
28
33
  * <p>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted,
@@ -34,6 +39,9 @@ export interface DisableControlInput {
34
39
  */
35
40
  targetIdentifier: string | undefined;
36
41
  }
42
+ /**
43
+ * @public
44
+ */
37
45
  export interface DisableControlOutput {
38
46
  /**
39
47
  * <p>The ID of the asynchronous operation, which is used to track status. The operation is
@@ -42,6 +50,7 @@ export interface DisableControlOutput {
42
50
  operationIdentifier: string | undefined;
43
51
  }
44
52
  /**
53
+ * @public
45
54
  * <p>Unexpected error during processing of request.</p>
46
55
  */
47
56
  export declare class InternalServerException extends __BaseException {
@@ -54,6 +63,7 @@ export declare class InternalServerException extends __BaseException {
54
63
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
55
64
  }
56
65
  /**
66
+ * @public
57
67
  * <p>Request references a resource which does not exist.</p>
58
68
  */
59
69
  export declare class ResourceNotFoundException extends __BaseException {
@@ -65,6 +75,7 @@ export declare class ResourceNotFoundException extends __BaseException {
65
75
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
66
76
  }
67
77
  /**
78
+ * @public
68
79
  * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. </p>
69
80
  */
70
81
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -76,6 +87,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
76
87
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
77
88
  }
78
89
  /**
90
+ * @public
79
91
  * <p> Request was denied due to request throttling.</p>
80
92
  */
81
93
  export declare class ThrottlingException extends __BaseException {
@@ -102,6 +114,7 @@ export declare class ThrottlingException extends __BaseException {
102
114
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
103
115
  }
104
116
  /**
117
+ * @public
105
118
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
106
119
  */
107
120
  export declare class ValidationException extends __BaseException {
@@ -112,6 +125,9 @@ export declare class ValidationException extends __BaseException {
112
125
  */
113
126
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
114
127
  }
128
+ /**
129
+ * @public
130
+ */
115
131
  export interface EnableControlInput {
116
132
  /**
117
133
  * <p>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted,
@@ -123,6 +139,9 @@ export interface EnableControlInput {
123
139
  */
124
140
  targetIdentifier: string | undefined;
125
141
  }
142
+ /**
143
+ * @public
144
+ */
126
145
  export interface EnableControlOutput {
127
146
  /**
128
147
  * <p>The ID of the asynchronous operation, which is used to track status. The operation is
@@ -130,6 +149,9 @@ export interface EnableControlOutput {
130
149
  */
131
150
  operationIdentifier: string | undefined;
132
151
  }
152
+ /**
153
+ * @public
154
+ */
133
155
  export interface GetControlOperationInput {
134
156
  /**
135
157
  * <p>The ID of the asynchronous operation, which is used to track status. The operation is
@@ -137,16 +159,23 @@ export interface GetControlOperationInput {
137
159
  */
138
160
  operationIdentifier: string | undefined;
139
161
  }
162
+ /**
163
+ * @public
164
+ */
140
165
  export declare enum ControlOperationType {
141
166
  DISABLE_CONTROL = "DISABLE_CONTROL",
142
167
  ENABLE_CONTROL = "ENABLE_CONTROL"
143
168
  }
169
+ /**
170
+ * @public
171
+ */
144
172
  export declare enum ControlOperationStatus {
145
173
  FAILED = "FAILED",
146
174
  IN_PROGRESS = "IN_PROGRESS",
147
175
  SUCCEEDED = "SUCCEEDED"
148
176
  }
149
177
  /**
178
+ * @public
150
179
  * <p>An operation performed by the control.</p>
151
180
  */
152
181
  export interface ControlOperation {
@@ -171,12 +200,18 @@ export interface ControlOperation {
171
200
  */
172
201
  statusMessage?: string;
173
202
  }
203
+ /**
204
+ * @public
205
+ */
174
206
  export interface GetControlOperationOutput {
175
207
  /**
176
208
  * <p/>
177
209
  */
178
210
  controlOperation: ControlOperation | undefined;
179
211
  }
212
+ /**
213
+ * @public
214
+ */
180
215
  export interface ListEnabledControlsInput {
181
216
  /**
182
217
  * <p>The ARN of the organizational unit.</p>
@@ -192,6 +227,7 @@ export interface ListEnabledControlsInput {
192
227
  maxResults?: number;
193
228
  }
194
229
  /**
230
+ * @public
195
231
  * <p>A summary of enabled controls.</p>
196
232
  */
197
233
  export interface EnabledControlSummary {
@@ -201,6 +237,9 @@ export interface EnabledControlSummary {
201
237
  */
202
238
  controlIdentifier?: string;
203
239
  }
240
+ /**
241
+ * @public
242
+ */
204
243
  export interface ListEnabledControlsOutput {
205
244
  /**
206
245
  * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { ControlTowerClient } from "../ControlTowerClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ControlTowerPaginationConfiguration extends PaginationConfiguration {
4
7
  client: ControlTowerClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "../commands/ListEnabledControlsCommand";
3
3
  import { ControlTowerPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListEnabledControls(config: ControlTowerPaginationConfiguration, input: ListEnabledControlsCommandInput, ...additionalArguments: any): Paginator<ListEnabledControlsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-controltower",
3
3
  "description": "AWS SDK for JavaScript Controltower Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },