@aws-sdk/client-controltower 3.427.0 → 3.429.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.
@@ -11,6 +11,7 @@ import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConf
11
11
  import { DisableControlCommandInput, DisableControlCommandOutput } from "./commands/DisableControlCommand";
12
12
  import { EnableControlCommandInput, EnableControlCommandOutput } from "./commands/EnableControlCommand";
13
13
  import { GetControlOperationCommandInput, GetControlOperationCommandOutput } from "./commands/GetControlOperationCommand";
14
+ import { GetEnabledControlCommandInput, GetEnabledControlCommandOutput } from "./commands/GetEnabledControlCommand";
14
15
  import { ListEnabledControlsCommandInput, ListEnabledControlsCommandOutput } from "./commands/ListEnabledControlsCommand";
15
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
16
17
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -18,11 +19,11 @@ export { __Client };
18
19
  /**
19
20
  * @public
20
21
  */
21
- export type ServiceInputTypes = DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | ListEnabledControlsCommandInput;
22
+ export type ServiceInputTypes = DisableControlCommandInput | EnableControlCommandInput | GetControlOperationCommandInput | GetEnabledControlCommandInput | ListEnabledControlsCommandInput;
22
23
  /**
23
24
  * @public
24
25
  */
25
- export type ServiceOutputTypes = DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | ListEnabledControlsCommandOutput;
26
+ export type ServiceOutputTypes = DisableControlCommandOutput | EnableControlCommandOutput | GetControlOperationCommandOutput | GetEnabledControlCommandOutput | ListEnabledControlsCommandOutput;
26
27
  /**
27
28
  * @public
28
29
  */
@@ -156,22 +157,31 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
156
157
  }
157
158
  /**
158
159
  * @public
159
- * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
160
- * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
160
+ * <p>These interfaces allow you to apply the AWS library of pre-defined
161
+ * <i>controls</i> to your organizational units, programmatically. In AWS Control Tower, the terms "control" and "guardrail" are synonyms. .</p>
161
162
  * <p>To call these APIs, you'll need to know:</p>
162
163
  * <ul>
163
164
  * <li>
164
- * <p>the <code>ControlARN</code> for the control--that is, the
165
- * guardrail--you are targeting,</p>
165
+ * <p>the <code>controlIdentifier</code> for the control--or guardrail--you are targeting.</p>
166
166
  * </li>
167
167
  * <li>
168
- * <p>and the ARN associated with the target organizational unit (OU).</p>
168
+ * <p>the ARN associated with the target organizational unit (OU), which we call the <code>targetIdentifier</code>.</p>
169
169
  * </li>
170
170
  * </ul>
171
171
  * <p>
172
- * <b>To get the <code>ControlARN</code> for your AWS Control Tower guardrail:</b>
172
+ * <b>To get the <code>controlIdentifier</code> for your AWS Control Tower
173
+ * control:</b>
173
174
  * </p>
174
- * <p>The <code>ControlARN</code> contains the control name which is specified in each guardrail. For a list of control names for <i>Strongly recommended</i> and <i>Elective</i> guardrails, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html">Automating tasks section</a> of the AWS Control Tower User Guide. Remember that <i>Mandatory</i> guardrails cannot be added or removed.</p>
175
+ * <p>The <code>controlIdentifier</code> is an ARN that is specified for each
176
+ * 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>
177
+ * <p>The <code>controlIdentifier</code> is unique in each AWS Region for each control. You can
178
+ * find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>AWS Control Tower User Guide.</i>
179
+ * </p>
180
+ * <p>A quick-reference list of control identifers for the AWS Control Tower legacy <i>Strongly recommended</i> and
181
+ * <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
182
+ * APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
183
+ * of the <i>AWS Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
184
+ * cannot be added or removed.</p>
175
185
  * <note>
176
186
  * <p>
177
187
  * <b>ARN format:</b>
@@ -185,8 +195,9 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
185
195
  * </p>
186
196
  * </note>
187
197
  * <p>
188
- * <b>To get the ARN for an OU:</b>
198
+ * <b>To get the <code>targetIdentifier</code>:</b>
189
199
  * </p>
200
+ * <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
190
201
  * <p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
191
202
  * <note>
192
203
  * <p>
@@ -202,17 +213,32 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
202
213
  * <ul>
203
214
  * <li>
204
215
  * <p>
205
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of resource identifiers for APIs and guardrails</a>
216
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">Control API input and output examples with CLI</a>
217
+ * </p>
218
+ * </li>
219
+ * <li>
220
+ * <p>
221
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with CloudFormation</a>
222
+ * </p>
223
+ * </li>
224
+ * <li>
225
+ * <p>
226
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Control metadata tables</a>
227
+ * </p>
228
+ * </li>
229
+ * <li>
230
+ * <p>
231
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of identifiers for legacy controls</a>
206
232
  * </p>
207
233
  * </li>
208
234
  * <li>
209
235
  * <p>
210
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html">Guardrail API examples (CLI)</a>
236
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">Controls reference guide</a>
211
237
  * </p>
212
238
  * </li>
213
239
  * <li>
214
240
  * <p>
215
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with AWS CloudFormation</a>
241
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html">Controls library groupings</a>
216
242
  * </p>
217
243
  * </li>
218
244
  * <li>
@@ -226,7 +252,14 @@ export interface ControlTowerClientResolvedConfig extends ControlTowerClientReso
226
252
  * <p>
227
253
  * <b>Recording API Requests</b>
228
254
  * </p>
229
- * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.</p>
255
+ * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your
256
+ * AWS account and delivers log files to an Amazon S3 bucket. By using information collected by
257
+ * CloudTrail, you can determine which requests the AWS Control Tower service received, who made
258
+ * the request and when, and so on. For more about AWS Control Tower and its support for
259
+ * CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower
260
+ * Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about
261
+ * CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User
262
+ * Guide.</p>
230
263
  */
231
264
  export declare class ControlTowerClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ControlTowerClientResolvedConfig> {
232
265
  /**
@@ -23,9 +23,11 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified
27
- * organizational unit and the accounts it contains. The resources will vary according to the
28
- * control that you specify.</p>
26
+ * <p>This API call turns off a control. It starts an asynchronous operation that deletes AWS
27
+ * resources on the specified organizational unit and the accounts it contains. The resources
28
+ * will vary according to the control that you specify. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
29
+ * <i>the AWS Control Tower User Guide</i>
30
+ * </a>.</p>
29
31
  * @example
30
32
  * Use a bare-bones client and the command you need to make an API call.
31
33
  * ```javascript
@@ -51,8 +53,7 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
51
53
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
52
54
  *
53
55
  * @throws {@link AccessDeniedException} (client fault)
54
- * <p>User does not have sufficient access to perform this action.
55
- * </p>
56
+ * <p>User does not have sufficient access to perform this action.</p>
56
57
  *
57
58
  * @throws {@link ConflictException} (client fault)
58
59
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
@@ -64,7 +65,7 @@ export interface DisableControlCommandOutput extends DisableControlOutput, __Met
64
65
  * <p>Request references a resource which does not exist.</p>
65
66
  *
66
67
  * @throws {@link ServiceQuotaExceededException} (client fault)
67
- * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. </p>
68
+ * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
68
69
  *
69
70
  * @throws {@link ThrottlingException} (client fault)
70
71
  * <p> Request was denied due to request throttling.</p>
@@ -23,9 +23,12 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified
27
- * organizational unit and the accounts it contains. The resources created will vary according to
28
- * the control that you specify.</p>
26
+ * <p>This API call activates a control. It starts an asynchronous operation that creates AWS
27
+ * resources on the specified organizational unit and the accounts it contains. The resources
28
+ * created will vary according to the control that you specify. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
29
+ * <i>the AWS Control Tower User Guide</i>
30
+ * </a>
31
+ * </p>
29
32
  * @example
30
33
  * Use a bare-bones client and the command you need to make an API call.
31
34
  * ```javascript
@@ -51,8 +54,7 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
51
54
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
52
55
  *
53
56
  * @throws {@link AccessDeniedException} (client fault)
54
- * <p>User does not have sufficient access to perform this action.
55
- * </p>
57
+ * <p>User does not have sufficient access to perform this action.</p>
56
58
  *
57
59
  * @throws {@link ConflictException} (client fault)
58
60
  * <p>Updating or deleting a resource can cause an inconsistent state.</p>
@@ -64,7 +66,7 @@ export interface EnableControlCommandOutput extends EnableControlOutput, __Metad
64
66
  * <p>Request references a resource which does not exist.</p>
65
67
  *
66
68
  * @throws {@link ServiceQuotaExceededException} (client fault)
67
- * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations. </p>
69
+ * <p>Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.</p>
68
70
  *
69
71
  * @throws {@link ThrottlingException} (client fault)
70
72
  * <p> Request was denied due to request throttling.</p>
@@ -24,8 +24,11 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
24
24
  /**
25
25
  * @public
26
26
  * <p>Returns the status of a particular <code>EnableControl</code> or
27
- * <code>DisableControl</code> operation. Displays a message in case of error.
28
- * Details for an operation are available for 90 days.</p>
27
+ * <code>DisableControl</code> operation. Displays a message in case of error. Details for an
28
+ * operation are available for 90 days. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
29
+ * <i>the AWS Control Tower User Guide</i>
30
+ * </a>
31
+ * </p>
29
32
  * @example
30
33
  * Use a bare-bones client and the command you need to make an API call.
31
34
  * ```javascript
@@ -56,8 +59,7 @@ export interface GetControlOperationCommandOutput extends GetControlOperationOut
56
59
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
57
60
  *
58
61
  * @throws {@link AccessDeniedException} (client fault)
59
- * <p>User does not have sufficient access to perform this action.
60
- * </p>
62
+ * <p>User does not have sufficient access to perform this action.</p>
61
63
  *
62
64
  * @throws {@link InternalServerException} (server fault)
63
65
  * <p>Unexpected error during processing of request.</p>
@@ -0,0 +1,121 @@
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 { GetEnabledControlInput, GetEnabledControlOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetEnabledControlCommand}.
14
+ */
15
+ export interface GetEnabledControlCommandInput extends GetEnabledControlInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetEnabledControlCommand}.
21
+ */
22
+ export interface GetEnabledControlCommandOutput extends GetEnabledControlOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>
27
+ * Provides details about the enabled control. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">
28
+ * <i>the AWS Control Tower User Guide</i>
29
+ * </a>.</p>
30
+ * <p class="title">
31
+ * <b>Returned values</b>
32
+ * </p>
33
+ * <ul>
34
+ * <li>
35
+ * <p>TargetRegions: Shows target AWS Regions where the enabled control is available to be deployed.</p>
36
+ * </li>
37
+ * <li>
38
+ * <p>StatusSummary: Provides a detailed summary of the deployment status.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>DriftSummary: Provides a detailed summary of the drifted status.</p>
42
+ * </li>
43
+ * </ul>
44
+ * @example
45
+ * Use a bare-bones client and the command you need to make an API call.
46
+ * ```javascript
47
+ * import { ControlTowerClient, GetEnabledControlCommand } from "@aws-sdk/client-controltower"; // ES Modules import
48
+ * // const { ControlTowerClient, GetEnabledControlCommand } = require("@aws-sdk/client-controltower"); // CommonJS import
49
+ * const client = new ControlTowerClient(config);
50
+ * const input = { // GetEnabledControlInput
51
+ * enabledControlIdentifier: "STRING_VALUE", // required
52
+ * };
53
+ * const command = new GetEnabledControlCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // GetEnabledControlOutput
56
+ * // enabledControlDetails: { // EnabledControlDetails
57
+ * // arn: "STRING_VALUE",
58
+ * // controlIdentifier: "STRING_VALUE",
59
+ * // targetIdentifier: "STRING_VALUE",
60
+ * // targetRegions: [ // TargetRegions
61
+ * // { // Region
62
+ * // name: "STRING_VALUE",
63
+ * // },
64
+ * // ],
65
+ * // statusSummary: { // EnablementStatusSummary
66
+ * // status: "STRING_VALUE",
67
+ * // lastOperationIdentifier: "STRING_VALUE",
68
+ * // },
69
+ * // driftStatusSummary: { // DriftStatusSummary
70
+ * // driftStatus: "STRING_VALUE",
71
+ * // },
72
+ * // },
73
+ * // };
74
+ *
75
+ * ```
76
+ *
77
+ * @param GetEnabledControlCommandInput - {@link GetEnabledControlCommandInput}
78
+ * @returns {@link GetEnabledControlCommandOutput}
79
+ * @see {@link GetEnabledControlCommandInput} for command's `input` shape.
80
+ * @see {@link GetEnabledControlCommandOutput} for command's `response` shape.
81
+ * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>User does not have sufficient access to perform this action.</p>
85
+ *
86
+ * @throws {@link InternalServerException} (server fault)
87
+ * <p>Unexpected error during processing of request.</p>
88
+ *
89
+ * @throws {@link ResourceNotFoundException} (client fault)
90
+ * <p>Request references a resource which does not exist.</p>
91
+ *
92
+ * @throws {@link ThrottlingException} (client fault)
93
+ * <p> Request was denied due to request throttling.</p>
94
+ *
95
+ * @throws {@link ValidationException} (client fault)
96
+ * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
97
+ *
98
+ * @throws {@link ControlTowerServiceException}
99
+ * <p>Base exception class for all service exceptions from ControlTower service.</p>
100
+ *
101
+ */
102
+ export declare class GetEnabledControlCommand extends $Command<GetEnabledControlCommandInput, GetEnabledControlCommandOutput, ControlTowerClientResolvedConfig> {
103
+ readonly input: GetEnabledControlCommandInput;
104
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
105
+ /**
106
+ * @public
107
+ */
108
+ constructor(input: GetEnabledControlCommandInput);
109
+ /**
110
+ * @internal
111
+ */
112
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ControlTowerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEnabledControlCommandInput, GetEnabledControlCommandOutput>;
113
+ /**
114
+ * @internal
115
+ */
116
+ private serialize;
117
+ /**
118
+ * @internal
119
+ */
120
+ private deserialize;
121
+ }
@@ -24,7 +24,10 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
24
24
  /**
25
25
  * @public
26
26
  * <p>Lists the controls enabled by AWS Control Tower on the specified organizational unit and
27
- * the accounts it contains.</p>
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 AWS Control Tower User Guide</i>
29
+ * </a>
30
+ * </p>
28
31
  * @example
29
32
  * Use a bare-bones client and the command you need to make an API call.
30
33
  * ```javascript
@@ -42,6 +45,15 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
42
45
  * // enabledControls: [ // EnabledControls // required
43
46
  * // { // EnabledControlSummary
44
47
  * // controlIdentifier: "STRING_VALUE",
48
+ * // arn: "STRING_VALUE",
49
+ * // targetIdentifier: "STRING_VALUE",
50
+ * // statusSummary: { // EnablementStatusSummary
51
+ * // status: "STRING_VALUE",
52
+ * // lastOperationIdentifier: "STRING_VALUE",
53
+ * // },
54
+ * // driftStatusSummary: { // DriftStatusSummary
55
+ * // driftStatus: "STRING_VALUE",
56
+ * // },
45
57
  * // },
46
58
  * // ],
47
59
  * // nextToken: "STRING_VALUE",
@@ -56,8 +68,7 @@ export interface ListEnabledControlsCommandOutput extends ListEnabledControlsOut
56
68
  * @see {@link ControlTowerClientResolvedConfig | config} for ControlTowerClient's `config` shape.
57
69
  *
58
70
  * @throws {@link AccessDeniedException} (client fault)
59
- * <p>User does not have sufficient access to perform this action.
60
- * </p>
71
+ * <p>User does not have sufficient access to perform this action.</p>
61
72
  *
62
73
  * @throws {@link InternalServerException} (server fault)
63
74
  * <p>Unexpected error during processing of request.</p>
@@ -1,4 +1,5 @@
1
1
  export * from "./DisableControlCommand";
2
2
  export * from "./EnableControlCommand";
3
3
  export * from "./GetControlOperationCommand";
4
+ export * from "./GetEnabledControlCommand";
4
5
  export * from "./ListEnabledControlsCommand";
@@ -1,20 +1,29 @@
1
1
  /**
2
- * <p>These interfaces allow you to apply the AWS library of pre-defined <i>controls</i> to your
3
- * organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.</p>
2
+ * <p>These interfaces allow you to apply the AWS library of pre-defined
3
+ * <i>controls</i> to your organizational units, programmatically. In AWS Control Tower, the terms "control" and "guardrail" are synonyms. .</p>
4
4
  * <p>To call these APIs, you'll need to know:</p>
5
5
  * <ul>
6
6
  * <li>
7
- * <p>the <code>ControlARN</code> for the control--that is, the
8
- * guardrail--you are targeting,</p>
7
+ * <p>the <code>controlIdentifier</code> for the control--or guardrail--you are targeting.</p>
9
8
  * </li>
10
9
  * <li>
11
- * <p>and the ARN associated with the target organizational unit (OU).</p>
10
+ * <p>the ARN associated with the target organizational unit (OU), which we call the <code>targetIdentifier</code>.</p>
12
11
  * </li>
13
12
  * </ul>
14
13
  * <p>
15
- * <b>To get the <code>ControlARN</code> for your AWS Control Tower guardrail:</b>
14
+ * <b>To get the <code>controlIdentifier</code> for your AWS Control Tower
15
+ * control:</b>
16
16
  * </p>
17
- * <p>The <code>ControlARN</code> contains the control name which is specified in each guardrail. For a list of control names for <i>Strongly recommended</i> and <i>Elective</i> guardrails, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html">Automating tasks section</a> of the AWS Control Tower User Guide. Remember that <i>Mandatory</i> guardrails cannot be added or removed.</p>
17
+ * <p>The <code>controlIdentifier</code> is an ARN that is specified for each
18
+ * 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>
19
+ * <p>The <code>controlIdentifier</code> is unique in each AWS Region for each control. You can
20
+ * find the <code>controlIdentifier</code> for each Region and control in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Tables of control metadata</a> in the <i>AWS Control Tower User Guide.</i>
21
+ * </p>
22
+ * <p>A quick-reference list of control identifers for the AWS Control Tower legacy <i>Strongly recommended</i> and
23
+ * <i>Elective</i> controls is given in <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html">Resource identifiers for
24
+ * APIs and guardrails</a> in the <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">Controls reference guide section</a>
25
+ * of the <i>AWS Control Tower User Guide</i>. Remember that <i>Mandatory</i> controls
26
+ * cannot be added or removed.</p>
18
27
  * <note>
19
28
  * <p>
20
29
  * <b>ARN format:</b>
@@ -28,8 +37,9 @@
28
37
  * </p>
29
38
  * </note>
30
39
  * <p>
31
- * <b>To get the ARN for an OU:</b>
40
+ * <b>To get the <code>targetIdentifier</code>:</b>
32
41
  * </p>
42
+ * <p>The <code>targetIdentifier</code> is the ARN for an OU.</p>
33
43
  * <p>In the AWS Organizations console, you can find the ARN for the OU on the <b>Organizational unit details</b> page associated with that OU.</p>
34
44
  * <note>
35
45
  * <p>
@@ -45,17 +55,32 @@
45
55
  * <ul>
46
56
  * <li>
47
57
  * <p>
48
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of resource identifiers for APIs and guardrails</a>
58
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html">Control API input and output examples with CLI</a>
59
+ * </p>
60
+ * </li>
61
+ * <li>
62
+ * <p>
63
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with CloudFormation</a>
64
+ * </p>
65
+ * </li>
66
+ * <li>
67
+ * <p>
68
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html">Control metadata tables</a>
69
+ * </p>
70
+ * </li>
71
+ * <li>
72
+ * <p>
73
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html">List of identifiers for legacy controls</a>
49
74
  * </p>
50
75
  * </li>
51
76
  * <li>
52
77
  * <p>
53
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html">Guardrail API examples (CLI)</a>
78
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls.html">Controls reference guide</a>
54
79
  * </p>
55
80
  * </li>
56
81
  * <li>
57
82
  * <p>
58
- * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html">Enable controls with AWS CloudFormation</a>
83
+ * <a href="https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html">Controls library groupings</a>
59
84
  * </p>
60
85
  * </li>
61
86
  * <li>
@@ -69,7 +94,14 @@
69
94
  * <p>
70
95
  * <b>Recording API Requests</b>
71
96
  * </p>
72
- * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.</p>
97
+ * <p>AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your
98
+ * AWS account and delivers log files to an Amazon S3 bucket. By using information collected by
99
+ * CloudTrail, you can determine which requests the AWS Control Tower service received, who made
100
+ * the request and when, and so on. For more about AWS Control Tower and its support for
101
+ * CloudTrail, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html">Logging AWS Control Tower
102
+ * Actions with AWS CloudTrail</a> in the AWS Control Tower User Guide. To learn more about
103
+ * CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User
104
+ * Guide.</p>
73
105
  *
74
106
  * @packageDocumentation
75
107
  */