@aws-sdk/client-cloudtrail 3.348.0 → 3.352.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.
Files changed (13) hide show
  1. package/README.md +0 -277
  2. package/dist-cjs/protocols/Aws_json1_1.js +3 -0
  3. package/dist-es/protocols/Aws_json1_1.js +3 -0
  4. package/dist-types/CloudTrail.d.ts +0 -277
  5. package/dist-types/CloudTrailClient.d.ts +0 -277
  6. package/dist-types/commands/DescribeQueryCommand.d.ts +7 -3
  7. package/dist-types/commands/GetQueryResultsCommand.d.ts +1 -2
  8. package/dist-types/commands/StartQueryCommand.d.ts +10 -3
  9. package/dist-types/commands/UpdateEventDataStoreCommand.d.ts +5 -1
  10. package/dist-types/index.d.ts +0 -277
  11. package/dist-types/models/models_0.d.ts +64 -6
  12. package/dist-types/ts3.4/models/models_0.d.ts +5 -2
  13. package/package.json +6 -6
package/dist-types/CloudTrailClient.d.ts CHANGED
@@ -207,283 +207,6 @@ export interface CloudTrailClientResolvedConfig extends CloudTrailClientResolved
207
207
  * </note>
208
208
  * <p>See the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html">CloudTrail
209
209
  * User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>
210
- * <p>
211
- * <b>Actions available for CloudTrail trails</b>
212
- * </p>
213
- * <p>The following actions are available for CloudTrail trails.</p>
214
- * <ul>
215
- * <li>
216
- * <p>
217
- * <a>AddTags</a>
218
- * </p>
219
- * </li>
220
- * <li>
221
- * <p>
222
- * <a>CreateTrail</a>
223
- * </p>
224
- * </li>
225
- * <li>
226
- * <p>
227
- * <a>DeleteTrail</a>
228
- * </p>
229
- * </li>
230
- * <li>
231
- * <p>
232
- * <a>DescribeTrails</a>
233
- * </p>
234
- * </li>
235
- * <li>
236
- * <p>
237
- * <a>GetEventSelectors</a>
238
- * </p>
239
- * </li>
240
- * <li>
241
- * <p>
242
- * <a>GetInsightSelectors</a>
243
- * </p>
244
- * </li>
245
- * <li>
246
- * <p>
247
- * <a>GetTrail</a>
248
- * </p>
249
- * </li>
250
- * <li>
251
- * <p>
252
- * <a>GetTrailStatus</a>
253
- * </p>
254
- * </li>
255
- * <li>
256
- * <p>
257
- * <a>ListTags</a>
258
- * </p>
259
- * </li>
260
- * <li>
261
- * <p>
262
- * <a>ListTrails</a>
263
- * </p>
264
- * </li>
265
- * <li>
266
- * <p>
267
- * <a>PutEventSelectors</a>
268
- * </p>
269
- * </li>
270
- * <li>
271
- * <p>
272
- * <a>PutInsightSelectors</a>
273
- * </p>
274
- * </li>
275
- * <li>
276
- * <p>
277
- * <a>RemoveTags</a>
278
- * </p>
279
- * </li>
280
- * <li>
281
- * <p>
282
- * <a>StartLogging</a>
283
- * </p>
284
- * </li>
285
- * <li>
286
- * <p>
287
- * <a>StopLogging</a>
288
- * </p>
289
- * </li>
290
- * <li>
291
- * <p>
292
- * <a>UpdateTrail</a>
293
- * </p>
294
- * </li>
295
- * </ul>
296
- * <p>
297
- * <b>Actions available for CloudTrail event data stores</b>
298
- * </p>
299
- * <p>The following actions are available for CloudTrail event data stores.</p>
300
- * <ul>
301
- * <li>
302
- * <p>
303
- * <a>AddTags</a>
304
- * </p>
305
- * </li>
306
- * <li>
307
- * <p>
308
- * <a>CancelQuery</a>
309
- * </p>
310
- * </li>
311
- * <li>
312
- * <p>
313
- * <a>CreateEventDataStore</a>
314
- * </p>
315
- * </li>
316
- * <li>
317
- * <p>
318
- * <a>DeleteEventDataStore</a>
319
- * </p>
320
- * </li>
321
- * <li>
322
- * <p>
323
- * <a>DescribeQuery</a>
324
- * </p>
325
- * </li>
326
- * <li>
327
- * <p>
328
- * <a>GetEventDataStore</a>
329
- * </p>
330
- * </li>
331
- * <li>
332
- * <p>
333
- * <a>GetQueryResults</a>
334
- * </p>
335
- * </li>
336
- * <li>
337
- * <p>
338
- * <a>ListEventDataStores</a>
339
- * </p>
340
- * </li>
341
- * <li>
342
- * <p>
343
- * <a>ListTags</a>
344
- * </p>
345
- * </li>
346
- * <li>
347
- * <p>
348
- * <a>ListQueries</a>
349
- * </p>
350
- * </li>
351
- * <li>
352
- * <p>
353
- * <a>RemoveTags</a>
354
- * </p>
355
- * </li>
356
- * <li>
357
- * <p>
358
- * <a>RestoreEventDataStore</a>
359
- * </p>
360
- * </li>
361
- * <li>
362
- * <p>
363
- * <a>StartEventDataStoreIngestion</a>
364
- * </p>
365
- * </li>
366
- * <li>
367
- * <p>
368
- * <a>StartImport</a>
369
- * </p>
370
- * <p>The following additional actions are available for imports.</p>
371
- * <ul>
372
- * <li>
373
- * <p>
374
- * <a>GetImport</a>
375
- * </p>
376
- * </li>
377
- * <li>
378
- * <p>
379
- * <a>ListImportFailures</a>
380
- * </p>
381
- * </li>
382
- * <li>
383
- * <p>
384
- * <a>ListImports</a>
385
- * </p>
386
- * </li>
387
- * <li>
388
- * <p>
389
- * <a>StopImport</a>
390
- * </p>
391
- * </li>
392
- * </ul>
393
- * </li>
394
- * <li>
395
- * <p>
396
- * <a>StartQuery</a>
397
- * </p>
398
- * </li>
399
- * <li>
400
- * <p>
401
- * <a>StartEventDataStoreIngestion</a>
402
- * </p>
403
- * </li>
404
- * <li>
405
- * <p>
406
- * <a>UpdateEventDataStore</a>
407
- * </p>
408
- * </li>
409
- * </ul>
410
- * <p>
411
- * <b>Actions available for CloudTrail channels</b>
412
- * </p>
413
- * <p>The following actions are available for CloudTrail channels.</p>
414
- * <ul>
415
- * <li>
416
- * <p>
417
- * <a>AddTags</a>
418
- * </p>
419
- * </li>
420
- * <li>
421
- * <p>
422
- * <a>CreateChannel</a>
423
- * </p>
424
- * </li>
425
- * <li>
426
- * <p>
427
- * <a>DeleteChannel</a>
428
- * </p>
429
- * </li>
430
- * <li>
431
- * <p>
432
- * <a>DeleteResourcePolicy</a>
433
- * </p>
434
- * </li>
435
- * <li>
436
- * <p>
437
- * <a>GetChannel</a>
438
- * </p>
439
- * </li>
440
- * <li>
441
- * <p>
442
- * <a>GetResourcePolicy</a>
443
- * </p>
444
- * </li>
445
- * <li>
446
- * <p>
447
- * <a>ListChannels</a>
448
- * </p>
449
- * </li>
450
- * <li>
451
- * <p>
452
- * <a>ListTags</a>
453
- * </p>
454
- * </li>
455
- * <li>
456
- * <p>
457
- * <a>PutResourcePolicy</a>
458
- * </p>
459
- * </li>
460
- * <li>
461
- * <p>
462
- * <a>RemoveTags</a>
463
- * </p>
464
- * </li>
465
- * <li>
466
- * <p>
467
- * <a>UpdateChannel</a>
468
- * </p>
469
- * </li>
470
- * </ul>
471
- * <p>
472
- * <b>Actions available for managing delegated administrators</b>
473
- * </p>
474
- * <p>The following actions are available for adding or a removing a delegated administrator to manage an Organizations organization’s CloudTrail resources.</p>
475
- * <ul>
476
- * <li>
477
- * <p>
478
- * <a>DeregisterOrganizationDelegatedAdmin</a>
479
- * </p>
480
- * </li>
481
- * <li>
482
- * <p>
483
- * <a>RegisterOrganizationDelegatedAdmin</a>
484
- * </p>
485
- * </li>
486
- * </ul>
487
210
  */
488
211
  export declare class CloudTrailClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CloudTrailClientResolvedConfig> {
489
212
  /**
package/dist-types/commands/DescribeQueryCommand.d.ts CHANGED
@@ -24,8 +24,11 @@ export interface DescribeQueryCommandOutput extends DescribeQueryResponse, __Met
24
24
  /**
25
25
  * @public
26
26
  * <p>Returns metadata about a query, including query run time in milliseconds, number of
27
- * events scanned and matched, and query status. You must specify an ARN for
28
- * <code>EventDataStore</code>, and a value for <code>QueryID</code>.</p>
27
+ * events scanned and matched, and query status. If the query results were delivered to an S3 bucket,
28
+ * the response also provides the S3 URI and the delivery status.</p>
29
+ * <p>You must specify either a <code>QueryID</code> or a <code>QueryAlias</code>. Specifying
30
+ * the <code>QueryAlias</code> parameter returns information about the last query run for the
31
+ * alias.</p>
29
32
  * @example
30
33
  * Use a bare-bones client and the command you need to make an API call.
31
34
  * ```javascript
@@ -34,7 +37,8 @@ export interface DescribeQueryCommandOutput extends DescribeQueryResponse, __Met
34
37
  * const client = new CloudTrailClient(config);
35
38
  * const input = { // DescribeQueryRequest
36
39
  * EventDataStore: "STRING_VALUE",
37
- * QueryId: "STRING_VALUE", // required
40
+ * QueryId: "STRING_VALUE",
41
+ * QueryAlias: "STRING_VALUE",
38
42
  * };
39
43
  * const command = new DescribeQueryCommand(input);
40
44
  * const response = await client.send(command);
package/dist-types/commands/GetQueryResultsCommand.d.ts CHANGED
@@ -24,8 +24,7 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _
24
24
  /**
25
25
  * @public
26
26
  * <p>Gets event data results of a query. You must specify the <code>QueryID</code> value
27
- * returned by the <code>StartQuery</code> operation, and an ARN for
28
- * <code>EventDataStore</code>.</p>
27
+ * returned by the <code>StartQuery</code> operation.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
31
30
  * ```javascript
package/dist-types/commands/StartQueryCommand.d.ts CHANGED
@@ -23,10 +23,13 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Starts a CloudTrail Lake query. The required <code>QueryStatement</code>
27
- * parameter provides your SQL query, enclosed in single quotation marks. Use the optional
26
+ * <p>Starts a CloudTrail Lake query. Use the <code>QueryStatement</code>
27
+ * parameter to provide your SQL query, enclosed in single quotation marks. Use the optional
28
28
  * <code>DeliveryS3Uri</code> parameter to deliver the query results to an S3
29
29
  * bucket.</p>
30
+ * <p>
31
+ * <code>StartQuery</code> requires you specify either the <code>QueryStatement</code> parameter, or a <code>QueryAlias</code> and any <code>QueryParameters</code>. In the current release,
32
+ * the <code>QueryAlias</code> and <code>QueryParameters</code> parameters are used only for the queries that populate the CloudTrail Lake dashboards.</p>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
32
35
  * ```javascript
@@ -34,8 +37,12 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
34
37
  * // const { CloudTrailClient, StartQueryCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import
35
38
  * const client = new CloudTrailClient(config);
36
39
  * const input = { // StartQueryRequest
37
- * QueryStatement: "STRING_VALUE", // required
40
+ * QueryStatement: "STRING_VALUE",
38
41
  * DeliveryS3Uri: "STRING_VALUE",
42
+ * QueryAlias: "STRING_VALUE",
43
+ * QueryParameters: [ // QueryParameters
44
+ * "STRING_VALUE",
45
+ * ],
39
46
  * };
40
47
  * const command = new StartQueryCommand(input);
41
48
  * const response = await client.send(command);
package/dist-types/commands/UpdateEventDataStoreCommand.d.ts CHANGED
@@ -30,7 +30,8 @@ export interface UpdateEventDataStoreCommandOutput extends UpdateEventDataStoreR
30
30
  * 2557. By default, <code>TerminationProtection</code> is enabled.</p>
31
31
  * <p>For event data stores for CloudTrail events, <code>AdvancedEventSelectors</code>
32
32
  * includes or excludes management and data events in your event data store. For more
33
- * information about <code>AdvancedEventSelectors</code>, see <a>PutEventSelectorsRequest$AdvancedEventSelectors</a>. </p>
33
+ * information about <code>AdvancedEventSelectors</code>, see
34
+ * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html">AdvancedEventSelectors</a>.</p>
34
35
  * <p> For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
35
36
  * <code>AdvancedEventSelectors</code> includes events of that type in your event data store.</p>
36
37
  * @example
@@ -126,6 +127,9 @@ export interface UpdateEventDataStoreCommandOutput extends UpdateEventDataStoreR
126
127
  * @throws {@link CloudTrailAccessNotEnabledException} (client fault)
127
128
  * <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>. </p>
128
129
  *
130
+ * @throws {@link EventDataStoreAlreadyExistsException} (client fault)
131
+ * <p>An event data store with that name already exists.</p>
132
+ *
129
133
  * @throws {@link EventDataStoreARNInvalidException} (client fault)
130
134
  * <p>The specified event data store ARN is not valid or does not map to an event data store
131
135
  * in your account.</p>
package/dist-types/index.d.ts CHANGED
@@ -15,283 +15,6 @@
15
15
  * </note>
16
16
  * <p>See the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html">CloudTrail
17
17
  * User Guide</a> for information about the data that is included with each Amazon Web Services API call listed in the log files.</p>
18
- * <p>
19
- * <b>Actions available for CloudTrail trails</b>
20
- * </p>
21
- * <p>The following actions are available for CloudTrail trails.</p>
22
- * <ul>
23
- * <li>
24
- * <p>
25
- * <a>AddTags</a>
26
- * </p>
27
- * </li>
28
- * <li>
29
- * <p>
30
- * <a>CreateTrail</a>
31
- * </p>
32
- * </li>
33
- * <li>
34
- * <p>
35
- * <a>DeleteTrail</a>
36
- * </p>
37
- * </li>
38
- * <li>
39
- * <p>
40
- * <a>DescribeTrails</a>
41
- * </p>
42
- * </li>
43
- * <li>
44
- * <p>
45
- * <a>GetEventSelectors</a>
46
- * </p>
47
- * </li>
48
- * <li>
49
- * <p>
50
- * <a>GetInsightSelectors</a>
51
- * </p>
52
- * </li>
53
- * <li>
54
- * <p>
55
- * <a>GetTrail</a>
56
- * </p>
57
- * </li>
58
- * <li>
59
- * <p>
60
- * <a>GetTrailStatus</a>
61
- * </p>
62
- * </li>
63
- * <li>
64
- * <p>
65
- * <a>ListTags</a>
66
- * </p>
67
- * </li>
68
- * <li>
69
- * <p>
70
- * <a>ListTrails</a>
71
- * </p>
72
- * </li>
73
- * <li>
74
- * <p>
75
- * <a>PutEventSelectors</a>
76
- * </p>
77
- * </li>
78
- * <li>
79
- * <p>
80
- * <a>PutInsightSelectors</a>
81
- * </p>
82
- * </li>
83
- * <li>
84
- * <p>
85
- * <a>RemoveTags</a>
86
- * </p>
87
- * </li>
88
- * <li>
89
- * <p>
90
- * <a>StartLogging</a>
91
- * </p>
92
- * </li>
93
- * <li>
94
- * <p>
95
- * <a>StopLogging</a>
96
- * </p>
97
- * </li>
98
- * <li>
99
- * <p>
100
- * <a>UpdateTrail</a>
101
- * </p>
102
- * </li>
103
- * </ul>
104
- * <p>
105
- * <b>Actions available for CloudTrail event data stores</b>
106
- * </p>
107
- * <p>The following actions are available for CloudTrail event data stores.</p>
108
- * <ul>
109
- * <li>
110
- * <p>
111
- * <a>AddTags</a>
112
- * </p>
113
- * </li>
114
- * <li>
115
- * <p>
116
- * <a>CancelQuery</a>
117
- * </p>
118
- * </li>
119
- * <li>
120
- * <p>
121
- * <a>CreateEventDataStore</a>
122
- * </p>
123
- * </li>
124
- * <li>
125
- * <p>
126
- * <a>DeleteEventDataStore</a>
127
- * </p>
128
- * </li>
129
- * <li>
130
- * <p>
131
- * <a>DescribeQuery</a>
132
- * </p>
133
- * </li>
134
- * <li>
135
- * <p>
136
- * <a>GetEventDataStore</a>
137
- * </p>
138
- * </li>
139
- * <li>
140
- * <p>
141
- * <a>GetQueryResults</a>
142
- * </p>
143
- * </li>
144
- * <li>
145
- * <p>
146
- * <a>ListEventDataStores</a>
147
- * </p>
148
- * </li>
149
- * <li>
150
- * <p>
151
- * <a>ListTags</a>
152
- * </p>
153
- * </li>
154
- * <li>
155
- * <p>
156
- * <a>ListQueries</a>
157
- * </p>
158
- * </li>
159
- * <li>
160
- * <p>
161
- * <a>RemoveTags</a>
162
- * </p>
163
- * </li>
164
- * <li>
165
- * <p>
166
- * <a>RestoreEventDataStore</a>
167
- * </p>
168
- * </li>
169
- * <li>
170
- * <p>
171
- * <a>StartEventDataStoreIngestion</a>
172
- * </p>
173
- * </li>
174
- * <li>
175
- * <p>
176
- * <a>StartImport</a>
177
- * </p>
178
- * <p>The following additional actions are available for imports.</p>
179
- * <ul>
180
- * <li>
181
- * <p>
182
- * <a>GetImport</a>
183
- * </p>
184
- * </li>
185
- * <li>
186
- * <p>
187
- * <a>ListImportFailures</a>
188
- * </p>
189
- * </li>
190
- * <li>
191
- * <p>
192
- * <a>ListImports</a>
193
- * </p>
194
- * </li>
195
- * <li>
196
- * <p>
197
- * <a>StopImport</a>
198
- * </p>
199
- * </li>
200
- * </ul>
201
- * </li>
202
- * <li>
203
- * <p>
204
- * <a>StartQuery</a>
205
- * </p>
206
- * </li>
207
- * <li>
208
- * <p>
209
- * <a>StartEventDataStoreIngestion</a>
210
- * </p>
211
- * </li>
212
- * <li>
213
- * <p>
214
- * <a>UpdateEventDataStore</a>
215
- * </p>
216
- * </li>
217
- * </ul>
218
- * <p>
219
- * <b>Actions available for CloudTrail channels</b>
220
- * </p>
221
- * <p>The following actions are available for CloudTrail channels.</p>
222
- * <ul>
223
- * <li>
224
- * <p>
225
- * <a>AddTags</a>
226
- * </p>
227
- * </li>
228
- * <li>
229
- * <p>
230
- * <a>CreateChannel</a>
231
- * </p>
232
- * </li>
233
- * <li>
234
- * <p>
235
- * <a>DeleteChannel</a>
236
- * </p>
237
- * </li>
238
- * <li>
239
- * <p>
240
- * <a>DeleteResourcePolicy</a>
241
- * </p>
242
- * </li>
243
- * <li>
244
- * <p>
245
- * <a>GetChannel</a>
246
- * </p>
247
- * </li>
248
- * <li>
249
- * <p>
250
- * <a>GetResourcePolicy</a>
251
- * </p>
252
- * </li>
253
- * <li>
254
- * <p>
255
- * <a>ListChannels</a>
256
- * </p>
257
- * </li>
258
- * <li>
259
- * <p>
260
- * <a>ListTags</a>
261
- * </p>
262
- * </li>
263
- * <li>
264
- * <p>
265
- * <a>PutResourcePolicy</a>
266
- * </p>
267
- * </li>
268
- * <li>
269
- * <p>
270
- * <a>RemoveTags</a>
271
- * </p>
272
- * </li>
273
- * <li>
274
- * <p>
275
- * <a>UpdateChannel</a>
276
- * </p>
277
- * </li>
278
- * </ul>
279
- * <p>
280
- * <b>Actions available for managing delegated administrators</b>
281
- * </p>
282
- * <p>The following actions are available for adding or a removing a delegated administrator to manage an Organizations organization’s CloudTrail resources.</p>
283
- * <ul>
284
- * <li>
285
- * <p>
286
- * <a>DeregisterOrganizationDelegatedAdmin</a>
287
- * </p>
288
- * </li>
289
- * <li>
290
- * <p>
291
- * <a>RegisterOrganizationDelegatedAdmin</a>
292
- * </p>
293
- * </li>
294
- * </ul>
295
18
  *
296
19
  * @packageDocumentation
297
20
  */