@aws-sdk/client-cloudtrail 3.36.0 → 3.36.1

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 (57) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/CloudTrail.js +0 -18
  3. package/dist-cjs/CloudTrailClient.js +0 -23
  4. package/dist-cjs/commands/AddTagsCommand.js +0 -27
  5. package/dist-cjs/commands/CreateTrailCommand.js +0 -25
  6. package/dist-cjs/commands/DeleteTrailCommand.js +0 -26
  7. package/dist-cjs/commands/DescribeTrailsCommand.js +0 -24
  8. package/dist-cjs/commands/GetEventSelectorsCommand.js +0 -40
  9. package/dist-cjs/commands/GetInsightSelectorsCommand.js +0 -30
  10. package/dist-cjs/commands/GetTrailCommand.js +0 -24
  11. package/dist-cjs/commands/GetTrailStatusCommand.js +0 -24
  12. package/dist-cjs/commands/ListPublicKeysCommand.js +0 -29
  13. package/dist-cjs/commands/ListTagsCommand.js +0 -24
  14. package/dist-cjs/commands/ListTrailsCommand.js +0 -24
  15. package/dist-cjs/commands/LookupEventsCommand.js +0 -71
  16. package/dist-cjs/commands/PutEventSelectorsCommand.js +0 -68
  17. package/dist-cjs/commands/PutInsightSelectorsCommand.js +0 -27
  18. package/dist-cjs/commands/RemoveTagsCommand.js +0 -24
  19. package/dist-cjs/commands/StartLoggingCommand.js +0 -24
  20. package/dist-cjs/commands/StopLoggingCommand.js +0 -30
  21. package/dist-cjs/commands/UpdateTrailCommand.js +0 -29
  22. package/dist-cjs/models/models_0.js +0 -279
  23. package/dist-cjs/pagination/ListPublicKeysPaginator.js +0 -10
  24. package/dist-cjs/pagination/ListTagsPaginator.js +0 -10
  25. package/dist-cjs/pagination/ListTrailsPaginator.js +0 -10
  26. package/dist-cjs/pagination/LookupEventsPaginator.js +0 -10
  27. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  28. package/dist-cjs/runtimeConfig.browser.js +1 -5
  29. package/dist-cjs/runtimeConfig.js +1 -5
  30. package/dist-cjs/runtimeConfig.native.js +0 -3
  31. package/dist-cjs/runtimeConfig.shared.js +0 -3
  32. package/dist-types/ts3.4/CloudTrail.d.ts +19 -210
  33. package/dist-types/ts3.4/CloudTrailClient.d.ts +24 -104
  34. package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +2 -23
  35. package/dist-types/ts3.4/commands/CreateTrailCommand.d.ts +2 -21
  36. package/dist-types/ts3.4/commands/DeleteTrailCommand.d.ts +2 -22
  37. package/dist-types/ts3.4/commands/DescribeTrailsCommand.d.ts +2 -20
  38. package/dist-types/ts3.4/commands/GetEventSelectorsCommand.d.ts +2 -36
  39. package/dist-types/ts3.4/commands/GetInsightSelectorsCommand.d.ts +2 -26
  40. package/dist-types/ts3.4/commands/GetTrailCommand.d.ts +2 -20
  41. package/dist-types/ts3.4/commands/GetTrailStatusCommand.d.ts +2 -20
  42. package/dist-types/ts3.4/commands/ListPublicKeysCommand.d.ts +2 -25
  43. package/dist-types/ts3.4/commands/ListTagsCommand.d.ts +2 -20
  44. package/dist-types/ts3.4/commands/ListTrailsCommand.d.ts +2 -20
  45. package/dist-types/ts3.4/commands/LookupEventsCommand.d.ts +2 -67
  46. package/dist-types/ts3.4/commands/PutEventSelectorsCommand.d.ts +2 -64
  47. package/dist-types/ts3.4/commands/PutInsightSelectorsCommand.d.ts +2 -23
  48. package/dist-types/ts3.4/commands/RemoveTagsCommand.d.ts +2 -20
  49. package/dist-types/ts3.4/commands/StartLoggingCommand.d.ts +2 -20
  50. package/dist-types/ts3.4/commands/StopLoggingCommand.d.ts +2 -26
  51. package/dist-types/ts3.4/commands/UpdateTrailCommand.d.ts +2 -25
  52. package/dist-types/ts3.4/models/models_0.d.ts +390 -1877
  53. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  54. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  55. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  56. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  57. package/package.json +3 -3
@@ -1,1459 +1,606 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>A custom key-value pair associated with a resource such as a CloudTrail trail.</p>
4
- */
2
+
5
3
  export interface Tag {
6
- /**
7
- * <p>The key in a key-value pair. The key must be must be no longer than 128 Unicode characters.
8
- * The key must be unique for the resource to which it applies.</p>
9
- */
4
+
10
5
  Key: string | undefined;
11
- /**
12
- * <p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.</p>
13
- */
6
+
14
7
  Value?: string;
15
8
  }
16
9
  export declare namespace Tag {
17
- /**
18
- * @internal
19
- */
10
+
20
11
  const filterSensitiveLog: (obj: Tag) => any;
21
12
  }
22
- /**
23
- * <p>Specifies the tags to add to a trail.</p>
24
- */
13
+
25
14
  export interface AddTagsRequest {
26
- /**
27
- * <p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p>
28
- * <p>
29
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
30
- * </p>
31
- */
15
+
32
16
  ResourceId: string | undefined;
33
- /**
34
- * <p>Contains a list of tags, up to a limit of 50</p>
35
- */
17
+
36
18
  TagsList?: Tag[];
37
19
  }
38
20
  export declare namespace AddTagsRequest {
39
- /**
40
- * @internal
41
- */
21
+
42
22
  const filterSensitiveLog: (obj: AddTagsRequest) => any;
43
23
  }
44
- /**
45
- * <p>Returns the objects or data if successful. Otherwise, returns an error.</p>
46
- */
24
+
47
25
  export interface AddTagsResponse {
48
26
  }
49
27
  export declare namespace AddTagsResponse {
50
- /**
51
- * @internal
52
- */
28
+
53
29
  const filterSensitiveLog: (obj: AddTagsResponse) => any;
54
30
  }
55
- /**
56
- * <p>This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.</p>
57
- * <p>
58
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
59
- * </p>
60
- */
31
+
61
32
  export interface CloudTrailARNInvalidException extends __SmithyException, $MetadataBearer {
62
33
  name: "CloudTrailARNInvalidException";
63
34
  $fault: "client";
64
- /**
65
- * <p>Brief description of the exception returned by the request.</p>
66
- */
35
+
67
36
  Message?: string;
68
37
  }
69
38
  export declare namespace CloudTrailARNInvalidException {
70
- /**
71
- * @internal
72
- */
39
+
73
40
  const filterSensitiveLog: (obj: CloudTrailARNInvalidException) => any;
74
41
  }
75
- /**
76
- * <p>This exception is thrown when the specified tag key or values are not valid.
77
- * It can also occur if there are duplicate tags or too many tags on the resource.</p>
78
- */
42
+
79
43
  export interface InvalidTagParameterException extends __SmithyException, $MetadataBearer {
80
44
  name: "InvalidTagParameterException";
81
45
  $fault: "client";
82
- /**
83
- * <p>Brief description of the exception returned by the request.</p>
84
- */
46
+
85
47
  Message?: string;
86
48
  }
87
49
  export declare namespace InvalidTagParameterException {
88
- /**
89
- * @internal
90
- */
50
+
91
51
  const filterSensitiveLog: (obj: InvalidTagParameterException) => any;
92
52
  }
93
- /**
94
- * <p>This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:</p>
95
- * <ul>
96
- * <li>
97
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
98
- * </li>
99
- * <li>
100
- * <p>Start with a letter or number, and end with a letter or number</p>
101
- * </li>
102
- * <li>
103
- * <p>Be between 3 and 128 characters</p>
104
- * </li>
105
- * <li>
106
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
107
- * and <code>my--namespace</code> are not valid.</p>
108
- * </li>
109
- * <li>
110
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
111
- * </li>
112
- * </ul>
113
- */
53
+
114
54
  export interface InvalidTrailNameException extends __SmithyException, $MetadataBearer {
115
55
  name: "InvalidTrailNameException";
116
56
  $fault: "client";
117
- /**
118
- * <p>Brief description of the exception returned by the request.</p>
119
- */
57
+
120
58
  Message?: string;
121
59
  }
122
60
  export declare namespace InvalidTrailNameException {
123
- /**
124
- * @internal
125
- */
61
+
126
62
  const filterSensitiveLog: (obj: InvalidTrailNameException) => any;
127
63
  }
128
- /**
129
- * <p>This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an
130
- * organization in Organizations. For more information, see
131
- * <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>
132
- */
64
+
133
65
  export interface NotOrganizationMasterAccountException extends __SmithyException, $MetadataBearer {
134
66
  name: "NotOrganizationMasterAccountException";
135
67
  $fault: "client";
136
- /**
137
- * <p>Brief description of the exception returned by the request.</p>
138
- */
68
+
139
69
  Message?: string;
140
70
  }
141
71
  export declare namespace NotOrganizationMasterAccountException {
142
- /**
143
- * @internal
144
- */
72
+
145
73
  const filterSensitiveLog: (obj: NotOrganizationMasterAccountException) => any;
146
74
  }
147
- /**
148
- * <p>This exception is thrown when the requested operation is not permitted.</p>
149
- */
75
+
150
76
  export interface OperationNotPermittedException extends __SmithyException, $MetadataBearer {
151
77
  name: "OperationNotPermittedException";
152
78
  $fault: "client";
153
- /**
154
- * <p>Brief description of the exception returned by the request.</p>
155
- */
79
+
156
80
  Message?: string;
157
81
  }
158
82
  export declare namespace OperationNotPermittedException {
159
- /**
160
- * @internal
161
- */
83
+
162
84
  const filterSensitiveLog: (obj: OperationNotPermittedException) => any;
163
85
  }
164
- /**
165
- * <p>This exception is thrown when the specified resource is not found.</p>
166
- */
86
+
167
87
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
168
88
  name: "ResourceNotFoundException";
169
89
  $fault: "client";
170
- /**
171
- * <p>Brief description of the exception returned by the request.</p>
172
- */
90
+
173
91
  Message?: string;
174
92
  }
175
93
  export declare namespace ResourceNotFoundException {
176
- /**
177
- * @internal
178
- */
94
+
179
95
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
180
96
  }
181
- /**
182
- * <p>This exception is thrown when the specified resource type is not supported by CloudTrail.</p>
183
- */
97
+
184
98
  export interface ResourceTypeNotSupportedException extends __SmithyException, $MetadataBearer {
185
99
  name: "ResourceTypeNotSupportedException";
186
100
  $fault: "client";
187
- /**
188
- * <p>Brief description of the exception returned by the request.</p>
189
- */
101
+
190
102
  Message?: string;
191
103
  }
192
104
  export declare namespace ResourceTypeNotSupportedException {
193
- /**
194
- * @internal
195
- */
105
+
196
106
  const filterSensitiveLog: (obj: ResourceTypeNotSupportedException) => any;
197
107
  }
198
- /**
199
- * <p>The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.</p>
200
- */
108
+
201
109
  export interface TagsLimitExceededException extends __SmithyException, $MetadataBearer {
202
110
  name: "TagsLimitExceededException";
203
111
  $fault: "client";
204
- /**
205
- * <p>Brief description of the exception returned by the request.</p>
206
- */
112
+
207
113
  Message?: string;
208
114
  }
209
115
  export declare namespace TagsLimitExceededException {
210
- /**
211
- * @internal
212
- */
116
+
213
117
  const filterSensitiveLog: (obj: TagsLimitExceededException) => any;
214
118
  }
215
- /**
216
- * <p>This exception is thrown when the requested operation is not supported.</p>
217
- */
119
+
218
120
  export interface UnsupportedOperationException extends __SmithyException, $MetadataBearer {
219
121
  name: "UnsupportedOperationException";
220
122
  $fault: "client";
221
- /**
222
- * <p>Brief description of the exception returned by the request.</p>
223
- */
123
+
224
124
  Message?: string;
225
125
  }
226
126
  export declare namespace UnsupportedOperationException {
227
- /**
228
- * @internal
229
- */
127
+
230
128
  const filterSensitiveLog: (obj: UnsupportedOperationException) => any;
231
129
  }
232
- /**
233
- * <p>A single selector statement in an advanced event selector.</p>
234
- */
130
+
235
131
  export interface AdvancedFieldSelector {
236
- /**
237
- * <p>
238
- * A field in an event record on which to filter events to be logged. Supported fields include <code>readOnly</code>, <code>eventCategory</code>,
239
- * <code>eventSource</code> (for management events), <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>.
240
- * </p>
241
- * <ul>
242
- * <li>
243
- * <p>
244
- * <b>
245
- * <code>readOnly</code>
246
- * </b> - Optional. Can be set to <code>Equals</code> a value of <code>true</code>
247
- * or <code>false</code>. A value of <code>false</code> logs both <code>read</code> and
248
- * <code>write</code> events.</p>
249
- * </li>
250
- * <li>
251
- * <p>
252
- * <b>
253
- * <code>eventSource</code>
254
- * </b> - For filtering management events only.
255
- * This can be set only to <code>NotEquals</code>
256
- * <code>kms.amazonaws.com</code>.</p>
257
- * </li>
258
- * <li>
259
- * <p>
260
- * <b>
261
- * <code>eventName</code>
262
- * </b> - Can use any operator. You can use it to filter in
263
- * or filter out any data event logged to CloudTrail, such as <code>PutBucket</code> or <code>GetSnapshotBlock</code>. You can have multiple values
264
- * for this field, separated by commas.</p>
265
- * </li>
266
- * <li>
267
- * <p>
268
- * <b>
269
- * <code>eventCategory</code>
270
- * </b> - This is required. It must be set to <code>Equals</code>, and
271
- * the value must be <code>Management</code> or <code>Data</code>.</p>
272
- * </li>
273
- * <li>
274
- * <p>
275
- * <b>
276
- * <code>resources.type</code>
277
- * </b> - This field is required.
278
- * <code>resources.type</code> can only use the <code>Equals</code> operator, and the
279
- * value can be one of the following: <code>AWS::S3::Object</code>,
280
- * <code>AWS::S3::AccessPoint</code>,
281
- * <code>AWS::Lambda::Function</code>, <code>AWS::DynamoDB::Table</code>,
282
- * <code>AWS::S3Outposts::Object</code>, <code>AWS::ManagedBlockchain::Node</code>,
283
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, or <code>AWS::EC2::Snapshot</code>.
284
- * You can have only one <code>resources.type</code> field per selector. To log data
285
- * events on more than one resource type, add another selector.</p>
286
- * </li>
287
- * <li>
288
- * <p>
289
- * <b>
290
- * <code>resources.ARN</code>
291
- * </b> - You can use any operator with
292
- * resources.ARN, but if you use <code>Equals</code> or <code>NotEquals</code>, the
293
- * value must exactly match the ARN of a valid resource of the type you've specified in
294
- * the template as the value of resources.type. For example, if resources.type equals
295
- * <code>AWS::S3::Object</code>, the ARN must be in one of the following formats. To
296
- * log all data events for all objects in a specific S3 bucket, use the
297
- * <code>StartsWith</code> operator, and include only the bucket ARN as the matching value.</p>
298
- * <p>The trailing slash is intentional; do not exclude it. Replace the text between
299
- * less than and greater than symbols (<>) with resource-specific information. </p>
300
- * <ul>
301
- * <li>
302
- * <p>
303
- * <code>arn:<partition>:s3:::<bucket_name>/</code>
304
- * </p>
305
- * </li>
306
- * <li>
307
- * <p>
308
- * <code>arn:<partition>:s3:::<bucket_name>/<object_path>/</code>
309
- * </p>
310
- * </li>
311
- * </ul>
312
- * <p>When <code>resources.type</code> equals <code>AWS::S3::AccessPoint</code>, and the
313
- * operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
314
- * one of the following formats. To log events on all objects in an S3 access point, we
315
- * recommend that you use only the access point ARN, don’t include the object path, and
316
- * use the <code>StartsWith</code> or <code>NotStartsWith</code> operators.</p>
317
- * <ul>
318
- * <li>
319
- * <p>
320
- * <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name></code>
321
- * </p>
322
- * </li>
323
- * <li>
324
- * <p>
325
- * <code>arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path></code>
326
- * </p>
327
- * </li>
328
- * </ul>
329
- * <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is set
330
- * to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
331
- * <ul>
332
- * <li>
333
- * <p>
334
- * <code>arn:<partition>:lambda:<region>:<account_ID>:function:<function_name></code>
335
- * </p>
336
- * </li>
337
- * </ul>
338
- * <p>When resources.type equals <code>AWS::DynamoDB::Table</code>, and the operator is
339
- * set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the
340
- * following format:</p>
341
- * <ul>
342
- * <li>
343
- * <p>
344
- * <code>arn:<partition>:dynamodb:<region>:<account_ID>:table:<table_name></code>
345
- * </p>
346
- * </li>
347
- * </ul>
348
- * <p>When <code>resources.type</code> equals <code>AWS::S3Outposts::Object</code>, and the operator
349
- * is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
350
- * <ul>
351
- * <li>
352
- * <p>
353
- * <code>arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path></code>
354
- * </p>
355
- * </li>
356
- * </ul>
357
- * <p>When <code>resources.type</code> equals <code>AWS::ManagedBlockchain::Node</code>,
358
- * and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
359
- * must be in the following format:</p>
360
- * <ul>
361
- * <li>
362
- * <p>
363
- * <code>arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID></code>
364
- * </p>
365
- * </li>
366
- * </ul>
367
- * <p>When <code>resources.type</code> equals
368
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, and the operator is set to
369
- * <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following
370
- * format:</p>
371
- * <ul>
372
- * <li>
373
- * <p>
374
- * <code>arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name></code>
375
- * </p>
376
- * </li>
377
- * </ul>
378
- * <p>When <code>resources.type</code> equals <code>AWS::EC2::Snapshot</code>, and the
379
- * operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
380
- * the following format:</p>
381
- * <ul>
382
- * <li>
383
- * <p>
384
- * <code>arn:<partition>:ec2:<region>::snapshot/<snapshot_ID></code>
385
- * </p>
386
- * </li>
387
- * </ul>
388
- * </li>
389
- * </ul>
390
- */
132
+
391
133
  Field: string | undefined;
392
- /**
393
- * <p> An operator that includes events that match the exact value of the event record field
394
- * specified as the value of <code>Field</code>. This is the only valid operator that you can
395
- * use with the <code>readOnly</code>, <code>eventCategory</code>, and
396
- * <code>resources.type</code> fields.</p>
397
- */
134
+
398
135
  Equals?: string[];
399
- /**
400
- * <p>An operator that includes events that match the first few characters of the event record
401
- * field specified as the value of <code>Field</code>.</p>
402
- */
136
+
403
137
  StartsWith?: string[];
404
- /**
405
- * <p>An operator that includes events that match the last few characters of the event record
406
- * field specified as the value of <code>Field</code>.</p>
407
- */
138
+
408
139
  EndsWith?: string[];
409
- /**
410
- * <p>
411
- * An operator that excludes events that match the exact value of the event record field specified as the value of <code>Field</code>.
412
- * </p>
413
- */
140
+
414
141
  NotEquals?: string[];
415
- /**
416
- * <p>
417
- * An operator that excludes events that match the first few characters of the event record field specified as the value of <code>Field</code>.
418
- * </p>
419
- */
142
+
420
143
  NotStartsWith?: string[];
421
- /**
422
- * <p>
423
- * An operator that excludes events that match the last few characters of the event record field specified as the value of <code>Field</code>.
424
- * </p>
425
- */
144
+
426
145
  NotEndsWith?: string[];
427
146
  }
428
147
  export declare namespace AdvancedFieldSelector {
429
- /**
430
- * @internal
431
- */
148
+
432
149
  const filterSensitiveLog: (obj: AdvancedFieldSelector) => any;
433
150
  }
434
- /**
435
- * <p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail
436
- * event record fields. They help you control costs by logging only those events
437
- * that are important to you. For more information about advanced event selectors, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events for trails</a> in the <i>CloudTrail User Guide</i>.</p>
438
- * <ul>
439
- * <li>
440
- * <p>
441
- * <code>readOnly</code>
442
- * </p>
443
- * </li>
444
- * <li>
445
- * <p>
446
- * <code>eventSource</code>
447
- * </p>
448
- * </li>
449
- * <li>
450
- * <p>
451
- * <code>eventName</code>
452
- * </p>
453
- * </li>
454
- * <li>
455
- * <p>
456
- * <code>eventCategory</code>
457
- * </p>
458
- * </li>
459
- * <li>
460
- * <p>
461
- * <code>resources.type</code>
462
- * </p>
463
- * </li>
464
- * <li>
465
- * <p>
466
- * <code>resources.ARN</code>
467
- * </p>
468
- * </li>
469
- * </ul>
470
- * <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>
471
- */
151
+
472
152
  export interface AdvancedEventSelector {
473
- /**
474
- * <p>An optional, descriptive name for an advanced event selector, such as "Log data events
475
- * for only two S3 buckets".</p>
476
- */
153
+
477
154
  Name?: string;
478
- /**
479
- * <p>Contains all selector statements in an advanced event selector.</p>
480
- */
155
+
481
156
  FieldSelectors: AdvancedFieldSelector[] | undefined;
482
157
  }
483
158
  export declare namespace AdvancedEventSelector {
484
- /**
485
- * @internal
486
- */
159
+
487
160
  const filterSensitiveLog: (obj: AdvancedEventSelector) => any;
488
161
  }
489
- /**
490
- * <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information,
491
- * 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>
492
- * 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>
493
- */
162
+
494
163
  export interface CloudTrailAccessNotEnabledException extends __SmithyException, $MetadataBearer {
495
164
  name: "CloudTrailAccessNotEnabledException";
496
165
  $fault: "client";
497
- /**
498
- * <p>Brief description of the exception returned by the request.</p>
499
- */
166
+
500
167
  Message?: string;
501
168
  }
502
169
  export declare namespace CloudTrailAccessNotEnabledException {
503
- /**
504
- * @internal
505
- */
170
+
506
171
  const filterSensitiveLog: (obj: CloudTrailAccessNotEnabledException) => any;
507
172
  }
508
- /**
509
- * <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code> error code.
510
- * This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that
511
- * is in a suspended Amazon Web Services account.</p>
512
- */
173
+
513
174
  export interface CloudTrailInvalidClientTokenIdException extends __SmithyException, $MetadataBearer {
514
175
  name: "CloudTrailInvalidClientTokenIdException";
515
176
  $fault: "client";
516
- /**
517
- * <p>Brief description of the exception returned by the request.</p>
518
- */
177
+
519
178
  Message?: string;
520
179
  }
521
180
  export declare namespace CloudTrailInvalidClientTokenIdException {
522
- /**
523
- * @internal
524
- */
181
+
525
182
  const filterSensitiveLog: (obj: CloudTrailInvalidClientTokenIdException) => any;
526
183
  }
527
- /**
528
- * <p>Cannot set a CloudWatch Logs delivery for this region.</p>
529
- */
184
+
530
185
  export interface CloudWatchLogsDeliveryUnavailableException extends __SmithyException, $MetadataBearer {
531
186
  name: "CloudWatchLogsDeliveryUnavailableException";
532
187
  $fault: "client";
533
- /**
534
- * <p>Brief description of the exception returned by the request.</p>
535
- */
188
+
536
189
  Message?: string;
537
190
  }
538
191
  export declare namespace CloudWatchLogsDeliveryUnavailableException {
539
- /**
540
- * @internal
541
- */
192
+
542
193
  const filterSensitiveLog: (obj: CloudWatchLogsDeliveryUnavailableException) => any;
543
194
  }
544
- /**
545
- * <p>Specifies the settings for each trail.</p>
546
- */
195
+
547
196
  export interface CreateTrailRequest {
548
- /**
549
- * <p>Specifies the name of the trail. The name must meet the following requirements:</p>
550
- * <ul>
551
- * <li>
552
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
553
- * </li>
554
- * <li>
555
- * <p>Start with a letter or number, and end with a letter or number</p>
556
- * </li>
557
- * <li>
558
- * <p>Be between 3 and 128 characters</p>
559
- * </li>
560
- * <li>
561
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
562
- * and <code>my--namespace</code> are not valid.</p>
563
- * </li>
564
- * <li>
565
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
566
- * </li>
567
- * </ul>
568
- */
197
+
569
198
  Name: string | undefined;
570
- /**
571
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
572
- */
199
+
573
200
  S3BucketName: string | undefined;
574
- /**
575
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
576
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>
577
- */
201
+
578
202
  S3KeyPrefix?: string;
579
- /**
580
- * <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>
581
- */
203
+
582
204
  SnsTopicName?: string;
583
- /**
584
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
585
- */
205
+
586
206
  IncludeGlobalServiceEvents?: boolean;
587
- /**
588
- * <p>Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider
589
- * creating trails that log events in all regions.</p>
590
- */
207
+
591
208
  IsMultiRegionTrail?: boolean;
592
- /**
593
- * <p>Specifies whether log file integrity validation is enabled. The default is false.</p>
594
- * <note>
595
- * <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does
596
- * not create digest files for log files that were delivered during a period in which log file integrity validation was disabled.
597
- * For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable
598
- * it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on
599
- * January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p>
600
- * </note>
601
- */
209
+
602
210
  EnableLogFileValidation?: boolean;
603
- /**
604
- * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group
605
- * to which CloudTrail logs will be delivered. Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
606
- */
211
+
607
212
  CloudWatchLogsLogGroupArn?: string;
608
- /**
609
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
610
- */
213
+
611
214
  CloudWatchLogsRoleArn?: string;
612
- /**
613
- * <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
614
- * value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
615
- * specified ARN to a key, or a globally unique identifier.</p>
616
- * <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys,
617
- * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
618
- * <p>Examples:</p>
619
- * <ul>
620
- * <li>
621
- * <p>alias/MyAliasName</p>
622
- * </li>
623
- * <li>
624
- * <p>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</p>
625
- * </li>
626
- * <li>
627
- * <p>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</p>
628
- * </li>
629
- * <li>
630
- * <p>12345678-1234-1234-1234-123456789012</p>
631
- * </li>
632
- * </ul>
633
- */
215
+
634
216
  KmsKeyId?: string;
635
- /**
636
- * <p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
637
- * The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in
638
- * Organizations.</p>
639
- */
217
+
640
218
  IsOrganizationTrail?: boolean;
641
- /**
642
- * <p>A list of tags.</p>
643
- */
219
+
644
220
  TagsList?: Tag[];
645
221
  }
646
222
  export declare namespace CreateTrailRequest {
647
- /**
648
- * @internal
649
- */
223
+
650
224
  const filterSensitiveLog: (obj: CreateTrailRequest) => any;
651
225
  }
652
- /**
653
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
654
- */
226
+
655
227
  export interface CreateTrailResponse {
656
- /**
657
- * <p>Specifies the name of the trail.</p>
658
- */
228
+
659
229
  Name?: string;
660
- /**
661
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>
662
- */
230
+
663
231
  S3BucketName?: string;
664
- /**
665
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
666
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>.</p>
667
- */
232
+
668
233
  S3KeyPrefix?: string;
669
- /**
670
- * @deprecated
671
- *
672
- * <p>This field is no longer in use. Use SnsTopicARN.</p>
673
- */
234
+
674
235
  SnsTopicName?: string;
675
- /**
676
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p>
677
- * <p>
678
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
679
- * </p>
680
- */
236
+
681
237
  SnsTopicARN?: string;
682
- /**
683
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
684
- */
238
+
685
239
  IncludeGlobalServiceEvents?: boolean;
686
- /**
687
- * <p>Specifies whether the trail exists in one region or in all regions.</p>
688
- */
240
+
689
241
  IsMultiRegionTrail?: boolean;
690
- /**
691
- * <p>Specifies the ARN of the trail that was created. The format of a trail ARN
692
- * is:</p>
693
- * <p>
694
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
695
- * </p>
696
- */
242
+
697
243
  TrailARN?: string;
698
- /**
699
- * <p>Specifies whether log file integrity validation is enabled.</p>
700
- */
244
+
701
245
  LogFileValidationEnabled?: boolean;
702
- /**
703
- * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>
704
- */
246
+
705
247
  CloudWatchLogsLogGroupArn?: string;
706
- /**
707
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
708
- */
248
+
709
249
  CloudWatchLogsRoleArn?: string;
710
- /**
711
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
712
- * The value is a fully specified ARN to a KMS key in the following format.</p>
713
- * <p>
714
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
715
- * </p>
716
- */
250
+
717
251
  KmsKeyId?: string;
718
- /**
719
- * <p>Specifies whether the trail is an organization trail.</p>
720
- */
252
+
721
253
  IsOrganizationTrail?: boolean;
722
254
  }
723
255
  export declare namespace CreateTrailResponse {
724
- /**
725
- * @internal
726
- */
256
+
727
257
  const filterSensitiveLog: (obj: CreateTrailResponse) => any;
728
258
  }
729
- /**
730
- * <p>This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for
731
- * creating an organization trail in a required service. For more information, see
732
- * <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>
733
- */
259
+
734
260
  export interface InsufficientDependencyServiceAccessPermissionException extends __SmithyException, $MetadataBearer {
735
261
  name: "InsufficientDependencyServiceAccessPermissionException";
736
262
  $fault: "client";
737
- /**
738
- * <p>Brief description of the exception returned by the request.</p>
739
- */
263
+
740
264
  Message?: string;
741
265
  }
742
266
  export declare namespace InsufficientDependencyServiceAccessPermissionException {
743
- /**
744
- * @internal
745
- */
267
+
746
268
  const filterSensitiveLog: (obj: InsufficientDependencyServiceAccessPermissionException) => any;
747
269
  }
748
- /**
749
- * <p>This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.</p>
750
- */
270
+
751
271
  export interface InsufficientEncryptionPolicyException extends __SmithyException, $MetadataBearer {
752
272
  name: "InsufficientEncryptionPolicyException";
753
273
  $fault: "client";
754
- /**
755
- * <p>Brief description of the exception returned by the request.</p>
756
- */
274
+
757
275
  Message?: string;
758
276
  }
759
277
  export declare namespace InsufficientEncryptionPolicyException {
760
- /**
761
- * @internal
762
- */
278
+
763
279
  const filterSensitiveLog: (obj: InsufficientEncryptionPolicyException) => any;
764
280
  }
765
- /**
766
- * <p>This exception is thrown when the policy on the S3 bucket is not sufficient.</p>
767
- */
281
+
768
282
  export interface InsufficientS3BucketPolicyException extends __SmithyException, $MetadataBearer {
769
283
  name: "InsufficientS3BucketPolicyException";
770
284
  $fault: "client";
771
- /**
772
- * <p>Brief description of the exception returned by the request.</p>
773
- */
285
+
774
286
  Message?: string;
775
287
  }
776
288
  export declare namespace InsufficientS3BucketPolicyException {
777
- /**
778
- * @internal
779
- */
289
+
780
290
  const filterSensitiveLog: (obj: InsufficientS3BucketPolicyException) => any;
781
291
  }
782
- /**
783
- * <p>This exception is thrown when the policy on the Amazon SNS topic is not sufficient.</p>
784
- */
292
+
785
293
  export interface InsufficientSnsTopicPolicyException extends __SmithyException, $MetadataBearer {
786
294
  name: "InsufficientSnsTopicPolicyException";
787
295
  $fault: "client";
788
- /**
789
- * <p>Brief description of the exception returned by the request.</p>
790
- */
296
+
791
297
  Message?: string;
792
298
  }
793
299
  export declare namespace InsufficientSnsTopicPolicyException {
794
- /**
795
- * @internal
796
- */
300
+
797
301
  const filterSensitiveLog: (obj: InsufficientSnsTopicPolicyException) => any;
798
302
  }
799
- /**
800
- * <p>This exception is thrown when the provided CloudWatch Logs log group is not valid.</p>
801
- */
303
+
802
304
  export interface InvalidCloudWatchLogsLogGroupArnException extends __SmithyException, $MetadataBearer {
803
305
  name: "InvalidCloudWatchLogsLogGroupArnException";
804
306
  $fault: "client";
805
- /**
806
- * <p>Brief description of the exception returned by the request.</p>
807
- */
307
+
808
308
  Message?: string;
809
309
  }
810
310
  export declare namespace InvalidCloudWatchLogsLogGroupArnException {
811
- /**
812
- * @internal
813
- */
311
+
814
312
  const filterSensitiveLog: (obj: InvalidCloudWatchLogsLogGroupArnException) => any;
815
313
  }
816
- /**
817
- * <p>This exception is thrown when the provided role is not valid.</p>
818
- */
314
+
819
315
  export interface InvalidCloudWatchLogsRoleArnException extends __SmithyException, $MetadataBearer {
820
316
  name: "InvalidCloudWatchLogsRoleArnException";
821
317
  $fault: "client";
822
- /**
823
- * <p>Brief description of the exception returned by the request.</p>
824
- */
318
+
825
319
  Message?: string;
826
320
  }
827
321
  export declare namespace InvalidCloudWatchLogsRoleArnException {
828
- /**
829
- * @internal
830
- */
322
+
831
323
  const filterSensitiveLog: (obj: InvalidCloudWatchLogsRoleArnException) => any;
832
324
  }
833
- /**
834
- * <p>This exception is thrown when the KMS key ARN is not valid.</p>
835
- */
325
+
836
326
  export interface InvalidKmsKeyIdException extends __SmithyException, $MetadataBearer {
837
327
  name: "InvalidKmsKeyIdException";
838
328
  $fault: "client";
839
- /**
840
- * <p>Brief description of the exception returned by the request.</p>
841
- */
329
+
842
330
  Message?: string;
843
331
  }
844
332
  export declare namespace InvalidKmsKeyIdException {
845
- /**
846
- * @internal
847
- */
333
+
848
334
  const filterSensitiveLog: (obj: InvalidKmsKeyIdException) => any;
849
335
  }
850
- /**
851
- * <p>This exception is thrown when the combination of parameters provided is not valid.</p>
852
- */
336
+
853
337
  export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
854
338
  name: "InvalidParameterCombinationException";
855
339
  $fault: "client";
856
- /**
857
- * <p>Brief description of the exception returned by the request.</p>
858
- */
340
+
859
341
  Message?: string;
860
342
  }
861
343
  export declare namespace InvalidParameterCombinationException {
862
- /**
863
- * @internal
864
- */
344
+
865
345
  const filterSensitiveLog: (obj: InvalidParameterCombinationException) => any;
866
346
  }
867
- /**
868
- * <p>This exception is thrown when the provided S3 bucket name is not valid.</p>
869
- */
347
+
870
348
  export interface InvalidS3BucketNameException extends __SmithyException, $MetadataBearer {
871
349
  name: "InvalidS3BucketNameException";
872
350
  $fault: "client";
873
- /**
874
- * <p>Brief description of the exception returned by the request.</p>
875
- */
351
+
876
352
  Message?: string;
877
353
  }
878
354
  export declare namespace InvalidS3BucketNameException {
879
- /**
880
- * @internal
881
- */
355
+
882
356
  const filterSensitiveLog: (obj: InvalidS3BucketNameException) => any;
883
357
  }
884
- /**
885
- * <p>This exception is thrown when the provided S3 prefix is not valid.</p>
886
- */
358
+
887
359
  export interface InvalidS3PrefixException extends __SmithyException, $MetadataBearer {
888
360
  name: "InvalidS3PrefixException";
889
361
  $fault: "client";
890
- /**
891
- * <p>Brief description of the exception returned by the request.</p>
892
- */
362
+
893
363
  Message?: string;
894
364
  }
895
365
  export declare namespace InvalidS3PrefixException {
896
- /**
897
- * @internal
898
- */
366
+
899
367
  const filterSensitiveLog: (obj: InvalidS3PrefixException) => any;
900
368
  }
901
- /**
902
- * <p>This exception is thrown when the provided SNS topic name is not valid.</p>
903
- */
369
+
904
370
  export interface InvalidSnsTopicNameException extends __SmithyException, $MetadataBearer {
905
371
  name: "InvalidSnsTopicNameException";
906
372
  $fault: "client";
907
- /**
908
- * <p>Brief description of the exception returned by the request.</p>
909
- */
373
+
910
374
  Message?: string;
911
375
  }
912
376
  export declare namespace InvalidSnsTopicNameException {
913
- /**
914
- * @internal
915
- */
377
+
916
378
  const filterSensitiveLog: (obj: InvalidSnsTopicNameException) => any;
917
379
  }
918
- /**
919
- * <p>This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.</p>
920
- */
380
+
921
381
  export interface KmsException extends __SmithyException, $MetadataBearer {
922
382
  name: "KmsException";
923
383
  $fault: "client";
924
- /**
925
- * <p>Brief description of the exception returned by the request.</p>
926
- */
384
+
927
385
  Message?: string;
928
386
  }
929
387
  export declare namespace KmsException {
930
- /**
931
- * @internal
932
- */
388
+
933
389
  const filterSensitiveLog: (obj: KmsException) => any;
934
390
  }
935
- /**
936
- * @deprecated
937
- *
938
- * <p>This exception is no longer in use.</p>
939
- */
391
+
940
392
  export interface KmsKeyDisabledException extends __SmithyException, $MetadataBearer {
941
393
  name: "KmsKeyDisabledException";
942
394
  $fault: "client";
943
- /**
944
- * <p>Brief description of the exception returned by the request.</p>
945
- */
395
+
946
396
  Message?: string;
947
397
  }
948
398
  export declare namespace KmsKeyDisabledException {
949
- /**
950
- * @internal
951
- */
399
+
952
400
  const filterSensitiveLog: (obj: KmsKeyDisabledException) => any;
953
401
  }
954
- /**
955
- * <p>This exception is thrown when the KMS key does not exist, when the S3 bucket and the
956
- * KMS key are not in the same region, or when the KMS key associated with the Amazon SNS
957
- * topic either does not exist or is not in the same region.</p>
958
- */
402
+
959
403
  export interface KmsKeyNotFoundException extends __SmithyException, $MetadataBearer {
960
404
  name: "KmsKeyNotFoundException";
961
405
  $fault: "client";
962
- /**
963
- * <p>Brief description of the exception returned by the request.</p>
964
- */
406
+
965
407
  Message?: string;
966
408
  }
967
409
  export declare namespace KmsKeyNotFoundException {
968
- /**
969
- * @internal
970
- */
410
+
971
411
  const filterSensitiveLog: (obj: KmsKeyNotFoundException) => any;
972
412
  }
973
- /**
974
- * <p>This exception is thrown when the maximum number of trails is reached.</p>
975
- */
413
+
976
414
  export interface MaximumNumberOfTrailsExceededException extends __SmithyException, $MetadataBearer {
977
415
  name: "MaximumNumberOfTrailsExceededException";
978
416
  $fault: "client";
979
- /**
980
- * <p>Brief description of the exception returned by the request.</p>
981
- */
417
+
982
418
  Message?: string;
983
419
  }
984
420
  export declare namespace MaximumNumberOfTrailsExceededException {
985
- /**
986
- * @internal
987
- */
421
+
988
422
  const filterSensitiveLog: (obj: MaximumNumberOfTrailsExceededException) => any;
989
423
  }
990
- /**
991
- * <p>This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support
992
- * creating an organization trail. For more information, see
993
- * <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>
994
- */
424
+
995
425
  export interface OrganizationNotInAllFeaturesModeException extends __SmithyException, $MetadataBearer {
996
426
  name: "OrganizationNotInAllFeaturesModeException";
997
427
  $fault: "client";
998
- /**
999
- * <p>Brief description of the exception returned by the request.</p>
1000
- */
428
+
1001
429
  Message?: string;
1002
430
  }
1003
431
  export declare namespace OrganizationNotInAllFeaturesModeException {
1004
- /**
1005
- * @internal
1006
- */
432
+
1007
433
  const filterSensitiveLog: (obj: OrganizationNotInAllFeaturesModeException) => any;
1008
434
  }
1009
- /**
1010
- * <p>This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization.
1011
- * To make this request, sign in using the credentials of an account that belongs to an organization.</p>
1012
- */
435
+
1013
436
  export interface OrganizationsNotInUseException extends __SmithyException, $MetadataBearer {
1014
437
  name: "OrganizationsNotInUseException";
1015
438
  $fault: "client";
1016
- /**
1017
- * <p>Brief description of the exception returned by the request.</p>
1018
- */
439
+
1019
440
  Message?: string;
1020
441
  }
1021
442
  export declare namespace OrganizationsNotInUseException {
1022
- /**
1023
- * @internal
1024
- */
443
+
1025
444
  const filterSensitiveLog: (obj: OrganizationsNotInUseException) => any;
1026
445
  }
1027
- /**
1028
- * <p>This exception is thrown when the specified S3 bucket does not exist.</p>
1029
- */
446
+
1030
447
  export interface S3BucketDoesNotExistException extends __SmithyException, $MetadataBearer {
1031
448
  name: "S3BucketDoesNotExistException";
1032
449
  $fault: "client";
1033
- /**
1034
- * <p>Brief description of the exception returned by the request.</p>
1035
- */
450
+
1036
451
  Message?: string;
1037
452
  }
1038
453
  export declare namespace S3BucketDoesNotExistException {
1039
- /**
1040
- * @internal
1041
- */
454
+
1042
455
  const filterSensitiveLog: (obj: S3BucketDoesNotExistException) => any;
1043
456
  }
1044
- /**
1045
- * <p>This exception is thrown when the specified trail already exists.</p>
1046
- */
457
+
1047
458
  export interface TrailAlreadyExistsException extends __SmithyException, $MetadataBearer {
1048
459
  name: "TrailAlreadyExistsException";
1049
460
  $fault: "client";
1050
- /**
1051
- * <p>Brief description of the exception returned by the request.</p>
1052
- */
461
+
1053
462
  Message?: string;
1054
463
  }
1055
464
  export declare namespace TrailAlreadyExistsException {
1056
- /**
1057
- * @internal
1058
- */
465
+
1059
466
  const filterSensitiveLog: (obj: TrailAlreadyExistsException) => any;
1060
467
  }
1061
- /**
1062
- * <p>This exception is no longer in use.</p>
1063
- */
468
+
1064
469
  export interface TrailNotProvidedException extends __SmithyException, $MetadataBearer {
1065
470
  name: "TrailNotProvidedException";
1066
471
  $fault: "client";
1067
- /**
1068
- * <p>Brief description of the exception returned by the request.</p>
1069
- */
472
+
1070
473
  Message?: string;
1071
474
  }
1072
475
  export declare namespace TrailNotProvidedException {
1073
- /**
1074
- * @internal
1075
- */
476
+
1076
477
  const filterSensitiveLog: (obj: TrailNotProvidedException) => any;
1077
478
  }
1078
- /**
1079
- * <p>This exception is thrown when the specified resource is not ready for an operation.
1080
- * This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail.
1081
- * If this exception occurs, wait a few minutes, and then try the operation again.</p>
1082
- */
479
+
1083
480
  export interface ConflictException extends __SmithyException, $MetadataBearer {
1084
481
  name: "ConflictException";
1085
482
  $fault: "client";
1086
- /**
1087
- * <p>Brief description of the exception returned by the request.</p>
1088
- */
483
+
1089
484
  Message?: string;
1090
485
  }
1091
486
  export declare namespace ConflictException {
1092
- /**
1093
- * @internal
1094
- */
487
+
1095
488
  const filterSensitiveLog: (obj: ConflictException) => any;
1096
489
  }
1097
- /**
1098
- * <p>The request that specifies the name of a trail to delete.</p>
1099
- */
490
+
1100
491
  export interface DeleteTrailRequest {
1101
- /**
1102
- * <p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a
1103
- * trail ARN.
1104
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1105
- * </p>
1106
- */
492
+
1107
493
  Name: string | undefined;
1108
494
  }
1109
495
  export declare namespace DeleteTrailRequest {
1110
- /**
1111
- * @internal
1112
- */
496
+
1113
497
  const filterSensitiveLog: (obj: DeleteTrailRequest) => any;
1114
498
  }
1115
- /**
1116
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1117
- */
499
+
1118
500
  export interface DeleteTrailResponse {
1119
501
  }
1120
502
  export declare namespace DeleteTrailResponse {
1121
- /**
1122
- * @internal
1123
- */
503
+
1124
504
  const filterSensitiveLog: (obj: DeleteTrailResponse) => any;
1125
505
  }
1126
- /**
1127
- * <p>This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.</p>
1128
- */
506
+
1129
507
  export interface InvalidHomeRegionException extends __SmithyException, $MetadataBearer {
1130
508
  name: "InvalidHomeRegionException";
1131
509
  $fault: "client";
1132
- /**
1133
- * <p>Brief description of the exception returned by the request.</p>
1134
- */
510
+
1135
511
  Message?: string;
1136
512
  }
1137
513
  export declare namespace InvalidHomeRegionException {
1138
- /**
1139
- * @internal
1140
- */
514
+
1141
515
  const filterSensitiveLog: (obj: InvalidHomeRegionException) => any;
1142
516
  }
1143
- /**
1144
- * <p>This exception is thrown when the trail with the given name is not found.</p>
1145
- */
517
+
1146
518
  export interface TrailNotFoundException extends __SmithyException, $MetadataBearer {
1147
519
  name: "TrailNotFoundException";
1148
520
  $fault: "client";
1149
- /**
1150
- * <p>Brief description of the exception returned by the request.</p>
1151
- */
521
+
1152
522
  Message?: string;
1153
523
  }
1154
524
  export declare namespace TrailNotFoundException {
1155
- /**
1156
- * @internal
1157
- */
525
+
1158
526
  const filterSensitiveLog: (obj: TrailNotFoundException) => any;
1159
527
  }
1160
- /**
1161
- * <p>Returns information about the trail.</p>
1162
- */
528
+
1163
529
  export interface DescribeTrailsRequest {
1164
- /**
1165
- * <p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:</p>
1166
- * <p>
1167
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1168
- * </p>
1169
- *
1170
- * <p>If an empty list is specified, information for the trail in the current region is returned.</p>
1171
- * <ul>
1172
- * <li>
1173
- * <p>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then
1174
- * information for all trails in the current region is returned.</p>
1175
- * </li>
1176
- * <li>
1177
- * <p>If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.</p>
1178
- * </li>
1179
- * </ul>
1180
- * <note>
1181
- * <p>If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.</p>
1182
- * </note>
1183
- */
530
+
1184
531
  trailNameList?: string[];
1185
- /**
1186
- * <p>Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region,
1187
- * or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account
1188
- * and region replication trails will not be returned. The default is true.</p>
1189
- */
532
+
1190
533
  includeShadowTrails?: boolean;
1191
534
  }
1192
535
  export declare namespace DescribeTrailsRequest {
1193
- /**
1194
- * @internal
1195
- */
536
+
1196
537
  const filterSensitiveLog: (obj: DescribeTrailsRequest) => any;
1197
538
  }
1198
- /**
1199
- * <p>The settings for a trail.</p>
1200
- */
539
+
1201
540
  export interface Trail {
1202
- /**
1203
- * <p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is 128
1204
- * characters.</p>
1205
- */
541
+
1206
542
  Name?: string;
1207
- /**
1208
- * <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
1209
- */
543
+
1210
544
  S3BucketName?: string;
1211
- /**
1212
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
1213
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>.
1214
- * The maximum length is 200 characters.</p>
1215
- */
545
+
1216
546
  S3KeyPrefix?: string;
1217
- /**
1218
- * @deprecated
1219
- *
1220
- * <p>This field is no longer in use. Use SnsTopicARN.</p>
1221
- */
547
+
1222
548
  SnsTopicName?: string;
1223
- /**
1224
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications
1225
- * when log files are delivered. The following is the format of a topic ARN.</p>
1226
- * <p>
1227
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
1228
- * </p>
1229
- */
549
+
1230
550
  SnsTopicARN?: string;
1231
- /**
1232
- * <p>Set to <b>True</b> to include Amazon Web Services API calls from Amazon Web Services global services such as IAM.
1233
- * Otherwise, <b>False</b>.</p>
1234
- */
551
+
1235
552
  IncludeGlobalServiceEvents?: boolean;
1236
- /**
1237
- * <p>Specifies whether the trail exists only in one region or exists in all regions.</p>
1238
- */
553
+
1239
554
  IsMultiRegionTrail?: boolean;
1240
- /**
1241
- * <p>The region in which the trail was created.</p>
1242
- */
555
+
1243
556
  HomeRegion?: string;
1244
- /**
1245
- * <p>Specifies the ARN of the trail. The following is the format of a trail ARN.</p>
1246
- * <p>
1247
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1248
- * </p>
1249
- */
557
+
1250
558
  TrailARN?: string;
1251
- /**
1252
- * <p>Specifies whether log file validation is enabled.</p>
1253
- */
559
+
1254
560
  LogFileValidationEnabled?: boolean;
1255
- /**
1256
- * <p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.</p>
1257
- */
561
+
1258
562
  CloudWatchLogsLogGroupArn?: string;
1259
- /**
1260
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
1261
- */
563
+
1262
564
  CloudWatchLogsRoleArn?: string;
1263
- /**
1264
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
1265
- * The value is a fully specified ARN to a KMS key in the following format.</p>
1266
- * <p>
1267
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
1268
- * </p>
1269
- */
565
+
1270
566
  KmsKeyId?: string;
1271
- /**
1272
- * <p>Specifies if the trail has custom event selectors.</p>
1273
- */
567
+
1274
568
  HasCustomEventSelectors?: boolean;
1275
- /**
1276
- * <p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code> list.</p>
1277
- */
569
+
1278
570
  HasInsightSelectors?: boolean;
1279
- /**
1280
- * <p>Specifies whether the trail is an organization trail.</p>
1281
- */
571
+
1282
572
  IsOrganizationTrail?: boolean;
1283
573
  }
1284
574
  export declare namespace Trail {
1285
- /**
1286
- * @internal
1287
- */
575
+
1288
576
  const filterSensitiveLog: (obj: Trail) => any;
1289
577
  }
1290
- /**
1291
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1292
- */
578
+
1293
579
  export interface DescribeTrailsResponse {
1294
- /**
1295
- * <p>The list of trail objects. Trail objects with string values are only returned if values for the objects exist in a trail's configuration.
1296
- * For example, <code>SNSTopicName</code> and <code>SNSTopicARN</code> are only returned in results if a trail is configured to send SNS notifications. Similarly,
1297
- * <code>KMSKeyId</code> only appears in results if a trail's log files are encrypted with KMS customer managed keys.</p>
1298
- */
580
+
1299
581
  trailList?: Trail[];
1300
582
  }
1301
583
  export declare namespace DescribeTrailsResponse {
1302
- /**
1303
- * @internal
1304
- */
584
+
1305
585
  const filterSensitiveLog: (obj: DescribeTrailsResponse) => any;
1306
586
  }
1307
587
  export interface GetEventSelectorsRequest {
1308
- /**
1309
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
1310
- * string must meet the following requirements:</p>
1311
- * <ul>
1312
- * <li>
1313
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
1314
- * </li>
1315
- * <li>
1316
- * <p>Start with a letter or number, and end with a letter or number</p>
1317
- * </li>
1318
- * <li>
1319
- * <p>Be between 3 and 128 characters</p>
1320
- * </li>
1321
- * <li>
1322
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
1323
- * and <code>my--namespace</code> are not valid.</p>
1324
- * </li>
1325
- * <li>
1326
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
1327
- * </li>
1328
- * </ul>
1329
- * <p>If you specify a trail ARN, it must be in the format:</p>
1330
- * <p>
1331
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1332
- * </p>
1333
- */
588
+
1334
589
  TrailName: string | undefined;
1335
590
  }
1336
591
  export declare namespace GetEventSelectorsRequest {
1337
- /**
1338
- * @internal
1339
- */
592
+
1340
593
  const filterSensitiveLog: (obj: GetEventSelectorsRequest) => any;
1341
594
  }
1342
- /**
1343
- * <p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify
1344
- * in your event selectors for your trail to log data events. Data events provide information
1345
- * about the resource operations performed on or within a resource itself. These are also
1346
- * known as data plane operations. You can specify up to 250 data resources for a
1347
- * trail.</p>
1348
- * <note>
1349
- * <p>The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors,
1350
- * but the total cannot exceed 250 across all selectors.</p>
1351
- * <p>If you are using advanced event selectors, the maximum total number of values for
1352
- * all conditions, across all advanced event selectors for the trail, is 500.</p>
1353
- * </note>
1354
- * <p>The following example demonstrates how logging works when you configure logging of all data events
1355
- * for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix,
1356
- * and the option to log both <code>Read</code> and <code>Write</code> data events.</p>
1357
- * <ol>
1358
- * <li>
1359
- * <p>A user uploads an image file to <code>bucket-1</code>.</p>
1360
- * </li>
1361
- * <li>
1362
- * <p>The <code>PutObject</code> API operation is an Amazon S3 object-level API.
1363
- * It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket
1364
- * with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the
1365
- * event.</p>
1366
- * </li>
1367
- * <li>
1368
- * <p>A user uploads an object to an Amazon S3 bucket named
1369
- * <code>arn:aws:s3:::bucket-2</code>.</p>
1370
- * </li>
1371
- * <li>
1372
- * <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket that the CloudTrail
1373
- * user didn't specify for the trail. The trail doesn’t log the event.</p>
1374
- * </li>
1375
- * </ol>
1376
- * <p>The following example demonstrates how logging works when you configure logging of Lambda data events for a
1377
- * Lambda function named <i>MyLambdaFunction</i>, but not for all Lambda functions.</p>
1378
- * <ol>
1379
- * <li>
1380
- * <p>A user runs a script that includes a call to the <i>MyLambdaFunction</i> function and the
1381
- * <i>MyOtherLambdaFunction</i> function.</p>
1382
- * </li>
1383
- * <li>
1384
- * <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is an Lambda API.
1385
- * It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for
1386
- * <i>MyLambdaFunction</i>, any invocations of that function are logged. The trail processes and logs the event.</p>
1387
- * </li>
1388
- * <li>
1389
- * <p>The <code>Invoke</code> API operation on <i>MyOtherLambdaFunction</i> is an Lambda API.
1390
- * Because the CloudTrail user did not specify logging data events for all Lambda functions,
1391
- * the <code>Invoke</code> operation for <i>MyOtherLambdaFunction</i> does not match the function specified for the trail.
1392
- * The trail doesn’t log the event. </p>
1393
- * </li>
1394
- * </ol>
1395
- */
595
+
1396
596
  export interface DataResource {
1397
- /**
1398
- * <p>The resource type in which you want to log data events. You can specify
1399
- * <code>AWS::S3::Object</code>, <code>AWS::Lambda::Function</code>, or
1400
- * <code>AWS::DynamoDB::Table</code> resources.</p>
1401
- * <p>The <code>AWS::S3Outposts::Object</code>, <code>AWS::ManagedBlockchain::Node</code>,
1402
- * <code>AWS::S3ObjectLambda::AccessPoint</code>, and <code>AWS::EC2::Snapshot</code> resource types are not valid in basic
1403
- * event selectors. To log data events on these resource types, use advanced event
1404
- * selectors.</p>
1405
- */
597
+
1406
598
  Type?: string;
1407
- /**
1408
- * <p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.</p>
1409
- * <ul>
1410
- * <li>
1411
- * <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the
1412
- * prefix as <code>arn:aws:s3:::</code>.</p>
1413
- * <note>
1414
- * <p>This also enables logging of data event activity performed by any user or role in your Amazon Web Services account,
1415
- * even if that activity is performed on a bucket that belongs to another Amazon Web Services account.</p>
1416
- * </note>
1417
- * </li>
1418
- * <li>
1419
- * <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty
1420
- * object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for
1421
- * all objects in this S3 bucket.</p>
1422
- * </li>
1423
- * <li>
1424
- * <p>To log data events for specific objects, specify the S3 bucket and object prefix such
1425
- * as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for
1426
- * objects in this S3 bucket that match the prefix.</p>
1427
- * </li>
1428
- * <li>
1429
- * <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as
1430
- * <code>arn:aws:lambda</code>.</p>
1431
- * <note>
1432
- * <p>This also enables logging of <code>Invoke</code> activity performed by any user or role in your Amazon Web Services account,
1433
- * even if that activity is performed on a function that belongs to another Amazon Web Services account. </p>
1434
- * </note>
1435
- * </li>
1436
- * <li>
1437
- * <p>To log data events for a specific Lambda function, specify the function ARN.</p>
1438
- * <note>
1439
- * <p>Lambda function ARNs are exact. For example, if you specify a
1440
- * function ARN <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>, data events will
1441
- * only be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>. They will
1442
- * not be logged for <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld2</i>.</p>
1443
- * </note>
1444
- * </li>
1445
- * <li>
1446
- * <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix
1447
- * as <code>arn:aws:dynamodb</code>.</p>
1448
- * </li>
1449
- * </ul>
1450
- */
599
+
1451
600
  Values?: string[];
1452
601
  }
1453
602
  export declare namespace DataResource {
1454
- /**
1455
- * @internal
1456
- */
603
+
1457
604
  const filterSensitiveLog: (obj: DataResource) => any;
1458
605
  }
1459
606
  export declare enum ReadWriteType {
@@ -1461,600 +608,307 @@ export declare enum ReadWriteType {
1461
608
  ReadOnly = "ReadOnly",
1462
609
  WriteOnly = "WriteOnly"
1463
610
  }
1464
- /**
1465
- * <p>Use event selectors to further specify the management and data event settings for your trail. By
1466
- * default, trails created without specific event selectors will be configured to log all read and
1467
- * write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector
1468
- * for all trails. For each trail, if the event matches any event selector, the trail
1469
- * processes and logs the event. If the event doesn't match any event selector, the trail
1470
- * doesn't log the event.</p>
1471
- * <p>You can configure up to five event selectors for a trail.</p>
1472
- * <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>
1473
- */
611
+
1474
612
  export interface EventSelector {
1475
- /**
1476
- * <p>Specify if you want your trail to log read-only events, write-only events, or all. For example,
1477
- * the EC2 <code>GetConsoleOutput</code> is a read-only API operation and
1478
- * <code>RunInstances</code> is a write-only API operation.</p>
1479
- * <p> By default, the value is <code>All</code>.</p>
1480
- */
613
+
1481
614
  ReadWriteType?: ReadWriteType | string;
1482
- /**
1483
- * <p>Specify if you want your event selector to include management events for your trail.</p>
1484
- * <p>
1485
- * For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events">Management Events</a> in the <i>CloudTrail User Guide</i>.</p>
1486
- *
1487
- * <p>By default, the value is <code>true</code>.</p>
1488
- * <p>The first copy of management events is free. You are charged for additional copies of management
1489
- * events that you are logging on any subsequent trail in the same region. For more information about
1490
- * CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a>.</p>
1491
- */
615
+
1492
616
  IncludeManagementEvents?: boolean;
1493
- /**
1494
- * <p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions,
1495
- * and Amazon DynamoDB tables
1496
- * with basic event selectors. You can specify up to 250 resources for an individual event
1497
- * selector, but the total number of data resources cannot exceed 250 across all event
1498
- * selectors in a trail. This limit does not apply if you configure resource logging for all
1499
- * data events.</p>
1500
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events">Data Events</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Limits in CloudTrail</a>
1501
- * in the <i>CloudTrail User Guide</i>.</p>
1502
- */
617
+
1503
618
  DataResources?: DataResource[];
1504
- /**
1505
- * <p>An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter),
1506
- * or it can filter out Key Management Service or Amazon RDS Data API events by
1507
- * containing <code>kms.amazonaws.com</code> or <code>rdsdata.amazonaws.com</code>. By default, <code>ExcludeManagementEventSources</code> is empty, and KMS and
1508
- * Amazon RDS Data API events are logged to your trail.</p>
1509
- */
619
+
1510
620
  ExcludeManagementEventSources?: string[];
1511
621
  }
1512
622
  export declare namespace EventSelector {
1513
- /**
1514
- * @internal
1515
- */
623
+
1516
624
  const filterSensitiveLog: (obj: EventSelector) => any;
1517
625
  }
1518
626
  export interface GetEventSelectorsResponse {
1519
- /**
1520
- * <p>The specified trail ARN that has the event selectors.</p>
1521
- */
627
+
1522
628
  TrailARN?: string;
1523
- /**
1524
- * <p>The event selectors that are configured for the trail.</p>
1525
- */
629
+
1526
630
  EventSelectors?: EventSelector[];
1527
- /**
1528
- * <p>
1529
- * The advanced event selectors that are configured for the trail.
1530
- * </p>
1531
- */
631
+
1532
632
  AdvancedEventSelectors?: AdvancedEventSelector[];
1533
633
  }
1534
634
  export declare namespace GetEventSelectorsResponse {
1535
- /**
1536
- * @internal
1537
- */
635
+
1538
636
  const filterSensitiveLog: (obj: GetEventSelectorsResponse) => any;
1539
637
  }
1540
638
  export interface GetInsightSelectorsRequest {
1541
- /**
1542
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
1543
- * string must meet the following requirements:</p>
1544
- * <ul>
1545
- * <li>
1546
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
1547
- * </li>
1548
- * <li>
1549
- * <p>Start with a letter or number, and end with a letter or number</p>
1550
- * </li>
1551
- * <li>
1552
- * <p>Be between 3 and 128 characters</p>
1553
- * </li>
1554
- * <li>
1555
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
1556
- * and <code>my--namespace</code> are not valid.</p>
1557
- * </li>
1558
- * <li>
1559
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
1560
- * </li>
1561
- * </ul>
1562
- * <p>If you specify a trail ARN, it must be in the format:</p>
1563
- * <p>
1564
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1565
- * </p>
1566
- */
639
+
1567
640
  TrailName: string | undefined;
1568
641
  }
1569
642
  export declare namespace GetInsightSelectorsRequest {
1570
- /**
1571
- * @internal
1572
- */
643
+
1573
644
  const filterSensitiveLog: (obj: GetInsightSelectorsRequest) => any;
1574
645
  }
1575
646
  export declare enum InsightType {
1576
647
  ApiCallRateInsight = "ApiCallRateInsight"
1577
648
  }
1578
- /**
1579
- * <p>A JSON string that contains a list of insight types that are logged on a trail.</p>
1580
- */
649
+
1581
650
  export interface InsightSelector {
1582
- /**
1583
- * <p>The type of Insights events to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
1584
- */
651
+
1585
652
  InsightType?: InsightType | string;
1586
653
  }
1587
654
  export declare namespace InsightSelector {
1588
- /**
1589
- * @internal
1590
- */
655
+
1591
656
  const filterSensitiveLog: (obj: InsightSelector) => any;
1592
657
  }
1593
658
  export interface GetInsightSelectorsResponse {
1594
- /**
1595
- * <p>The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.</p>
1596
- */
659
+
1597
660
  TrailARN?: string;
1598
- /**
1599
- * <p>A JSON string that contains the insight types you want to log on a trail. In this release, only <code>ApiCallRateInsight</code> is supported as an insight type.</p>
1600
- */
661
+
1601
662
  InsightSelectors?: InsightSelector[];
1602
663
  }
1603
664
  export declare namespace GetInsightSelectorsResponse {
1604
- /**
1605
- * @internal
1606
- */
665
+
1607
666
  const filterSensitiveLog: (obj: GetInsightSelectorsResponse) => any;
1608
667
  }
1609
- /**
1610
- * <p>If you run <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code>.</p>
1611
- */
668
+
1612
669
  export interface InsightNotEnabledException extends __SmithyException, $MetadataBearer {
1613
670
  name: "InsightNotEnabledException";
1614
671
  $fault: "client";
1615
- /**
1616
- * <p>Brief description of the exception returned by the request.</p>
1617
- */
672
+
1618
673
  Message?: string;
1619
674
  }
1620
675
  export declare namespace InsightNotEnabledException {
1621
- /**
1622
- * @internal
1623
- */
676
+
1624
677
  const filterSensitiveLog: (obj: InsightNotEnabledException) => any;
1625
678
  }
1626
679
  export interface GetTrailRequest {
1627
- /**
1628
- * <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.</p>
1629
- */
680
+
1630
681
  Name: string | undefined;
1631
682
  }
1632
683
  export declare namespace GetTrailRequest {
1633
- /**
1634
- * @internal
1635
- */
684
+
1636
685
  const filterSensitiveLog: (obj: GetTrailRequest) => any;
1637
686
  }
1638
687
  export interface GetTrailResponse {
1639
- /**
1640
- * <p>The settings for a trail.</p>
1641
- */
688
+
1642
689
  Trail?: Trail;
1643
690
  }
1644
691
  export declare namespace GetTrailResponse {
1645
- /**
1646
- * @internal
1647
- */
692
+
1648
693
  const filterSensitiveLog: (obj: GetTrailResponse) => any;
1649
694
  }
1650
- /**
1651
- * <p>The name of a trail about which you want the current status.</p>
1652
- */
695
+
1653
696
  export interface GetTrailStatusRequest {
1654
- /**
1655
- * <p>Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a
1656
- * shadow trail (a replication of the trail in another region), you must specify its ARN. The following is the format of a trail ARN.</p>
1657
- * <p>
1658
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1659
- * </p>
1660
- */
697
+
1661
698
  Name: string | undefined;
1662
699
  }
1663
700
  export declare namespace GetTrailStatusRequest {
1664
- /**
1665
- * @internal
1666
- */
701
+
1667
702
  const filterSensitiveLog: (obj: GetTrailStatusRequest) => any;
1668
703
  }
1669
- /**
1670
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1671
- */
704
+
1672
705
  export interface GetTrailStatusResponse {
1673
- /**
1674
- * <p>Whether the CloudTrail trail is currently logging Amazon Web Services API calls.</p>
1675
- */
706
+
1676
707
  IsLogging?: boolean;
1677
- /**
1678
- * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files
1679
- * to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
1680
- * Responses</a> in the Amazon S3 API Reference. </p>
1681
- * <note>
1682
- * <p>This error occurs only when there is a problem with the destination S3 bucket, and does
1683
- * not occur for requests that time out. To resolve the issue, create a new bucket, and then call
1684
- * <code>UpdateTrail</code> to specify the new bucket; or fix the existing objects so that
1685
- * CloudTrail can again write to the bucket.</p>
1686
- * </note>
1687
- */
708
+
1688
709
  LatestDeliveryError?: string;
1689
- /**
1690
- * <p>Displays any Amazon SNS error that CloudTrail encountered when attempting to send a
1691
- * notification. For more information about Amazon SNS errors, see the <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon SNS Developer Guide</a>.
1692
- * </p>
1693
- */
710
+
1694
711
  LatestNotificationError?: string;
1695
- /**
1696
- * <p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>
1697
- */
712
+
1698
713
  LatestDeliveryTime?: Date;
1699
- /**
1700
- * <p>Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.</p>
1701
- */
714
+
1702
715
  LatestNotificationTime?: Date;
1703
- /**
1704
- * <p>Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.</p>
1705
- */
716
+
1706
717
  StartLoggingTime?: Date;
1707
- /**
1708
- * <p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.</p>
1709
- */
718
+
1710
719
  StopLoggingTime?: Date;
1711
- /**
1712
- * <p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.</p>
1713
- */
720
+
1714
721
  LatestCloudWatchLogsDeliveryError?: string;
1715
- /**
1716
- * <p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>
1717
- */
722
+
1718
723
  LatestCloudWatchLogsDeliveryTime?: Date;
1719
- /**
1720
- * <p>Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.</p>
1721
- */
724
+
1722
725
  LatestDigestDeliveryTime?: Date;
1723
- /**
1724
- * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest
1725
- * file to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
1726
- * Responses</a> in the Amazon S3 API Reference. </p>
1727
- * <note>
1728
- * <p>This error occurs only when there is a problem with the destination S3 bucket, and does
1729
- * not occur for requests that time out. To resolve the issue, create a new bucket, and then call
1730
- * <code>UpdateTrail</code> to specify the new bucket; or fix the existing objects so that
1731
- * CloudTrail can again write to the bucket.</p>
1732
- * </note>
1733
- */
726
+
1734
727
  LatestDigestDeliveryError?: string;
1735
- /**
1736
- * <p>This field is no longer in use.</p>
1737
- */
728
+
1738
729
  LatestDeliveryAttemptTime?: string;
1739
- /**
1740
- * <p>This field is no longer in use.</p>
1741
- */
730
+
1742
731
  LatestNotificationAttemptTime?: string;
1743
- /**
1744
- * <p>This field is no longer in use.</p>
1745
- */
732
+
1746
733
  LatestNotificationAttemptSucceeded?: string;
1747
- /**
1748
- * <p>This field is no longer in use.</p>
1749
- */
734
+
1750
735
  LatestDeliveryAttemptSucceeded?: string;
1751
- /**
1752
- * <p>This field is no longer in use.</p>
1753
- */
736
+
1754
737
  TimeLoggingStarted?: string;
1755
- /**
1756
- * <p>This field is no longer in use.</p>
1757
- */
738
+
1758
739
  TimeLoggingStopped?: string;
1759
740
  }
1760
741
  export declare namespace GetTrailStatusResponse {
1761
- /**
1762
- * @internal
1763
- */
742
+
1764
743
  const filterSensitiveLog: (obj: GetTrailStatusResponse) => any;
1765
744
  }
1766
- /**
1767
- * <p>Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.</p>
1768
- */
745
+
1769
746
  export interface InvalidTimeRangeException extends __SmithyException, $MetadataBearer {
1770
747
  name: "InvalidTimeRangeException";
1771
748
  $fault: "client";
1772
- /**
1773
- * <p>Brief description of the exception returned by the request.</p>
1774
- */
749
+
1775
750
  Message?: string;
1776
751
  }
1777
752
  export declare namespace InvalidTimeRangeException {
1778
- /**
1779
- * @internal
1780
- */
753
+
1781
754
  const filterSensitiveLog: (obj: InvalidTimeRangeException) => any;
1782
755
  }
1783
- /**
1784
- * <p>Reserved for future use.</p>
1785
- */
756
+
1786
757
  export interface InvalidTokenException extends __SmithyException, $MetadataBearer {
1787
758
  name: "InvalidTokenException";
1788
759
  $fault: "client";
1789
- /**
1790
- * <p>Brief description of the exception returned by the request.</p>
1791
- */
760
+
1792
761
  Message?: string;
1793
762
  }
1794
763
  export declare namespace InvalidTokenException {
1795
- /**
1796
- * @internal
1797
- */
764
+
1798
765
  const filterSensitiveLog: (obj: InvalidTokenException) => any;
1799
766
  }
1800
- /**
1801
- * <p>Requests the public keys for a specified time range.</p>
1802
- */
767
+
1803
768
  export interface ListPublicKeysRequest {
1804
- /**
1805
- * <p>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files.
1806
- * If not specified, the current time is used, and the current public key is returned.</p>
1807
- */
769
+
1808
770
  StartTime?: Date;
1809
- /**
1810
- * <p>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not
1811
- * specified, the current time is used.</p>
1812
- */
771
+
1813
772
  EndTime?: Date;
1814
- /**
1815
- * <p>Reserved for future use.</p>
1816
- */
773
+
1817
774
  NextToken?: string;
1818
775
  }
1819
776
  export declare namespace ListPublicKeysRequest {
1820
- /**
1821
- * @internal
1822
- */
777
+
1823
778
  const filterSensitiveLog: (obj: ListPublicKeysRequest) => any;
1824
779
  }
1825
- /**
1826
- * <p>Contains information about a returned public key.</p>
1827
- */
780
+
1828
781
  export interface PublicKey {
1829
- /**
1830
- * <p>The DER encoded public key value in PKCS#1 format.</p>
1831
- */
782
+
1832
783
  Value?: Uint8Array;
1833
- /**
1834
- * <p>The starting time of validity of the public key.</p>
1835
- */
784
+
1836
785
  ValidityStartTime?: Date;
1837
- /**
1838
- * <p>The ending time of validity of the public key.</p>
1839
- */
786
+
1840
787
  ValidityEndTime?: Date;
1841
- /**
1842
- * <p>The fingerprint of the public key.</p>
1843
- */
788
+
1844
789
  Fingerprint?: string;
1845
790
  }
1846
791
  export declare namespace PublicKey {
1847
- /**
1848
- * @internal
1849
- */
792
+
1850
793
  const filterSensitiveLog: (obj: PublicKey) => any;
1851
794
  }
1852
- /**
1853
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1854
- */
795
+
1855
796
  export interface ListPublicKeysResponse {
1856
- /**
1857
- * <p>Contains an array of PublicKey objects.</p>
1858
- * <note>
1859
- * <p>The returned public keys may have validity time ranges that overlap.</p>
1860
- * </note>
1861
- */
797
+
1862
798
  PublicKeyList?: PublicKey[];
1863
- /**
1864
- * <p>Reserved for future use.</p>
1865
- */
799
+
1866
800
  NextToken?: string;
1867
801
  }
1868
802
  export declare namespace ListPublicKeysResponse {
1869
- /**
1870
- * @internal
1871
- */
803
+
1872
804
  const filterSensitiveLog: (obj: ListPublicKeysResponse) => any;
1873
805
  }
1874
- /**
1875
- * <p>Specifies a list of trail tags to return.</p>
1876
- */
806
+
1877
807
  export interface ListTagsRequest {
1878
- /**
1879
- * <p>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The following is the format of
1880
- * a trail ARN.</p>
1881
- * <p>
1882
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
1883
- * </p>
1884
- */
808
+
1885
809
  ResourceIdList: string[] | undefined;
1886
- /**
1887
- * <p>Reserved for future use.</p>
1888
- */
810
+
1889
811
  NextToken?: string;
1890
812
  }
1891
813
  export declare namespace ListTagsRequest {
1892
- /**
1893
- * @internal
1894
- */
814
+
1895
815
  const filterSensitiveLog: (obj: ListTagsRequest) => any;
1896
816
  }
1897
- /**
1898
- * <p>A resource tag.</p>
1899
- */
817
+
1900
818
  export interface ResourceTag {
1901
- /**
1902
- * <p>Specifies the ARN of the resource.</p>
1903
- */
819
+
1904
820
  ResourceId?: string;
1905
- /**
1906
- * <p>A list of tags.</p>
1907
- */
821
+
1908
822
  TagsList?: Tag[];
1909
823
  }
1910
824
  export declare namespace ResourceTag {
1911
- /**
1912
- * @internal
1913
- */
825
+
1914
826
  const filterSensitiveLog: (obj: ResourceTag) => any;
1915
827
  }
1916
- /**
1917
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
1918
- */
828
+
1919
829
  export interface ListTagsResponse {
1920
- /**
1921
- * <p>A list of resource tags.</p>
1922
- */
830
+
1923
831
  ResourceTagList?: ResourceTag[];
1924
- /**
1925
- * <p>Reserved for future use.</p>
1926
- */
832
+
1927
833
  NextToken?: string;
1928
834
  }
1929
835
  export declare namespace ListTagsResponse {
1930
- /**
1931
- * @internal
1932
- */
836
+
1933
837
  const filterSensitiveLog: (obj: ListTagsResponse) => any;
1934
838
  }
1935
839
  export interface ListTrailsRequest {
1936
- /**
1937
- * <p>The token to use to get the next page of results after a previous API call. This token must be passed
1938
- * in with the same parameters that were specified in the the original call. For example, if the original
1939
- * call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should
1940
- * include those same parameters.</p>
1941
- */
840
+
1942
841
  NextToken?: string;
1943
842
  }
1944
843
  export declare namespace ListTrailsRequest {
1945
- /**
1946
- * @internal
1947
- */
844
+
1948
845
  const filterSensitiveLog: (obj: ListTrailsRequest) => any;
1949
846
  }
1950
- /**
1951
- * <p>Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).</p>
1952
- */
847
+
1953
848
  export interface TrailInfo {
1954
- /**
1955
- * <p>The ARN of a trail.</p>
1956
- */
849
+
1957
850
  TrailARN?: string;
1958
- /**
1959
- * <p>The name of a trail.</p>
1960
- */
851
+
1961
852
  Name?: string;
1962
- /**
1963
- * <p>The Amazon Web Services Region in which a trail was created.</p>
1964
- */
853
+
1965
854
  HomeRegion?: string;
1966
855
  }
1967
856
  export declare namespace TrailInfo {
1968
- /**
1969
- * @internal
1970
- */
857
+
1971
858
  const filterSensitiveLog: (obj: TrailInfo) => any;
1972
859
  }
1973
860
  export interface ListTrailsResponse {
1974
- /**
1975
- * <p>Returns the name, ARN, and home region of trails in the current account.</p>
1976
- */
861
+
1977
862
  Trails?: TrailInfo[];
1978
- /**
1979
- * <p>The token to use to get the next page of results after a previous API call. If the token does not appear,
1980
- * there are no more results to return. The token must be passed in with the same parameters as the previous call.
1981
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
1982
- * NextToken should include those same parameters.</p>
1983
- */
863
+
1984
864
  NextToken?: string;
1985
865
  }
1986
866
  export declare namespace ListTrailsResponse {
1987
- /**
1988
- * @internal
1989
- */
867
+
1990
868
  const filterSensitiveLog: (obj: ListTrailsResponse) => any;
1991
869
  }
1992
- /**
1993
- * <p>Occurs if an event category that is not valid is specified as a value of <code>EventCategory</code>.</p>
1994
- */
870
+
1995
871
  export interface InvalidEventCategoryException extends __SmithyException, $MetadataBearer {
1996
872
  name: "InvalidEventCategoryException";
1997
873
  $fault: "client";
1998
- /**
1999
- * <p>Brief description of the exception returned by the request.</p>
2000
- */
874
+
2001
875
  Message?: string;
2002
876
  }
2003
877
  export declare namespace InvalidEventCategoryException {
2004
- /**
2005
- * @internal
2006
- */
878
+
2007
879
  const filterSensitiveLog: (obj: InvalidEventCategoryException) => any;
2008
880
  }
2009
- /**
2010
- * <p>Occurs when a lookup attribute is specified that is not valid.</p>
2011
- */
881
+
2012
882
  export interface InvalidLookupAttributesException extends __SmithyException, $MetadataBearer {
2013
883
  name: "InvalidLookupAttributesException";
2014
884
  $fault: "client";
2015
- /**
2016
- * <p>Brief description of the exception returned by the request.</p>
2017
- */
885
+
2018
886
  Message?: string;
2019
887
  }
2020
888
  export declare namespace InvalidLookupAttributesException {
2021
- /**
2022
- * @internal
2023
- */
889
+
2024
890
  const filterSensitiveLog: (obj: InvalidLookupAttributesException) => any;
2025
891
  }
2026
- /**
2027
- * <p>This exception is thrown if the limit specified is not valid.</p>
2028
- */
892
+
2029
893
  export interface InvalidMaxResultsException extends __SmithyException, $MetadataBearer {
2030
894
  name: "InvalidMaxResultsException";
2031
895
  $fault: "client";
2032
- /**
2033
- * <p>Brief description of the exception returned by the request.</p>
2034
- */
896
+
2035
897
  Message?: string;
2036
898
  }
2037
899
  export declare namespace InvalidMaxResultsException {
2038
- /**
2039
- * @internal
2040
- */
900
+
2041
901
  const filterSensitiveLog: (obj: InvalidMaxResultsException) => any;
2042
902
  }
2043
- /**
2044
- * <p>A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.</p>
2045
- */
903
+
2046
904
  export interface InvalidNextTokenException extends __SmithyException, $MetadataBearer {
2047
905
  name: "InvalidNextTokenException";
2048
906
  $fault: "client";
2049
- /**
2050
- * <p>Brief description of the exception returned by the request.</p>
2051
- */
907
+
2052
908
  Message?: string;
2053
909
  }
2054
910
  export declare namespace InvalidNextTokenException {
2055
- /**
2056
- * @internal
2057
- */
911
+
2058
912
  const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
2059
913
  }
2060
914
  export declare enum EventCategory {
@@ -2070,599 +924,258 @@ export declare enum LookupAttributeKey {
2070
924
  RESOURCE_TYPE = "ResourceType",
2071
925
  USERNAME = "Username"
2072
926
  }
2073
- /**
2074
- * <p>Specifies an attribute and value that filter the events returned.</p>
2075
- */
927
+
2076
928
  export interface LookupAttribute {
2077
- /**
2078
- * <p>Specifies an attribute on which to filter the events returned.</p>
2079
- */
929
+
2080
930
  AttributeKey: LookupAttributeKey | string | undefined;
2081
- /**
2082
- * <p>Specifies a value for the specified AttributeKey.</p>
2083
- */
931
+
2084
932
  AttributeValue: string | undefined;
2085
933
  }
2086
934
  export declare namespace LookupAttribute {
2087
- /**
2088
- * @internal
2089
- */
935
+
2090
936
  const filterSensitiveLog: (obj: LookupAttribute) => any;
2091
937
  }
2092
- /**
2093
- * <p>Contains a request for LookupEvents.</p>
2094
- */
938
+
2095
939
  export interface LookupEventsRequest {
2096
- /**
2097
- * <p>Contains a list of lookup attributes. Currently the list can contain only one item.</p>
2098
- */
940
+
2099
941
  LookupAttributes?: LookupAttribute[];
2100
- /**
2101
- * <p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>
2102
- */
942
+
2103
943
  StartTime?: Date;
2104
- /**
2105
- * <p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>
2106
- */
944
+
2107
945
  EndTime?: Date;
2108
- /**
2109
- * <p>Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example,
2110
- * if you do not specify <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are returned.</p>
2111
- */
946
+
2112
947
  EventCategory?: EventCategory | string;
2113
- /**
2114
- * <p>The number of events to return. Possible values are 1 through 50. The default is 50.</p>
2115
- */
948
+
2116
949
  MaxResults?: number;
2117
- /**
2118
- * <p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call.
2119
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>
2120
- */
950
+
2121
951
  NextToken?: string;
2122
952
  }
2123
953
  export declare namespace LookupEventsRequest {
2124
- /**
2125
- * @internal
2126
- */
954
+
2127
955
  const filterSensitiveLog: (obj: LookupEventsRequest) => any;
2128
956
  }
2129
- /**
2130
- * <p>Specifies the type and name of a resource referenced by an event.</p>
2131
- */
957
+
2132
958
  export interface Resource {
2133
- /**
2134
- * <p>The type of a resource referenced by the event returned. When the resource type cannot be
2135
- * determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2,
2136
- * <b>Trail</b> for CloudTrail, <b>DBInstance</b> for Amazon RDS, and <b>AccessKey</b> for IAM.
2137
- * To learn more about how to look up and filter events by the resource types supported for a service, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events">Filtering CloudTrail Events</a>.</p>
2138
- */
959
+
2139
960
  ResourceType?: string;
2140
- /**
2141
- * <p>The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.</p>
2142
- */
961
+
2143
962
  ResourceName?: string;
2144
963
  }
2145
964
  export declare namespace Resource {
2146
- /**
2147
- * @internal
2148
- */
965
+
2149
966
  const filterSensitiveLog: (obj: Resource) => any;
2150
967
  }
2151
- /**
2152
- * <p>Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.</p>
2153
- */
968
+
2154
969
  export interface Event {
2155
- /**
2156
- * <p>The CloudTrail ID of the event returned.</p>
2157
- */
970
+
2158
971
  EventId?: string;
2159
- /**
2160
- * <p>The name of the event returned.</p>
2161
- */
972
+
2162
973
  EventName?: string;
2163
- /**
2164
- * <p>Information about whether the event is a write event or a read event. </p>
2165
- */
974
+
2166
975
  ReadOnly?: string;
2167
- /**
2168
- * <p>The Amazon Web Services access key ID that was used to sign the request. If the request was made
2169
- * with temporary security credentials, this is the access key ID of the temporary credentials.</p>
2170
- */
976
+
2171
977
  AccessKeyId?: string;
2172
- /**
2173
- * <p>The date and time of the event returned.</p>
2174
- */
978
+
2175
979
  EventTime?: Date;
2176
- /**
2177
- * <p>The Amazon Web Services service to which the request was made.</p>
2178
- */
980
+
2179
981
  EventSource?: string;
2180
- /**
2181
- * <p>A user name or role name of the requester that called the API in the event returned.</p>
2182
- */
982
+
2183
983
  Username?: string;
2184
- /**
2185
- * <p>A list of resources referenced by the event returned.</p>
2186
- */
984
+
2187
985
  Resources?: Resource[];
2188
- /**
2189
- * <p>A JSON string that contains a representation of the event returned.</p>
2190
- */
986
+
2191
987
  CloudTrailEvent?: string;
2192
988
  }
2193
989
  export declare namespace Event {
2194
- /**
2195
- * @internal
2196
- */
990
+
2197
991
  const filterSensitiveLog: (obj: Event) => any;
2198
992
  }
2199
- /**
2200
- * <p>Contains a response to a LookupEvents action.</p>
2201
- */
993
+
2202
994
  export interface LookupEventsResponse {
2203
- /**
2204
- * <p>A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.</p>
2205
- */
995
+
2206
996
  Events?: Event[];
2207
- /**
2208
- * <p>The token to use to get the next page of results after a previous API call. If the token does not appear,
2209
- * there are no more results to return. The token must be passed in with the same parameters as the previous call.
2210
- * For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
2211
- * NextToken should include those same parameters.</p>
2212
- */
997
+
2213
998
  NextToken?: string;
2214
999
  }
2215
1000
  export declare namespace LookupEventsResponse {
2216
- /**
2217
- * @internal
2218
- */
1001
+
2219
1002
  const filterSensitiveLog: (obj: LookupEventsResponse) => any;
2220
1003
  }
2221
- /**
2222
- * <p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with a number of event
2223
- * selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and
2224
- * data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum
2225
- * of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.</p>
2226
- * <p>You can:</p>
2227
- * <ul>
2228
- * <li>
2229
- * <p>Specify a valid number of event selectors (1 to 5) for a trail.</p>
2230
- * </li>
2231
- * <li>
2232
- * <p>Specify a valid number of data resources (1 to 250) for an event selector.
2233
- * The limit of number of resources on an individual event selector is configurable up to 250.
2234
- * However, this upper limit is allowed only if the total number of data resources does not
2235
- * exceed 250 across all event selectors for a trail.</p>
2236
- * </li>
2237
- * <li>
2238
- * <p>Specify up to 500 values for all conditions in all advanced event selectors for a trail.</p>
2239
- * </li>
2240
- * <li>
2241
- * <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code>
2242
- * parameter with a value of <code>read-only</code> is not valid.</p>
2243
- * </li>
2244
- * </ul>
2245
- */
1004
+
2246
1005
  export interface InvalidEventSelectorsException extends __SmithyException, $MetadataBearer {
2247
1006
  name: "InvalidEventSelectorsException";
2248
1007
  $fault: "client";
2249
- /**
2250
- * <p>Brief description of the exception returned by the request.</p>
2251
- */
1008
+
2252
1009
  Message?: string;
2253
1010
  }
2254
1011
  export declare namespace InvalidEventSelectorsException {
2255
- /**
2256
- * @internal
2257
- */
1012
+
2258
1013
  const filterSensitiveLog: (obj: InvalidEventSelectorsException) => any;
2259
1014
  }
2260
1015
  export interface PutEventSelectorsRequest {
2261
- /**
2262
- * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
2263
- * string must meet the following requirements:</p>
2264
- * <ul>
2265
- * <li>
2266
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
2267
- * </li>
2268
- * <li>
2269
- * <p>Start with a letter or number, and end with a letter or number</p>
2270
- * </li>
2271
- * <li>
2272
- * <p>Be between 3 and 128 characters</p>
2273
- * </li>
2274
- * <li>
2275
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
2276
- * and <code>my--namespace</code> are not valid.</p>
2277
- * </li>
2278
- * <li>
2279
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
2280
- * </li>
2281
- * </ul>
2282
- * <p>If you specify a trail ARN, it must be in the following format.</p>
2283
- * <p>
2284
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2285
- * </p>
2286
- */
1016
+
2287
1017
  TrailName: string | undefined;
2288
- /**
2289
- * <p>Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.
2290
- * You can use either <code>EventSelectors</code> or <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not both.
2291
- * If you apply <code>EventSelectors</code> to a trail, any existing <code>AdvancedEventSelectors</code> are overwritten.</p>
2292
- */
1018
+
2293
1019
  EventSelectors?: EventSelector[];
2294
- /**
2295
- * <p>
2296
- * Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced
2297
- * event selectors, up to a maximum of 500 values for all conditions and selectors on a trail.
2298
- * You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code>
2299
- * to a trail, any existing <code>EventSelectors</code> are overwritten. For more information about
2300
- * advanced event selectors, see
2301
- * <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
2302
- * data events for trails</a> in the <i>CloudTrail User Guide</i>.
2303
- * </p>
2304
- */
1020
+
2305
1021
  AdvancedEventSelectors?: AdvancedEventSelector[];
2306
1022
  }
2307
1023
  export declare namespace PutEventSelectorsRequest {
2308
- /**
2309
- * @internal
2310
- */
1024
+
2311
1025
  const filterSensitiveLog: (obj: PutEventSelectorsRequest) => any;
2312
1026
  }
2313
1027
  export interface PutEventSelectorsResponse {
2314
- /**
2315
- * <p>Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.</p>
2316
- * <p>
2317
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2318
- * </p>
2319
- */
1028
+
2320
1029
  TrailARN?: string;
2321
- /**
2322
- * <p>Specifies the event selectors configured for your trail.</p>
2323
- */
1030
+
2324
1031
  EventSelectors?: EventSelector[];
2325
- /**
2326
- * <p>Specifies the advanced event selectors configured for your trail.</p>
2327
- */
1032
+
2328
1033
  AdvancedEventSelectors?: AdvancedEventSelector[];
2329
1034
  }
2330
1035
  export declare namespace PutEventSelectorsResponse {
2331
- /**
2332
- * @internal
2333
- */
1036
+
2334
1037
  const filterSensitiveLog: (obj: PutEventSelectorsResponse) => any;
2335
1038
  }
2336
- /**
2337
- * <p>The formatting or syntax of the <code>InsightSelectors</code> JSON statement in your <code>PutInsightSelectors</code> or <code>GetInsightSelectors</code> request
2338
- * is not valid, or the specified insight type in the <code>InsightSelectors</code> statement is not a valid insight type.</p>
2339
- */
1039
+
2340
1040
  export interface InvalidInsightSelectorsException extends __SmithyException, $MetadataBearer {
2341
1041
  name: "InvalidInsightSelectorsException";
2342
1042
  $fault: "client";
2343
- /**
2344
- * <p>Brief description of the exception returned by the request.</p>
2345
- */
1043
+
2346
1044
  Message?: string;
2347
1045
  }
2348
1046
  export declare namespace InvalidInsightSelectorsException {
2349
- /**
2350
- * @internal
2351
- */
1047
+
2352
1048
  const filterSensitiveLog: (obj: InvalidInsightSelectorsException) => any;
2353
1049
  }
2354
1050
  export interface PutInsightSelectorsRequest {
2355
- /**
2356
- * <p>The name of the CloudTrail trail for which you want to change or add Insights selectors.</p>
2357
- */
1051
+
2358
1052
  TrailName: string | undefined;
2359
- /**
2360
- * <p>A JSON string that contains the Insights types that you want to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
2361
- */
1053
+
2362
1054
  InsightSelectors: InsightSelector[] | undefined;
2363
1055
  }
2364
1056
  export declare namespace PutInsightSelectorsRequest {
2365
- /**
2366
- * @internal
2367
- */
1057
+
2368
1058
  const filterSensitiveLog: (obj: PutInsightSelectorsRequest) => any;
2369
1059
  }
2370
1060
  export interface PutInsightSelectorsResponse {
2371
- /**
2372
- * <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.</p>
2373
- */
1061
+
2374
1062
  TrailARN?: string;
2375
- /**
2376
- * <p>A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights type in this release is <code>ApiCallRateInsight</code>.</p>
2377
- */
1063
+
2378
1064
  InsightSelectors?: InsightSelector[];
2379
1065
  }
2380
1066
  export declare namespace PutInsightSelectorsResponse {
2381
- /**
2382
- * @internal
2383
- */
1067
+
2384
1068
  const filterSensitiveLog: (obj: PutInsightSelectorsResponse) => any;
2385
1069
  }
2386
- /**
2387
- * <p>Specifies the tags to remove from a trail.</p>
2388
- */
1070
+
2389
1071
  export interface RemoveTagsRequest {
2390
- /**
2391
- * <p>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</p>
2392
- * <p>
2393
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2394
- * </p>
2395
- */
1072
+
2396
1073
  ResourceId: string | undefined;
2397
- /**
2398
- * <p>Specifies a list of tags to be removed.</p>
2399
- */
1074
+
2400
1075
  TagsList?: Tag[];
2401
1076
  }
2402
1077
  export declare namespace RemoveTagsRequest {
2403
- /**
2404
- * @internal
2405
- */
1078
+
2406
1079
  const filterSensitiveLog: (obj: RemoveTagsRequest) => any;
2407
1080
  }
2408
- /**
2409
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2410
- */
1081
+
2411
1082
  export interface RemoveTagsResponse {
2412
1083
  }
2413
1084
  export declare namespace RemoveTagsResponse {
2414
- /**
2415
- * @internal
2416
- */
1085
+
2417
1086
  const filterSensitiveLog: (obj: RemoveTagsResponse) => any;
2418
1087
  }
2419
- /**
2420
- * <p>The request to CloudTrail to start logging Amazon Web Services API calls for an account.</p>
2421
- */
1088
+
2422
1089
  export interface StartLoggingRequest {
2423
- /**
2424
- * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls.
2425
- * The following is the format of a trail ARN.</p>
2426
- * <p>
2427
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2428
- * </p>
2429
- */
1090
+
2430
1091
  Name: string | undefined;
2431
1092
  }
2432
1093
  export declare namespace StartLoggingRequest {
2433
- /**
2434
- * @internal
2435
- */
1094
+
2436
1095
  const filterSensitiveLog: (obj: StartLoggingRequest) => any;
2437
1096
  }
2438
- /**
2439
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2440
- */
1097
+
2441
1098
  export interface StartLoggingResponse {
2442
1099
  }
2443
1100
  export declare namespace StartLoggingResponse {
2444
- /**
2445
- * @internal
2446
- */
1101
+
2447
1102
  const filterSensitiveLog: (obj: StartLoggingResponse) => any;
2448
1103
  }
2449
- /**
2450
- * <p>Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.</p>
2451
- */
1104
+
2452
1105
  export interface StopLoggingRequest {
2453
- /**
2454
- * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services
2455
- * API calls. The following is the format of a trail ARN.</p>
2456
- * <p>
2457
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2458
- * </p>
2459
- */
1106
+
2460
1107
  Name: string | undefined;
2461
1108
  }
2462
1109
  export declare namespace StopLoggingRequest {
2463
- /**
2464
- * @internal
2465
- */
1110
+
2466
1111
  const filterSensitiveLog: (obj: StopLoggingRequest) => any;
2467
1112
  }
2468
- /**
2469
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2470
- */
1113
+
2471
1114
  export interface StopLoggingResponse {
2472
1115
  }
2473
1116
  export declare namespace StopLoggingResponse {
2474
- /**
2475
- * @internal
2476
- */
1117
+
2477
1118
  const filterSensitiveLog: (obj: StopLoggingResponse) => any;
2478
1119
  }
2479
- /**
2480
- * <p>Specifies settings to update for the trail.</p>
2481
- */
1120
+
2482
1121
  export interface UpdateTrailRequest {
2483
- /**
2484
- * <p>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the
2485
- * string must meet the following requirements:</p>
2486
- * <ul>
2487
- * <li>
2488
- * <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p>
2489
- * </li>
2490
- * <li>
2491
- * <p>Start with a letter or number, and end with a letter or number</p>
2492
- * </li>
2493
- * <li>
2494
- * <p>Be between 3 and 128 characters</p>
2495
- * </li>
2496
- * <li>
2497
- * <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code>
2498
- * and <code>my--namespace</code> are not valid.</p>
2499
- * </li>
2500
- * <li>
2501
- * <p>Not be in IP address format (for example, 192.168.5.4)</p>
2502
- * </li>
2503
- * </ul>
2504
- * <p>If <code>Name</code> is a trail ARN, it must be in the following format.</p>
2505
- * <p>
2506
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2507
- * </p>
2508
- */
1122
+
2509
1123
  Name: string | undefined;
2510
- /**
2511
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</p>
2512
- */
1124
+
2513
1125
  S3BucketName?: string;
2514
- /**
2515
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
2516
- * for log file delivery. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>
2517
- */
1126
+
2518
1127
  S3KeyPrefix?: string;
2519
- /**
2520
- * <p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>
2521
- */
1128
+
2522
1129
  SnsTopicName?: string;
2523
- /**
2524
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
2525
- */
1130
+
2526
1131
  IncludeGlobalServiceEvents?: boolean;
2527
- /**
2528
- * <p>Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true,
2529
- * shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region
2530
- * where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider
2531
- * using trails that log events in all regions.</p>
2532
- */
1132
+
2533
1133
  IsMultiRegionTrail?: boolean;
2534
- /**
2535
- * <p>Specifies whether log file validation is enabled. The default is false.</p>
2536
- * <note>
2537
- * <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail
2538
- * does not create digest files for log files that were delivered during a period in which log file integrity validation
2539
- * was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on
2540
- * January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon
2541
- * on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p>
2542
- * </note>
2543
- */
1134
+
2544
1135
  EnableLogFileValidation?: boolean;
2545
- /**
2546
- * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered. Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
2547
- */
1136
+
2548
1137
  CloudWatchLogsLogGroupArn?: string;
2549
- /**
2550
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
2551
- */
1138
+
2552
1139
  CloudWatchLogsRoleArn?: string;
2553
- /**
2554
- * <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
2555
- * value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully
2556
- * specified ARN to a key, or a globally unique identifier.</p>
2557
- * <p>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys,
2558
- * see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
2559
- * <p>Examples:</p>
2560
- * <ul>
2561
- * <li>
2562
- * <p>alias/MyAliasName</p>
2563
- * </li>
2564
- * <li>
2565
- * <p>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</p>
2566
- * </li>
2567
- * <li>
2568
- * <p>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</p>
2569
- * </li>
2570
- * <li>
2571
- * <p>12345678-1234-1234-1234-123456789012</p>
2572
- * </li>
2573
- * </ul>
2574
- */
1140
+
2575
1141
  KmsKeyId?: string;
2576
- /**
2577
- * <p>Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
2578
- * The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in
2579
- * Organizations. If the trail is not an organization trail and this is set to <code>true</code>, the trail will be created in all Amazon Web Services accounts that belong
2580
- * to the organization. If the trail is an organization trail and this is set to <code>false</code>, the trail will remain in the current Amazon Web Services account but be
2581
- * deleted from all member accounts in the organization.</p>
2582
- */
1142
+
2583
1143
  IsOrganizationTrail?: boolean;
2584
1144
  }
2585
1145
  export declare namespace UpdateTrailRequest {
2586
- /**
2587
- * @internal
2588
- */
1146
+
2589
1147
  const filterSensitiveLog: (obj: UpdateTrailRequest) => any;
2590
1148
  }
2591
- /**
2592
- * <p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>
2593
- */
1149
+
2594
1150
  export interface UpdateTrailResponse {
2595
- /**
2596
- * <p>Specifies the name of the trail.</p>
2597
- */
1151
+
2598
1152
  Name?: string;
2599
- /**
2600
- * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>
2601
- */
1153
+
2602
1154
  S3BucketName?: string;
2603
- /**
2604
- * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated
2605
- * for log file delivery.
2606
- * For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your IAM Log Files</a>.</p>
2607
- */
1155
+
2608
1156
  S3KeyPrefix?: string;
2609
- /**
2610
- * @deprecated
2611
- *
2612
- * <p>This field is no longer in use. Use <a>UpdateTrailResponse$SnsTopicARN</a>.</p>
2613
- */
1157
+
2614
1158
  SnsTopicName?: string;
2615
- /**
2616
- * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications
2617
- * when log files are delivered. The following is the format of a topic ARN.</p>
2618
- * <p>
2619
- * <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
2620
- * </p>
2621
- */
1159
+
2622
1160
  SnsTopicARN?: string;
2623
- /**
2624
- * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
2625
- */
1161
+
2626
1162
  IncludeGlobalServiceEvents?: boolean;
2627
- /**
2628
- * <p>Specifies whether the trail exists in one region or in all regions.</p>
2629
- */
1163
+
2630
1164
  IsMultiRegionTrail?: boolean;
2631
- /**
2632
- * <p>Specifies the ARN of the trail that was updated. The following is the format of a trail ARN.</p>
2633
- * <p>
2634
- * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
2635
- * </p>
2636
- */
1165
+
2637
1166
  TrailARN?: string;
2638
- /**
2639
- * <p>Specifies whether log file integrity validation is enabled.</p>
2640
- */
1167
+
2641
1168
  LogFileValidationEnabled?: boolean;
2642
- /**
2643
- * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs are delivered.</p>
2644
- */
1169
+
2645
1170
  CloudWatchLogsLogGroupArn?: string;
2646
- /**
2647
- * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>
2648
- */
1171
+
2649
1172
  CloudWatchLogsRoleArn?: string;
2650
- /**
2651
- * <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.</p>
2652
- *
2653
- * <p>
2654
- * <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
2655
- * </p>
2656
- */
1173
+
2657
1174
  KmsKeyId?: string;
2658
- /**
2659
- * <p>Specifies whether the trail is an organization trail.</p>
2660
- */
1175
+
2661
1176
  IsOrganizationTrail?: boolean;
2662
1177
  }
2663
1178
  export declare namespace UpdateTrailResponse {
2664
- /**
2665
- * @internal
2666
- */
1179
+
2667
1180
  const filterSensitiveLog: (obj: UpdateTrailResponse) => any;
2668
1181
  }