@aws-sdk/client-cloudtrail 3.261.0 → 3.264.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -12
- package/dist-cjs/CloudTrail.js +90 -0
- package/dist-cjs/commands/CreateChannelCommand.js +46 -0
- package/dist-cjs/commands/DeleteChannelCommand.js +46 -0
- package/dist-cjs/commands/DeleteResourcePolicyCommand.js +46 -0
- package/dist-cjs/commands/GetResourcePolicyCommand.js +46 -0
- package/dist-cjs/commands/PutResourcePolicyCommand.js +46 -0
- package/dist-cjs/commands/UpdateChannelCommand.js +46 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +181 -30
- package/dist-cjs/protocols/Aws_json1_1.js +602 -2
- package/dist-es/CloudTrail.js +90 -0
- package/dist-es/commands/CreateChannelCommand.js +42 -0
- package/dist-es/commands/DeleteChannelCommand.js +42 -0
- package/dist-es/commands/DeleteResourcePolicyCommand.js +42 -0
- package/dist-es/commands/GetResourcePolicyCommand.js +42 -0
- package/dist-es/commands/PutResourcePolicyCommand.js +42 -0
- package/dist-es/commands/UpdateChannelCommand.js +42 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +152 -22
- package/dist-es/protocols/Aws_json1_1.js +589 -1
- package/dist-types/CloudTrail.d.ts +238 -164
- package/dist-types/CloudTrailClient.d.ts +21 -14
- package/dist-types/commands/AddTagsCommand.d.ts +7 -9
- package/dist-types/commands/CancelQueryCommand.d.ts +6 -3
- package/dist-types/commands/CreateChannelCommand.d.ts +39 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +37 -0
- package/dist-types/commands/DeleteEventDataStoreCommand.d.ts +10 -7
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +39 -0
- package/dist-types/commands/DeregisterOrganizationDelegatedAdminCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQueryCommand.d.ts +3 -2
- package/dist-types/commands/DescribeTrailsCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelCommand.d.ts +1 -3
- package/dist-types/commands/GetEventDataStoreCommand.d.ts +2 -1
- package/dist-types/commands/GetEventSelectorsCommand.d.ts +10 -11
- package/dist-types/commands/GetImportCommand.d.ts +1 -3
- package/dist-types/commands/GetInsightSelectorsCommand.d.ts +6 -6
- package/dist-types/commands/GetQueryResultsCommand.d.ts +3 -2
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +39 -0
- package/dist-types/commands/GetTrailStatusCommand.d.ts +5 -1
- package/dist-types/commands/ListChannelsCommand.d.ts +1 -3
- package/dist-types/commands/ListEventDataStoresCommand.d.ts +2 -1
- package/dist-types/commands/ListImportFailuresCommand.d.ts +1 -3
- package/dist-types/commands/ListImportsCommand.d.ts +2 -3
- package/dist-types/commands/ListPublicKeysCommand.d.ts +7 -4
- package/dist-types/commands/ListQueriesCommand.d.ts +7 -5
- package/dist-types/commands/ListTagsCommand.d.ts +1 -1
- package/dist-types/commands/LookupEventsCommand.d.ts +5 -5
- package/dist-types/commands/PutEventSelectorsCommand.d.ts +28 -31
- package/dist-types/commands/PutInsightSelectorsCommand.d.ts +5 -4
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +41 -0
- package/dist-types/commands/RegisterOrganizationDelegatedAdminCommand.d.ts +2 -1
- package/dist-types/commands/RemoveTagsCommand.d.ts +1 -1
- package/dist-types/commands/RestoreEventDataStoreCommand.d.ts +4 -3
- package/dist-types/commands/StartImportCommand.d.ts +17 -13
- package/dist-types/commands/StartLoggingCommand.d.ts +4 -1
- package/dist-types/commands/StartQueryCommand.d.ts +3 -1
- package/dist-types/commands/StopImportCommand.d.ts +1 -3
- package/dist-types/commands/StopLoggingCommand.d.ts +7 -7
- package/dist-types/commands/UpdateChannelCommand.d.ts +37 -0
- package/dist-types/commands/UpdateEventDataStoreCommand.d.ts +11 -6
- package/dist-types/commands/UpdateTrailCommand.d.ts +6 -6
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +1428 -835
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CloudTrail.d.ts +102 -0
- package/dist-types/ts3.4/CloudTrailClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +181 -22
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +72 -0
- package/package.json +4 -4
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { CloudTrailServiceException as __BaseException } from "./CloudTrailServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>
|
|
5
|
-
*
|
|
6
|
-
* previous import is still in progress.
|
|
7
|
-
* </p>
|
|
4
|
+
* <p> This exception is thrown when you start a new import and a previous import is still in
|
|
5
|
+
* progress. </p>
|
|
8
6
|
*/
|
|
9
7
|
export declare class AccountHasOngoingImportException extends __BaseException {
|
|
10
8
|
readonly name: "AccountHasOngoingImportException";
|
|
@@ -19,7 +17,8 @@ export declare class AccountHasOngoingImportException extends __BaseException {
|
|
|
19
17
|
constructor(opts: __ExceptionOptionType<AccountHasOngoingImportException, __BaseException>);
|
|
20
18
|
}
|
|
21
19
|
/**
|
|
22
|
-
* <p>This exception is thrown when
|
|
20
|
+
* <p>This exception is thrown when the specified account is not found or not part of an
|
|
21
|
+
* organization.</p>
|
|
23
22
|
*/
|
|
24
23
|
export declare class AccountNotFoundException extends __BaseException {
|
|
25
24
|
readonly name: "AccountNotFoundException";
|
|
@@ -49,7 +48,8 @@ export declare class AccountNotRegisteredException extends __BaseException {
|
|
|
49
48
|
constructor(opts: __ExceptionOptionType<AccountNotRegisteredException, __BaseException>);
|
|
50
49
|
}
|
|
51
50
|
/**
|
|
52
|
-
* <p>This exception is thrown when the account is already registered as the CloudTrail
|
|
51
|
+
* <p>This exception is thrown when the account is already registered as the CloudTrail
|
|
52
|
+
* delegated administrator.</p>
|
|
53
53
|
*/
|
|
54
54
|
export declare class AccountRegisteredException extends __BaseException {
|
|
55
55
|
readonly name: "AccountRegisteredException";
|
|
@@ -64,27 +64,36 @@ export declare class AccountRegisteredException extends __BaseException {
|
|
|
64
64
|
constructor(opts: __ExceptionOptionType<AccountRegisteredException, __BaseException>);
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
* <p>A custom key-value pair associated with a resource such as a CloudTrail
|
|
67
|
+
* <p>A custom key-value pair associated with a resource such as a CloudTrail
|
|
68
|
+
* trail, event data store, or channel.</p>
|
|
68
69
|
*/
|
|
69
70
|
export interface Tag {
|
|
70
71
|
/**
|
|
71
|
-
* <p>The key in a key-value pair. The key must be must be no longer than 128 Unicode
|
|
72
|
-
* The key must be unique for the resource to which it applies.</p>
|
|
72
|
+
* <p>The key in a key-value pair. The key must be must be no longer than 128 Unicode
|
|
73
|
+
* characters. The key must be unique for the resource to which it applies.</p>
|
|
73
74
|
*/
|
|
74
75
|
Key: string | undefined;
|
|
75
76
|
/**
|
|
76
|
-
* <p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode
|
|
77
|
+
* <p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode
|
|
78
|
+
* characters.</p>
|
|
77
79
|
*/
|
|
78
80
|
Value?: string;
|
|
79
81
|
}
|
|
80
82
|
/**
|
|
81
|
-
* <p>Specifies the tags to add to a trail
|
|
83
|
+
* <p>Specifies the tags to add to a trail, event data store, or channel.</p>
|
|
82
84
|
*/
|
|
83
85
|
export interface AddTagsRequest {
|
|
84
86
|
/**
|
|
85
|
-
* <p>Specifies the ARN of the trail
|
|
86
|
-
*
|
|
87
|
-
*
|
|
87
|
+
* <p>Specifies the ARN of the trail, event data store, or channel to which one or more tags will be
|
|
88
|
+
* added.</p>
|
|
89
|
+
* <p>The format of a trail ARN is:
|
|
90
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
91
|
+
* </p>
|
|
92
|
+
* <p>The format of an event data store ARN is:
|
|
93
|
+
* <code>arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
94
|
+
* </p>
|
|
95
|
+
* <p>The format of a channel ARN is:
|
|
96
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
88
97
|
* </p>
|
|
89
98
|
*/
|
|
90
99
|
ResourceId: string | undefined;
|
|
@@ -99,10 +108,33 @@ export interface AddTagsRequest {
|
|
|
99
108
|
export interface AddTagsResponse {
|
|
100
109
|
}
|
|
101
110
|
/**
|
|
102
|
-
* <p>This exception is thrown when
|
|
111
|
+
* <p>This exception is thrown when CloudTrail cannot find the specified channel.</p>
|
|
112
|
+
*/
|
|
113
|
+
export declare class ChannelNotFoundException extends __BaseException {
|
|
114
|
+
readonly name: "ChannelNotFoundException";
|
|
115
|
+
readonly $fault: "client";
|
|
116
|
+
/**
|
|
117
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
118
|
+
*/
|
|
119
|
+
Message?: string;
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* <p>This exception is thrown when an operation is called with a trail ARN that is not valid.
|
|
127
|
+
* The following is the format of a trail ARN.</p>
|
|
103
128
|
* <p>
|
|
104
129
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
105
130
|
* </p>
|
|
131
|
+
* <p>This exception is also thrown when you call <code>AddTags</code> or <code>RemoveTags</code> on a trail, event data store, or channel with a resource ARN that is not valid.</p>
|
|
132
|
+
* <p>The following is the format of an event data store ARN:
|
|
133
|
+
* <code>arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
134
|
+
* </p>
|
|
135
|
+
* <p>The following is the format of a channel ARN:
|
|
136
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
137
|
+
* </p>
|
|
106
138
|
*/
|
|
107
139
|
export declare class CloudTrailARNInvalidException extends __BaseException {
|
|
108
140
|
readonly name: "CloudTrailARNInvalidException";
|
|
@@ -117,9 +149,10 @@ export declare class CloudTrailARNInvalidException extends __BaseException {
|
|
|
117
149
|
constructor(opts: __ExceptionOptionType<CloudTrailARNInvalidException, __BaseException>);
|
|
118
150
|
}
|
|
119
151
|
/**
|
|
120
|
-
* <p>This exception is thrown when the specified resource is not ready for an operation.
|
|
121
|
-
*
|
|
122
|
-
* If this exception occurs, wait a few minutes, and then try the
|
|
152
|
+
* <p>This exception is thrown when the specified resource is not ready for an operation. This
|
|
153
|
+
* can occur when you try to run an operation on a resource before CloudTrail has time
|
|
154
|
+
* to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the
|
|
155
|
+
* operation again.</p>
|
|
123
156
|
*/
|
|
124
157
|
export declare class ConflictException extends __BaseException {
|
|
125
158
|
readonly name: "ConflictException";
|
|
@@ -164,8 +197,8 @@ export declare class InactiveEventDataStoreException extends __BaseException {
|
|
|
164
197
|
constructor(opts: __ExceptionOptionType<InactiveEventDataStoreException, __BaseException>);
|
|
165
198
|
}
|
|
166
199
|
/**
|
|
167
|
-
* <p>This exception is thrown when the specified tag key or values are not valid.
|
|
168
|
-
*
|
|
200
|
+
* <p>This exception is thrown when the specified tag key or values are not valid. It can also
|
|
201
|
+
* occur if there are duplicate tags or too many tags on the resource.</p>
|
|
169
202
|
*/
|
|
170
203
|
export declare class InvalidTagParameterException extends __BaseException {
|
|
171
204
|
readonly name: "InvalidTagParameterException";
|
|
@@ -180,10 +213,12 @@ export declare class InvalidTagParameterException extends __BaseException {
|
|
|
180
213
|
constructor(opts: __ExceptionOptionType<InvalidTagParameterException, __BaseException>);
|
|
181
214
|
}
|
|
182
215
|
/**
|
|
183
|
-
* <p>This exception is thrown when the provided trail name is not valid. Trail names must
|
|
216
|
+
* <p>This exception is thrown when the provided trail name is not valid. Trail names must
|
|
217
|
+
* meet the following requirements:</p>
|
|
184
218
|
* <ul>
|
|
185
219
|
* <li>
|
|
186
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
220
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
221
|
+
* (_), or dashes (-)</p>
|
|
187
222
|
* </li>
|
|
188
223
|
* <li>
|
|
189
224
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -192,8 +227,8 @@ export declare class InvalidTagParameterException extends __BaseException {
|
|
|
192
227
|
* <p>Be between 3 and 128 characters</p>
|
|
193
228
|
* </li>
|
|
194
229
|
* <li>
|
|
195
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
196
|
-
*
|
|
230
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
231
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
197
232
|
* </li>
|
|
198
233
|
* <li>
|
|
199
234
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -213,9 +248,8 @@ export declare class InvalidTrailNameException extends __BaseException {
|
|
|
213
248
|
constructor(opts: __ExceptionOptionType<InvalidTrailNameException, __BaseException>);
|
|
214
249
|
}
|
|
215
250
|
/**
|
|
216
|
-
* <p>
|
|
217
|
-
*
|
|
218
|
-
* </p>
|
|
251
|
+
* <p> This exception is thrown when the management account does not have a service-linked
|
|
252
|
+
* role. </p>
|
|
219
253
|
*/
|
|
220
254
|
export declare class NoManagementAccountSLRExistsException extends __BaseException {
|
|
221
255
|
readonly name: "NoManagementAccountSLRExistsException";
|
|
@@ -230,10 +264,9 @@ export declare class NoManagementAccountSLRExistsException extends __BaseExcepti
|
|
|
230
264
|
constructor(opts: __ExceptionOptionType<NoManagementAccountSLRExistsException, __BaseException>);
|
|
231
265
|
}
|
|
232
266
|
/**
|
|
233
|
-
* <p>This exception is thrown when the Amazon Web Services account making the request to
|
|
234
|
-
* or update an organization trail or event data store is not the management account
|
|
235
|
-
* organization in Organizations. For more information, see
|
|
236
|
-
* <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> or <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html">Create an event data store</a>.</p>
|
|
267
|
+
* <p>This exception is thrown when the Amazon Web Services account making the request to
|
|
268
|
+
* create or update an organization trail or event data store is not the management account
|
|
269
|
+
* for an organization in Organizations. For more information, see <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> or <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html">Create an event data store</a>.</p>
|
|
237
270
|
*/
|
|
238
271
|
export declare class NotOrganizationMasterAccountException extends __BaseException {
|
|
239
272
|
readonly name: "NotOrganizationMasterAccountException";
|
|
@@ -293,7 +326,8 @@ export declare class ResourceTypeNotSupportedException extends __BaseException {
|
|
|
293
326
|
constructor(opts: __ExceptionOptionType<ResourceTypeNotSupportedException, __BaseException>);
|
|
294
327
|
}
|
|
295
328
|
/**
|
|
296
|
-
* <p>The number of tags per trail has exceeded the permitted amount. Currently, the limit is
|
|
329
|
+
* <p>The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is
|
|
330
|
+
* 50.</p>
|
|
297
331
|
*/
|
|
298
332
|
export declare class TagsLimitExceededException extends __BaseException {
|
|
299
333
|
readonly name: "TagsLimitExceededException";
|
|
@@ -327,53 +361,91 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
327
361
|
*/
|
|
328
362
|
export interface AdvancedFieldSelector {
|
|
329
363
|
/**
|
|
330
|
-
* <p>
|
|
331
|
-
*
|
|
332
|
-
*
|
|
333
|
-
*
|
|
364
|
+
* <p> A field in a CloudTrail event record on which to filter events to be logged. For
|
|
365
|
+
* event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for
|
|
366
|
+
* selecting events as filtering is not supported. </p>
|
|
367
|
+
* <p> For CloudTrail event records, supported fields include <code>readOnly</code>,
|
|
368
|
+
* <code>eventCategory</code>, <code>eventSource</code> (for management events),
|
|
369
|
+
* <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>. </p>
|
|
370
|
+
* <p> For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is
|
|
371
|
+
* <code>eventCategory</code>. </p>
|
|
334
372
|
* <ul>
|
|
335
373
|
* <li>
|
|
336
374
|
* <p>
|
|
337
375
|
* <b>
|
|
338
376
|
* <code>readOnly</code>
|
|
339
|
-
* </b> - Optional. Can be set to
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
377
|
+
* </b> - Optional. Can be set to
|
|
378
|
+
* <code>Equals</code> a value of <code>true</code> or <code>false</code>. If you do
|
|
379
|
+
* not add this field, CloudTrail logs both <code>read</code> and
|
|
380
|
+
* <code>write</code> events. A value of <code>true</code> logs only
|
|
381
|
+
* <code>read</code> events. A value of <code>false</code> logs only
|
|
382
|
+
* <code>write</code> events.</p>
|
|
343
383
|
* </li>
|
|
344
384
|
* <li>
|
|
345
385
|
* <p>
|
|
346
386
|
* <b>
|
|
347
387
|
* <code>eventSource</code>
|
|
348
|
-
* </b> - For filtering
|
|
349
|
-
*
|
|
388
|
+
* </b> - For filtering
|
|
389
|
+
* management events only. This can be set only to <code>NotEquals</code>
|
|
350
390
|
* <code>kms.amazonaws.com</code>.</p>
|
|
351
391
|
* </li>
|
|
352
392
|
* <li>
|
|
353
393
|
* <p>
|
|
354
394
|
* <b>
|
|
355
395
|
* <code>eventName</code>
|
|
356
|
-
* </b> - Can use any operator.
|
|
357
|
-
*
|
|
358
|
-
*
|
|
396
|
+
* </b> - Can use any operator.
|
|
397
|
+
* You can use it to filter in or filter out any data event logged to CloudTrail,
|
|
398
|
+
* such as <code>PutBucket</code> or <code>GetSnapshotBlock</code>. You can have
|
|
399
|
+
* multiple values for this field, separated by commas.</p>
|
|
359
400
|
* </li>
|
|
360
401
|
* <li>
|
|
361
402
|
* <p>
|
|
362
403
|
* <b>
|
|
363
404
|
* <code>eventCategory</code>
|
|
364
|
-
* </b> - This is required
|
|
365
|
-
*
|
|
405
|
+
* </b> - This is required and
|
|
406
|
+
* must be set to <code>Equals</code>.
|
|
407
|
+
* </p>
|
|
408
|
+
* <ul>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>
|
|
411
|
+
* For CloudTrail event records, the value
|
|
412
|
+
* must be <code>Management</code> or <code>Data</code>.
|
|
413
|
+
* </p>
|
|
414
|
+
* </li>
|
|
415
|
+
* <li>
|
|
416
|
+
* <p>
|
|
417
|
+
* For Config
|
|
418
|
+
* configuration items, the value must be <code>ConfigurationItem</code>.
|
|
419
|
+
* </p>
|
|
420
|
+
* </li>
|
|
421
|
+
* <li>
|
|
422
|
+
* <p>
|
|
423
|
+
* For Audit Manager evidence, the value must be <code>Evidence</code>.
|
|
424
|
+
* </p>
|
|
425
|
+
* </li>
|
|
426
|
+
* <li>
|
|
427
|
+
* <p>
|
|
428
|
+
* For non-Amazon Web Services events, the value must be <code>ActivityAuditLog</code>.
|
|
429
|
+
* </p>
|
|
430
|
+
* </li>
|
|
431
|
+
* </ul>
|
|
366
432
|
* </li>
|
|
367
433
|
* <li>
|
|
368
434
|
* <p>
|
|
369
435
|
* <b>
|
|
370
436
|
* <code>resources.type</code>
|
|
371
|
-
* </b> - This field is
|
|
372
|
-
*
|
|
373
|
-
*
|
|
437
|
+
* </b> - This field is
|
|
438
|
+
* required for CloudTrail data events. <code>resources.type</code> can only
|
|
439
|
+
* use the <code>Equals</code> operator, and the value can be one of the
|
|
440
|
+
* following:</p>
|
|
374
441
|
* <ul>
|
|
375
442
|
* <li>
|
|
376
443
|
* <p>
|
|
444
|
+
* <code>AWS::CloudTrail::Channel</code>
|
|
445
|
+
* </p>
|
|
446
|
+
* </li>
|
|
447
|
+
* <li>
|
|
448
|
+
* <p>
|
|
377
449
|
* <code>AWS::S3::Object</code>
|
|
378
450
|
* </p>
|
|
379
451
|
* </li>
|
|
@@ -422,22 +494,37 @@ export interface AdvancedFieldSelector {
|
|
|
422
494
|
* <code>AWS::Glue::Table</code>
|
|
423
495
|
* </p>
|
|
424
496
|
* </li>
|
|
497
|
+
* <li>
|
|
498
|
+
* <p>
|
|
499
|
+
* <code>AWS::FinSpace::Environment</code>
|
|
500
|
+
* </p>
|
|
501
|
+
* </li>
|
|
502
|
+
* <li>
|
|
503
|
+
* <p>
|
|
504
|
+
* <code>AWS::SageMaker::ExperimentTrialComponent</code>
|
|
505
|
+
* </p>
|
|
506
|
+
* </li>
|
|
507
|
+
* <li>
|
|
508
|
+
* <p>
|
|
509
|
+
* <code>AWS::SageMaker::FeatureGroup</code>
|
|
510
|
+
* </p>
|
|
511
|
+
* </li>
|
|
425
512
|
* </ul>
|
|
426
|
-
* <p>
|
|
427
|
-
* You can have only one <code>resources.type</code> field per selector. To log data
|
|
513
|
+
* <p> You can have only one <code>resources.type</code> field per selector. To log data
|
|
428
514
|
* events on more than one resource type, add another selector.</p>
|
|
429
515
|
* </li>
|
|
430
516
|
* <li>
|
|
431
517
|
* <p>
|
|
432
518
|
* <b>
|
|
433
519
|
* <code>resources.ARN</code>
|
|
434
|
-
* </b> - You can use any
|
|
435
|
-
* <code>resources.ARN</code>, but if you use <code>Equals</code> or
|
|
436
|
-
*
|
|
437
|
-
* the template as the value of resources.type. For
|
|
438
|
-
*
|
|
439
|
-
* log all data events for all objects in a specific S3
|
|
440
|
-
*
|
|
520
|
+
* </b> - You can use any
|
|
521
|
+
* operator with <code>resources.ARN</code>, but if you use <code>Equals</code> or
|
|
522
|
+
* <code>NotEquals</code>, the value must exactly match the ARN of a valid resource
|
|
523
|
+
* of the type you've specified in the template as the value of resources.type. For
|
|
524
|
+
* example, if resources.type equals <code>AWS::S3::Object</code>, the ARN must be in
|
|
525
|
+
* one of the following formats. To log all data events for all objects in a specific S3
|
|
526
|
+
* bucket, use the <code>StartsWith</code> operator, and include only the bucket ARN as
|
|
527
|
+
* the matching value.</p>
|
|
441
528
|
* <p>The trailing slash is intentional; do not exclude it. Replace the text between
|
|
442
529
|
* less than and greater than symbols (<>) with resource-specific information. </p>
|
|
443
530
|
* <ul>
|
|
@@ -469,8 +556,9 @@ export interface AdvancedFieldSelector {
|
|
|
469
556
|
* </p>
|
|
470
557
|
* </li>
|
|
471
558
|
* </ul>
|
|
472
|
-
* <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is
|
|
473
|
-
*
|
|
559
|
+
* <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is
|
|
560
|
+
* set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the
|
|
561
|
+
* following format:</p>
|
|
474
562
|
* <ul>
|
|
475
563
|
* <li>
|
|
476
564
|
* <p>
|
|
@@ -488,8 +576,19 @@ export interface AdvancedFieldSelector {
|
|
|
488
576
|
* </p>
|
|
489
577
|
* </li>
|
|
490
578
|
* </ul>
|
|
491
|
-
* <p>When
|
|
492
|
-
*
|
|
579
|
+
* <p>When resources.type equals <code>AWS::CloudTrail::Channel</code>, and the operator is
|
|
580
|
+
* set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the
|
|
581
|
+
* following format:</p>
|
|
582
|
+
* <ul>
|
|
583
|
+
* <li>
|
|
584
|
+
* <p>
|
|
585
|
+
* <code>arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID></code>
|
|
586
|
+
* </p>
|
|
587
|
+
* </li>
|
|
588
|
+
* </ul>
|
|
589
|
+
* <p>When <code>resources.type</code> equals <code>AWS::S3Outposts::Object</code>, and
|
|
590
|
+
* the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be
|
|
591
|
+
* in the following format:</p>
|
|
493
592
|
* <ul>
|
|
494
593
|
* <li>
|
|
495
594
|
* <p>
|
|
@@ -528,8 +627,9 @@ export interface AdvancedFieldSelector {
|
|
|
528
627
|
* </p>
|
|
529
628
|
* </li>
|
|
530
629
|
* </ul>
|
|
531
|
-
* <p>When <code>resources.type</code> equals <code>AWS::DynamoDB::Stream</code>, and
|
|
532
|
-
* <code>Equals</code> or <code>NotEquals</code>, the ARN must be
|
|
630
|
+
* <p>When <code>resources.type</code> equals <code>AWS::DynamoDB::Stream</code>, and
|
|
631
|
+
* the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be
|
|
632
|
+
* in the following format:</p>
|
|
533
633
|
* <ul>
|
|
534
634
|
* <li>
|
|
535
635
|
* <p>
|
|
@@ -537,8 +637,9 @@ export interface AdvancedFieldSelector {
|
|
|
537
637
|
* </p>
|
|
538
638
|
* </li>
|
|
539
639
|
* </ul>
|
|
540
|
-
* <p>When <code>resources.type</code> equals <code>AWS::Glue::Table</code>, and the
|
|
541
|
-
* <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
|
|
640
|
+
* <p>When <code>resources.type</code> equals <code>AWS::Glue::Table</code>, and the
|
|
641
|
+
* operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in
|
|
642
|
+
* the following format:</p>
|
|
542
643
|
* <ul>
|
|
543
644
|
* <li>
|
|
544
645
|
* <p>
|
|
@@ -546,6 +647,34 @@ export interface AdvancedFieldSelector {
|
|
|
546
647
|
* </p>
|
|
547
648
|
* </li>
|
|
548
649
|
* </ul>
|
|
650
|
+
* <p>When <code>resources.type</code> equals <code>AWS::FinSpace::Environment</code>,
|
|
651
|
+
* and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN
|
|
652
|
+
* must be in the following format:</p>
|
|
653
|
+
* <ul>
|
|
654
|
+
* <li>
|
|
655
|
+
* <p>
|
|
656
|
+
* <code>arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID></code>
|
|
657
|
+
* </p>
|
|
658
|
+
* </li>
|
|
659
|
+
* </ul>
|
|
660
|
+
* <p>When <code>resources.type</code> equals <code>AWS::SageMaker::ExperimentTrialComponent</code>, and the operator is set to
|
|
661
|
+
* <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
|
|
662
|
+
* <ul>
|
|
663
|
+
* <li>
|
|
664
|
+
* <p>
|
|
665
|
+
* <code>arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name></code>
|
|
666
|
+
* </p>
|
|
667
|
+
* </li>
|
|
668
|
+
* </ul>
|
|
669
|
+
* <p>When <code>resources.type</code> equals <code>AWS::SageMaker::FeatureGroup</code>, and the operator is set to
|
|
670
|
+
* <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p>
|
|
671
|
+
* <ul>
|
|
672
|
+
* <li>
|
|
673
|
+
* <p>
|
|
674
|
+
* <code>arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name></code>
|
|
675
|
+
* </p>
|
|
676
|
+
* </li>
|
|
677
|
+
* </ul>
|
|
549
678
|
* </li>
|
|
550
679
|
* </ul>
|
|
551
680
|
*/
|
|
@@ -568,28 +697,25 @@ export interface AdvancedFieldSelector {
|
|
|
568
697
|
*/
|
|
569
698
|
EndsWith?: string[];
|
|
570
699
|
/**
|
|
571
|
-
* <p>
|
|
572
|
-
*
|
|
573
|
-
* </p>
|
|
700
|
+
* <p> An operator that excludes events that match the exact value of the event record field
|
|
701
|
+
* specified as the value of <code>Field</code>. </p>
|
|
574
702
|
*/
|
|
575
703
|
NotEquals?: string[];
|
|
576
704
|
/**
|
|
577
|
-
* <p>
|
|
578
|
-
*
|
|
579
|
-
* </p>
|
|
705
|
+
* <p> An operator that excludes events that match the first few characters of the event
|
|
706
|
+
* record field specified as the value of <code>Field</code>. </p>
|
|
580
707
|
*/
|
|
581
708
|
NotStartsWith?: string[];
|
|
582
709
|
/**
|
|
583
|
-
* <p>
|
|
584
|
-
*
|
|
585
|
-
* </p>
|
|
710
|
+
* <p> An operator that excludes events that match the last few characters of the event record
|
|
711
|
+
* field specified as the value of <code>Field</code>. </p>
|
|
586
712
|
*/
|
|
587
713
|
NotEndsWith?: string[];
|
|
588
714
|
}
|
|
589
715
|
/**
|
|
590
|
-
* <p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail
|
|
591
|
-
*
|
|
592
|
-
*
|
|
716
|
+
* <p>Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those
|
|
717
|
+
* events that are important to you. For more information about advanced event selectors, see
|
|
718
|
+
* <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>
|
|
593
719
|
* <ul>
|
|
594
720
|
* <li>
|
|
595
721
|
* <p>
|
|
@@ -639,12 +765,13 @@ export interface CancelQueryRequest {
|
|
|
639
765
|
/**
|
|
640
766
|
* @deprecated
|
|
641
767
|
*
|
|
642
|
-
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
|
|
768
|
+
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
|
|
769
|
+
* query is running.</p>
|
|
643
770
|
*/
|
|
644
771
|
EventDataStore?: string;
|
|
645
772
|
/**
|
|
646
|
-
* <p>The ID of the query that you want to cancel. The <code>QueryId</code> comes from the
|
|
647
|
-
*
|
|
773
|
+
* <p>The ID of the query that you want to cancel. The <code>QueryId</code> comes from the
|
|
774
|
+
* response of a <code>StartQuery</code> operation.</p>
|
|
648
775
|
*/
|
|
649
776
|
QueryId: string | undefined;
|
|
650
777
|
}
|
|
@@ -662,13 +789,14 @@ export interface CancelQueryResponse {
|
|
|
662
789
|
*/
|
|
663
790
|
QueryId: string | undefined;
|
|
664
791
|
/**
|
|
665
|
-
* <p>Shows the status of a query after a <code>CancelQuery</code> request. Typically, the
|
|
666
|
-
* <code>RUNNING</code> or <code>CANCELLED</code>.</p>
|
|
792
|
+
* <p>Shows the status of a query after a <code>CancelQuery</code> request. Typically, the
|
|
793
|
+
* values shown are either <code>RUNNING</code> or <code>CANCELLED</code>.</p>
|
|
667
794
|
*/
|
|
668
795
|
QueryStatus: QueryStatus | string | undefined;
|
|
669
796
|
}
|
|
670
797
|
/**
|
|
671
|
-
* <p>The specified event data store ARN is not valid or does not map to an event data store
|
|
798
|
+
* <p>The specified event data store ARN is not valid or does not map to an event data store
|
|
799
|
+
* in your account.</p>
|
|
672
800
|
*/
|
|
673
801
|
export declare class EventDataStoreARNInvalidException extends __BaseException {
|
|
674
802
|
readonly name: "EventDataStoreARNInvalidException";
|
|
@@ -683,8 +811,8 @@ export declare class EventDataStoreARNInvalidException extends __BaseException {
|
|
|
683
811
|
constructor(opts: __ExceptionOptionType<EventDataStoreARNInvalidException, __BaseException>);
|
|
684
812
|
}
|
|
685
813
|
/**
|
|
686
|
-
* <p>The specified query cannot be canceled because it is in the <code>FINISHED</code>,
|
|
687
|
-
*
|
|
814
|
+
* <p>The specified query cannot be canceled because it is in the <code>FINISHED</code>,
|
|
815
|
+
* <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code> state.</p>
|
|
688
816
|
*/
|
|
689
817
|
export declare class InactiveQueryException extends __BaseException {
|
|
690
818
|
readonly name: "InactiveQueryException";
|
|
@@ -729,7 +857,8 @@ export declare class QueryIdNotFoundException extends __BaseException {
|
|
|
729
857
|
constructor(opts: __ExceptionOptionType<QueryIdNotFoundException, __BaseException>);
|
|
730
858
|
}
|
|
731
859
|
/**
|
|
732
|
-
* <p>This exception is thrown when the management account of an organization is registered as
|
|
860
|
+
* <p>This exception is thrown when the management account of an organization is registered as
|
|
861
|
+
* the CloudTrail delegated administrator.</p>
|
|
733
862
|
*/
|
|
734
863
|
export declare class CannotDelegateManagementAccountException extends __BaseException {
|
|
735
864
|
readonly name: "CannotDelegateManagementAccountException";
|
|
@@ -752,15 +881,34 @@ export interface Channel {
|
|
|
752
881
|
*/
|
|
753
882
|
ChannelArn?: string;
|
|
754
883
|
/**
|
|
755
|
-
* <p>
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
884
|
+
* <p> The name of the CloudTrail channel. For service-linked channels, the name is
|
|
885
|
+
* <code>aws-service-channel/service-name/custom-suffix</code> where
|
|
886
|
+
* <code>service-name</code> represents the name of the Amazon Web Services service that
|
|
887
|
+
* created the channel and <code>custom-suffix</code> represents the suffix created by the
|
|
888
|
+
* Amazon Web Services service. </p>
|
|
759
889
|
*/
|
|
760
890
|
Name?: string;
|
|
761
891
|
}
|
|
762
892
|
/**
|
|
763
|
-
* <p>
|
|
893
|
+
* <p>
|
|
894
|
+
* This exception is thrown when the provided channel already exists.
|
|
895
|
+
* </p>
|
|
896
|
+
*/
|
|
897
|
+
export declare class ChannelAlreadyExistsException extends __BaseException {
|
|
898
|
+
readonly name: "ChannelAlreadyExistsException";
|
|
899
|
+
readonly $fault: "client";
|
|
900
|
+
/**
|
|
901
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
902
|
+
*/
|
|
903
|
+
Message?: string;
|
|
904
|
+
/**
|
|
905
|
+
* @internal
|
|
906
|
+
*/
|
|
907
|
+
constructor(opts: __ExceptionOptionType<ChannelAlreadyExistsException, __BaseException>);
|
|
908
|
+
}
|
|
909
|
+
/**
|
|
910
|
+
* <p>This exception is thrown when the specified value of <code>ChannelARN</code> is not
|
|
911
|
+
* valid.</p>
|
|
764
912
|
*/
|
|
765
913
|
export declare class ChannelARNInvalidException extends __BaseException {
|
|
766
914
|
readonly name: "ChannelARNInvalidException";
|
|
@@ -774,13 +922,29 @@ export declare class ChannelARNInvalidException extends __BaseException {
|
|
|
774
922
|
*/
|
|
775
923
|
constructor(opts: __ExceptionOptionType<ChannelARNInvalidException, __BaseException>);
|
|
776
924
|
}
|
|
925
|
+
/**
|
|
926
|
+
* <p>This exception is thrown when the specified event data store cannot yet be deleted because it
|
|
927
|
+
* is in use by a channel.</p>
|
|
928
|
+
*/
|
|
929
|
+
export declare class ChannelExistsForEDSException extends __BaseException {
|
|
930
|
+
readonly name: "ChannelExistsForEDSException";
|
|
931
|
+
readonly $fault: "client";
|
|
932
|
+
/**
|
|
933
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
934
|
+
*/
|
|
935
|
+
Message?: string;
|
|
936
|
+
/**
|
|
937
|
+
* @internal
|
|
938
|
+
*/
|
|
939
|
+
constructor(opts: __ExceptionOptionType<ChannelExistsForEDSException, __BaseException>);
|
|
940
|
+
}
|
|
777
941
|
/**
|
|
778
942
|
* <p>
|
|
779
|
-
*
|
|
943
|
+
* This exception is thrown when the maximum number of channels limit is exceeded.
|
|
780
944
|
* </p>
|
|
781
945
|
*/
|
|
782
|
-
export declare class
|
|
783
|
-
readonly name: "
|
|
946
|
+
export declare class ChannelMaxLimitExceededException extends __BaseException {
|
|
947
|
+
readonly name: "ChannelMaxLimitExceededException";
|
|
784
948
|
readonly $fault: "client";
|
|
785
949
|
/**
|
|
786
950
|
* <p>Brief description of the exception returned by the request.</p>
|
|
@@ -789,12 +953,105 @@ export declare class ChannelNotFoundException extends __BaseException {
|
|
|
789
953
|
/**
|
|
790
954
|
* @internal
|
|
791
955
|
*/
|
|
792
|
-
constructor(opts: __ExceptionOptionType<
|
|
956
|
+
constructor(opts: __ExceptionOptionType<ChannelMaxLimitExceededException, __BaseException>);
|
|
957
|
+
}
|
|
958
|
+
export declare enum DestinationType {
|
|
959
|
+
AWS_SERVICE = "AWS_SERVICE",
|
|
960
|
+
EVENT_DATA_STORE = "EVENT_DATA_STORE"
|
|
793
961
|
}
|
|
794
962
|
/**
|
|
795
|
-
* <p>
|
|
796
|
-
|
|
797
|
-
|
|
963
|
+
* <p>Contains information about the destination receiving events.</p>
|
|
964
|
+
*/
|
|
965
|
+
export interface Destination {
|
|
966
|
+
/**
|
|
967
|
+
* <p>The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is <code>EventDataStore</code>. For service-linked channels,
|
|
968
|
+
* the value is <code>AWS_SERVICE</code>. </p>
|
|
969
|
+
*/
|
|
970
|
+
Type: DestinationType | string | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p> For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel.
|
|
973
|
+
* For service-linked channels, the location is the name of the Amazon Web Services service.</p>
|
|
974
|
+
*/
|
|
975
|
+
Location: string | undefined;
|
|
976
|
+
}
|
|
977
|
+
export interface CreateChannelRequest {
|
|
978
|
+
/**
|
|
979
|
+
* <p>The name of the channel.</p>
|
|
980
|
+
*/
|
|
981
|
+
Name: string | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* <p>The name of the partner or external event source. You cannot change this name after you create the
|
|
984
|
+
* channel. A maximum of one channel is allowed per source.</p>
|
|
985
|
+
* <p>
|
|
986
|
+
* A source can be either <code>Custom</code> for all valid non-Amazon Web Services
|
|
987
|
+
* events, or the name of a partner event source. For information about the source names for available partners, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information">Additional information about integration partners</a> in the CloudTrail User Guide.
|
|
988
|
+
* </p>
|
|
989
|
+
*/
|
|
990
|
+
Source: string | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>One or more event data stores to which events arriving through a channel will be logged.</p>
|
|
993
|
+
*/
|
|
994
|
+
Destinations: Destination[] | undefined;
|
|
995
|
+
/**
|
|
996
|
+
* <p>A list of tags.</p>
|
|
997
|
+
*/
|
|
998
|
+
Tags?: Tag[];
|
|
999
|
+
}
|
|
1000
|
+
export interface CreateChannelResponse {
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The Amazon Resource Name (ARN) of the new channel.</p>
|
|
1003
|
+
*/
|
|
1004
|
+
ChannelArn?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>The name of the new channel.</p>
|
|
1007
|
+
*/
|
|
1008
|
+
Name?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The partner or external event source name.</p>
|
|
1011
|
+
*/
|
|
1012
|
+
Source?: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* <p>The event data stores that log the events arriving through the channel.</p>
|
|
1015
|
+
*/
|
|
1016
|
+
Destinations?: Destination[];
|
|
1017
|
+
/**
|
|
1018
|
+
* <p>A list of tags.</p>
|
|
1019
|
+
*/
|
|
1020
|
+
Tags?: Tag[];
|
|
1021
|
+
}
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>This exception is thrown when event categories of specified event data stores are not
|
|
1024
|
+
* valid.</p>
|
|
1025
|
+
*/
|
|
1026
|
+
export declare class InvalidEventDataStoreCategoryException extends __BaseException {
|
|
1027
|
+
readonly name: "InvalidEventDataStoreCategoryException";
|
|
1028
|
+
readonly $fault: "client";
|
|
1029
|
+
/**
|
|
1030
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
1031
|
+
*/
|
|
1032
|
+
Message?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* @internal
|
|
1035
|
+
*/
|
|
1036
|
+
constructor(opts: __ExceptionOptionType<InvalidEventDataStoreCategoryException, __BaseException>);
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>This exception is thrown when the specified value of <code>Source</code> is not valid.</p>
|
|
1040
|
+
*/
|
|
1041
|
+
export declare class InvalidSourceException extends __BaseException {
|
|
1042
|
+
readonly name: "InvalidSourceException";
|
|
1043
|
+
readonly $fault: "client";
|
|
1044
|
+
/**
|
|
1045
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
1046
|
+
*/
|
|
1047
|
+
Message?: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* @internal
|
|
1050
|
+
*/
|
|
1051
|
+
constructor(opts: __ExceptionOptionType<InvalidSourceException, __BaseException>);
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* <p>This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html">Enabling Trusted Access with Other Amazon Web Services Services</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html">Prepare For Creating a Trail For Your Organization</a>. </p>
|
|
798
1055
|
*/
|
|
799
1056
|
export declare class CloudTrailAccessNotEnabledException extends __BaseException {
|
|
800
1057
|
readonly name: "CloudTrailAccessNotEnabledException";
|
|
@@ -814,28 +1071,34 @@ export interface CreateEventDataStoreRequest {
|
|
|
814
1071
|
*/
|
|
815
1072
|
Name: string | undefined;
|
|
816
1073
|
/**
|
|
817
|
-
* <p>The advanced event selectors to use to select the events for the data store.
|
|
818
|
-
*
|
|
819
|
-
*
|
|
1074
|
+
* <p>The advanced event selectors to use to select the events for the data store. You can
|
|
1075
|
+
* configure up to five advanced event selectors for each event data store.</p>
|
|
1076
|
+
* <p> For more information about how to use advanced event selectors to log CloudTrail
|
|
1077
|
+
* events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced">Log events by using advanced event selectors</a> in the CloudTrail User Guide.</p>
|
|
1078
|
+
* <p>For more information about how to use advanced event selectors to include Config configuration items in your event data store, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config">Create an event data store for Config configuration
|
|
1079
|
+
* items</a> in the CloudTrail User Guide.</p>
|
|
1080
|
+
* <p>For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration">Create an integration to log events from outside Amazon Web Services</a> in the CloudTrail User Guide.</p>
|
|
820
1081
|
*/
|
|
821
1082
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
822
1083
|
/**
|
|
823
|
-
* <p>Specifies whether the event data store includes events from all regions, or only from
|
|
824
|
-
* is created.</p>
|
|
1084
|
+
* <p>Specifies whether the event data store includes events from all regions, or only from
|
|
1085
|
+
* the region in which the event data store is created.</p>
|
|
825
1086
|
*/
|
|
826
1087
|
MultiRegionEnabled?: boolean;
|
|
827
1088
|
/**
|
|
828
|
-
* <p>Specifies whether an event data store collects events logged for an organization in
|
|
1089
|
+
* <p>Specifies whether an event data store collects events logged for an organization in
|
|
1090
|
+
* Organizations.</p>
|
|
829
1091
|
*/
|
|
830
1092
|
OrganizationEnabled?: boolean;
|
|
831
1093
|
/**
|
|
832
|
-
* <p>The retention period of the event data store, in days. You can set a retention period of
|
|
833
|
-
*
|
|
1094
|
+
* <p>The retention period of the event data store, in days. You can set a retention period of
|
|
1095
|
+
* up to 2557 days, the equivalent of seven years.</p>
|
|
834
1096
|
*/
|
|
835
1097
|
RetentionPeriod?: number;
|
|
836
1098
|
/**
|
|
837
|
-
* <p>Specifies whether termination protection is enabled for the event data store. If
|
|
838
|
-
*
|
|
1099
|
+
* <p>Specifies whether termination protection is enabled for the event data store. If
|
|
1100
|
+
* termination protection is enabled, you cannot delete the event data store until termination
|
|
1101
|
+
* protection is disabled.</p>
|
|
839
1102
|
*/
|
|
840
1103
|
TerminationProtectionEnabled?: boolean;
|
|
841
1104
|
/**
|
|
@@ -843,18 +1106,21 @@ export interface CreateEventDataStoreRequest {
|
|
|
843
1106
|
*/
|
|
844
1107
|
TagsList?: Tag[];
|
|
845
1108
|
/**
|
|
846
|
-
* <p>Specifies the KMS key ID to use to encrypt the events delivered by
|
|
847
|
-
*
|
|
848
|
-
* specified ARN to a key, or a globally unique
|
|
1109
|
+
* <p>Specifies the KMS key ID to use to encrypt the events delivered by
|
|
1110
|
+
* CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a
|
|
1111
|
+
* fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique
|
|
1112
|
+
* identifier.</p>
|
|
849
1113
|
* <important>
|
|
850
1114
|
* <p>Disabling or deleting the KMS key, or removing CloudTrail
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
1115
|
+
* permissions on the key, prevents CloudTrail from logging events to the event data
|
|
1116
|
+
* store, and prevents users from querying the data in the event data store that was
|
|
1117
|
+
* encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you
|
|
1118
|
+
* disable or delete a KMS key that you are using with an event data store,
|
|
1119
|
+
* delete or back up your event data store.</p>
|
|
855
1120
|
* </important>
|
|
856
|
-
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
857
|
-
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
1121
|
+
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
1122
|
+
* information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
1123
|
+
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
858
1124
|
* <p>Examples:</p>
|
|
859
1125
|
* <ul>
|
|
860
1126
|
* <li>
|
|
@@ -900,15 +1166,18 @@ export interface CreateEventDataStoreResponse {
|
|
|
900
1166
|
*/
|
|
901
1167
|
Status?: EventDataStoreStatus | string;
|
|
902
1168
|
/**
|
|
903
|
-
* <p>The advanced event selectors that were used to select the events for the data
|
|
1169
|
+
* <p>The advanced event selectors that were used to select the events for the data
|
|
1170
|
+
* store.</p>
|
|
904
1171
|
*/
|
|
905
1172
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
906
1173
|
/**
|
|
907
|
-
* <p>Indicates whether the event data store collects events from all regions, or only from
|
|
1174
|
+
* <p>Indicates whether the event data store collects events from all regions, or only from
|
|
1175
|
+
* the region in which it was created.</p>
|
|
908
1176
|
*/
|
|
909
1177
|
MultiRegionEnabled?: boolean;
|
|
910
1178
|
/**
|
|
911
|
-
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
1179
|
+
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
1180
|
+
* Organizations.</p>
|
|
912
1181
|
*/
|
|
913
1182
|
OrganizationEnabled?: boolean;
|
|
914
1183
|
/**
|
|
@@ -929,12 +1198,13 @@ export interface CreateEventDataStoreResponse {
|
|
|
929
1198
|
CreatedTimestamp?: Date;
|
|
930
1199
|
/**
|
|
931
1200
|
* <p>The timestamp that shows when an event data store was updated, if applicable.
|
|
932
|
-
*
|
|
1201
|
+
* <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
|
|
1202
|
+
* <code>CreatedTimestamp</code>.</p>
|
|
933
1203
|
*/
|
|
934
1204
|
UpdatedTimestamp?: Date;
|
|
935
1205
|
/**
|
|
936
|
-
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
|
|
937
|
-
*
|
|
1206
|
+
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the
|
|
1207
|
+
* following format.</p>
|
|
938
1208
|
* <p>
|
|
939
1209
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
940
1210
|
* </p>
|
|
@@ -973,8 +1243,8 @@ export declare class EventDataStoreMaxLimitExceededException extends __BaseExcep
|
|
|
973
1243
|
}
|
|
974
1244
|
/**
|
|
975
1245
|
* <p>This exception is thrown when the IAM user or role that is used to create
|
|
976
|
-
* the organization resource lacks one or more required permissions for
|
|
977
|
-
*
|
|
1246
|
+
* the organization resource lacks one or more required permissions for creating an
|
|
1247
|
+
* organization resource in a required service.</p>
|
|
978
1248
|
*/
|
|
979
1249
|
export declare class InsufficientDependencyServiceAccessPermissionException extends __BaseException {
|
|
980
1250
|
readonly name: "InsufficientDependencyServiceAccessPermissionException";
|
|
@@ -989,7 +1259,8 @@ export declare class InsufficientDependencyServiceAccessPermissionException exte
|
|
|
989
1259
|
constructor(opts: __ExceptionOptionType<InsufficientDependencyServiceAccessPermissionException, __BaseException>);
|
|
990
1260
|
}
|
|
991
1261
|
/**
|
|
992
|
-
* <p>This exception is thrown when the policy on the S3 bucket or KMS key does
|
|
1262
|
+
* <p>This exception is thrown when the policy on the S3 bucket or KMS key does
|
|
1263
|
+
* not have sufficient permissions for the operation.</p>
|
|
993
1264
|
*/
|
|
994
1265
|
export declare class InsufficientEncryptionPolicyException extends __BaseException {
|
|
995
1266
|
readonly name: "InsufficientEncryptionPolicyException";
|
|
@@ -1004,27 +1275,32 @@ export declare class InsufficientEncryptionPolicyException extends __BaseExcepti
|
|
|
1004
1275
|
constructor(opts: __ExceptionOptionType<InsufficientEncryptionPolicyException, __BaseException>);
|
|
1005
1276
|
}
|
|
1006
1277
|
/**
|
|
1007
|
-
* <p>This exception is thrown when the <code>PutEventSelectors</code> operation is called
|
|
1008
|
-
* selectors, advanced event selectors, or data resources that is not
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1278
|
+
* <p>This exception is thrown when the <code>PutEventSelectors</code> operation is called
|
|
1279
|
+
* with a number of event selectors, advanced event selectors, or data resources that is not
|
|
1280
|
+
* valid. The combination of event selectors or advanced event selectors and data resources is
|
|
1281
|
+
* not valid. A trail can have up to 5 event selectors. If a trail uses advanced event
|
|
1282
|
+
* selectors, a maximum of 500 total values for all conditions in all advanced event selectors
|
|
1283
|
+
* is allowed. A trail is limited to 250 data resources. These data resources can be
|
|
1284
|
+
* distributed across event selectors, but the overall total cannot exceed 250.</p>
|
|
1011
1285
|
* <p>You can:</p>
|
|
1012
1286
|
* <ul>
|
|
1013
1287
|
* <li>
|
|
1014
1288
|
* <p>Specify a valid number of event selectors (1 to 5) for a trail.</p>
|
|
1015
1289
|
* </li>
|
|
1016
1290
|
* <li>
|
|
1017
|
-
* <p>Specify a valid number of data resources (1 to 250) for an event selector.
|
|
1018
|
-
*
|
|
1019
|
-
* However, this upper limit is allowed only if the total number of data resources
|
|
1020
|
-
* exceed 250 across all event selectors for a trail.</p>
|
|
1291
|
+
* <p>Specify a valid number of data resources (1 to 250) for an event selector. The
|
|
1292
|
+
* limit of number of resources on an individual event selector is configurable up to
|
|
1293
|
+
* 250. However, this upper limit is allowed only if the total number of data resources
|
|
1294
|
+
* does not exceed 250 across all event selectors for a trail.</p>
|
|
1021
1295
|
* </li>
|
|
1022
1296
|
* <li>
|
|
1023
|
-
* <p>Specify up to 500 values for all conditions in all advanced event selectors for a
|
|
1297
|
+
* <p>Specify up to 500 values for all conditions in all advanced event selectors for a
|
|
1298
|
+
* trail.</p>
|
|
1024
1299
|
* </li>
|
|
1025
1300
|
* <li>
|
|
1026
|
-
* <p>Specify a valid value for a parameter. For example, specifying the
|
|
1027
|
-
*
|
|
1301
|
+
* <p>Specify a valid value for a parameter. For example, specifying the
|
|
1302
|
+
* <code>ReadWriteType</code> parameter with a value of <code>read-only</code> is not
|
|
1303
|
+
* valid.</p>
|
|
1028
1304
|
* </li>
|
|
1029
1305
|
* </ul>
|
|
1030
1306
|
*/
|
|
@@ -1056,7 +1332,8 @@ export declare class InvalidKmsKeyIdException extends __BaseException {
|
|
|
1056
1332
|
constructor(opts: __ExceptionOptionType<InvalidKmsKeyIdException, __BaseException>);
|
|
1057
1333
|
}
|
|
1058
1334
|
/**
|
|
1059
|
-
* <p>This exception is thrown when there is an issue with the specified KMS
|
|
1335
|
+
* <p>This exception is thrown when there is an issue with the specified KMS
|
|
1336
|
+
* key and the trail or event data store can't be updated.</p>
|
|
1060
1337
|
*/
|
|
1061
1338
|
export declare class KmsException extends __BaseException {
|
|
1062
1339
|
readonly name: "KmsException";
|
|
@@ -1071,9 +1348,9 @@ export declare class KmsException extends __BaseException {
|
|
|
1071
1348
|
constructor(opts: __ExceptionOptionType<KmsException, __BaseException>);
|
|
1072
1349
|
}
|
|
1073
1350
|
/**
|
|
1074
|
-
* <p>This exception is thrown when the KMS key does not exist, when the S3
|
|
1075
|
-
* KMS key are not in the same region, or when the KMS key associated with the Amazon SNS
|
|
1076
|
-
*
|
|
1351
|
+
* <p>This exception is thrown when the KMS key does not exist, when the S3
|
|
1352
|
+
* bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is
|
|
1353
|
+
* not in the same region.</p>
|
|
1077
1354
|
*/
|
|
1078
1355
|
export declare class KmsKeyNotFoundException extends __BaseException {
|
|
1079
1356
|
readonly name: "KmsKeyNotFoundException";
|
|
@@ -1089,8 +1366,8 @@ export declare class KmsKeyNotFoundException extends __BaseException {
|
|
|
1089
1366
|
}
|
|
1090
1367
|
/**
|
|
1091
1368
|
* <p>This exception is thrown when Organizations is not configured to support all
|
|
1092
|
-
* features. All features must be enabled in Organizations to support
|
|
1093
|
-
*
|
|
1369
|
+
* features. All features must be enabled in Organizations to support creating an
|
|
1370
|
+
* organization trail or event data store.</p>
|
|
1094
1371
|
*/
|
|
1095
1372
|
export declare class OrganizationNotInAllFeaturesModeException extends __BaseException {
|
|
1096
1373
|
readonly name: "OrganizationNotInAllFeaturesModeException";
|
|
@@ -1105,8 +1382,9 @@ export declare class OrganizationNotInAllFeaturesModeException extends __BaseExc
|
|
|
1105
1382
|
constructor(opts: __ExceptionOptionType<OrganizationNotInAllFeaturesModeException, __BaseException>);
|
|
1106
1383
|
}
|
|
1107
1384
|
/**
|
|
1108
|
-
* <p>This exception is thrown when the request is made from an Amazon Web Services account
|
|
1109
|
-
* To make this request, sign in using the
|
|
1385
|
+
* <p>This exception is thrown when the request is made from an Amazon Web Services account
|
|
1386
|
+
* that is not a member of an organization. To make this request, sign in using the
|
|
1387
|
+
* credentials of an account that belongs to an organization.</p>
|
|
1110
1388
|
*/
|
|
1111
1389
|
export declare class OrganizationsNotInUseException extends __BaseException {
|
|
1112
1390
|
readonly name: "OrganizationsNotInUseException";
|
|
@@ -1121,9 +1399,9 @@ export declare class OrganizationsNotInUseException extends __BaseException {
|
|
|
1121
1399
|
constructor(opts: __ExceptionOptionType<OrganizationsNotInUseException, __BaseException>);
|
|
1122
1400
|
}
|
|
1123
1401
|
/**
|
|
1124
|
-
* <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code>
|
|
1125
|
-
* This can occur when you are creating or updating a trail to send notifications
|
|
1126
|
-
* is in a suspended Amazon Web Services account.</p>
|
|
1402
|
+
* <p>This exception is thrown when a call results in the <code>InvalidClientTokenId</code>
|
|
1403
|
+
* error code. This can occur when you are creating or updating a trail to send notifications
|
|
1404
|
+
* to an Amazon SNS topic that is in a suspended Amazon Web Services account.</p>
|
|
1127
1405
|
*/
|
|
1128
1406
|
export declare class CloudTrailInvalidClientTokenIdException extends __BaseException {
|
|
1129
1407
|
readonly name: "CloudTrailInvalidClientTokenIdException";
|
|
@@ -1160,7 +1438,8 @@ export interface CreateTrailRequest {
|
|
|
1160
1438
|
* <p>Specifies the name of the trail. The name must meet the following requirements:</p>
|
|
1161
1439
|
* <ul>
|
|
1162
1440
|
* <li>
|
|
1163
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
1441
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
1442
|
+
* (_), or dashes (-)</p>
|
|
1164
1443
|
* </li>
|
|
1165
1444
|
* <li>
|
|
1166
1445
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -1169,8 +1448,8 @@ export interface CreateTrailRequest {
|
|
|
1169
1448
|
* <p>Be between 3 and 128 characters</p>
|
|
1170
1449
|
* </li>
|
|
1171
1450
|
* <li>
|
|
1172
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
1173
|
-
*
|
|
1451
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
1452
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
1174
1453
|
* </li>
|
|
1175
1454
|
* <li>
|
|
1176
1455
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -1179,53 +1458,65 @@ export interface CreateTrailRequest {
|
|
|
1179
1458
|
*/
|
|
1180
1459
|
Name: string | undefined;
|
|
1181
1460
|
/**
|
|
1182
|
-
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
|
1461
|
+
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
|
1462
|
+
* See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
|
|
1463
|
+
* Bucket Naming Requirements</a>.</p>
|
|
1183
1464
|
*/
|
|
1184
1465
|
S3BucketName: string | undefined;
|
|
1185
1466
|
/**
|
|
1186
|
-
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
1187
|
-
* 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
|
|
1467
|
+
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
1468
|
+
* have designated 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
|
|
1469
|
+
* characters.</p>
|
|
1188
1470
|
*/
|
|
1189
1471
|
S3KeyPrefix?: string;
|
|
1190
1472
|
/**
|
|
1191
|
-
* <p>Specifies the name of the Amazon SNS topic defined for notification of log file
|
|
1473
|
+
* <p>Specifies the name of the Amazon SNS topic defined for notification of log file
|
|
1474
|
+
* delivery. The maximum length is 256 characters.</p>
|
|
1192
1475
|
*/
|
|
1193
1476
|
SnsTopicName?: string;
|
|
1194
1477
|
/**
|
|
1195
|
-
* <p>Specifies whether the trail is publishing events from global services such as IAM to the
|
|
1478
|
+
* <p>Specifies whether the trail is publishing events from global services such as IAM to the
|
|
1479
|
+
* log files.</p>
|
|
1196
1480
|
*/
|
|
1197
1481
|
IncludeGlobalServiceEvents?: boolean;
|
|
1198
1482
|
/**
|
|
1199
|
-
* <p>Specifies whether the trail is created in the current region or in all regions. The
|
|
1200
|
-
*
|
|
1483
|
+
* <p>Specifies whether the trail is created in the current region or in all regions. The
|
|
1484
|
+
* default is false, which creates a trail only in the region where you are signed in. As a
|
|
1485
|
+
* best practice, consider creating trails that log events in all regions.</p>
|
|
1201
1486
|
*/
|
|
1202
1487
|
IsMultiRegionTrail?: boolean;
|
|
1203
1488
|
/**
|
|
1204
1489
|
* <p>Specifies whether log file integrity validation is enabled. The default is false.</p>
|
|
1205
1490
|
* <note>
|
|
1206
|
-
* <p>When you disable log file integrity validation, the chain of digest files is broken
|
|
1207
|
-
* not create digest files for log files that were
|
|
1208
|
-
*
|
|
1209
|
-
*
|
|
1210
|
-
* January
|
|
1491
|
+
* <p>When you disable log file integrity validation, the chain of digest files is broken
|
|
1492
|
+
* after one hour. CloudTrail does not create digest files for log files that were
|
|
1493
|
+
* delivered during a period in which log file integrity validation was disabled. For
|
|
1494
|
+
* example, if you enable log file integrity validation at noon on January 1, disable it at
|
|
1495
|
+
* noon on January 2, and re-enable it at noon on January 10, digest files will not be
|
|
1496
|
+
* created for the log files delivered from noon on January 2 to noon on January 10. The
|
|
1497
|
+
* same applies whenever you stop CloudTrail logging or delete a trail.</p>
|
|
1211
1498
|
* </note>
|
|
1212
1499
|
*/
|
|
1213
1500
|
EnableLogFileValidation?: boolean;
|
|
1214
1501
|
/**
|
|
1215
|
-
* <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
|
|
1216
|
-
* to which CloudTrail logs will be delivered.
|
|
1502
|
+
* <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
|
|
1503
|
+
* represents the log group to which CloudTrail logs will be delivered. You must use a
|
|
1504
|
+
* log group that exists in your account.</p>
|
|
1505
|
+
* <p>Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
|
|
1217
1506
|
*/
|
|
1218
1507
|
CloudWatchLogsLogGroupArn?: string;
|
|
1219
1508
|
/**
|
|
1220
|
-
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
1509
|
+
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
1510
|
+
* log group. You must use a role that exists in your account.</p>
|
|
1221
1511
|
*/
|
|
1222
1512
|
CloudWatchLogsRoleArn?: string;
|
|
1223
1513
|
/**
|
|
1224
|
-
* <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
|
|
1225
|
-
*
|
|
1226
|
-
*
|
|
1227
|
-
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
1228
|
-
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
1514
|
+
* <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a fully
|
|
1515
|
+
* specified ARN to an alias, a fully specified ARN to a key, or a globally unique
|
|
1516
|
+
* identifier.</p>
|
|
1517
|
+
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
1518
|
+
* information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
1519
|
+
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1229
1520
|
* <p>Examples:</p>
|
|
1230
1521
|
* <ul>
|
|
1231
1522
|
* <li>
|
|
@@ -1252,9 +1543,9 @@ export interface CreateTrailRequest {
|
|
|
1252
1543
|
*/
|
|
1253
1544
|
KmsKeyId?: string;
|
|
1254
1545
|
/**
|
|
1255
|
-
* <p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
|
|
1256
|
-
*
|
|
1257
|
-
* Organizations.</p>
|
|
1546
|
+
* <p>Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,
|
|
1547
|
+
* and cannot be true unless the call is made on behalf of an Amazon Web Services account that
|
|
1548
|
+
* is the management account or delegated administrator account for an organization in Organizations.</p>
|
|
1258
1549
|
*/
|
|
1259
1550
|
IsOrganizationTrail?: boolean;
|
|
1260
1551
|
/**
|
|
@@ -1263,7 +1554,8 @@ export interface CreateTrailRequest {
|
|
|
1263
1554
|
TagsList?: Tag[];
|
|
1264
1555
|
}
|
|
1265
1556
|
/**
|
|
1266
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
1557
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
1558
|
+
* error.</p>
|
|
1267
1559
|
*/
|
|
1268
1560
|
export interface CreateTrailResponse {
|
|
1269
1561
|
/**
|
|
@@ -1271,12 +1563,13 @@ export interface CreateTrailResponse {
|
|
|
1271
1563
|
*/
|
|
1272
1564
|
Name?: string;
|
|
1273
1565
|
/**
|
|
1274
|
-
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log
|
|
1566
|
+
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log
|
|
1567
|
+
* files.</p>
|
|
1275
1568
|
*/
|
|
1276
1569
|
S3BucketName?: string;
|
|
1277
1570
|
/**
|
|
1278
|
-
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
1279
|
-
* 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>
|
|
1571
|
+
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
1572
|
+
* have designated 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>
|
|
1280
1573
|
*/
|
|
1281
1574
|
S3KeyPrefix?: string;
|
|
1282
1575
|
/**
|
|
@@ -1286,14 +1579,16 @@ export interface CreateTrailResponse {
|
|
|
1286
1579
|
*/
|
|
1287
1580
|
SnsTopicName?: string;
|
|
1288
1581
|
/**
|
|
1289
|
-
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
1582
|
+
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
1583
|
+
* notifications when log files are delivered. The format of a topic ARN is:</p>
|
|
1290
1584
|
* <p>
|
|
1291
1585
|
* <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
|
|
1292
1586
|
* </p>
|
|
1293
1587
|
*/
|
|
1294
1588
|
SnsTopicARN?: string;
|
|
1295
1589
|
/**
|
|
1296
|
-
* <p>Specifies whether the trail is publishing events from global services such as IAM to the
|
|
1590
|
+
* <p>Specifies whether the trail is publishing events from global services such as IAM to the
|
|
1591
|
+
* log files.</p>
|
|
1297
1592
|
*/
|
|
1298
1593
|
IncludeGlobalServiceEvents?: boolean;
|
|
1299
1594
|
/**
|
|
@@ -1301,8 +1596,7 @@ export interface CreateTrailResponse {
|
|
|
1301
1596
|
*/
|
|
1302
1597
|
IsMultiRegionTrail?: boolean;
|
|
1303
1598
|
/**
|
|
1304
|
-
* <p>Specifies the ARN of the trail that was created. The format of a trail ARN
|
|
1305
|
-
* is:</p>
|
|
1599
|
+
* <p>Specifies the ARN of the trail that was created. The format of a trail ARN is:</p>
|
|
1306
1600
|
* <p>
|
|
1307
1601
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
1308
1602
|
* </p>
|
|
@@ -1313,16 +1607,18 @@ export interface CreateTrailResponse {
|
|
|
1313
1607
|
*/
|
|
1314
1608
|
LogFileValidationEnabled?: boolean;
|
|
1315
1609
|
/**
|
|
1316
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
|
|
1610
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
|
|
1611
|
+
* logs will be delivered.</p>
|
|
1317
1612
|
*/
|
|
1318
1613
|
CloudWatchLogsLogGroupArn?: string;
|
|
1319
1614
|
/**
|
|
1320
|
-
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
1615
|
+
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
1616
|
+
* log group.</p>
|
|
1321
1617
|
*/
|
|
1322
1618
|
CloudWatchLogsRoleArn?: string;
|
|
1323
1619
|
/**
|
|
1324
|
-
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
|
|
1325
|
-
*
|
|
1620
|
+
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the
|
|
1621
|
+
* following format.</p>
|
|
1326
1622
|
* <p>
|
|
1327
1623
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
1328
1624
|
* </p>
|
|
@@ -1349,7 +1645,8 @@ export declare class InsufficientS3BucketPolicyException extends __BaseException
|
|
|
1349
1645
|
constructor(opts: __ExceptionOptionType<InsufficientS3BucketPolicyException, __BaseException>);
|
|
1350
1646
|
}
|
|
1351
1647
|
/**
|
|
1352
|
-
* <p>This exception is thrown when the policy on the Amazon SNS topic is not
|
|
1648
|
+
* <p>This exception is thrown when the policy on the Amazon SNS topic is not
|
|
1649
|
+
* sufficient.</p>
|
|
1353
1650
|
*/
|
|
1354
1651
|
export declare class InsufficientSnsTopicPolicyException extends __BaseException {
|
|
1355
1652
|
readonly name: "InsufficientSnsTopicPolicyException";
|
|
@@ -1364,7 +1661,8 @@ export declare class InsufficientSnsTopicPolicyException extends __BaseException
|
|
|
1364
1661
|
constructor(opts: __ExceptionOptionType<InsufficientSnsTopicPolicyException, __BaseException>);
|
|
1365
1662
|
}
|
|
1366
1663
|
/**
|
|
1367
|
-
* <p>This exception is thrown when the provided CloudWatch Logs log group is not
|
|
1664
|
+
* <p>This exception is thrown when the provided CloudWatch Logs log group is not
|
|
1665
|
+
* valid.</p>
|
|
1368
1666
|
*/
|
|
1369
1667
|
export declare class InvalidCloudWatchLogsLogGroupArnException extends __BaseException {
|
|
1370
1668
|
readonly name: "InvalidCloudWatchLogsLogGroupArnException";
|
|
@@ -1394,7 +1692,8 @@ export declare class InvalidCloudWatchLogsRoleArnException extends __BaseExcepti
|
|
|
1394
1692
|
constructor(opts: __ExceptionOptionType<InvalidCloudWatchLogsRoleArnException, __BaseException>);
|
|
1395
1693
|
}
|
|
1396
1694
|
/**
|
|
1397
|
-
* <p>This exception is thrown when the combination of parameters provided is not
|
|
1695
|
+
* <p>This exception is thrown when the combination of parameters provided is not
|
|
1696
|
+
* valid.</p>
|
|
1398
1697
|
*/
|
|
1399
1698
|
export declare class InvalidParameterCombinationException extends __BaseException {
|
|
1400
1699
|
readonly name: "InvalidParameterCombinationException";
|
|
@@ -1530,6 +1829,14 @@ export declare class TrailNotProvidedException extends __BaseException {
|
|
|
1530
1829
|
*/
|
|
1531
1830
|
constructor(opts: __ExceptionOptionType<TrailNotProvidedException, __BaseException>);
|
|
1532
1831
|
}
|
|
1832
|
+
export interface DeleteChannelRequest {
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>The ARN or the <code>UUID</code> value of the channel that you want to delete.</p>
|
|
1835
|
+
*/
|
|
1836
|
+
Channel: string | undefined;
|
|
1837
|
+
}
|
|
1838
|
+
export interface DeleteChannelResponse {
|
|
1839
|
+
}
|
|
1533
1840
|
export interface DeleteEventDataStoreRequest {
|
|
1534
1841
|
/**
|
|
1535
1842
|
* <p>The ARN (or the ID suffix of the ARN) of the event data store to delete.</p>
|
|
@@ -1539,9 +1846,8 @@ export interface DeleteEventDataStoreRequest {
|
|
|
1539
1846
|
export interface DeleteEventDataStoreResponse {
|
|
1540
1847
|
}
|
|
1541
1848
|
/**
|
|
1542
|
-
* <p>
|
|
1543
|
-
*
|
|
1544
|
-
* </p>
|
|
1849
|
+
* <p> This exception is thrown when you try to update or delete an event data store that
|
|
1850
|
+
* currently has an import in progress. </p>
|
|
1545
1851
|
*/
|
|
1546
1852
|
export declare class EventDataStoreHasOngoingImportException extends __BaseException {
|
|
1547
1853
|
readonly name: "EventDataStoreHasOngoingImportException";
|
|
@@ -1556,7 +1862,8 @@ export declare class EventDataStoreHasOngoingImportException extends __BaseExcep
|
|
|
1556
1862
|
constructor(opts: __ExceptionOptionType<EventDataStoreHasOngoingImportException, __BaseException>);
|
|
1557
1863
|
}
|
|
1558
1864
|
/**
|
|
1559
|
-
* <p>The event data store cannot be deleted because termination protection is enabled for
|
|
1865
|
+
* <p>The event data store cannot be deleted because termination protection is enabled for
|
|
1866
|
+
* it.</p>
|
|
1560
1867
|
*/
|
|
1561
1868
|
export declare class EventDataStoreTerminationProtectedException extends __BaseException {
|
|
1562
1869
|
readonly name: "EventDataStoreTerminationProtectedException";
|
|
@@ -1570,25 +1877,74 @@ export declare class EventDataStoreTerminationProtectedException extends __BaseE
|
|
|
1570
1877
|
*/
|
|
1571
1878
|
constructor(opts: __ExceptionOptionType<EventDataStoreTerminationProtectedException, __BaseException>);
|
|
1572
1879
|
}
|
|
1880
|
+
export interface DeleteResourcePolicyRequest {
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>
|
|
1883
|
+
* The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from.
|
|
1884
|
+
* The following is the format of a resource ARN:
|
|
1885
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
1886
|
+
* </p>
|
|
1887
|
+
*/
|
|
1888
|
+
ResourceArn: string | undefined;
|
|
1889
|
+
}
|
|
1890
|
+
export interface DeleteResourcePolicyResponse {
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>
|
|
1894
|
+
* This exception is thrown when the provided resource does not exist, or the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
|
|
1895
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
1896
|
+
* </p>
|
|
1897
|
+
*/
|
|
1898
|
+
export declare class ResourceARNNotValidException extends __BaseException {
|
|
1899
|
+
readonly name: "ResourceARNNotValidException";
|
|
1900
|
+
readonly $fault: "client";
|
|
1901
|
+
/**
|
|
1902
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
1903
|
+
*/
|
|
1904
|
+
Message?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* @internal
|
|
1907
|
+
*/
|
|
1908
|
+
constructor(opts: __ExceptionOptionType<ResourceARNNotValidException, __BaseException>);
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* <p>
|
|
1912
|
+
* This exception is thrown when the specified resource policy is not found.
|
|
1913
|
+
* </p>
|
|
1914
|
+
*/
|
|
1915
|
+
export declare class ResourcePolicyNotFoundException extends __BaseException {
|
|
1916
|
+
readonly name: "ResourcePolicyNotFoundException";
|
|
1917
|
+
readonly $fault: "client";
|
|
1918
|
+
/**
|
|
1919
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
1920
|
+
*/
|
|
1921
|
+
Message?: string;
|
|
1922
|
+
/**
|
|
1923
|
+
* @internal
|
|
1924
|
+
*/
|
|
1925
|
+
constructor(opts: __ExceptionOptionType<ResourcePolicyNotFoundException, __BaseException>);
|
|
1926
|
+
}
|
|
1573
1927
|
/**
|
|
1574
1928
|
* <p>The request that specifies the name of a trail to delete.</p>
|
|
1575
1929
|
*/
|
|
1576
1930
|
export interface DeleteTrailRequest {
|
|
1577
1931
|
/**
|
|
1578
|
-
* <p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The
|
|
1579
|
-
* trail ARN.
|
|
1580
|
-
*
|
|
1932
|
+
* <p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The
|
|
1933
|
+
* following is the format of a trail ARN.
|
|
1934
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
1581
1935
|
* </p>
|
|
1582
1936
|
*/
|
|
1583
1937
|
Name: string | undefined;
|
|
1584
1938
|
}
|
|
1585
1939
|
/**
|
|
1586
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
1940
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
1941
|
+
* error.</p>
|
|
1587
1942
|
*/
|
|
1588
1943
|
export interface DeleteTrailResponse {
|
|
1589
1944
|
}
|
|
1590
1945
|
/**
|
|
1591
|
-
* <p>This exception is thrown when an operation is called on a trail from a region other than
|
|
1946
|
+
* <p>This exception is thrown when an operation is called on a trail from a region other than
|
|
1947
|
+
* the region in which the trail was created.</p>
|
|
1592
1948
|
*/
|
|
1593
1949
|
export declare class InvalidHomeRegionException extends __BaseException {
|
|
1594
1950
|
readonly name: "InvalidHomeRegionException";
|
|
@@ -1618,13 +1974,14 @@ export declare class TrailNotFoundException extends __BaseException {
|
|
|
1618
1974
|
constructor(opts: __ExceptionOptionType<TrailNotFoundException, __BaseException>);
|
|
1619
1975
|
}
|
|
1620
1976
|
/**
|
|
1621
|
-
* <p>Removes CloudTrail delegated administrator permissions from a specified member
|
|
1622
|
-
* that is currently designated as a delegated
|
|
1977
|
+
* <p>Removes CloudTrail delegated administrator permissions from a specified member
|
|
1978
|
+
* account in an organization that is currently designated as a delegated
|
|
1979
|
+
* administrator.</p>
|
|
1623
1980
|
*/
|
|
1624
1981
|
export interface DeregisterOrganizationDelegatedAdminRequest {
|
|
1625
1982
|
/**
|
|
1626
|
-
* <p>A delegated administrator account ID. This is a member account in an organization
|
|
1627
|
-
*
|
|
1983
|
+
* <p>A delegated administrator account ID. This is a member account in an organization that
|
|
1984
|
+
* is currently designated as a delegated administrator.</p>
|
|
1628
1985
|
*/
|
|
1629
1986
|
DelegatedAdminAccountId: string | undefined;
|
|
1630
1987
|
}
|
|
@@ -1634,9 +1991,8 @@ export interface DeregisterOrganizationDelegatedAdminRequest {
|
|
|
1634
1991
|
export interface DeregisterOrganizationDelegatedAdminResponse {
|
|
1635
1992
|
}
|
|
1636
1993
|
/**
|
|
1637
|
-
* <p>
|
|
1638
|
-
*
|
|
1639
|
-
* </p>
|
|
1994
|
+
* <p> This exception is thrown when the account making the request is not the organization's
|
|
1995
|
+
* management account. </p>
|
|
1640
1996
|
*/
|
|
1641
1997
|
export declare class NotOrganizationManagementAccountException extends __BaseException {
|
|
1642
1998
|
readonly name: "NotOrganizationManagementAccountException";
|
|
@@ -1654,7 +2010,8 @@ export interface DescribeQueryRequest {
|
|
|
1654
2010
|
/**
|
|
1655
2011
|
* @deprecated
|
|
1656
2012
|
*
|
|
1657
|
-
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
|
|
2013
|
+
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
|
|
2014
|
+
* query was run.</p>
|
|
1658
2015
|
*/
|
|
1659
2016
|
EventDataStore?: string;
|
|
1660
2017
|
/**
|
|
@@ -1674,8 +2031,9 @@ export declare enum DeliveryStatus {
|
|
|
1674
2031
|
UNKNOWN = "UNKNOWN"
|
|
1675
2032
|
}
|
|
1676
2033
|
/**
|
|
1677
|
-
* <p>Gets metadata about a query, including the number of events that were matched, the total
|
|
1678
|
-
* in milliseconds, and the query's creation
|
|
2034
|
+
* <p>Gets metadata about a query, including the number of events that were matched, the total
|
|
2035
|
+
* number of events scanned, the query run time in milliseconds, and the query's creation
|
|
2036
|
+
* time.</p>
|
|
1679
2037
|
*/
|
|
1680
2038
|
export interface QueryStatisticsForDescribeQuery {
|
|
1681
2039
|
/**
|
|
@@ -1687,8 +2045,9 @@ export interface QueryStatisticsForDescribeQuery {
|
|
|
1687
2045
|
*/
|
|
1688
2046
|
EventsScanned?: number;
|
|
1689
2047
|
/**
|
|
1690
|
-
* <p>The total bytes that the query scanned in the event data store. This value matches the
|
|
1691
|
-
*
|
|
2048
|
+
* <p>The total bytes that the query scanned in the event data store. This value matches the
|
|
2049
|
+
* number of bytes for which your account is billed for the query, unless the query is still
|
|
2050
|
+
* running.</p>
|
|
1692
2051
|
*/
|
|
1693
2052
|
BytesScanned?: number;
|
|
1694
2053
|
/**
|
|
@@ -1710,14 +2069,16 @@ export interface DescribeQueryResponse {
|
|
|
1710
2069
|
*/
|
|
1711
2070
|
QueryString?: string;
|
|
1712
2071
|
/**
|
|
1713
|
-
* <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>,
|
|
1714
|
-
*
|
|
2072
|
+
* <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>,
|
|
2073
|
+
* <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>,
|
|
2074
|
+
* <code>TIMED_OUT</code>, or <code>CANCELLED</code>
|
|
1715
2075
|
* </p>
|
|
1716
2076
|
*/
|
|
1717
2077
|
QueryStatus?: QueryStatus | string;
|
|
1718
2078
|
/**
|
|
1719
|
-
* <p>Metadata about a query, including the number of events that were matched, the total
|
|
1720
|
-
* in milliseconds, and the query's creation
|
|
2079
|
+
* <p>Metadata about a query, including the number of events that were matched, the total
|
|
2080
|
+
* number of events scanned, the query run time in milliseconds, and the query's creation
|
|
2081
|
+
* time.</p>
|
|
1721
2082
|
*/
|
|
1722
2083
|
QueryStatistics?: QueryStatisticsForDescribeQuery;
|
|
1723
2084
|
/**
|
|
@@ -1725,7 +2086,8 @@ export interface DescribeQueryResponse {
|
|
|
1725
2086
|
*/
|
|
1726
2087
|
ErrorMessage?: string;
|
|
1727
2088
|
/**
|
|
1728
|
-
* <p>The URI for the S3 bucket where CloudTrail delivered query results, if
|
|
2089
|
+
* <p>The URI for the S3 bucket where CloudTrail delivered query results, if
|
|
2090
|
+
* applicable.</p>
|
|
1729
2091
|
*/
|
|
1730
2092
|
DeliveryS3Uri?: string;
|
|
1731
2093
|
/**
|
|
@@ -1738,29 +2100,37 @@ export interface DescribeQueryResponse {
|
|
|
1738
2100
|
*/
|
|
1739
2101
|
export interface DescribeTrailsRequest {
|
|
1740
2102
|
/**
|
|
1741
|
-
* <p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The
|
|
2103
|
+
* <p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The
|
|
2104
|
+
* format of a trail ARN is:</p>
|
|
1742
2105
|
* <p>
|
|
1743
2106
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
1744
2107
|
* </p>
|
|
1745
|
-
* <p>If an empty list is specified, information for the trail in the current region is
|
|
2108
|
+
* <p>If an empty list is specified, information for the trail in the current region is
|
|
2109
|
+
* returned.</p>
|
|
1746
2110
|
* <ul>
|
|
1747
2111
|
* <li>
|
|
1748
2112
|
* <p>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then
|
|
1749
|
-
*
|
|
2113
|
+
* information for all trails in the current region is returned.</p>
|
|
1750
2114
|
* </li>
|
|
1751
2115
|
* <li>
|
|
1752
|
-
* <p>If an empty list is specified and IncludeShadowTrails is null or true, then
|
|
2116
|
+
* <p>If an empty list is specified and IncludeShadowTrails is null or true, then
|
|
2117
|
+
* information for all trails in the current region and any associated shadow trails in
|
|
2118
|
+
* other regions is returned.</p>
|
|
1753
2119
|
* </li>
|
|
1754
2120
|
* </ul>
|
|
1755
2121
|
* <note>
|
|
1756
|
-
* <p>If one or more trail names are specified, information is returned only if the names
|
|
2122
|
+
* <p>If one or more trail names are specified, information is returned only if the names
|
|
2123
|
+
* match the names of trails belonging only to the current region and current account. To return information
|
|
2124
|
+
* about a trail in another region, you must specify its trail ARN.</p>
|
|
1757
2125
|
* </note>
|
|
1758
2126
|
*/
|
|
1759
2127
|
trailNameList?: string[];
|
|
1760
2128
|
/**
|
|
1761
|
-
* <p>Specifies whether to include shadow trails in the response. A shadow trail is the
|
|
1762
|
-
*
|
|
1763
|
-
*
|
|
2129
|
+
* <p>Specifies whether to include shadow trails in the response. A shadow trail is the
|
|
2130
|
+
* replication in a region of a trail that was created in a different region, or in the case
|
|
2131
|
+
* of an organization trail, the replication of an organization trail in member accounts. If
|
|
2132
|
+
* you do not include shadow trails, organization trails in a member account and region
|
|
2133
|
+
* replication trails will not be returned. The default is true.</p>
|
|
1764
2134
|
*/
|
|
1765
2135
|
includeShadowTrails?: boolean;
|
|
1766
2136
|
}
|
|
@@ -1769,18 +2139,20 @@ export interface DescribeTrailsRequest {
|
|
|
1769
2139
|
*/
|
|
1770
2140
|
export interface Trail {
|
|
1771
2141
|
/**
|
|
1772
|
-
* <p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is
|
|
1773
|
-
* characters.</p>
|
|
2142
|
+
* <p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is
|
|
2143
|
+
* 128 characters.</p>
|
|
1774
2144
|
*/
|
|
1775
2145
|
Name?: string;
|
|
1776
2146
|
/**
|
|
1777
|
-
* <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail
|
|
2147
|
+
* <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail
|
|
2148
|
+
* files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
|
|
2149
|
+
* Bucket Naming Requirements</a>.</p>
|
|
1778
2150
|
*/
|
|
1779
2151
|
S3BucketName?: string;
|
|
1780
2152
|
/**
|
|
1781
|
-
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
1782
|
-
* 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>.
|
|
1783
|
-
*
|
|
2153
|
+
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
2154
|
+
* have designated 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
|
|
2155
|
+
* characters.</p>
|
|
1784
2156
|
*/
|
|
1785
2157
|
S3KeyPrefix?: string;
|
|
1786
2158
|
/**
|
|
@@ -1790,16 +2162,17 @@ export interface Trail {
|
|
|
1790
2162
|
*/
|
|
1791
2163
|
SnsTopicName?: string;
|
|
1792
2164
|
/**
|
|
1793
|
-
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
1794
|
-
* when log files are delivered. The following is the format of a topic
|
|
2165
|
+
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
2166
|
+
* notifications when log files are delivered. The following is the format of a topic
|
|
2167
|
+
* ARN.</p>
|
|
1795
2168
|
* <p>
|
|
1796
2169
|
* <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
|
|
1797
2170
|
* </p>
|
|
1798
2171
|
*/
|
|
1799
2172
|
SnsTopicARN?: string;
|
|
1800
2173
|
/**
|
|
1801
|
-
* <p>Set to <b>True</b> to include Amazon Web Services API calls
|
|
1802
|
-
* Otherwise, <b>False</b>.</p>
|
|
2174
|
+
* <p>Set to <b>True</b> to include Amazon Web Services API calls
|
|
2175
|
+
* from Amazon Web Services global services such as IAM. Otherwise, <b>False</b>.</p>
|
|
1803
2176
|
*/
|
|
1804
2177
|
IncludeGlobalServiceEvents?: boolean;
|
|
1805
2178
|
/**
|
|
@@ -1822,16 +2195,18 @@ export interface Trail {
|
|
|
1822
2195
|
*/
|
|
1823
2196
|
LogFileValidationEnabled?: boolean;
|
|
1824
2197
|
/**
|
|
1825
|
-
* <p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log
|
|
2198
|
+
* <p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log
|
|
2199
|
+
* group to which CloudTrail logs will be delivered.</p>
|
|
1826
2200
|
*/
|
|
1827
2201
|
CloudWatchLogsLogGroupArn?: string;
|
|
1828
2202
|
/**
|
|
1829
|
-
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
2203
|
+
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
2204
|
+
* log group.</p>
|
|
1830
2205
|
*/
|
|
1831
2206
|
CloudWatchLogsRoleArn?: string;
|
|
1832
2207
|
/**
|
|
1833
|
-
* <p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
|
|
1834
|
-
*
|
|
2208
|
+
* <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
|
|
2209
|
+
* following format.</p>
|
|
1835
2210
|
* <p>
|
|
1836
2211
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
1837
2212
|
* </p>
|
|
@@ -1842,7 +2217,8 @@ export interface Trail {
|
|
|
1842
2217
|
*/
|
|
1843
2218
|
HasCustomEventSelectors?: boolean;
|
|
1844
2219
|
/**
|
|
1845
|
-
* <p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code>
|
|
2220
|
+
* <p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code>
|
|
2221
|
+
* list.</p>
|
|
1846
2222
|
*/
|
|
1847
2223
|
HasInsightSelectors?: boolean;
|
|
1848
2224
|
/**
|
|
@@ -1851,13 +2227,17 @@ export interface Trail {
|
|
|
1851
2227
|
IsOrganizationTrail?: boolean;
|
|
1852
2228
|
}
|
|
1853
2229
|
/**
|
|
1854
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
2230
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
2231
|
+
* error.</p>
|
|
1855
2232
|
*/
|
|
1856
2233
|
export interface DescribeTrailsResponse {
|
|
1857
2234
|
/**
|
|
1858
|
-
* <p>The list of trail objects. Trail objects with string values are only returned if values
|
|
1859
|
-
*
|
|
1860
|
-
* <code>
|
|
2235
|
+
* <p>The list of trail objects. Trail objects with string values are only returned if values
|
|
2236
|
+
* for the objects exist in a trail's configuration. For example, <code>SNSTopicName</code>
|
|
2237
|
+
* and <code>SNSTopicARN</code> are only returned in results if a trail is configured to send
|
|
2238
|
+
* SNS notifications. Similarly, <code>KMSKeyId</code> only appears in results if a trail's
|
|
2239
|
+
* log files are encrypted with KMS
|
|
2240
|
+
* customer managed keys.</p>
|
|
1861
2241
|
*/
|
|
1862
2242
|
trailList?: Trail[];
|
|
1863
2243
|
}
|
|
@@ -1867,38 +2247,42 @@ export interface GetChannelRequest {
|
|
|
1867
2247
|
*/
|
|
1868
2248
|
Channel: string | undefined;
|
|
1869
2249
|
}
|
|
1870
|
-
export declare enum DestinationType {
|
|
1871
|
-
AWS_SERVICE = "AWS_SERVICE",
|
|
1872
|
-
EVENT_DATA_STORE = "EVENT_DATA_STORE"
|
|
1873
|
-
}
|
|
1874
2250
|
/**
|
|
1875
|
-
* <p>
|
|
2251
|
+
* <p>A table showing information about the most recent successful and failed attempts
|
|
2252
|
+
* to ingest events.</p>
|
|
1876
2253
|
*/
|
|
1877
|
-
export interface
|
|
2254
|
+
export interface IngestionStatus {
|
|
1878
2255
|
/**
|
|
1879
|
-
* <p>The
|
|
1880
|
-
* the value is <code>AWS_SERVICE</code>.</p>
|
|
2256
|
+
* <p>The time stamp of the most recent successful ingestion of events for the channel.</p>
|
|
1881
2257
|
*/
|
|
1882
|
-
|
|
2258
|
+
LatestIngestionSuccessTime?: Date;
|
|
1883
2259
|
/**
|
|
1884
|
-
* <p>
|
|
2260
|
+
* <p>The event ID of the most recent successful ingestion of events.</p>
|
|
1885
2261
|
*/
|
|
1886
|
-
|
|
2262
|
+
LatestIngestionSuccessEventID?: string;
|
|
2263
|
+
/**
|
|
2264
|
+
* <p>The error code for the most recent failure to ingest events.</p>
|
|
2265
|
+
*/
|
|
2266
|
+
LatestIngestionErrorCode?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* <p>The time stamp of the most recent attempt to ingest events on the channel.</p>
|
|
2269
|
+
*/
|
|
2270
|
+
LatestIngestionAttemptTime?: Date;
|
|
2271
|
+
/**
|
|
2272
|
+
* <p>The event ID of the most recent attempt to ingest events.</p>
|
|
2273
|
+
*/
|
|
2274
|
+
LatestIngestionAttemptEventID?: string;
|
|
1887
2275
|
}
|
|
1888
2276
|
/**
|
|
1889
|
-
* <p>
|
|
1890
|
-
* Contains configuration information about the channel.
|
|
1891
|
-
* </p>
|
|
2277
|
+
* <p> Contains configuration information about the channel. </p>
|
|
1892
2278
|
*/
|
|
1893
2279
|
export interface SourceConfig {
|
|
1894
2280
|
/**
|
|
1895
|
-
* <p>
|
|
1896
|
-
* Specifies whether the channel applies to a single region or to all regions.</p>
|
|
2281
|
+
* <p> Specifies whether the channel applies to a single region or to all regions.</p>
|
|
1897
2282
|
*/
|
|
1898
2283
|
ApplyToAllRegions?: boolean;
|
|
1899
2284
|
/**
|
|
1900
|
-
* <p>
|
|
1901
|
-
* The advanced event selectors that are configured for the channel.</p>
|
|
2285
|
+
* <p> The advanced event selectors that are configured for the channel.</p>
|
|
1902
2286
|
*/
|
|
1903
2287
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
1904
2288
|
}
|
|
@@ -1908,32 +2292,38 @@ export interface GetChannelResponse {
|
|
|
1908
2292
|
*/
|
|
1909
2293
|
ChannelArn?: string;
|
|
1910
2294
|
/**
|
|
1911
|
-
* <p>
|
|
1912
|
-
*
|
|
1913
|
-
*
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
2295
|
+
* <p> The name of the CloudTrail channel. For service-linked channels, the name is
|
|
2296
|
+
* <code>aws-service-channel/service-name/custom-suffix</code> where
|
|
2297
|
+
* <code>service-name</code> represents the name of the Amazon Web Services service that
|
|
2298
|
+
* created the channel and <code>custom-suffix</code> represents the suffix generated by the
|
|
2299
|
+
* Amazon Web Services service. </p>
|
|
1916
2300
|
*/
|
|
1917
2301
|
Name?: string;
|
|
1918
2302
|
/**
|
|
1919
|
-
* <p>The
|
|
2303
|
+
* <p>The source for the CloudTrail channel.</p>
|
|
1920
2304
|
*/
|
|
1921
2305
|
Source?: string;
|
|
1922
2306
|
/**
|
|
1923
|
-
* <p>
|
|
1924
|
-
*
|
|
1925
|
-
* whether the channel applies to all regions or a single region.
|
|
1926
|
-
* </p>
|
|
2307
|
+
* <p> Provides information about the advanced event selectors configured for the channel, and
|
|
2308
|
+
* whether the channel applies to all regions or a single region. </p>
|
|
1927
2309
|
*/
|
|
1928
2310
|
SourceConfig?: SourceConfig;
|
|
1929
2311
|
/**
|
|
1930
|
-
* <p>The
|
|
2312
|
+
* <p>The destinations for the channel. For channels created for integrations,
|
|
2313
|
+
* the destinations are the event data stores that log events arriving through the channel.
|
|
2314
|
+
* For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.</p>
|
|
1931
2315
|
*/
|
|
1932
2316
|
Destinations?: Destination[];
|
|
2317
|
+
/**
|
|
2318
|
+
* <p>A table showing information about the most recent successful and failed attempts
|
|
2319
|
+
* to ingest events.</p>
|
|
2320
|
+
*/
|
|
2321
|
+
IngestionStatus?: IngestionStatus;
|
|
1933
2322
|
}
|
|
1934
2323
|
export interface GetEventDataStoreRequest {
|
|
1935
2324
|
/**
|
|
1936
|
-
* <p>The ARN (or ID suffix of the ARN) of the event data store about which you want
|
|
2325
|
+
* <p>The ARN (or ID suffix of the ARN) of the event data store about which you want
|
|
2326
|
+
* information.</p>
|
|
1937
2327
|
*/
|
|
1938
2328
|
EventDataStore: string | undefined;
|
|
1939
2329
|
}
|
|
@@ -1947,7 +2337,8 @@ export interface GetEventDataStoreResponse {
|
|
|
1947
2337
|
*/
|
|
1948
2338
|
Name?: string;
|
|
1949
2339
|
/**
|
|
1950
|
-
* <p>The status of an event data store. Values can be <code>ENABLED</code> and
|
|
2340
|
+
* <p>The status of an event data store. Values can be <code>ENABLED</code> and
|
|
2341
|
+
* <code>PENDING_DELETION</code>.</p>
|
|
1951
2342
|
*/
|
|
1952
2343
|
Status?: EventDataStoreStatus | string;
|
|
1953
2344
|
/**
|
|
@@ -1955,11 +2346,13 @@ export interface GetEventDataStoreResponse {
|
|
|
1955
2346
|
*/
|
|
1956
2347
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
1957
2348
|
/**
|
|
1958
|
-
* <p>Indicates whether the event data store includes events from all regions, or only from
|
|
2349
|
+
* <p>Indicates whether the event data store includes events from all regions, or only from
|
|
2350
|
+
* the region in which it was created.</p>
|
|
1959
2351
|
*/
|
|
1960
2352
|
MultiRegionEnabled?: boolean;
|
|
1961
2353
|
/**
|
|
1962
|
-
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
2354
|
+
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
2355
|
+
* Organizations.</p>
|
|
1963
2356
|
*/
|
|
1964
2357
|
OrganizationEnabled?: boolean;
|
|
1965
2358
|
/**
|
|
@@ -1975,12 +2368,14 @@ export interface GetEventDataStoreResponse {
|
|
|
1975
2368
|
*/
|
|
1976
2369
|
CreatedTimestamp?: Date;
|
|
1977
2370
|
/**
|
|
1978
|
-
* <p>Shows the time that an event data store was updated, if applicable.
|
|
2371
|
+
* <p>Shows the time that an event data store was updated, if applicable.
|
|
2372
|
+
* <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
|
|
2373
|
+
* <code>CreatedTimestamp</code>.</p>
|
|
1979
2374
|
*/
|
|
1980
2375
|
UpdatedTimestamp?: Date;
|
|
1981
2376
|
/**
|
|
1982
|
-
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
|
|
1983
|
-
*
|
|
2377
|
+
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the
|
|
2378
|
+
* following format.</p>
|
|
1984
2379
|
* <p>
|
|
1985
2380
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
1986
2381
|
* </p>
|
|
@@ -1989,11 +2384,12 @@ export interface GetEventDataStoreResponse {
|
|
|
1989
2384
|
}
|
|
1990
2385
|
export interface GetEventSelectorsRequest {
|
|
1991
2386
|
/**
|
|
1992
|
-
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
|
|
1993
|
-
*
|
|
2387
|
+
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
|
|
2388
|
+
* must meet the following requirements:</p>
|
|
1994
2389
|
* <ul>
|
|
1995
2390
|
* <li>
|
|
1996
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
2391
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
2392
|
+
* (_), or dashes (-)</p>
|
|
1997
2393
|
* </li>
|
|
1998
2394
|
* <li>
|
|
1999
2395
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -2002,8 +2398,8 @@ export interface GetEventSelectorsRequest {
|
|
|
2002
2398
|
* <p>Be between 3 and 128 characters</p>
|
|
2003
2399
|
* </li>
|
|
2004
2400
|
* <li>
|
|
2005
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
2006
|
-
* and <code>my--namespace</code> are not valid.</p>
|
|
2401
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
2402
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
2007
2403
|
* </li>
|
|
2008
2404
|
* <li>
|
|
2009
2405
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -2017,63 +2413,70 @@ export interface GetEventSelectorsRequest {
|
|
|
2017
2413
|
TrailName: string | undefined;
|
|
2018
2414
|
}
|
|
2019
2415
|
/**
|
|
2020
|
-
* <p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify
|
|
2021
|
-
*
|
|
2022
|
-
*
|
|
2023
|
-
*
|
|
2024
|
-
* trail.</p>
|
|
2416
|
+
* <p>The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data
|
|
2417
|
+
* events provide information about the resource operations performed on or within a resource
|
|
2418
|
+
* itself. These are also known as data plane operations. You can specify up to 250 data
|
|
2419
|
+
* resources for a trail.</p>
|
|
2025
2420
|
* <note>
|
|
2026
|
-
* <p>The total number of allowed data resources is 250. This number can be distributed
|
|
2027
|
-
*
|
|
2421
|
+
* <p>The total number of allowed data resources is 250. This number can be distributed
|
|
2422
|
+
* between 1 and 5 event selectors, but the total cannot exceed 250 across all
|
|
2423
|
+
* selectors for the trail.</p>
|
|
2028
2424
|
* <p>If you are using advanced event selectors, the maximum total number of values for
|
|
2029
2425
|
* all conditions, across all advanced event selectors for the trail, is 500.</p>
|
|
2030
2426
|
* </note>
|
|
2031
|
-
* <p>The following example demonstrates how logging works when you configure logging of all
|
|
2032
|
-
* for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix,
|
|
2033
|
-
*
|
|
2427
|
+
* <p>The following example demonstrates how logging works when you configure logging of all
|
|
2428
|
+
* data events for an S3 bucket named <code>bucket-1</code>. In this example, the CloudTrail user specified an empty prefix, and the option to log both <code>Read</code>
|
|
2429
|
+
* and <code>Write</code> data events.</p>
|
|
2034
2430
|
* <ol>
|
|
2035
2431
|
* <li>
|
|
2036
2432
|
* <p>A user uploads an image file to <code>bucket-1</code>.</p>
|
|
2037
2433
|
* </li>
|
|
2038
2434
|
* <li>
|
|
2039
2435
|
* <p>The <code>PutObject</code> API operation is an Amazon S3 object-level API.
|
|
2040
|
-
*
|
|
2041
|
-
*
|
|
2042
|
-
* event.</p>
|
|
2436
|
+
* It is recorded as a data event in CloudTrail. Because the CloudTrail
|
|
2437
|
+
* user specified an S3 bucket with an empty prefix, events that occur on any object in
|
|
2438
|
+
* that bucket are logged. The trail processes and logs the event.</p>
|
|
2043
2439
|
* </li>
|
|
2044
2440
|
* <li>
|
|
2045
2441
|
* <p>A user uploads an object to an Amazon S3 bucket named
|
|
2046
2442
|
* <code>arn:aws:s3:::bucket-2</code>.</p>
|
|
2047
2443
|
* </li>
|
|
2048
2444
|
* <li>
|
|
2049
|
-
* <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket
|
|
2050
|
-
*
|
|
2445
|
+
* <p>The <code>PutObject</code> API operation occurred for an object in an S3 bucket
|
|
2446
|
+
* that the CloudTrail user didn't specify for the trail. The trail doesn’t log
|
|
2447
|
+
* the event.</p>
|
|
2051
2448
|
* </li>
|
|
2052
2449
|
* </ol>
|
|
2053
|
-
* <p>The following example demonstrates how logging works when you configure logging of
|
|
2054
|
-
*
|
|
2450
|
+
* <p>The following example demonstrates how logging works when you configure logging of
|
|
2451
|
+
* Lambda data events for a Lambda function named
|
|
2452
|
+
* <i>MyLambdaFunction</i>, but not for all Lambda
|
|
2453
|
+
* functions.</p>
|
|
2055
2454
|
* <ol>
|
|
2056
2455
|
* <li>
|
|
2057
|
-
* <p>A user runs a script that includes a call to the
|
|
2058
|
-
*
|
|
2456
|
+
* <p>A user runs a script that includes a call to the
|
|
2457
|
+
* <i>MyLambdaFunction</i> function and the
|
|
2458
|
+
* <i>MyOtherLambdaFunction</i> function.</p>
|
|
2059
2459
|
* </li>
|
|
2060
2460
|
* <li>
|
|
2061
|
-
* <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is
|
|
2062
|
-
* It is recorded as a data event in CloudTrail.
|
|
2063
|
-
*
|
|
2461
|
+
* <p>The <code>Invoke</code> API operation on <i>MyLambdaFunction</i> is
|
|
2462
|
+
* an Lambda API. It is recorded as a data event in CloudTrail.
|
|
2463
|
+
* Because the CloudTrail user specified logging data events for
|
|
2464
|
+
* <i>MyLambdaFunction</i>, any invocations of that function are
|
|
2465
|
+
* logged. The trail processes and logs the event.</p>
|
|
2064
2466
|
* </li>
|
|
2065
2467
|
* <li>
|
|
2066
|
-
* <p>The <code>Invoke</code> API operation on
|
|
2067
|
-
*
|
|
2068
|
-
* the
|
|
2069
|
-
*
|
|
2468
|
+
* <p>The <code>Invoke</code> API operation on
|
|
2469
|
+
* <i>MyOtherLambdaFunction</i> is an Lambda API. Because
|
|
2470
|
+
* the CloudTrail user did not specify logging data events for all Lambda functions, the <code>Invoke</code> operation for
|
|
2471
|
+
* <i>MyOtherLambdaFunction</i> does not match the function specified
|
|
2472
|
+
* for the trail. The trail doesn’t log the event. </p>
|
|
2070
2473
|
* </li>
|
|
2071
2474
|
* </ol>
|
|
2072
2475
|
*/
|
|
2073
2476
|
export interface DataResource {
|
|
2074
2477
|
/**
|
|
2075
|
-
* <p>The resource type in which you want to log data events. You can specify
|
|
2076
|
-
*
|
|
2478
|
+
* <p>The resource type in which you want to log data events. You can specify the following
|
|
2479
|
+
* <i>basic</i> event selector resource types:</p>
|
|
2077
2480
|
* <ul>
|
|
2078
2481
|
* <li>
|
|
2079
2482
|
* <p>
|
|
@@ -2091,13 +2494,18 @@ export interface DataResource {
|
|
|
2091
2494
|
* </p>
|
|
2092
2495
|
* </li>
|
|
2093
2496
|
* </ul>
|
|
2094
|
-
* <p>The following resource types are also available through <i>advanced</i>
|
|
2095
|
-
* Basic event selector resource types are valid in advanced event selectors,
|
|
2096
|
-
* advanced event selector resource types are not valid in basic event selectors.
|
|
2097
|
-
*
|
|
2497
|
+
* <p>The following resource types are also available through <i>advanced</i>
|
|
2498
|
+
* event selectors. Basic event selector resource types are valid in advanced event selectors,
|
|
2499
|
+
* but advanced event selector resource types are not valid in basic event selectors. For more
|
|
2500
|
+
* information, see <a>AdvancedFieldSelector$Field</a>.</p>
|
|
2098
2501
|
* <ul>
|
|
2099
2502
|
* <li>
|
|
2100
2503
|
* <p>
|
|
2504
|
+
* <code>AWS::CloudTrail::Channel</code>
|
|
2505
|
+
* </p>
|
|
2506
|
+
* </li>
|
|
2507
|
+
* <li>
|
|
2508
|
+
* <p>
|
|
2101
2509
|
* <code>AWS::S3Outposts::Object</code>
|
|
2102
2510
|
* </p>
|
|
2103
2511
|
* </li>
|
|
@@ -2131,50 +2539,69 @@ export interface DataResource {
|
|
|
2131
2539
|
* <code>AWS::Glue::Table</code>
|
|
2132
2540
|
* </p>
|
|
2133
2541
|
* </li>
|
|
2542
|
+
* <li>
|
|
2543
|
+
* <p>
|
|
2544
|
+
* <code>AWS::FinSpace::Environment</code>
|
|
2545
|
+
* </p>
|
|
2546
|
+
* </li>
|
|
2547
|
+
* <li>
|
|
2548
|
+
* <p>
|
|
2549
|
+
* <code>AWS::SageMaker::ExperimentTrialComponent</code>
|
|
2550
|
+
* </p>
|
|
2551
|
+
* </li>
|
|
2552
|
+
* <li>
|
|
2553
|
+
* <p>
|
|
2554
|
+
* <code>AWS::SageMaker::FeatureGroup</code>
|
|
2555
|
+
* </p>
|
|
2556
|
+
* </li>
|
|
2134
2557
|
* </ul>
|
|
2135
2558
|
*/
|
|
2136
2559
|
Type?: string;
|
|
2137
2560
|
/**
|
|
2138
|
-
* <p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified
|
|
2561
|
+
* <p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified
|
|
2562
|
+
* objects.</p>
|
|
2139
2563
|
* <ul>
|
|
2140
2564
|
* <li>
|
|
2141
|
-
* <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the
|
|
2142
|
-
* prefix as <code>arn:aws:s3</code>.</p>
|
|
2565
|
+
* <p>To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as <code>arn:aws:s3</code>.</p>
|
|
2143
2566
|
* <note>
|
|
2144
|
-
* <p>This also enables logging of data event activity performed by any user or role
|
|
2145
|
-
*
|
|
2567
|
+
* <p>This also enables logging of data event activity performed by any user or role
|
|
2568
|
+
* in your Amazon Web Services account, even if that activity is performed on a bucket
|
|
2569
|
+
* that belongs to another Amazon Web Services account.</p>
|
|
2146
2570
|
* </note>
|
|
2147
2571
|
* </li>
|
|
2148
2572
|
* <li>
|
|
2149
|
-
* <p>To log data events for all objects in an S3 bucket, specify the bucket and an
|
|
2150
|
-
*
|
|
2151
|
-
*
|
|
2573
|
+
* <p>To log data events for all objects in an S3 bucket, specify the bucket and an
|
|
2574
|
+
* empty object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data
|
|
2575
|
+
* events for all objects in this S3 bucket.</p>
|
|
2152
2576
|
* </li>
|
|
2153
2577
|
* <li>
|
|
2154
|
-
* <p>To log data events for specific objects, specify the S3 bucket and object prefix
|
|
2155
|
-
*
|
|
2156
|
-
*
|
|
2578
|
+
* <p>To log data events for specific objects, specify the S3 bucket and object prefix
|
|
2579
|
+
* such as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events
|
|
2580
|
+
* for objects in this S3 bucket that match the prefix.</p>
|
|
2157
2581
|
* </li>
|
|
2158
2582
|
* <li>
|
|
2159
|
-
* <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as
|
|
2160
|
-
* <code>arn:aws:lambda</code>.</p>
|
|
2583
|
+
* <p>To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as <code>arn:aws:lambda</code>.</p>
|
|
2161
2584
|
* <note>
|
|
2162
|
-
* <p>This also enables logging of <code>Invoke</code> activity performed by any user
|
|
2163
|
-
*
|
|
2585
|
+
* <p>This also enables logging of <code>Invoke</code> activity performed by any user
|
|
2586
|
+
* or role in your Amazon Web Services account, even if that activity is performed on
|
|
2587
|
+
* a function that belongs to another Amazon Web Services account. </p>
|
|
2164
2588
|
* </note>
|
|
2165
2589
|
* </li>
|
|
2166
2590
|
* <li>
|
|
2167
|
-
* <p>To log data events for a specific Lambda function, specify the
|
|
2591
|
+
* <p>To log data events for a specific Lambda function, specify the
|
|
2592
|
+
* function ARN.</p>
|
|
2168
2593
|
* <note>
|
|
2169
2594
|
* <p>Lambda function ARNs are exact. For example, if you specify a
|
|
2170
|
-
*
|
|
2171
|
-
*
|
|
2172
|
-
*
|
|
2595
|
+
* function ARN
|
|
2596
|
+
* <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>,
|
|
2597
|
+
* data events will only be logged for
|
|
2598
|
+
* <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld</i>.
|
|
2599
|
+
* They will not be logged for
|
|
2600
|
+
* <i>arn:aws:lambda:us-west-2:111111111111:function:helloworld2</i>.</p>
|
|
2173
2601
|
* </note>
|
|
2174
2602
|
* </li>
|
|
2175
2603
|
* <li>
|
|
2176
|
-
* <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix
|
|
2177
|
-
* as <code>arn:aws:dynamodb</code>.</p>
|
|
2604
|
+
* <p>To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as <code>arn:aws:dynamodb</code>.</p>
|
|
2178
2605
|
* </li>
|
|
2179
2606
|
* </ul>
|
|
2180
2607
|
*/
|
|
@@ -2186,49 +2613,52 @@ export declare enum ReadWriteType {
|
|
|
2186
2613
|
WriteOnly = "WriteOnly"
|
|
2187
2614
|
}
|
|
2188
2615
|
/**
|
|
2189
|
-
* <p>Use event selectors to further specify the management and data event settings for your
|
|
2190
|
-
* default, trails created without specific event selectors will be configured to
|
|
2191
|
-
* write management events, and no data events. When an event occurs in your
|
|
2192
|
-
* for all trails. For each trail, if
|
|
2193
|
-
*
|
|
2194
|
-
* doesn't log the event.</p>
|
|
2616
|
+
* <p>Use event selectors to further specify the management and data event settings for your
|
|
2617
|
+
* trail. By default, trails created without specific event selectors will be configured to
|
|
2618
|
+
* log all read and write management events, and no data events. When an event occurs in your
|
|
2619
|
+
* account, CloudTrail evaluates the event selector for all trails. For each trail, if
|
|
2620
|
+
* the event matches any event selector, the trail processes and logs the event. If the event
|
|
2621
|
+
* doesn't match any event selector, the trail doesn't log the event.</p>
|
|
2195
2622
|
* <p>You can configure up to five event selectors for a trail.</p>
|
|
2196
2623
|
* <p>You cannot apply both event selectors and advanced event selectors to a trail.</p>
|
|
2197
2624
|
*/
|
|
2198
2625
|
export interface EventSelector {
|
|
2199
2626
|
/**
|
|
2200
|
-
* <p>Specify if you want your trail to log read-only events, write-only events, or all. For
|
|
2201
|
-
* the EC2 <code>GetConsoleOutput</code> is a read-only API operation and
|
|
2627
|
+
* <p>Specify if you want your trail to log read-only events, write-only events, or all. For
|
|
2628
|
+
* example, the EC2 <code>GetConsoleOutput</code> is a read-only API operation and
|
|
2202
2629
|
* <code>RunInstances</code> is a write-only API operation.</p>
|
|
2203
2630
|
* <p> By default, the value is <code>All</code>.</p>
|
|
2204
2631
|
*/
|
|
2205
2632
|
ReadWriteType?: ReadWriteType | string;
|
|
2206
2633
|
/**
|
|
2207
|
-
* <p>Specify if you want your event selector to include management events for your
|
|
2208
|
-
*
|
|
2209
|
-
* For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Management Events</a> in the <i>CloudTrail User
|
|
2634
|
+
* <p>Specify if you want your event selector to include management events for your
|
|
2635
|
+
* trail.</p>
|
|
2636
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Management Events</a> in the <i>CloudTrail User
|
|
2637
|
+
* Guide</i>.</p>
|
|
2210
2638
|
* <p>By default, the value is <code>true</code>.</p>
|
|
2211
|
-
* <p>The first copy of management events is free. You are charged for additional copies of
|
|
2212
|
-
* events that you are logging on any subsequent trail in the same region. For more
|
|
2213
|
-
* CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a>.</p>
|
|
2639
|
+
* <p>The first copy of management events is free. You are charged for additional copies of
|
|
2640
|
+
* management events that you are logging on any subsequent trail in the same region. For more
|
|
2641
|
+
* information about CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a>.</p>
|
|
2214
2642
|
*/
|
|
2215
2643
|
IncludeManagementEvents?: boolean;
|
|
2216
2644
|
/**
|
|
2217
|
-
* <p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions,
|
|
2218
|
-
*
|
|
2219
|
-
*
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2222
|
-
*
|
|
2223
|
-
*
|
|
2224
|
-
* in the <i>CloudTrail User Guide</i>.</p>
|
|
2645
|
+
* <p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors.
|
|
2646
|
+
* You can specify up to 250 resources for an individual event selector, but the total number
|
|
2647
|
+
* of data resources cannot exceed 250 across all event selectors in a trail. This limit does
|
|
2648
|
+
* not apply if you configure resource logging for all data events.</p>
|
|
2649
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Data
|
|
2650
|
+
* Events</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Limits in CloudTrail</a> in the <i>CloudTrail User
|
|
2651
|
+
* Guide</i>.</p>
|
|
2225
2652
|
*/
|
|
2226
2653
|
DataResources?: DataResource[];
|
|
2227
2654
|
/**
|
|
2228
|
-
* <p>An optional list of service event sources from which you do not want management events
|
|
2655
|
+
* <p>An optional list of service event sources from which you do not want management events
|
|
2656
|
+
* to be logged on your trail. In this release, the list can be empty (disables the filter),
|
|
2229
2657
|
* or it can filter out Key Management Service or Amazon RDS Data API events by
|
|
2230
|
-
* containing <code>kms.amazonaws.com</code> or <code>rdsdata.amazonaws.com</code>. By
|
|
2231
|
-
*
|
|
2658
|
+
* containing <code>kms.amazonaws.com</code> or <code>rdsdata.amazonaws.com</code>. By
|
|
2659
|
+
* default, <code>ExcludeManagementEventSources</code> is empty, and KMS and
|
|
2660
|
+
* Amazon RDS Data API events are logged to your trail. You can exclude management
|
|
2661
|
+
* event sources only in regions that support the event source.</p>
|
|
2232
2662
|
*/
|
|
2233
2663
|
ExcludeManagementEventSources?: string[];
|
|
2234
2664
|
}
|
|
@@ -2242,76 +2672,54 @@ export interface GetEventSelectorsResponse {
|
|
|
2242
2672
|
*/
|
|
2243
2673
|
EventSelectors?: EventSelector[];
|
|
2244
2674
|
/**
|
|
2245
|
-
* <p>
|
|
2246
|
-
* The advanced event selectors that are configured for the trail.
|
|
2247
|
-
* </p>
|
|
2675
|
+
* <p> The advanced event selectors that are configured for the trail. </p>
|
|
2248
2676
|
*/
|
|
2249
2677
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
2250
2678
|
}
|
|
2251
2679
|
export interface GetImportRequest {
|
|
2252
2680
|
/**
|
|
2253
|
-
* <p>
|
|
2254
|
-
* The ID for the import.
|
|
2255
|
-
* </p>
|
|
2681
|
+
* <p> The ID for the import. </p>
|
|
2256
2682
|
*/
|
|
2257
2683
|
ImportId: string | undefined;
|
|
2258
2684
|
}
|
|
2259
2685
|
/**
|
|
2260
|
-
* <p>
|
|
2261
|
-
* The settings for the source S3 bucket.
|
|
2262
|
-
* </p>
|
|
2686
|
+
* <p> The settings for the source S3 bucket. </p>
|
|
2263
2687
|
*/
|
|
2264
2688
|
export interface S3ImportSource {
|
|
2265
2689
|
/**
|
|
2266
|
-
* <p>
|
|
2267
|
-
* The URI for the source S3 bucket.
|
|
2268
|
-
* </p>
|
|
2690
|
+
* <p> The URI for the source S3 bucket. </p>
|
|
2269
2691
|
*/
|
|
2270
2692
|
S3LocationUri: string | undefined;
|
|
2271
2693
|
/**
|
|
2272
|
-
* <p>
|
|
2273
|
-
* The region associated with the source S3 bucket.
|
|
2274
|
-
* </p>
|
|
2694
|
+
* <p> The region associated with the source S3 bucket. </p>
|
|
2275
2695
|
*/
|
|
2276
2696
|
S3BucketRegion: string | undefined;
|
|
2277
2697
|
/**
|
|
2278
|
-
* <p>
|
|
2279
|
-
* The IAM ARN role used to access the source S3 bucket.
|
|
2280
|
-
* </p>
|
|
2698
|
+
* <p> The IAM ARN role used to access the source S3 bucket. </p>
|
|
2281
2699
|
*/
|
|
2282
2700
|
S3BucketAccessRoleArn: string | undefined;
|
|
2283
2701
|
}
|
|
2284
2702
|
/**
|
|
2285
|
-
* <p>
|
|
2286
|
-
* The import source.
|
|
2287
|
-
* </p>
|
|
2703
|
+
* <p> The import source. </p>
|
|
2288
2704
|
*/
|
|
2289
2705
|
export interface ImportSource {
|
|
2290
2706
|
/**
|
|
2291
|
-
* <p>
|
|
2292
|
-
* The source S3 bucket.
|
|
2293
|
-
* </p>
|
|
2707
|
+
* <p> The source S3 bucket. </p>
|
|
2294
2708
|
*/
|
|
2295
2709
|
S3: S3ImportSource | undefined;
|
|
2296
2710
|
}
|
|
2297
2711
|
/**
|
|
2298
|
-
* <p>
|
|
2299
|
-
*
|
|
2300
|
-
*
|
|
2301
|
-
* CloudTrail updates statistics incrementally over the course of the import.
|
|
2302
|
-
* </p>
|
|
2712
|
+
* <p> Provides statistics for the specified <code>ImportID</code>. CloudTrail does not
|
|
2713
|
+
* update import statistics in real-time. Returned values for parameters such as
|
|
2714
|
+
* <code>EventsCompleted</code> may be lower than the actual value, because CloudTrail updates statistics incrementally over the course of the import. </p>
|
|
2303
2715
|
*/
|
|
2304
2716
|
export interface ImportStatistics {
|
|
2305
2717
|
/**
|
|
2306
|
-
* <p>
|
|
2307
|
-
* The number of S3 prefixes found for the import.
|
|
2308
|
-
* </p>
|
|
2718
|
+
* <p> The number of S3 prefixes found for the import. </p>
|
|
2309
2719
|
*/
|
|
2310
2720
|
PrefixesFound?: number;
|
|
2311
2721
|
/**
|
|
2312
|
-
* <p>
|
|
2313
|
-
* The number of S3 prefixes that completed import.
|
|
2314
|
-
* </p>
|
|
2722
|
+
* <p> The number of S3 prefixes that completed import. </p>
|
|
2315
2723
|
*/
|
|
2316
2724
|
PrefixesCompleted?: number;
|
|
2317
2725
|
/**
|
|
@@ -2319,15 +2727,11 @@ export interface ImportStatistics {
|
|
|
2319
2727
|
*/
|
|
2320
2728
|
FilesCompleted?: number;
|
|
2321
2729
|
/**
|
|
2322
|
-
* <p>
|
|
2323
|
-
* The number of trail events imported into the event data store.
|
|
2324
|
-
* </p>
|
|
2730
|
+
* <p> The number of trail events imported into the event data store. </p>
|
|
2325
2731
|
*/
|
|
2326
2732
|
EventsCompleted?: number;
|
|
2327
2733
|
/**
|
|
2328
|
-
* <p>
|
|
2329
|
-
* The number of failed entries.
|
|
2330
|
-
* </p>
|
|
2734
|
+
* <p> The number of failed entries. </p>
|
|
2331
2735
|
*/
|
|
2332
2736
|
FailedEntries?: number;
|
|
2333
2737
|
}
|
|
@@ -2340,68 +2744,51 @@ export declare enum ImportStatus {
|
|
|
2340
2744
|
}
|
|
2341
2745
|
export interface GetImportResponse {
|
|
2342
2746
|
/**
|
|
2343
|
-
* <p>
|
|
2344
|
-
* The ID of the import.
|
|
2345
|
-
* </p>
|
|
2747
|
+
* <p> The ID of the import. </p>
|
|
2346
2748
|
*/
|
|
2347
2749
|
ImportId?: string;
|
|
2348
2750
|
/**
|
|
2349
|
-
* <p>
|
|
2350
|
-
* The ARN of the destination event data store.
|
|
2351
|
-
* </p>
|
|
2751
|
+
* <p> The ARN of the destination event data store. </p>
|
|
2352
2752
|
*/
|
|
2353
2753
|
Destinations?: string[];
|
|
2354
2754
|
/**
|
|
2355
|
-
* <p>
|
|
2356
|
-
* The source S3 bucket.
|
|
2357
|
-
* </p>
|
|
2755
|
+
* <p> The source S3 bucket. </p>
|
|
2358
2756
|
*/
|
|
2359
2757
|
ImportSource?: ImportSource;
|
|
2360
2758
|
/**
|
|
2361
|
-
* <p>
|
|
2362
|
-
*
|
|
2363
|
-
* to only those events logged within a specified time period.
|
|
2759
|
+
* <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
|
|
2760
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
2364
2761
|
* </p>
|
|
2365
2762
|
*/
|
|
2366
2763
|
StartEventTime?: Date;
|
|
2367
2764
|
/**
|
|
2368
|
-
* <p>
|
|
2369
|
-
*
|
|
2370
|
-
* to only those events logged within a specified time period.
|
|
2765
|
+
* <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
|
|
2766
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
2371
2767
|
* </p>
|
|
2372
2768
|
*/
|
|
2373
2769
|
EndEventTime?: Date;
|
|
2374
2770
|
/**
|
|
2375
|
-
* <p>
|
|
2376
|
-
* The status of the import.
|
|
2377
|
-
* </p>
|
|
2771
|
+
* <p> The status of the import. </p>
|
|
2378
2772
|
*/
|
|
2379
2773
|
ImportStatus?: ImportStatus | string;
|
|
2380
2774
|
/**
|
|
2381
|
-
* <p>
|
|
2382
|
-
* The timestamp of the import's creation.
|
|
2383
|
-
* </p>
|
|
2775
|
+
* <p> The timestamp of the import's creation. </p>
|
|
2384
2776
|
*/
|
|
2385
2777
|
CreatedTimestamp?: Date;
|
|
2386
2778
|
/**
|
|
2387
|
-
* <p>
|
|
2388
|
-
* The timestamp of when the import was updated.
|
|
2389
|
-
* </p>
|
|
2779
|
+
* <p> The timestamp of when the import was updated. </p>
|
|
2390
2780
|
*/
|
|
2391
2781
|
UpdatedTimestamp?: Date;
|
|
2392
2782
|
/**
|
|
2393
|
-
* <p>
|
|
2394
|
-
*
|
|
2395
|
-
*
|
|
2396
|
-
*
|
|
2397
|
-
* </p>
|
|
2783
|
+
* <p> Provides statistics for the import. CloudTrail does not update import statistics
|
|
2784
|
+
* in real-time. Returned values for parameters such as <code>EventsCompleted</code> may be
|
|
2785
|
+
* lower than the actual value, because CloudTrail updates statistics incrementally
|
|
2786
|
+
* over the course of the import. </p>
|
|
2398
2787
|
*/
|
|
2399
2788
|
ImportStatistics?: ImportStatistics;
|
|
2400
2789
|
}
|
|
2401
2790
|
/**
|
|
2402
|
-
* <p>
|
|
2403
|
-
* The specified import was not found.
|
|
2404
|
-
* </p>
|
|
2791
|
+
* <p> The specified import was not found. </p>
|
|
2405
2792
|
*/
|
|
2406
2793
|
export declare class ImportNotFoundException extends __BaseException {
|
|
2407
2794
|
readonly name: "ImportNotFoundException";
|
|
@@ -2417,11 +2804,12 @@ export declare class ImportNotFoundException extends __BaseException {
|
|
|
2417
2804
|
}
|
|
2418
2805
|
export interface GetInsightSelectorsRequest {
|
|
2419
2806
|
/**
|
|
2420
|
-
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
|
|
2421
|
-
*
|
|
2807
|
+
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
|
|
2808
|
+
* must meet the following requirements:</p>
|
|
2422
2809
|
* <ul>
|
|
2423
2810
|
* <li>
|
|
2424
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
2811
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
2812
|
+
* (_), or dashes (-)</p>
|
|
2425
2813
|
* </li>
|
|
2426
2814
|
* <li>
|
|
2427
2815
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -2430,8 +2818,8 @@ export interface GetInsightSelectorsRequest {
|
|
|
2430
2818
|
* <p>Be between 3 and 128 characters</p>
|
|
2431
2819
|
* </li>
|
|
2432
2820
|
* <li>
|
|
2433
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
2434
|
-
*
|
|
2821
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
2822
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
2435
2823
|
* </li>
|
|
2436
2824
|
* <li>
|
|
2437
2825
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -2453,23 +2841,28 @@ export declare enum InsightType {
|
|
|
2453
2841
|
*/
|
|
2454
2842
|
export interface InsightSelector {
|
|
2455
2843
|
/**
|
|
2456
|
-
* <p>The type of insights to log on a trail. <code>ApiCallRateInsight</code> and
|
|
2844
|
+
* <p>The type of insights to log on a trail. <code>ApiCallRateInsight</code> and
|
|
2845
|
+
* <code>ApiErrorRateInsight</code> are valid insight types.</p>
|
|
2457
2846
|
*/
|
|
2458
2847
|
InsightType?: InsightType | string;
|
|
2459
2848
|
}
|
|
2460
2849
|
export interface GetInsightSelectorsResponse {
|
|
2461
2850
|
/**
|
|
2462
|
-
* <p>The Amazon Resource Name (ARN) of a trail for which you want to get Insights
|
|
2851
|
+
* <p>The Amazon Resource Name (ARN) of a trail for which you want to get Insights
|
|
2852
|
+
* selectors.</p>
|
|
2463
2853
|
*/
|
|
2464
2854
|
TrailARN?: string;
|
|
2465
2855
|
/**
|
|
2466
|
-
* <p>A JSON string that contains the insight types you want to log on a trail. In this
|
|
2467
|
-
* <code>ApiCallRateInsight</code> are supported
|
|
2856
|
+
* <p>A JSON string that contains the insight types you want to log on a trail. In this
|
|
2857
|
+
* release, <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code> are supported
|
|
2858
|
+
* as insight types.</p>
|
|
2468
2859
|
*/
|
|
2469
2860
|
InsightSelectors?: InsightSelector[];
|
|
2470
2861
|
}
|
|
2471
2862
|
/**
|
|
2472
|
-
* <p>If you run <code>GetInsightSelectors</code> on a trail that does not have Insights
|
|
2863
|
+
* <p>If you run <code>GetInsightSelectors</code> on a trail that does not have Insights
|
|
2864
|
+
* events enabled, the operation throws the exception
|
|
2865
|
+
* <code>InsightNotEnabledException</code>.</p>
|
|
2473
2866
|
*/
|
|
2474
2867
|
export declare class InsightNotEnabledException extends __BaseException {
|
|
2475
2868
|
readonly name: "InsightNotEnabledException";
|
|
@@ -2487,7 +2880,8 @@ export interface GetQueryResultsRequest {
|
|
|
2487
2880
|
/**
|
|
2488
2881
|
* @deprecated
|
|
2489
2882
|
*
|
|
2490
|
-
* <p>The ARN (or ID suffix of the ARN) of the event data store against which the query was
|
|
2883
|
+
* <p>The ARN (or ID suffix of the ARN) of the event data store against which the query was
|
|
2884
|
+
* run.</p>
|
|
2491
2885
|
*/
|
|
2492
2886
|
EventDataStore?: string;
|
|
2493
2887
|
/**
|
|
@@ -2516,15 +2910,17 @@ export interface QueryStatistics {
|
|
|
2516
2910
|
*/
|
|
2517
2911
|
TotalResultsCount?: number;
|
|
2518
2912
|
/**
|
|
2519
|
-
* <p>The total bytes that the query scanned in the event data store. This value matches the
|
|
2520
|
-
* bytes for which your account is billed for the query, unless the query is still
|
|
2913
|
+
* <p>The total bytes that the query scanned in the event data store. This value matches the
|
|
2914
|
+
* number of bytes for which your account is billed for the query, unless the query is still
|
|
2915
|
+
* running.</p>
|
|
2521
2916
|
*/
|
|
2522
2917
|
BytesScanned?: number;
|
|
2523
2918
|
}
|
|
2524
2919
|
export interface GetQueryResultsResponse {
|
|
2525
2920
|
/**
|
|
2526
|
-
* <p>The status of the query. Values include <code>QUEUED</code>, <code>RUNNING</code>,
|
|
2527
|
-
*
|
|
2921
|
+
* <p>The status of the query. Values include <code>QUEUED</code>, <code>RUNNING</code>,
|
|
2922
|
+
* <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
|
|
2923
|
+
* <code>CANCELLED</code>.</p>
|
|
2528
2924
|
*/
|
|
2529
2925
|
QueryStatus?: QueryStatus | string;
|
|
2530
2926
|
/**
|
|
@@ -2560,7 +2956,8 @@ export declare class InvalidMaxResultsException extends __BaseException {
|
|
|
2560
2956
|
constructor(opts: __ExceptionOptionType<InvalidMaxResultsException, __BaseException>);
|
|
2561
2957
|
}
|
|
2562
2958
|
/**
|
|
2563
|
-
* <p>A token that is not valid, or a token that was previously used in a request with
|
|
2959
|
+
* <p>A token that is not valid, or a token that was previously used in a request with
|
|
2960
|
+
* different parameters. This exception is thrown if the token is not valid.</p>
|
|
2564
2961
|
*/
|
|
2565
2962
|
export declare class InvalidNextTokenException extends __BaseException {
|
|
2566
2963
|
readonly name: "InvalidNextTokenException";
|
|
@@ -2574,9 +2971,34 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
2574
2971
|
*/
|
|
2575
2972
|
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
2576
2973
|
}
|
|
2974
|
+
export interface GetResourcePolicyRequest {
|
|
2975
|
+
/**
|
|
2976
|
+
* <p>
|
|
2977
|
+
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
|
|
2978
|
+
* The following is the format of a resource ARN:
|
|
2979
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
2980
|
+
* </p>
|
|
2981
|
+
*/
|
|
2982
|
+
ResourceArn: string | undefined;
|
|
2983
|
+
}
|
|
2984
|
+
export interface GetResourcePolicyResponse {
|
|
2985
|
+
/**
|
|
2986
|
+
* <p>
|
|
2987
|
+
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to resource-based policy.
|
|
2988
|
+
* </p>
|
|
2989
|
+
*/
|
|
2990
|
+
ResourceArn?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* <p>
|
|
2993
|
+
* A JSON-formatted string that contains the resource-based policy attached to the CloudTrail channel.
|
|
2994
|
+
* </p>
|
|
2995
|
+
*/
|
|
2996
|
+
ResourcePolicy?: string;
|
|
2997
|
+
}
|
|
2577
2998
|
export interface GetTrailRequest {
|
|
2578
2999
|
/**
|
|
2579
|
-
* <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve
|
|
3000
|
+
* <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve
|
|
3001
|
+
* settings information.</p>
|
|
2580
3002
|
*/
|
|
2581
3003
|
Name: string | undefined;
|
|
2582
3004
|
}
|
|
@@ -2591,8 +3013,10 @@ export interface GetTrailResponse {
|
|
|
2591
3013
|
*/
|
|
2592
3014
|
export interface GetTrailStatusRequest {
|
|
2593
3015
|
/**
|
|
2594
|
-
* <p>Specifies the name or the CloudTrail ARN of the trail for which you are
|
|
2595
|
-
*
|
|
3016
|
+
* <p>Specifies the name or the CloudTrail ARN of the trail for which you are
|
|
3017
|
+
* requesting status. To get the status of a shadow trail (a replication of the trail in
|
|
3018
|
+
* another region), you must specify its ARN. The following is the format of a trail
|
|
3019
|
+
* ARN.</p>
|
|
2596
3020
|
* <p>
|
|
2597
3021
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
2598
3022
|
* </p>
|
|
@@ -2600,49 +3024,58 @@ export interface GetTrailStatusRequest {
|
|
|
2600
3024
|
Name: string | undefined;
|
|
2601
3025
|
}
|
|
2602
3026
|
/**
|
|
2603
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3027
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3028
|
+
* error.</p>
|
|
2604
3029
|
*/
|
|
2605
3030
|
export interface GetTrailStatusResponse {
|
|
2606
3031
|
/**
|
|
2607
|
-
* <p>Whether the CloudTrail trail is currently logging Amazon Web Services API
|
|
3032
|
+
* <p>Whether the CloudTrail trail is currently logging Amazon Web Services API
|
|
3033
|
+
* calls.</p>
|
|
2608
3034
|
*/
|
|
2609
3035
|
IsLogging?: boolean;
|
|
2610
3036
|
/**
|
|
2611
|
-
* <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
|
|
2612
|
-
* to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
|
|
3037
|
+
* <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
|
|
3038
|
+
* to deliver log files to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
|
|
2613
3039
|
* Responses</a> in the Amazon S3 API Reference. </p>
|
|
2614
3040
|
* <note>
|
|
2615
|
-
* <p>This error occurs only when there is a problem with the destination S3 bucket, and
|
|
2616
|
-
*
|
|
2617
|
-
* <code>UpdateTrail</code> to specify the new bucket; or fix the existing
|
|
2618
|
-
*
|
|
3041
|
+
* <p>This error occurs only when there is a problem with the destination S3 bucket, and
|
|
3042
|
+
* does not occur for requests that time out. To resolve the issue, create a new bucket,
|
|
3043
|
+
* and then call <code>UpdateTrail</code> to specify the new bucket; or fix the existing
|
|
3044
|
+
* objects so that CloudTrail can again write to the bucket.</p>
|
|
2619
3045
|
* </note>
|
|
2620
3046
|
*/
|
|
2621
3047
|
LatestDeliveryError?: string;
|
|
2622
3048
|
/**
|
|
2623
|
-
* <p>Displays any Amazon SNS error that CloudTrail encountered when attempting
|
|
2624
|
-
* notification. For more information about Amazon SNS errors, see the
|
|
2625
|
-
*
|
|
3049
|
+
* <p>Displays any Amazon SNS error that CloudTrail encountered when attempting
|
|
3050
|
+
* to send a notification. For more information about Amazon SNS errors, see the
|
|
3051
|
+
* <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon SNS
|
|
3052
|
+
* Developer Guide</a>. </p>
|
|
2626
3053
|
*/
|
|
2627
3054
|
LatestNotificationError?: string;
|
|
2628
3055
|
/**
|
|
2629
|
-
* <p>Specifies the date and time that CloudTrail last delivered log files to an
|
|
3056
|
+
* <p>Specifies the date and time that CloudTrail last delivered log files to an
|
|
3057
|
+
* account's Amazon S3 bucket.</p>
|
|
2630
3058
|
*/
|
|
2631
3059
|
LatestDeliveryTime?: Date;
|
|
2632
3060
|
/**
|
|
2633
|
-
* <p>Specifies the date and time of the most recent Amazon SNS notification that
|
|
3061
|
+
* <p>Specifies the date and time of the most recent Amazon SNS notification that
|
|
3062
|
+
* CloudTrail has written a new log file to an account's Amazon S3
|
|
3063
|
+
* bucket.</p>
|
|
2634
3064
|
*/
|
|
2635
3065
|
LatestNotificationTime?: Date;
|
|
2636
3066
|
/**
|
|
2637
|
-
* <p>Specifies the most recent date and time when CloudTrail started recording API
|
|
3067
|
+
* <p>Specifies the most recent date and time when CloudTrail started recording API
|
|
3068
|
+
* calls for an Amazon Web Services account.</p>
|
|
2638
3069
|
*/
|
|
2639
3070
|
StartLoggingTime?: Date;
|
|
2640
3071
|
/**
|
|
2641
|
-
* <p>Specifies the most recent date and time when CloudTrail stopped recording API
|
|
3072
|
+
* <p>Specifies the most recent date and time when CloudTrail stopped recording API
|
|
3073
|
+
* calls for an Amazon Web Services account.</p>
|
|
2642
3074
|
*/
|
|
2643
3075
|
StopLoggingTime?: Date;
|
|
2644
3076
|
/**
|
|
2645
|
-
* <p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting
|
|
3077
|
+
* <p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting
|
|
3078
|
+
* to deliver logs to CloudWatch Logs.</p>
|
|
2646
3079
|
*/
|
|
2647
3080
|
LatestCloudWatchLogsDeliveryError?: string;
|
|
2648
3081
|
/**
|
|
@@ -2650,18 +3083,19 @@ export interface GetTrailStatusResponse {
|
|
|
2650
3083
|
*/
|
|
2651
3084
|
LatestCloudWatchLogsDeliveryTime?: Date;
|
|
2652
3085
|
/**
|
|
2653
|
-
* <p>Specifies the date and time that CloudTrail last delivered a digest file to an
|
|
3086
|
+
* <p>Specifies the date and time that CloudTrail last delivered a digest file to an
|
|
3087
|
+
* account's Amazon S3 bucket.</p>
|
|
2654
3088
|
*/
|
|
2655
3089
|
LatestDigestDeliveryTime?: Date;
|
|
2656
3090
|
/**
|
|
2657
|
-
* <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
|
|
2658
|
-
* file to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
|
|
3091
|
+
* <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
|
|
3092
|
+
* to deliver a digest file to the designated bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error
|
|
2659
3093
|
* Responses</a> in the Amazon S3 API Reference. </p>
|
|
2660
3094
|
* <note>
|
|
2661
|
-
* <p>This error occurs only when there is a problem with the destination S3 bucket, and
|
|
2662
|
-
*
|
|
2663
|
-
* <code>UpdateTrail</code> to specify the new bucket; or fix the existing
|
|
2664
|
-
* CloudTrail can again write to the bucket.</p>
|
|
3095
|
+
* <p>This error occurs only when there is a problem with the destination S3 bucket, and
|
|
3096
|
+
* does not occur for requests that time out. To resolve the issue, create a new bucket,
|
|
3097
|
+
* and then call <code>UpdateTrail</code> to specify the new bucket; or fix the existing
|
|
3098
|
+
* objects so that CloudTrail can again write to the bucket.</p>
|
|
2665
3099
|
* </note>
|
|
2666
3100
|
*/
|
|
2667
3101
|
LatestDigestDeliveryError?: string;
|
|
@@ -2692,24 +3126,20 @@ export interface GetTrailStatusResponse {
|
|
|
2692
3126
|
}
|
|
2693
3127
|
export interface ListChannelsRequest {
|
|
2694
3128
|
/**
|
|
2695
|
-
* <p>
|
|
2696
|
-
* The maximum number of CloudTrail channels to display on a single page.
|
|
2697
|
-
* </p>
|
|
3129
|
+
* <p> The maximum number of CloudTrail channels to display on a single page. </p>
|
|
2698
3130
|
*/
|
|
2699
3131
|
MaxResults?: number;
|
|
2700
3132
|
/**
|
|
2701
|
-
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
2702
|
-
* passed in with the same parameters that were specified in the original call.
|
|
2703
|
-
*
|
|
2704
|
-
* the call with NextToken should include those same parameters.</p>
|
|
3133
|
+
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
3134
|
+
* must be passed in with the same parameters that were specified in the original call. For
|
|
3135
|
+
* example, if the original call specified an AttributeKey of 'Username' with a value of
|
|
3136
|
+
* 'root', the call with NextToken should include those same parameters.</p>
|
|
2705
3137
|
*/
|
|
2706
3138
|
NextToken?: string;
|
|
2707
3139
|
}
|
|
2708
3140
|
export interface ListChannelsResponse {
|
|
2709
3141
|
/**
|
|
2710
|
-
* <p>
|
|
2711
|
-
* The list of channels in the account.
|
|
2712
|
-
* </p>
|
|
3142
|
+
* <p> The list of channels in the account. </p>
|
|
2713
3143
|
*/
|
|
2714
3144
|
Channels?: Channel[];
|
|
2715
3145
|
/**
|
|
@@ -2728,10 +3158,10 @@ export interface ListEventDataStoresRequest {
|
|
|
2728
3158
|
MaxResults?: number;
|
|
2729
3159
|
}
|
|
2730
3160
|
/**
|
|
2731
|
-
* <p>A storage lake of event data against which you can run complex SQL-based queries. An
|
|
2732
|
-
* that you have logged on your account from the last 90
|
|
2733
|
-
* (about three months to up to seven years). To select events for an event data
|
|
2734
|
-
* use <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced">advanced event selectors</a>.</p>
|
|
3161
|
+
* <p>A storage lake of event data against which you can run complex SQL-based queries. An
|
|
3162
|
+
* event data store can include events that you have logged on your account from the last 90
|
|
3163
|
+
* to 2557 days (about three months to up to seven years). To select events for an event data
|
|
3164
|
+
* store, use <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced">advanced event selectors</a>.</p>
|
|
2735
3165
|
*/
|
|
2736
3166
|
export interface EventDataStore {
|
|
2737
3167
|
/**
|
|
@@ -2745,55 +3175,63 @@ export interface EventDataStore {
|
|
|
2745
3175
|
/**
|
|
2746
3176
|
* @deprecated
|
|
2747
3177
|
*
|
|
2748
|
-
* <p>
|
|
3178
|
+
* <p>Indicates whether the event data store is protected from
|
|
3179
|
+
* termination.</p>
|
|
2749
3180
|
*/
|
|
2750
3181
|
TerminationProtectionEnabled?: boolean;
|
|
2751
3182
|
/**
|
|
2752
3183
|
* @deprecated
|
|
2753
3184
|
*
|
|
2754
|
-
* <p>
|
|
3185
|
+
* <p>The status of an event data store. Values are
|
|
3186
|
+
* <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>
|
|
2755
3187
|
*/
|
|
2756
3188
|
Status?: EventDataStoreStatus | string;
|
|
2757
3189
|
/**
|
|
2758
3190
|
* @deprecated
|
|
2759
3191
|
*
|
|
2760
|
-
* <p>
|
|
3192
|
+
* <p>The advanced event selectors that were used to select
|
|
3193
|
+
* events for the data store.</p>
|
|
2761
3194
|
*/
|
|
2762
3195
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
2763
3196
|
/**
|
|
2764
3197
|
* @deprecated
|
|
2765
3198
|
*
|
|
2766
|
-
* <p>
|
|
3199
|
+
* <p>Indicates whether the event data store includes events
|
|
3200
|
+
* from all regions, or only from the region in which it was created.</p>
|
|
2767
3201
|
*/
|
|
2768
3202
|
MultiRegionEnabled?: boolean;
|
|
2769
3203
|
/**
|
|
2770
3204
|
* @deprecated
|
|
2771
3205
|
*
|
|
2772
|
-
* <p>
|
|
3206
|
+
* <p>Indicates that an event data store is collecting logged
|
|
3207
|
+
* events for an organization.</p>
|
|
2773
3208
|
*/
|
|
2774
3209
|
OrganizationEnabled?: boolean;
|
|
2775
3210
|
/**
|
|
2776
3211
|
* @deprecated
|
|
2777
3212
|
*
|
|
2778
|
-
* <p>
|
|
3213
|
+
* <p>The retention period, in days.</p>
|
|
2779
3214
|
*/
|
|
2780
3215
|
RetentionPeriod?: number;
|
|
2781
3216
|
/**
|
|
2782
3217
|
* @deprecated
|
|
2783
3218
|
*
|
|
2784
|
-
* <p>
|
|
3219
|
+
* <p>The timestamp of the event data store's creation.</p>
|
|
2785
3220
|
*/
|
|
2786
3221
|
CreatedTimestamp?: Date;
|
|
2787
3222
|
/**
|
|
2788
3223
|
* @deprecated
|
|
2789
3224
|
*
|
|
2790
|
-
* <p>
|
|
3225
|
+
* <p>The timestamp showing when an event data store was
|
|
3226
|
+
* updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer
|
|
3227
|
+
* than the time shown in <code>CreatedTimestamp</code>.</p>
|
|
2791
3228
|
*/
|
|
2792
3229
|
UpdatedTimestamp?: Date;
|
|
2793
3230
|
}
|
|
2794
3231
|
export interface ListEventDataStoresResponse {
|
|
2795
3232
|
/**
|
|
2796
|
-
* <p>Contains information about event data stores in the account, in the current
|
|
3233
|
+
* <p>Contains information about event data stores in the account, in the current
|
|
3234
|
+
* region.</p>
|
|
2797
3235
|
*/
|
|
2798
3236
|
EventDataStores?: EventDataStore[];
|
|
2799
3237
|
/**
|
|
@@ -2803,21 +3241,15 @@ export interface ListEventDataStoresResponse {
|
|
|
2803
3241
|
}
|
|
2804
3242
|
export interface ListImportFailuresRequest {
|
|
2805
3243
|
/**
|
|
2806
|
-
* <p>
|
|
2807
|
-
* The ID of the import.
|
|
2808
|
-
* </p>
|
|
3244
|
+
* <p> The ID of the import. </p>
|
|
2809
3245
|
*/
|
|
2810
3246
|
ImportId: string | undefined;
|
|
2811
3247
|
/**
|
|
2812
|
-
* <p>
|
|
2813
|
-
* The maximum number of failures to display on a single page.
|
|
2814
|
-
* </p>
|
|
3248
|
+
* <p> The maximum number of failures to display on a single page. </p>
|
|
2815
3249
|
*/
|
|
2816
3250
|
MaxResults?: number;
|
|
2817
3251
|
/**
|
|
2818
|
-
* <p>
|
|
2819
|
-
* A token you can use to get the next page of import failures.
|
|
2820
|
-
* </p>
|
|
3252
|
+
* <p> A token you can use to get the next page of import failures. </p>
|
|
2821
3253
|
*/
|
|
2822
3254
|
NextToken?: string;
|
|
2823
3255
|
}
|
|
@@ -2827,135 +3259,96 @@ export declare enum ImportFailureStatus {
|
|
|
2827
3259
|
SUCCEEDED = "SUCCEEDED"
|
|
2828
3260
|
}
|
|
2829
3261
|
/**
|
|
2830
|
-
* <p>
|
|
2831
|
-
* Provides information about an import failure.
|
|
2832
|
-
* </p>
|
|
3262
|
+
* <p> Provides information about an import failure. </p>
|
|
2833
3263
|
*/
|
|
2834
3264
|
export interface ImportFailureListItem {
|
|
2835
3265
|
/**
|
|
2836
|
-
* <p>
|
|
2837
|
-
* The location of the failure in the S3 bucket.
|
|
2838
|
-
* </p>
|
|
3266
|
+
* <p> The location of the failure in the S3 bucket. </p>
|
|
2839
3267
|
*/
|
|
2840
3268
|
Location?: string;
|
|
2841
3269
|
/**
|
|
2842
|
-
* <p>
|
|
2843
|
-
* The status of the import.
|
|
2844
|
-
* </p>
|
|
3270
|
+
* <p> The status of the import. </p>
|
|
2845
3271
|
*/
|
|
2846
3272
|
Status?: ImportFailureStatus | string;
|
|
2847
3273
|
/**
|
|
2848
|
-
* <p>
|
|
2849
|
-
* The type of import error.
|
|
2850
|
-
* </p>
|
|
3274
|
+
* <p> The type of import error. </p>
|
|
2851
3275
|
*/
|
|
2852
3276
|
ErrorType?: string;
|
|
2853
3277
|
/**
|
|
2854
|
-
* <p>
|
|
2855
|
-
* Provides the reason the import failed.
|
|
2856
|
-
* </p>
|
|
3278
|
+
* <p> Provides the reason the import failed. </p>
|
|
2857
3279
|
*/
|
|
2858
3280
|
ErrorMessage?: string;
|
|
2859
3281
|
/**
|
|
2860
|
-
* <p>
|
|
2861
|
-
* When the import was last updated.
|
|
2862
|
-
* </p>
|
|
3282
|
+
* <p> When the import was last updated. </p>
|
|
2863
3283
|
*/
|
|
2864
3284
|
LastUpdatedTime?: Date;
|
|
2865
3285
|
}
|
|
2866
3286
|
export interface ListImportFailuresResponse {
|
|
2867
3287
|
/**
|
|
2868
|
-
* <p>
|
|
2869
|
-
* Contains information about the import failures.
|
|
2870
|
-
* </p>
|
|
3288
|
+
* <p> Contains information about the import failures. </p>
|
|
2871
3289
|
*/
|
|
2872
3290
|
Failures?: ImportFailureListItem[];
|
|
2873
3291
|
/**
|
|
2874
|
-
* <p>
|
|
2875
|
-
* A token you can use to get the next page of results.
|
|
2876
|
-
* </p>
|
|
3292
|
+
* <p> A token you can use to get the next page of results. </p>
|
|
2877
3293
|
*/
|
|
2878
3294
|
NextToken?: string;
|
|
2879
3295
|
}
|
|
2880
3296
|
export interface ListImportsRequest {
|
|
2881
3297
|
/**
|
|
2882
|
-
* <p>
|
|
2883
|
-
* The maximum number of imports to display on a single page.
|
|
2884
|
-
* </p>
|
|
3298
|
+
* <p> The maximum number of imports to display on a single page. </p>
|
|
2885
3299
|
*/
|
|
2886
3300
|
MaxResults?: number;
|
|
2887
3301
|
/**
|
|
2888
|
-
* <p>
|
|
2889
|
-
* The ARN of the destination event data store.
|
|
2890
|
-
* </p>
|
|
3302
|
+
* <p> The ARN of the destination event data store. </p>
|
|
2891
3303
|
*/
|
|
2892
3304
|
Destination?: string;
|
|
2893
3305
|
/**
|
|
2894
|
-
* <p>
|
|
2895
|
-
* The status of the import.
|
|
2896
|
-
* </p>
|
|
3306
|
+
* <p> The status of the import. </p>
|
|
2897
3307
|
*/
|
|
2898
3308
|
ImportStatus?: ImportStatus | string;
|
|
2899
3309
|
/**
|
|
2900
|
-
* <p>
|
|
2901
|
-
* A token you can use to get the next page of import results.
|
|
2902
|
-
* </p>
|
|
3310
|
+
* <p> A token you can use to get the next page of import results. </p>
|
|
2903
3311
|
*/
|
|
2904
3312
|
NextToken?: string;
|
|
2905
3313
|
}
|
|
2906
3314
|
/**
|
|
2907
|
-
* <p>
|
|
2908
|
-
* Contains information about an import that was returned by a lookup request.
|
|
2909
|
-
* </p>
|
|
3315
|
+
* <p> Contains information about an import that was returned by a lookup request. </p>
|
|
2910
3316
|
*/
|
|
2911
3317
|
export interface ImportsListItem {
|
|
2912
3318
|
/**
|
|
2913
|
-
* <p>
|
|
2914
|
-
* The ID of the import.
|
|
2915
|
-
* </p>
|
|
3319
|
+
* <p> The ID of the import. </p>
|
|
2916
3320
|
*/
|
|
2917
3321
|
ImportId?: string;
|
|
2918
3322
|
/**
|
|
2919
|
-
* <p>
|
|
2920
|
-
* The status of the import.
|
|
2921
|
-
* </p>
|
|
3323
|
+
* <p> The status of the import. </p>
|
|
2922
3324
|
*/
|
|
2923
3325
|
ImportStatus?: ImportStatus | string;
|
|
2924
3326
|
/**
|
|
2925
|
-
* <p>
|
|
2926
|
-
* The ARN of the destination event data store.
|
|
2927
|
-
* </p>
|
|
3327
|
+
* <p> The ARN of the destination event data store. </p>
|
|
2928
3328
|
*/
|
|
2929
3329
|
Destinations?: string[];
|
|
2930
3330
|
/**
|
|
2931
|
-
* <p>
|
|
2932
|
-
* The timestamp of the import's creation.
|
|
2933
|
-
* </p>
|
|
3331
|
+
* <p> The timestamp of the import's creation. </p>
|
|
2934
3332
|
*/
|
|
2935
3333
|
CreatedTimestamp?: Date;
|
|
2936
3334
|
/**
|
|
2937
|
-
* <p>
|
|
2938
|
-
* The timestamp of the import's last update.
|
|
2939
|
-
* </p>
|
|
3335
|
+
* <p> The timestamp of the import's last update. </p>
|
|
2940
3336
|
*/
|
|
2941
3337
|
UpdatedTimestamp?: Date;
|
|
2942
3338
|
}
|
|
2943
3339
|
export interface ListImportsResponse {
|
|
2944
3340
|
/**
|
|
2945
|
-
* <p>
|
|
2946
|
-
* The list of returned imports.
|
|
2947
|
-
* </p>
|
|
3341
|
+
* <p> The list of returned imports. </p>
|
|
2948
3342
|
*/
|
|
2949
3343
|
Imports?: ImportsListItem[];
|
|
2950
3344
|
/**
|
|
2951
|
-
* <p>
|
|
2952
|
-
* A token you can use to get the next page of import results.
|
|
2953
|
-
* </p>
|
|
3345
|
+
* <p> A token you can use to get the next page of import results. </p>
|
|
2954
3346
|
*/
|
|
2955
3347
|
NextToken?: string;
|
|
2956
3348
|
}
|
|
2957
3349
|
/**
|
|
2958
|
-
* <p>Occurs if the timestamp values are not valid. Either the start time occurs after the end
|
|
3350
|
+
* <p>Occurs if the timestamp values are not valid. Either the start time occurs after the end
|
|
3351
|
+
* time, or the time range is outside the range of possible values.</p>
|
|
2959
3352
|
*/
|
|
2960
3353
|
export declare class InvalidTimeRangeException extends __BaseException {
|
|
2961
3354
|
readonly name: "InvalidTimeRangeException";
|
|
@@ -2989,13 +3382,14 @@ export declare class InvalidTokenException extends __BaseException {
|
|
|
2989
3382
|
*/
|
|
2990
3383
|
export interface ListPublicKeysRequest {
|
|
2991
3384
|
/**
|
|
2992
|
-
* <p>Optionally specifies, in UTC, the start of the time range to look up public keys for
|
|
2993
|
-
*
|
|
3385
|
+
* <p>Optionally specifies, in UTC, the start of the time range to look up public keys for
|
|
3386
|
+
* CloudTrail digest files. If not specified, the current time is used, and the
|
|
3387
|
+
* current public key is returned.</p>
|
|
2994
3388
|
*/
|
|
2995
3389
|
StartTime?: Date;
|
|
2996
3390
|
/**
|
|
2997
|
-
* <p>Optionally specifies, in UTC, the end of the time range to look up public keys for
|
|
2998
|
-
*
|
|
3391
|
+
* <p>Optionally specifies, in UTC, the end of the time range to look up public keys for
|
|
3392
|
+
* CloudTrail digest files. If not specified, the current time is used.</p>
|
|
2999
3393
|
*/
|
|
3000
3394
|
EndTime?: Date;
|
|
3001
3395
|
/**
|
|
@@ -3025,7 +3419,8 @@ export interface PublicKey {
|
|
|
3025
3419
|
Fingerprint?: string;
|
|
3026
3420
|
}
|
|
3027
3421
|
/**
|
|
3028
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3422
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3423
|
+
* error.</p>
|
|
3029
3424
|
*/
|
|
3030
3425
|
export interface ListPublicKeysResponse {
|
|
3031
3426
|
/**
|
|
@@ -3041,10 +3436,9 @@ export interface ListPublicKeysResponse {
|
|
|
3041
3436
|
NextToken?: string;
|
|
3042
3437
|
}
|
|
3043
3438
|
/**
|
|
3044
|
-
* <p>A date range for the query was specified that is not valid. Be sure that the start time
|
|
3045
|
-
* before the end time. For more information
|
|
3046
|
-
*
|
|
3047
|
-
* or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>
|
|
3439
|
+
* <p>A date range for the query was specified that is not valid. Be sure that the start time
|
|
3440
|
+
* is chronologically before the end time. For more information about writing a query, see
|
|
3441
|
+
* <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html">Create or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>
|
|
3048
3442
|
*/
|
|
3049
3443
|
export declare class InvalidDateRangeException extends __BaseException {
|
|
3050
3444
|
readonly name: "InvalidDateRangeException";
|
|
@@ -3075,7 +3469,8 @@ export declare class InvalidQueryStatusException extends __BaseException {
|
|
|
3075
3469
|
}
|
|
3076
3470
|
export interface ListQueriesRequest {
|
|
3077
3471
|
/**
|
|
3078
|
-
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which queries were
|
|
3472
|
+
* <p>The ARN (or the ID suffix of the ARN) of an event data store on which queries were
|
|
3473
|
+
* run.</p>
|
|
3079
3474
|
*/
|
|
3080
3475
|
EventDataStore: string | undefined;
|
|
3081
3476
|
/**
|
|
@@ -3087,23 +3482,26 @@ export interface ListQueriesRequest {
|
|
|
3087
3482
|
*/
|
|
3088
3483
|
MaxResults?: number;
|
|
3089
3484
|
/**
|
|
3090
|
-
* <p>Use with <code>EndTime</code> to bound a <code>ListQueries</code> request, and limit its
|
|
3091
|
-
* within a specified time period.</p>
|
|
3485
|
+
* <p>Use with <code>EndTime</code> to bound a <code>ListQueries</code> request, and limit its
|
|
3486
|
+
* results to only those queries run within a specified time period.</p>
|
|
3092
3487
|
*/
|
|
3093
3488
|
StartTime?: Date;
|
|
3094
3489
|
/**
|
|
3095
|
-
* <p>Use with <code>StartTime</code> to bound a <code>ListQueries</code> request, and limit
|
|
3096
|
-
*
|
|
3490
|
+
* <p>Use with <code>StartTime</code> to bound a <code>ListQueries</code> request, and limit
|
|
3491
|
+
* its results to only those queries run within a specified time period.</p>
|
|
3097
3492
|
*/
|
|
3098
3493
|
EndTime?: Date;
|
|
3099
3494
|
/**
|
|
3100
|
-
* <p>The status of queries that you want to return in results. Valid values for
|
|
3101
|
-
*
|
|
3495
|
+
* <p>The status of queries that you want to return in results. Valid values for
|
|
3496
|
+
* <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>,
|
|
3497
|
+
* <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
|
|
3498
|
+
* <code>CANCELLED</code>.</p>
|
|
3102
3499
|
*/
|
|
3103
3500
|
QueryStatus?: QueryStatus | string;
|
|
3104
3501
|
}
|
|
3105
3502
|
/**
|
|
3106
|
-
* <p>A SQL string of criteria about events that you want to collect in an event data
|
|
3503
|
+
* <p>A SQL string of criteria about events that you want to collect in an event data
|
|
3504
|
+
* store.</p>
|
|
3107
3505
|
*/
|
|
3108
3506
|
export interface Query {
|
|
3109
3507
|
/**
|
|
@@ -3111,8 +3509,9 @@ export interface Query {
|
|
|
3111
3509
|
*/
|
|
3112
3510
|
QueryId?: string;
|
|
3113
3511
|
/**
|
|
3114
|
-
* <p>The status of the query. This can be <code>QUEUED</code>, <code>RUNNING</code>,
|
|
3115
|
-
*
|
|
3512
|
+
* <p>The status of the query. This can be <code>QUEUED</code>, <code>RUNNING</code>,
|
|
3513
|
+
* <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
|
|
3514
|
+
* <code>CANCELLED</code>.</p>
|
|
3116
3515
|
*/
|
|
3117
3516
|
QueryStatus?: QueryStatus | string;
|
|
3118
3517
|
/**
|
|
@@ -3122,7 +3521,8 @@ export interface Query {
|
|
|
3122
3521
|
}
|
|
3123
3522
|
export interface ListQueriesResponse {
|
|
3124
3523
|
/**
|
|
3125
|
-
* <p>Lists matching query results, and shows query ID, status, and creation time of each
|
|
3524
|
+
* <p>Lists matching query results, and shows query ID, status, and creation time of each
|
|
3525
|
+
* query.</p>
|
|
3126
3526
|
*/
|
|
3127
3527
|
Queries?: Query[];
|
|
3128
3528
|
/**
|
|
@@ -3135,7 +3535,7 @@ export interface ListQueriesResponse {
|
|
|
3135
3535
|
*/
|
|
3136
3536
|
export interface ListTagsRequest {
|
|
3137
3537
|
/**
|
|
3138
|
-
* <p>Specifies a list of trail
|
|
3538
|
+
* <p>Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list
|
|
3139
3539
|
* has a limit of 20 ARNs.</p>
|
|
3140
3540
|
*/
|
|
3141
3541
|
ResourceIdList: string[] | undefined;
|
|
@@ -3158,7 +3558,8 @@ export interface ResourceTag {
|
|
|
3158
3558
|
TagsList?: Tag[];
|
|
3159
3559
|
}
|
|
3160
3560
|
/**
|
|
3161
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3561
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
3562
|
+
* error.</p>
|
|
3162
3563
|
*/
|
|
3163
3564
|
export interface ListTagsResponse {
|
|
3164
3565
|
/**
|
|
@@ -3172,15 +3573,16 @@ export interface ListTagsResponse {
|
|
|
3172
3573
|
}
|
|
3173
3574
|
export interface ListTrailsRequest {
|
|
3174
3575
|
/**
|
|
3175
|
-
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
3176
|
-
* in with the same parameters that were specified in the original call. For
|
|
3177
|
-
* call specified an AttributeKey of 'Username' with a value of
|
|
3178
|
-
* include those same parameters.</p>
|
|
3576
|
+
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
3577
|
+
* must be passed in with the same parameters that were specified in the original call. For
|
|
3578
|
+
* example, if the original call specified an AttributeKey of 'Username' with a value of
|
|
3579
|
+
* 'root', the call with NextToken should include those same parameters.</p>
|
|
3179
3580
|
*/
|
|
3180
3581
|
NextToken?: string;
|
|
3181
3582
|
}
|
|
3182
3583
|
/**
|
|
3183
|
-
* <p>Information about a CloudTrail trail, including the trail's name, home region,
|
|
3584
|
+
* <p>Information about a CloudTrail trail, including the trail's name, home region,
|
|
3585
|
+
* and Amazon Resource Name (ARN).</p>
|
|
3184
3586
|
*/
|
|
3185
3587
|
export interface TrailInfo {
|
|
3186
3588
|
/**
|
|
@@ -3202,15 +3604,17 @@ export interface ListTrailsResponse {
|
|
|
3202
3604
|
*/
|
|
3203
3605
|
Trails?: TrailInfo[];
|
|
3204
3606
|
/**
|
|
3205
|
-
* <p>The token to use to get the next page of results after a previous API call. If the token
|
|
3206
|
-
* there are no more results to return. The token must be passed in with the
|
|
3207
|
-
* For example, if the original call specified an
|
|
3208
|
-
* NextToken should include
|
|
3607
|
+
* <p>The token to use to get the next page of results after a previous API call. If the token
|
|
3608
|
+
* does not appear, there are no more results to return. The token must be passed in with the
|
|
3609
|
+
* same parameters as the previous call. For example, if the original call specified an
|
|
3610
|
+
* AttributeKey of 'Username' with a value of 'root', the call with NextToken should include
|
|
3611
|
+
* those same parameters.</p>
|
|
3209
3612
|
*/
|
|
3210
3613
|
NextToken?: string;
|
|
3211
3614
|
}
|
|
3212
3615
|
/**
|
|
3213
|
-
* <p>Occurs if an event category that is not valid is specified as a value of
|
|
3616
|
+
* <p>Occurs if an event category that is not valid is specified as a value of
|
|
3617
|
+
* <code>EventCategory</code>.</p>
|
|
3214
3618
|
*/
|
|
3215
3619
|
export declare class InvalidEventCategoryException extends __BaseException {
|
|
3216
3620
|
readonly name: "InvalidEventCategoryException";
|
|
@@ -3270,29 +3674,37 @@ export interface LookupAttribute {
|
|
|
3270
3674
|
*/
|
|
3271
3675
|
export interface LookupEventsRequest {
|
|
3272
3676
|
/**
|
|
3273
|
-
* <p>Contains a list of lookup attributes. Currently the list can contain only one
|
|
3677
|
+
* <p>Contains a list of lookup attributes. Currently the list can contain only one
|
|
3678
|
+
* item.</p>
|
|
3274
3679
|
*/
|
|
3275
3680
|
LookupAttributes?: LookupAttribute[];
|
|
3276
3681
|
/**
|
|
3277
|
-
* <p>Specifies that only events that occur after or at the specified time are returned. If
|
|
3682
|
+
* <p>Specifies that only events that occur after or at the specified time are returned. If
|
|
3683
|
+
* the specified start time is after the specified end time, an error is returned.</p>
|
|
3278
3684
|
*/
|
|
3279
3685
|
StartTime?: Date;
|
|
3280
3686
|
/**
|
|
3281
|
-
* <p>Specifies that only events that occur before or at the specified time are returned. If
|
|
3687
|
+
* <p>Specifies that only events that occur before or at the specified time are returned. If
|
|
3688
|
+
* the specified end time is before the specified start time, an error is returned.</p>
|
|
3282
3689
|
*/
|
|
3283
3690
|
EndTime?: Date;
|
|
3284
3691
|
/**
|
|
3285
|
-
* <p>Specifies the event category. If you do not specify an event category, events of the
|
|
3286
|
-
*
|
|
3692
|
+
* <p>Specifies the event category. If you do not specify an event category, events of the
|
|
3693
|
+
* category are not returned in the response. For example, if you do not specify
|
|
3694
|
+
* <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are
|
|
3695
|
+
* returned.</p>
|
|
3287
3696
|
*/
|
|
3288
3697
|
EventCategory?: EventCategory | string;
|
|
3289
3698
|
/**
|
|
3290
|
-
* <p>The number of events to return. Possible values are 1 through 50. The default is
|
|
3699
|
+
* <p>The number of events to return. Possible values are 1 through 50. The default is
|
|
3700
|
+
* 50.</p>
|
|
3291
3701
|
*/
|
|
3292
3702
|
MaxResults?: number;
|
|
3293
3703
|
/**
|
|
3294
|
-
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
3295
|
-
*
|
|
3704
|
+
* <p>The token to use to get the next page of results after a previous API call. This token
|
|
3705
|
+
* must be passed in with the same parameters that were specified in the original call. For
|
|
3706
|
+
* example, if the original call specified an AttributeKey of 'Username' with a value of
|
|
3707
|
+
* 'root', the call with NextToken should include those same parameters.</p>
|
|
3296
3708
|
*/
|
|
3297
3709
|
NextToken?: string;
|
|
3298
3710
|
}
|
|
@@ -3301,19 +3713,22 @@ export interface LookupEventsRequest {
|
|
|
3301
3713
|
*/
|
|
3302
3714
|
export interface Resource {
|
|
3303
3715
|
/**
|
|
3304
|
-
* <p>The type of a resource referenced by the event returned. When the resource type cannot
|
|
3305
|
-
* determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2,
|
|
3306
|
-
*
|
|
3307
|
-
* 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>
|
|
3716
|
+
* <p>The type of a resource referenced by the event returned. When the resource type cannot
|
|
3717
|
+
* be determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2, <b>Trail</b> for CloudTrail, <b>DBInstance</b> for Amazon RDS, and <b>AccessKey</b> for IAM. To learn more about how to look up and filter
|
|
3718
|
+
* 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>
|
|
3308
3719
|
*/
|
|
3309
3720
|
ResourceType?: string;
|
|
3310
3721
|
/**
|
|
3311
|
-
* <p>The name of the resource referenced by the event returned. These are user-created names
|
|
3722
|
+
* <p>The name of the resource referenced by the event returned. These are user-created names
|
|
3723
|
+
* whose values will depend on the environment. For example, the resource name might be
|
|
3724
|
+
* "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2
|
|
3725
|
+
* Instance.</p>
|
|
3312
3726
|
*/
|
|
3313
3727
|
ResourceName?: string;
|
|
3314
3728
|
}
|
|
3315
3729
|
/**
|
|
3316
|
-
* <p>Contains information about an event that was returned by a lookup request. The result
|
|
3730
|
+
* <p>Contains information about an event that was returned by a lookup request. The result
|
|
3731
|
+
* includes a representation of a CloudTrail event.</p>
|
|
3317
3732
|
*/
|
|
3318
3733
|
export interface Event {
|
|
3319
3734
|
/**
|
|
@@ -3329,8 +3744,9 @@ export interface Event {
|
|
|
3329
3744
|
*/
|
|
3330
3745
|
ReadOnly?: string;
|
|
3331
3746
|
/**
|
|
3332
|
-
* <p>The Amazon Web Services access key ID that was used to sign the request. If the request
|
|
3333
|
-
* with temporary security credentials, this is the access key ID of the temporary
|
|
3747
|
+
* <p>The Amazon Web Services access key ID that was used to sign the request. If the request
|
|
3748
|
+
* was made with temporary security credentials, this is the access key ID of the temporary
|
|
3749
|
+
* credentials.</p>
|
|
3334
3750
|
*/
|
|
3335
3751
|
AccessKeyId?: string;
|
|
3336
3752
|
/**
|
|
@@ -3342,7 +3758,8 @@ export interface Event {
|
|
|
3342
3758
|
*/
|
|
3343
3759
|
EventSource?: string;
|
|
3344
3760
|
/**
|
|
3345
|
-
* <p>A user name or role name of the requester that called the API in the event
|
|
3761
|
+
* <p>A user name or role name of the requester that called the API in the event
|
|
3762
|
+
* returned.</p>
|
|
3346
3763
|
*/
|
|
3347
3764
|
Username?: string;
|
|
3348
3765
|
/**
|
|
@@ -3359,24 +3776,27 @@ export interface Event {
|
|
|
3359
3776
|
*/
|
|
3360
3777
|
export interface LookupEventsResponse {
|
|
3361
3778
|
/**
|
|
3362
|
-
* <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
|
|
3779
|
+
* <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
|
|
3780
|
+
* first.</p>
|
|
3363
3781
|
*/
|
|
3364
3782
|
Events?: Event[];
|
|
3365
3783
|
/**
|
|
3366
|
-
* <p>The token to use to get the next page of results after a previous API call. If the token
|
|
3367
|
-
* there are no more results to return. The token must be passed in with the
|
|
3368
|
-
* For example, if the original call specified an
|
|
3369
|
-
* NextToken should include
|
|
3784
|
+
* <p>The token to use to get the next page of results after a previous API call. If the token
|
|
3785
|
+
* does not appear, there are no more results to return. The token must be passed in with the
|
|
3786
|
+
* same parameters as the previous call. For example, if the original call specified an
|
|
3787
|
+
* AttributeKey of 'Username' with a value of 'root', the call with NextToken should include
|
|
3788
|
+
* those same parameters.</p>
|
|
3370
3789
|
*/
|
|
3371
3790
|
NextToken?: string;
|
|
3372
3791
|
}
|
|
3373
3792
|
export interface PutEventSelectorsRequest {
|
|
3374
3793
|
/**
|
|
3375
|
-
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the
|
|
3376
|
-
*
|
|
3794
|
+
* <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
|
|
3795
|
+
* must meet the following requirements:</p>
|
|
3377
3796
|
* <ul>
|
|
3378
3797
|
* <li>
|
|
3379
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
3798
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
3799
|
+
* (_), or dashes (-)</p>
|
|
3380
3800
|
* </li>
|
|
3381
3801
|
* <li>
|
|
3382
3802
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -3385,8 +3805,8 @@ export interface PutEventSelectorsRequest {
|
|
|
3385
3805
|
* <p>Be between 3 and 128 characters</p>
|
|
3386
3806
|
* </li>
|
|
3387
3807
|
* <li>
|
|
3388
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
3389
|
-
*
|
|
3808
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
3809
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
3390
3810
|
* </li>
|
|
3391
3811
|
* <li>
|
|
3392
3812
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -3399,27 +3819,28 @@ export interface PutEventSelectorsRequest {
|
|
|
3399
3819
|
*/
|
|
3400
3820
|
TrailName: string | undefined;
|
|
3401
3821
|
/**
|
|
3402
|
-
* <p>Specifies the settings for your event selectors. You can configure up to five event
|
|
3403
|
-
* You can use either <code>EventSelectors</code> or
|
|
3404
|
-
*
|
|
3822
|
+
* <p>Specifies the settings for your event selectors. You can configure up to five event
|
|
3823
|
+
* selectors for a trail. You can use either <code>EventSelectors</code> or
|
|
3824
|
+
* <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not
|
|
3825
|
+
* both. If you apply <code>EventSelectors</code> to a trail, any existing
|
|
3826
|
+
* <code>AdvancedEventSelectors</code> are overwritten.</p>
|
|
3405
3827
|
*/
|
|
3406
3828
|
EventSelectors?: EventSelector[];
|
|
3407
3829
|
/**
|
|
3408
|
-
* <p>
|
|
3409
|
-
*
|
|
3410
|
-
*
|
|
3411
|
-
*
|
|
3412
|
-
*
|
|
3413
|
-
*
|
|
3414
|
-
* <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging
|
|
3415
|
-
* data events for trails</a> in the <i>CloudTrail User Guide</i>.
|
|
3416
|
-
* </p>
|
|
3830
|
+
* <p> Specifies the settings for advanced event selectors. You can add advanced event
|
|
3831
|
+
* selectors, and conditions for your advanced event selectors, up to a maximum of 500 values
|
|
3832
|
+
* for all conditions and selectors on a trail. You can use either
|
|
3833
|
+
* <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you
|
|
3834
|
+
* apply <code>AdvancedEventSelectors</code> to a trail, any existing
|
|
3835
|
+
* <code>EventSelectors</code> are overwritten. For more information about advanced event
|
|
3836
|
+
* 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>
|
|
3417
3837
|
*/
|
|
3418
3838
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
3419
3839
|
}
|
|
3420
3840
|
export interface PutEventSelectorsResponse {
|
|
3421
3841
|
/**
|
|
3422
|
-
* <p>Specifies the ARN of the trail that was updated with event selectors. The following is
|
|
3842
|
+
* <p>Specifies the ARN of the trail that was updated with event selectors. The following is
|
|
3843
|
+
* the format of a trail ARN.</p>
|
|
3423
3844
|
* <p>
|
|
3424
3845
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
3425
3846
|
* </p>
|
|
@@ -3435,8 +3856,10 @@ export interface PutEventSelectorsResponse {
|
|
|
3435
3856
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
3436
3857
|
}
|
|
3437
3858
|
/**
|
|
3438
|
-
* <p>The formatting or syntax of the <code>InsightSelectors</code> JSON statement in your
|
|
3439
|
-
*
|
|
3859
|
+
* <p>The formatting or syntax of the <code>InsightSelectors</code> JSON statement in your
|
|
3860
|
+
* <code>PutInsightSelectors</code> or <code>GetInsightSelectors</code> request is not
|
|
3861
|
+
* valid, or the specified insight type in the <code>InsightSelectors</code> statement is not
|
|
3862
|
+
* a valid insight type.</p>
|
|
3440
3863
|
*/
|
|
3441
3864
|
export declare class InvalidInsightSelectorsException extends __BaseException {
|
|
3442
3865
|
readonly name: "InvalidInsightSelectorsException";
|
|
@@ -3452,27 +3875,116 @@ export declare class InvalidInsightSelectorsException extends __BaseException {
|
|
|
3452
3875
|
}
|
|
3453
3876
|
export interface PutInsightSelectorsRequest {
|
|
3454
3877
|
/**
|
|
3455
|
-
* <p>The name of the CloudTrail trail for which you want to change or add Insights
|
|
3878
|
+
* <p>The name of the CloudTrail trail for which you want to change or add Insights
|
|
3879
|
+
* selectors.</p>
|
|
3456
3880
|
*/
|
|
3457
3881
|
TrailName: string | undefined;
|
|
3458
3882
|
/**
|
|
3459
|
-
* <p>A JSON string that contains the insight types you want to log on a trail.
|
|
3883
|
+
* <p>A JSON string that contains the insight types you want to log on a trail.
|
|
3884
|
+
* <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid insight
|
|
3885
|
+
* types.</p>
|
|
3460
3886
|
*/
|
|
3461
3887
|
InsightSelectors: InsightSelector[] | undefined;
|
|
3462
3888
|
}
|
|
3463
3889
|
export interface PutInsightSelectorsResponse {
|
|
3464
3890
|
/**
|
|
3465
|
-
* <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights
|
|
3891
|
+
* <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights
|
|
3892
|
+
* selectors.</p>
|
|
3466
3893
|
*/
|
|
3467
3894
|
TrailARN?: string;
|
|
3468
3895
|
/**
|
|
3469
|
-
* <p>A JSON string that contains the Insights event types that you want to log on a trail.
|
|
3470
|
-
* <code>ApiErrorRateInsight</code> and
|
|
3896
|
+
* <p>A JSON string that contains the Insights event types that you want to log on a trail.
|
|
3897
|
+
* The valid Insights types in this release are <code>ApiErrorRateInsight</code> and
|
|
3898
|
+
* <code>ApiCallRateInsight</code>.</p>
|
|
3471
3899
|
*/
|
|
3472
3900
|
InsightSelectors?: InsightSelector[];
|
|
3473
3901
|
}
|
|
3902
|
+
export interface PutResourcePolicyRequest {
|
|
3903
|
+
/**
|
|
3904
|
+
* <p>
|
|
3905
|
+
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
|
|
3906
|
+
* The following is the format of a resource ARN:
|
|
3907
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</code>.
|
|
3908
|
+
* </p>
|
|
3909
|
+
*/
|
|
3910
|
+
ResourceArn: string | undefined;
|
|
3911
|
+
/**
|
|
3912
|
+
* <p>
|
|
3913
|
+
* A JSON-formatted string for an Amazon Web Services resource-based policy.
|
|
3914
|
+
* </p>
|
|
3915
|
+
* <p>The following are requirements for the resource policy:</p>
|
|
3916
|
+
* <ul>
|
|
3917
|
+
* <li>
|
|
3918
|
+
* <p>
|
|
3919
|
+
* Contains only one action: cloudtrail-data:PutAuditEvents
|
|
3920
|
+
* </p>
|
|
3921
|
+
* </li>
|
|
3922
|
+
* <li>
|
|
3923
|
+
* <p>
|
|
3924
|
+
* Contains at least one statement. The policy can have a maximum of 20 statements.
|
|
3925
|
+
* </p>
|
|
3926
|
+
* </li>
|
|
3927
|
+
* <li>
|
|
3928
|
+
* <p>
|
|
3929
|
+
* Each statement contains at least one principal. A statement can have a maximum of 50 principals.
|
|
3930
|
+
* </p>
|
|
3931
|
+
* </li>
|
|
3932
|
+
* </ul>
|
|
3933
|
+
*/
|
|
3934
|
+
ResourcePolicy: string | undefined;
|
|
3935
|
+
}
|
|
3936
|
+
export interface PutResourcePolicyResponse {
|
|
3937
|
+
/**
|
|
3938
|
+
* <p>
|
|
3939
|
+
* The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
|
|
3940
|
+
* </p>
|
|
3941
|
+
*/
|
|
3942
|
+
ResourceArn?: string;
|
|
3943
|
+
/**
|
|
3944
|
+
* <p>
|
|
3945
|
+
* The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail channel.
|
|
3946
|
+
* </p>
|
|
3947
|
+
*/
|
|
3948
|
+
ResourcePolicy?: string;
|
|
3949
|
+
}
|
|
3950
|
+
/**
|
|
3951
|
+
* <p>
|
|
3952
|
+
* This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is not valid.
|
|
3953
|
+
* </p>
|
|
3954
|
+
* <p>The following are requirements for the resource policy:</p>
|
|
3955
|
+
* <ul>
|
|
3956
|
+
* <li>
|
|
3957
|
+
* <p>
|
|
3958
|
+
* Contains only one action: cloudtrail-data:PutAuditEvents
|
|
3959
|
+
* </p>
|
|
3960
|
+
* </li>
|
|
3961
|
+
* <li>
|
|
3962
|
+
* <p>
|
|
3963
|
+
* Contains at least one statement. The policy can have a maximum of 20 statements.
|
|
3964
|
+
* </p>
|
|
3965
|
+
* </li>
|
|
3966
|
+
* <li>
|
|
3967
|
+
* <p>
|
|
3968
|
+
* Each statement contains at least one principal. A statement can have a maximum of 50 principals.
|
|
3969
|
+
* </p>
|
|
3970
|
+
* </li>
|
|
3971
|
+
* </ul>
|
|
3972
|
+
*/
|
|
3973
|
+
export declare class ResourcePolicyNotValidException extends __BaseException {
|
|
3974
|
+
readonly name: "ResourcePolicyNotValidException";
|
|
3975
|
+
readonly $fault: "client";
|
|
3976
|
+
/**
|
|
3977
|
+
* <p>Brief description of the exception returned by the request.</p>
|
|
3978
|
+
*/
|
|
3979
|
+
Message?: string;
|
|
3980
|
+
/**
|
|
3981
|
+
* @internal
|
|
3982
|
+
*/
|
|
3983
|
+
constructor(opts: __ExceptionOptionType<ResourcePolicyNotValidException, __BaseException>);
|
|
3984
|
+
}
|
|
3474
3985
|
/**
|
|
3475
|
-
* <p>This exception is thrown when the maximum number of CloudTrail delegated
|
|
3986
|
+
* <p>This exception is thrown when the maximum number of CloudTrail delegated
|
|
3987
|
+
* administrators is reached.</p>
|
|
3476
3988
|
*/
|
|
3477
3989
|
export declare class DelegatedAdminAccountLimitExceededException extends __BaseException {
|
|
3478
3990
|
readonly name: "DelegatedAdminAccountLimitExceededException";
|
|
@@ -3487,11 +3999,13 @@ export declare class DelegatedAdminAccountLimitExceededException extends __BaseE
|
|
|
3487
3999
|
constructor(opts: __ExceptionOptionType<DelegatedAdminAccountLimitExceededException, __BaseException>);
|
|
3488
4000
|
}
|
|
3489
4001
|
/**
|
|
3490
|
-
* <p>Specifies an organization member account ID as a CloudTrail delegated
|
|
4002
|
+
* <p>Specifies an organization member account ID as a CloudTrail delegated
|
|
4003
|
+
* administrator.</p>
|
|
3491
4004
|
*/
|
|
3492
4005
|
export interface RegisterOrganizationDelegatedAdminRequest {
|
|
3493
4006
|
/**
|
|
3494
|
-
* <p>An organization member account ID that you want to designate as a delegated
|
|
4007
|
+
* <p>An organization member account ID that you want to designate as a delegated
|
|
4008
|
+
* administrator.</p>
|
|
3495
4009
|
*/
|
|
3496
4010
|
MemberAccountId: string | undefined;
|
|
3497
4011
|
}
|
|
@@ -3501,15 +4015,20 @@ export interface RegisterOrganizationDelegatedAdminRequest {
|
|
|
3501
4015
|
export interface RegisterOrganizationDelegatedAdminResponse {
|
|
3502
4016
|
}
|
|
3503
4017
|
/**
|
|
3504
|
-
* <p>Specifies the tags to remove from a trail
|
|
4018
|
+
* <p>Specifies the tags to remove from a trail, event data store, or channel.</p>
|
|
3505
4019
|
*/
|
|
3506
4020
|
export interface RemoveTagsRequest {
|
|
3507
4021
|
/**
|
|
3508
|
-
* <p>Specifies the ARN of the trail
|
|
3509
|
-
*
|
|
3510
|
-
* Example trail ARN format:
|
|
4022
|
+
* <p>Specifies the ARN of the trail, event data store, or channel from which tags should be
|
|
4023
|
+
* removed.</p>
|
|
4024
|
+
* <p> Example trail ARN format:
|
|
4025
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
3511
4026
|
* </p>
|
|
3512
|
-
* <p>Example event data store ARN format:
|
|
4027
|
+
* <p>Example event data store ARN format:
|
|
4028
|
+
* <code>arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>
|
|
4029
|
+
* </p>
|
|
4030
|
+
* <p>Example channel ARN format:
|
|
4031
|
+
* <code>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</code>
|
|
3513
4032
|
* </p>
|
|
3514
4033
|
*/
|
|
3515
4034
|
ResourceId: string | undefined;
|
|
@@ -3519,7 +4038,8 @@ export interface RemoveTagsRequest {
|
|
|
3519
4038
|
TagsList: Tag[] | undefined;
|
|
3520
4039
|
}
|
|
3521
4040
|
/**
|
|
3522
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4041
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4042
|
+
* error.</p>
|
|
3523
4043
|
*/
|
|
3524
4044
|
export interface RemoveTagsResponse {
|
|
3525
4045
|
}
|
|
@@ -3540,7 +4060,8 @@ export declare class InvalidEventDataStoreStatusException extends __BaseExceptio
|
|
|
3540
4060
|
}
|
|
3541
4061
|
export interface RestoreEventDataStoreRequest {
|
|
3542
4062
|
/**
|
|
3543
|
-
* <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
|
|
4063
|
+
* <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
|
|
4064
|
+
* restore.</p>
|
|
3544
4065
|
*/
|
|
3545
4066
|
EventDataStore: string | undefined;
|
|
3546
4067
|
}
|
|
@@ -3562,12 +4083,13 @@ export interface RestoreEventDataStoreResponse {
|
|
|
3562
4083
|
*/
|
|
3563
4084
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
3564
4085
|
/**
|
|
3565
|
-
* <p>Indicates whether the event data store is collecting events from all regions, or only
|
|
3566
|
-
*
|
|
4086
|
+
* <p>Indicates whether the event data store is collecting events from all regions, or only
|
|
4087
|
+
* from the region in which the event data store was created.</p>
|
|
3567
4088
|
*/
|
|
3568
4089
|
MultiRegionEnabled?: boolean;
|
|
3569
4090
|
/**
|
|
3570
|
-
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
4091
|
+
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
4092
|
+
* Organizations.</p>
|
|
3571
4093
|
*/
|
|
3572
4094
|
OrganizationEnabled?: boolean;
|
|
3573
4095
|
/**
|
|
@@ -3575,7 +4097,8 @@ export interface RestoreEventDataStoreResponse {
|
|
|
3575
4097
|
*/
|
|
3576
4098
|
RetentionPeriod?: number;
|
|
3577
4099
|
/**
|
|
3578
|
-
* <p>Indicates that termination protection is enabled and the event data store cannot be
|
|
4100
|
+
* <p>Indicates that termination protection is enabled and the event data store cannot be
|
|
4101
|
+
* automatically deleted.</p>
|
|
3579
4102
|
*/
|
|
3580
4103
|
TerminationProtectionEnabled?: boolean;
|
|
3581
4104
|
/**
|
|
@@ -3584,12 +4107,13 @@ export interface RestoreEventDataStoreResponse {
|
|
|
3584
4107
|
CreatedTimestamp?: Date;
|
|
3585
4108
|
/**
|
|
3586
4109
|
* <p>The timestamp that shows when an event data store was updated, if applicable.
|
|
3587
|
-
*
|
|
4110
|
+
* <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
|
|
4111
|
+
* <code>CreatedTimestamp</code>.</p>
|
|
3588
4112
|
*/
|
|
3589
4113
|
UpdatedTimestamp?: Date;
|
|
3590
4114
|
/**
|
|
3591
|
-
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
|
|
3592
|
-
*
|
|
4115
|
+
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the
|
|
4116
|
+
* following format.</p>
|
|
3593
4117
|
* <p>
|
|
3594
4118
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
3595
4119
|
* </p>
|
|
@@ -3597,23 +4121,7 @@ export interface RestoreEventDataStoreResponse {
|
|
|
3597
4121
|
KmsKeyId?: string;
|
|
3598
4122
|
}
|
|
3599
4123
|
/**
|
|
3600
|
-
* <p>This exception is thrown when
|
|
3601
|
-
*/
|
|
3602
|
-
export declare class InvalidEventDataStoreCategoryException extends __BaseException {
|
|
3603
|
-
readonly name: "InvalidEventDataStoreCategoryException";
|
|
3604
|
-
readonly $fault: "client";
|
|
3605
|
-
/**
|
|
3606
|
-
* <p>Brief description of the exception returned by the request.</p>
|
|
3607
|
-
*/
|
|
3608
|
-
Message?: string;
|
|
3609
|
-
/**
|
|
3610
|
-
* @internal
|
|
3611
|
-
*/
|
|
3612
|
-
constructor(opts: __ExceptionOptionType<InvalidEventDataStoreCategoryException, __BaseException>);
|
|
3613
|
-
}
|
|
3614
|
-
/**
|
|
3615
|
-
* <p>
|
|
3616
|
-
* This exception is thrown when the provided source S3 bucket is not valid for import.
|
|
4124
|
+
* <p> This exception is thrown when the provided source S3 bucket is not valid for import.
|
|
3617
4125
|
* </p>
|
|
3618
4126
|
*/
|
|
3619
4127
|
export declare class InvalidImportSourceException extends __BaseException {
|
|
@@ -3630,102 +4138,83 @@ export declare class InvalidImportSourceException extends __BaseException {
|
|
|
3630
4138
|
}
|
|
3631
4139
|
export interface StartImportRequest {
|
|
3632
4140
|
/**
|
|
3633
|
-
* <p>
|
|
3634
|
-
* The ARN of the destination event data store. Use this parameter for a new import.
|
|
4141
|
+
* <p> The ARN of the destination event data store. Use this parameter for a new import.
|
|
3635
4142
|
* </p>
|
|
3636
4143
|
*/
|
|
3637
4144
|
Destinations?: string[];
|
|
3638
4145
|
/**
|
|
3639
|
-
* <p>
|
|
3640
|
-
* The source S3 bucket for the import. Use this parameter for a new import.
|
|
3641
|
-
* </p>
|
|
4146
|
+
* <p> The source S3 bucket for the import. Use this parameter for a new import. </p>
|
|
3642
4147
|
*/
|
|
3643
4148
|
ImportSource?: ImportSource;
|
|
3644
4149
|
/**
|
|
3645
|
-
* <p>
|
|
3646
|
-
*
|
|
3647
|
-
*
|
|
3648
|
-
*
|
|
3649
|
-
*
|
|
3650
|
-
* </p>
|
|
4150
|
+
* <p> Use with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4151
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
4152
|
+
* When you specify a time range, CloudTrail checks the prefix and log file names to
|
|
4153
|
+
* verify the names contain a date between the specified <code>StartEventTime</code> and
|
|
4154
|
+
* <code>EndEventTime</code> before attempting to import events. </p>
|
|
3651
4155
|
*/
|
|
3652
4156
|
StartEventTime?: Date;
|
|
3653
4157
|
/**
|
|
3654
|
-
* <p>
|
|
3655
|
-
*
|
|
3656
|
-
*
|
|
3657
|
-
*
|
|
3658
|
-
*
|
|
3659
|
-
* </p>
|
|
4158
|
+
* <p> Use with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4159
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
4160
|
+
* When you specify a time range, CloudTrail checks the prefix and log file names to
|
|
4161
|
+
* verify the names contain a date between the specified <code>StartEventTime</code> and
|
|
4162
|
+
* <code>EndEventTime</code> before attempting to import events. </p>
|
|
3660
4163
|
*/
|
|
3661
4164
|
EndEventTime?: Date;
|
|
3662
4165
|
/**
|
|
3663
|
-
* <p>
|
|
3664
|
-
* The ID of the import. Use this parameter when you are retrying an import.
|
|
3665
|
-
* </p>
|
|
4166
|
+
* <p> The ID of the import. Use this parameter when you are retrying an import. </p>
|
|
3666
4167
|
*/
|
|
3667
4168
|
ImportId?: string;
|
|
3668
4169
|
}
|
|
3669
4170
|
export interface StartImportResponse {
|
|
3670
4171
|
/**
|
|
3671
|
-
* <p>
|
|
3672
|
-
* The ID of the import.
|
|
3673
|
-
* </p>
|
|
4172
|
+
* <p> The ID of the import. </p>
|
|
3674
4173
|
*/
|
|
3675
4174
|
ImportId?: string;
|
|
3676
4175
|
/**
|
|
3677
|
-
* <p>
|
|
3678
|
-
* The ARN of the destination event data store.
|
|
3679
|
-
* </p>
|
|
4176
|
+
* <p> The ARN of the destination event data store. </p>
|
|
3680
4177
|
*/
|
|
3681
4178
|
Destinations?: string[];
|
|
3682
4179
|
/**
|
|
3683
|
-
* <p>
|
|
3684
|
-
* The source S3 bucket for the import.
|
|
3685
|
-
* </p>
|
|
4180
|
+
* <p> The source S3 bucket for the import. </p>
|
|
3686
4181
|
*/
|
|
3687
4182
|
ImportSource?: ImportSource;
|
|
3688
4183
|
/**
|
|
3689
|
-
* <p>
|
|
3690
|
-
*
|
|
3691
|
-
* to only those events logged within a specified time period.
|
|
4184
|
+
* <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4185
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
3692
4186
|
* </p>
|
|
3693
4187
|
*/
|
|
3694
4188
|
StartEventTime?: Date;
|
|
3695
4189
|
/**
|
|
3696
|
-
* <p>
|
|
3697
|
-
*
|
|
3698
|
-
* to only those events logged within a specified time period.
|
|
4190
|
+
* <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4191
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
3699
4192
|
* </p>
|
|
3700
4193
|
*/
|
|
3701
4194
|
EndEventTime?: Date;
|
|
3702
4195
|
/**
|
|
3703
|
-
* <p>
|
|
3704
|
-
*
|
|
3705
|
-
*
|
|
3706
|
-
* </p>
|
|
4196
|
+
* <p> Shows the status of the import after a <code>StartImport</code> request. An import
|
|
4197
|
+
* finishes with a status of <code>COMPLETED</code> if there were no failures, or
|
|
4198
|
+
* <code>FAILED</code> if there were failures. </p>
|
|
3707
4199
|
*/
|
|
3708
4200
|
ImportStatus?: ImportStatus | string;
|
|
3709
4201
|
/**
|
|
3710
|
-
* <p>
|
|
3711
|
-
* The timestamp for the import's creation.
|
|
3712
|
-
* </p>
|
|
4202
|
+
* <p> The timestamp for the import's creation. </p>
|
|
3713
4203
|
*/
|
|
3714
4204
|
CreatedTimestamp?: Date;
|
|
3715
4205
|
/**
|
|
3716
|
-
* <p>
|
|
3717
|
-
* The timestamp of the import's last update, if applicable.
|
|
3718
|
-
* </p>
|
|
4206
|
+
* <p> The timestamp of the import's last update, if applicable. </p>
|
|
3719
4207
|
*/
|
|
3720
4208
|
UpdatedTimestamp?: Date;
|
|
3721
4209
|
}
|
|
3722
4210
|
/**
|
|
3723
|
-
* <p>The request to CloudTrail to start logging Amazon Web Services API calls for an
|
|
4211
|
+
* <p>The request to CloudTrail to start logging Amazon Web Services API calls for an
|
|
4212
|
+
* account.</p>
|
|
3724
4213
|
*/
|
|
3725
4214
|
export interface StartLoggingRequest {
|
|
3726
4215
|
/**
|
|
3727
|
-
* <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
|
|
3728
|
-
* The following is the format of a trail ARN.</p>
|
|
4216
|
+
* <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
|
|
4217
|
+
* logs Amazon Web Services API calls. The following is the format of a trail ARN.</p>
|
|
3729
4218
|
* <p>
|
|
3730
4219
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
3731
4220
|
* </p>
|
|
@@ -3733,14 +4222,15 @@ export interface StartLoggingRequest {
|
|
|
3733
4222
|
Name: string | undefined;
|
|
3734
4223
|
}
|
|
3735
4224
|
/**
|
|
3736
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4225
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4226
|
+
* error.</p>
|
|
3737
4227
|
*/
|
|
3738
4228
|
export interface StartLoggingResponse {
|
|
3739
4229
|
}
|
|
3740
4230
|
/**
|
|
3741
|
-
* <p>The query that was submitted has validation errors, or uses incorrect syntax or
|
|
3742
|
-
* about writing a query, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html">Create
|
|
3743
|
-
*
|
|
4231
|
+
* <p>The query that was submitted has validation errors, or uses incorrect syntax or
|
|
4232
|
+
* unsupported keywords. For more information about writing a query, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html">Create or edit a query</a> in the <i>CloudTrail User
|
|
4233
|
+
* Guide</i>.</p>
|
|
3744
4234
|
*/
|
|
3745
4235
|
export declare class InvalidQueryStatementException extends __BaseException {
|
|
3746
4236
|
readonly name: "InvalidQueryStatementException";
|
|
@@ -3755,8 +4245,8 @@ export declare class InvalidQueryStatementException extends __BaseException {
|
|
|
3755
4245
|
constructor(opts: __ExceptionOptionType<InvalidQueryStatementException, __BaseException>);
|
|
3756
4246
|
}
|
|
3757
4247
|
/**
|
|
3758
|
-
* <p>You are already running the maximum number of concurrent queries. Wait a minute for some
|
|
3759
|
-
* run the query again.</p>
|
|
4248
|
+
* <p>You are already running the maximum number of concurrent queries. Wait a minute for some
|
|
4249
|
+
* queries to finish, and then run the query again.</p>
|
|
3760
4250
|
*/
|
|
3761
4251
|
export declare class MaxConcurrentQueriesException extends __BaseException {
|
|
3762
4252
|
readonly name: "MaxConcurrentQueriesException";
|
|
@@ -3776,9 +4266,7 @@ export interface StartQueryRequest {
|
|
|
3776
4266
|
*/
|
|
3777
4267
|
QueryStatement: string | undefined;
|
|
3778
4268
|
/**
|
|
3779
|
-
* <p>
|
|
3780
|
-
* The URI for the S3 bucket where CloudTrail delivers the query results.
|
|
3781
|
-
* </p>
|
|
4269
|
+
* <p> The URI for the S3 bucket where CloudTrail delivers the query results. </p>
|
|
3782
4270
|
*/
|
|
3783
4271
|
DeliveryS3Uri?: string;
|
|
3784
4272
|
}
|
|
@@ -3790,77 +4278,61 @@ export interface StartQueryResponse {
|
|
|
3790
4278
|
}
|
|
3791
4279
|
export interface StopImportRequest {
|
|
3792
4280
|
/**
|
|
3793
|
-
* <p>
|
|
3794
|
-
* The ID of the import.
|
|
3795
|
-
* </p>
|
|
4281
|
+
* <p> The ID of the import. </p>
|
|
3796
4282
|
*/
|
|
3797
4283
|
ImportId: string | undefined;
|
|
3798
4284
|
}
|
|
3799
4285
|
export interface StopImportResponse {
|
|
3800
4286
|
/**
|
|
3801
|
-
* <p>
|
|
3802
|
-
* The ID for the import.
|
|
3803
|
-
* </p>
|
|
4287
|
+
* <p> The ID for the import. </p>
|
|
3804
4288
|
*/
|
|
3805
4289
|
ImportId?: string;
|
|
3806
4290
|
/**
|
|
3807
|
-
* <p>
|
|
3808
|
-
* The source S3 bucket for the import.
|
|
3809
|
-
* </p>
|
|
4291
|
+
* <p> The source S3 bucket for the import. </p>
|
|
3810
4292
|
*/
|
|
3811
4293
|
ImportSource?: ImportSource;
|
|
3812
4294
|
/**
|
|
3813
|
-
* <p>
|
|
3814
|
-
* The ARN of the destination event data store.
|
|
3815
|
-
* </p>
|
|
4295
|
+
* <p> The ARN of the destination event data store. </p>
|
|
3816
4296
|
*/
|
|
3817
4297
|
Destinations?: string[];
|
|
3818
4298
|
/**
|
|
3819
|
-
* <p>
|
|
3820
|
-
* The status of the import.
|
|
3821
|
-
* </p>
|
|
4299
|
+
* <p> The status of the import. </p>
|
|
3822
4300
|
*/
|
|
3823
4301
|
ImportStatus?: ImportStatus | string;
|
|
3824
4302
|
/**
|
|
3825
|
-
* <p>
|
|
3826
|
-
* The timestamp of the import's creation.
|
|
3827
|
-
* </p>
|
|
4303
|
+
* <p> The timestamp of the import's creation. </p>
|
|
3828
4304
|
*/
|
|
3829
4305
|
CreatedTimestamp?: Date;
|
|
3830
4306
|
/**
|
|
3831
|
-
* <p>
|
|
3832
|
-
* The timestamp of the import's last update.
|
|
3833
|
-
* </p>
|
|
4307
|
+
* <p> The timestamp of the import's last update. </p>
|
|
3834
4308
|
*/
|
|
3835
4309
|
UpdatedTimestamp?: Date;
|
|
3836
4310
|
/**
|
|
3837
|
-
* <p>
|
|
3838
|
-
*
|
|
3839
|
-
* to only those events logged within a specified time period.
|
|
4311
|
+
* <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4312
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
3840
4313
|
* </p>
|
|
3841
4314
|
*/
|
|
3842
4315
|
StartEventTime?: Date;
|
|
3843
4316
|
/**
|
|
3844
|
-
* <p>
|
|
3845
|
-
*
|
|
3846
|
-
* to only those events logged within a specified time period.
|
|
4317
|
+
* <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
|
|
4318
|
+
* limit imported trail events to only those events logged within a specified time period.
|
|
3847
4319
|
* </p>
|
|
3848
4320
|
*/
|
|
3849
4321
|
EndEventTime?: Date;
|
|
3850
4322
|
/**
|
|
3851
|
-
* <p>
|
|
3852
|
-
* Returns information on the stopped import.
|
|
3853
|
-
* </p>
|
|
4323
|
+
* <p> Returns information on the stopped import. </p>
|
|
3854
4324
|
*/
|
|
3855
4325
|
ImportStatistics?: ImportStatistics;
|
|
3856
4326
|
}
|
|
3857
4327
|
/**
|
|
3858
|
-
* <p>Passes the request to CloudTrail to stop logging Amazon Web Services API calls for
|
|
4328
|
+
* <p>Passes the request to CloudTrail to stop logging Amazon Web Services API calls for
|
|
4329
|
+
* the specified account.</p>
|
|
3859
4330
|
*/
|
|
3860
4331
|
export interface StopLoggingRequest {
|
|
3861
4332
|
/**
|
|
3862
|
-
* <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
|
|
3863
|
-
* API calls. The following is the format of a trail
|
|
4333
|
+
* <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
|
|
4334
|
+
* will stop logging Amazon Web Services API calls. The following is the format of a trail
|
|
4335
|
+
* ARN.</p>
|
|
3864
4336
|
* <p>
|
|
3865
4337
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
3866
4338
|
* </p>
|
|
@@ -3868,13 +4340,49 @@ export interface StopLoggingRequest {
|
|
|
3868
4340
|
Name: string | undefined;
|
|
3869
4341
|
}
|
|
3870
4342
|
/**
|
|
3871
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4343
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4344
|
+
* error.</p>
|
|
3872
4345
|
*/
|
|
3873
4346
|
export interface StopLoggingResponse {
|
|
3874
4347
|
}
|
|
4348
|
+
export interface UpdateChannelRequest {
|
|
4349
|
+
/**
|
|
4350
|
+
* <p>The ARN or ID (the ARN suffix) of the channel that you want to update.</p>
|
|
4351
|
+
*/
|
|
4352
|
+
Channel: string | undefined;
|
|
4353
|
+
/**
|
|
4354
|
+
* <p>The ARNs of event data stores that you want to log events arriving through the channel.</p>
|
|
4355
|
+
*/
|
|
4356
|
+
Destinations?: Destination[];
|
|
4357
|
+
/**
|
|
4358
|
+
* <p>
|
|
4359
|
+
* Changes the name of the channel.
|
|
4360
|
+
* </p>
|
|
4361
|
+
*/
|
|
4362
|
+
Name?: string;
|
|
4363
|
+
}
|
|
4364
|
+
export interface UpdateChannelResponse {
|
|
4365
|
+
/**
|
|
4366
|
+
* <p>The ARN of the channel that was updated.</p>
|
|
4367
|
+
*/
|
|
4368
|
+
ChannelArn?: string;
|
|
4369
|
+
/**
|
|
4370
|
+
* <p>The name of the channel that was updated.</p>
|
|
4371
|
+
*/
|
|
4372
|
+
Name?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
* <p>The event source of the channel that was updated.</p>
|
|
4375
|
+
*/
|
|
4376
|
+
Source?: string;
|
|
4377
|
+
/**
|
|
4378
|
+
* <p>The event data stores that log events arriving through the channel.</p>
|
|
4379
|
+
*/
|
|
4380
|
+
Destinations?: Destination[];
|
|
4381
|
+
}
|
|
3875
4382
|
export interface UpdateEventDataStoreRequest {
|
|
3876
4383
|
/**
|
|
3877
|
-
* <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
|
|
4384
|
+
* <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
|
|
4385
|
+
* update.</p>
|
|
3878
4386
|
*/
|
|
3879
4387
|
EventDataStore: string | undefined;
|
|
3880
4388
|
/**
|
|
@@ -3882,15 +4390,18 @@ export interface UpdateEventDataStoreRequest {
|
|
|
3882
4390
|
*/
|
|
3883
4391
|
Name?: string;
|
|
3884
4392
|
/**
|
|
3885
|
-
* <p>The advanced event selectors used to select events for the event data store. You can
|
|
4393
|
+
* <p>The advanced event selectors used to select events for the event data store. You can
|
|
4394
|
+
* configure up to five advanced event selectors for each event data store.</p>
|
|
3886
4395
|
*/
|
|
3887
4396
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
3888
4397
|
/**
|
|
3889
|
-
* <p>Specifies whether an event data store collects events from all regions, or only from the
|
|
4398
|
+
* <p>Specifies whether an event data store collects events from all regions, or only from the
|
|
4399
|
+
* region in which it was created.</p>
|
|
3890
4400
|
*/
|
|
3891
4401
|
MultiRegionEnabled?: boolean;
|
|
3892
4402
|
/**
|
|
3893
|
-
* <p>Specifies whether an event data store collects events logged for an organization in
|
|
4403
|
+
* <p>Specifies whether an event data store collects events logged for an organization in
|
|
4404
|
+
* Organizations.</p>
|
|
3894
4405
|
*/
|
|
3895
4406
|
OrganizationEnabled?: boolean;
|
|
3896
4407
|
/**
|
|
@@ -3898,22 +4409,26 @@ export interface UpdateEventDataStoreRequest {
|
|
|
3898
4409
|
*/
|
|
3899
4410
|
RetentionPeriod?: number;
|
|
3900
4411
|
/**
|
|
3901
|
-
* <p>Indicates that termination protection is enabled and the event data store cannot be
|
|
4412
|
+
* <p>Indicates that termination protection is enabled and the event data store cannot be
|
|
4413
|
+
* automatically deleted.</p>
|
|
3902
4414
|
*/
|
|
3903
4415
|
TerminationProtectionEnabled?: boolean;
|
|
3904
4416
|
/**
|
|
3905
|
-
* <p>Specifies the KMS key ID to use to encrypt the events delivered by
|
|
3906
|
-
*
|
|
3907
|
-
* specified ARN to a key, or a globally unique
|
|
4417
|
+
* <p>Specifies the KMS key ID to use to encrypt the events delivered by
|
|
4418
|
+
* CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a
|
|
4419
|
+
* fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique
|
|
4420
|
+
* identifier.</p>
|
|
3908
4421
|
* <important>
|
|
3909
4422
|
* <p>Disabling or deleting the KMS key, or removing CloudTrail
|
|
3910
|
-
*
|
|
3911
|
-
*
|
|
3912
|
-
*
|
|
3913
|
-
*
|
|
4423
|
+
* permissions on the key, prevents CloudTrail from logging events to the event data
|
|
4424
|
+
* store, and prevents users from querying the data in the event data store that was
|
|
4425
|
+
* encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you
|
|
4426
|
+
* disable or delete a KMS key that you are using with an event data store,
|
|
4427
|
+
* delete or back up your event data store.</p>
|
|
3914
4428
|
* </important>
|
|
3915
|
-
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
3916
|
-
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
4429
|
+
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
4430
|
+
* information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
4431
|
+
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3917
4432
|
* <p>Examples:</p>
|
|
3918
4433
|
* <ul>
|
|
3919
4434
|
* <li>
|
|
@@ -3950,7 +4465,8 @@ export interface UpdateEventDataStoreResponse {
|
|
|
3950
4465
|
*/
|
|
3951
4466
|
Name?: string;
|
|
3952
4467
|
/**
|
|
3953
|
-
* <p>The status of an event data store. Values can be <code>ENABLED</code> and
|
|
4468
|
+
* <p>The status of an event data store. Values can be <code>ENABLED</code> and
|
|
4469
|
+
* <code>PENDING_DELETION</code>.</p>
|
|
3954
4470
|
*/
|
|
3955
4471
|
Status?: EventDataStoreStatus | string;
|
|
3956
4472
|
/**
|
|
@@ -3958,11 +4474,13 @@ export interface UpdateEventDataStoreResponse {
|
|
|
3958
4474
|
*/
|
|
3959
4475
|
AdvancedEventSelectors?: AdvancedEventSelector[];
|
|
3960
4476
|
/**
|
|
3961
|
-
* <p>Indicates whether the event data store includes events from all regions, or only from
|
|
4477
|
+
* <p>Indicates whether the event data store includes events from all regions, or only from
|
|
4478
|
+
* the region in which it was created.</p>
|
|
3962
4479
|
*/
|
|
3963
4480
|
MultiRegionEnabled?: boolean;
|
|
3964
4481
|
/**
|
|
3965
|
-
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
4482
|
+
* <p>Indicates whether an event data store is collecting logged events for an organization in
|
|
4483
|
+
* Organizations.</p>
|
|
3966
4484
|
*/
|
|
3967
4485
|
OrganizationEnabled?: boolean;
|
|
3968
4486
|
/**
|
|
@@ -3978,12 +4496,14 @@ export interface UpdateEventDataStoreResponse {
|
|
|
3978
4496
|
*/
|
|
3979
4497
|
CreatedTimestamp?: Date;
|
|
3980
4498
|
/**
|
|
3981
|
-
* <p>The timestamp that shows when the event data store was last updated.
|
|
4499
|
+
* <p>The timestamp that shows when the event data store was last updated.
|
|
4500
|
+
* <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
|
|
4501
|
+
* <code>CreatedTimestamp</code>.</p>
|
|
3982
4502
|
*/
|
|
3983
4503
|
UpdatedTimestamp?: Date;
|
|
3984
4504
|
/**
|
|
3985
|
-
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail.
|
|
3986
|
-
*
|
|
4505
|
+
* <p>Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the
|
|
4506
|
+
* following format.</p>
|
|
3987
4507
|
* <p>
|
|
3988
4508
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
3989
4509
|
* </p>
|
|
@@ -3999,7 +4519,8 @@ export interface UpdateTrailRequest {
|
|
|
3999
4519
|
* string must meet the following requirements:</p>
|
|
4000
4520
|
* <ul>
|
|
4001
4521
|
* <li>
|
|
4002
|
-
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
4522
|
+
* <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores
|
|
4523
|
+
* (_), or dashes (-)</p>
|
|
4003
4524
|
* </li>
|
|
4004
4525
|
* <li>
|
|
4005
4526
|
* <p>Start with a letter or number, and end with a letter or number</p>
|
|
@@ -4008,8 +4529,8 @@ export interface UpdateTrailRequest {
|
|
|
4008
4529
|
* <p>Be between 3 and 128 characters</p>
|
|
4009
4530
|
* </li>
|
|
4010
4531
|
* <li>
|
|
4011
|
-
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
4012
|
-
*
|
|
4532
|
+
* <p>Have no adjacent periods, underscores or dashes. Names like
|
|
4533
|
+
* <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</p>
|
|
4013
4534
|
* </li>
|
|
4014
4535
|
* <li>
|
|
4015
4536
|
* <p>Not be in IP address format (for example, 192.168.5.4)</p>
|
|
@@ -4022,16 +4543,20 @@ export interface UpdateTrailRequest {
|
|
|
4022
4543
|
*/
|
|
4023
4544
|
Name: string | undefined;
|
|
4024
4545
|
/**
|
|
4025
|
-
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
|
4546
|
+
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
|
|
4547
|
+
* See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
|
|
4548
|
+
* Bucket Naming Requirements</a>.</p>
|
|
4026
4549
|
*/
|
|
4027
4550
|
S3BucketName?: string;
|
|
4028
4551
|
/**
|
|
4029
|
-
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
4030
|
-
* 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
|
|
4552
|
+
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
4553
|
+
* have designated 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
|
|
4554
|
+
* characters.</p>
|
|
4031
4555
|
*/
|
|
4032
4556
|
S3KeyPrefix?: string;
|
|
4033
4557
|
/**
|
|
4034
|
-
* <p>Specifies the name of the Amazon SNS topic defined for notification of log file
|
|
4558
|
+
* <p>Specifies the name of the Amazon SNS topic defined for notification of log file
|
|
4559
|
+
* delivery. The maximum length is 256 characters.</p>
|
|
4035
4560
|
*/
|
|
4036
4561
|
SnsTopicName?: string;
|
|
4037
4562
|
/**
|
|
@@ -4039,37 +4564,45 @@ export interface UpdateTrailRequest {
|
|
|
4039
4564
|
*/
|
|
4040
4565
|
IncludeGlobalServiceEvents?: boolean;
|
|
4041
4566
|
/**
|
|
4042
|
-
* <p>Specifies whether the trail applies only to the current region or to all regions. The
|
|
4043
|
-
*
|
|
4044
|
-
*
|
|
4045
|
-
*
|
|
4567
|
+
* <p>Specifies whether the trail applies only to the current region or to all regions. The
|
|
4568
|
+
* default is false. If the trail exists only in the current region and this value is set to
|
|
4569
|
+
* true, shadow trails (replications of the trail) will be created in the other regions. If
|
|
4570
|
+
* the trail exists in all regions and this value is set to false, the trail will remain in
|
|
4571
|
+
* the region where it was created, and its shadow trails in other regions will be deleted. As
|
|
4572
|
+
* a best practice, consider using trails that log events in all regions.</p>
|
|
4046
4573
|
*/
|
|
4047
4574
|
IsMultiRegionTrail?: boolean;
|
|
4048
4575
|
/**
|
|
4049
4576
|
* <p>Specifies whether log file validation is enabled. The default is false.</p>
|
|
4050
4577
|
* <note>
|
|
4051
|
-
* <p>When you disable log file integrity validation, the chain of digest files is broken
|
|
4052
|
-
* does not create digest files for log files that were
|
|
4053
|
-
*
|
|
4054
|
-
*
|
|
4055
|
-
* on January 2
|
|
4578
|
+
* <p>When you disable log file integrity validation, the chain of digest files is broken
|
|
4579
|
+
* after one hour. CloudTrail does not create digest files for log files that were
|
|
4580
|
+
* delivered during a period in which log file integrity validation was disabled. For
|
|
4581
|
+
* example, if you enable log file integrity validation at noon on January 1, disable it at
|
|
4582
|
+
* noon on January 2, and re-enable it at noon on January 10, digest files will not be
|
|
4583
|
+
* created for the log files delivered from noon on January 2 to noon on January 10. The
|
|
4584
|
+
* same applies whenever you stop CloudTrail logging or delete a trail.</p>
|
|
4056
4585
|
* </note>
|
|
4057
4586
|
*/
|
|
4058
4587
|
EnableLogFileValidation?: boolean;
|
|
4059
4588
|
/**
|
|
4060
|
-
* <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
|
|
4589
|
+
* <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
|
|
4590
|
+
* represents the log group to which CloudTrail logs are delivered. You must use a log
|
|
4591
|
+
* group that exists in your account.</p>
|
|
4592
|
+
* <p>Not required unless you specify <code>CloudWatchLogsRoleArn</code>.</p>
|
|
4061
4593
|
*/
|
|
4062
4594
|
CloudWatchLogsLogGroupArn?: string;
|
|
4063
4595
|
/**
|
|
4064
|
-
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
4596
|
+
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
4597
|
+
* log group. You must use a role that exists in your account.</p>
|
|
4065
4598
|
*/
|
|
4066
4599
|
CloudWatchLogsRoleArn?: string;
|
|
4067
4600
|
/**
|
|
4068
|
-
* <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The
|
|
4069
|
-
*
|
|
4070
|
-
*
|
|
4071
|
-
*
|
|
4072
|
-
*
|
|
4601
|
+
* <p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by "alias/", a fully specified ARN to
|
|
4602
|
+
* an alias, a fully specified ARN to a key, or a globally unique identifier.</p>
|
|
4603
|
+
* <p>CloudTrail also supports KMS multi-Region keys. For more
|
|
4604
|
+
* information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region
|
|
4605
|
+
* keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4073
4606
|
* <p>Examples:</p>
|
|
4074
4607
|
* <ul>
|
|
4075
4608
|
* <li>
|
|
@@ -4088,16 +4621,19 @@ export interface UpdateTrailRequest {
|
|
|
4088
4621
|
*/
|
|
4089
4622
|
KmsKeyId?: string;
|
|
4090
4623
|
/**
|
|
4091
|
-
* <p>Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
|
|
4092
|
-
*
|
|
4093
|
-
* Organizations. If the trail is not an organization trail and this is set to
|
|
4094
|
-
*
|
|
4095
|
-
*
|
|
4624
|
+
* <p>Specifies whether the trail is applied to all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false,
|
|
4625
|
+
* and cannot be true unless the call is made on behalf of an Amazon Web Services account that
|
|
4626
|
+
* is the management account or delegated administrator account for an organization in Organizations. If the trail is not an organization trail and this is set to
|
|
4627
|
+
* <code>true</code>, the trail will be created in all Amazon Web Services accounts that
|
|
4628
|
+
* belong to the organization. If the trail is an organization trail and this is set to
|
|
4629
|
+
* <code>false</code>, the trail will remain in the current Amazon Web Services account but
|
|
4630
|
+
* be deleted from all member accounts in the organization.</p>
|
|
4096
4631
|
*/
|
|
4097
4632
|
IsOrganizationTrail?: boolean;
|
|
4098
4633
|
}
|
|
4099
4634
|
/**
|
|
4100
|
-
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4635
|
+
* <p>Returns the objects or data listed below if successful. Otherwise, returns an
|
|
4636
|
+
* error.</p>
|
|
4101
4637
|
*/
|
|
4102
4638
|
export interface UpdateTrailResponse {
|
|
4103
4639
|
/**
|
|
@@ -4105,13 +4641,13 @@ export interface UpdateTrailResponse {
|
|
|
4105
4641
|
*/
|
|
4106
4642
|
Name?: string;
|
|
4107
4643
|
/**
|
|
4108
|
-
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log
|
|
4644
|
+
* <p>Specifies the name of the Amazon S3 bucket designated for publishing log
|
|
4645
|
+
* files.</p>
|
|
4109
4646
|
*/
|
|
4110
4647
|
S3BucketName?: string;
|
|
4111
4648
|
/**
|
|
4112
|
-
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
4113
|
-
* for log file delivery.
|
|
4114
|
-
* 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>
|
|
4649
|
+
* <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
|
|
4650
|
+
* have designated 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 IAM Log Files</a>.</p>
|
|
4115
4651
|
*/
|
|
4116
4652
|
S3KeyPrefix?: string;
|
|
4117
4653
|
/**
|
|
@@ -4121,8 +4657,9 @@ export interface UpdateTrailResponse {
|
|
|
4121
4657
|
*/
|
|
4122
4658
|
SnsTopicName?: string;
|
|
4123
4659
|
/**
|
|
4124
|
-
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
4125
|
-
* when log files are delivered. The following is the format of a topic
|
|
4660
|
+
* <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
|
|
4661
|
+
* notifications when log files are delivered. The following is the format of a topic
|
|
4662
|
+
* ARN.</p>
|
|
4126
4663
|
* <p>
|
|
4127
4664
|
* <code>arn:aws:sns:us-east-2:123456789012:MyTopic</code>
|
|
4128
4665
|
* </p>
|
|
@@ -4137,7 +4674,8 @@ export interface UpdateTrailResponse {
|
|
|
4137
4674
|
*/
|
|
4138
4675
|
IsMultiRegionTrail?: boolean;
|
|
4139
4676
|
/**
|
|
4140
|
-
* <p>Specifies the ARN of the trail that was updated. The following is the format of a trail
|
|
4677
|
+
* <p>Specifies the ARN of the trail that was updated. The following is the format of a trail
|
|
4678
|
+
* ARN.</p>
|
|
4141
4679
|
* <p>
|
|
4142
4680
|
* <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
|
|
4143
4681
|
* </p>
|
|
@@ -4148,15 +4686,18 @@ export interface UpdateTrailResponse {
|
|
|
4148
4686
|
*/
|
|
4149
4687
|
LogFileValidationEnabled?: boolean;
|
|
4150
4688
|
/**
|
|
4151
|
-
* <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
|
|
4689
|
+
* <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
|
|
4690
|
+
* logs are delivered.</p>
|
|
4152
4691
|
*/
|
|
4153
4692
|
CloudWatchLogsLogGroupArn?: string;
|
|
4154
4693
|
/**
|
|
4155
|
-
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
4694
|
+
* <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
|
|
4695
|
+
* log group.</p>
|
|
4156
4696
|
*/
|
|
4157
4697
|
CloudWatchLogsRoleArn?: string;
|
|
4158
4698
|
/**
|
|
4159
|
-
* <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
|
|
4699
|
+
* <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
|
|
4700
|
+
* following format.</p>
|
|
4160
4701
|
* <p>
|
|
4161
4702
|
* <code>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</code>
|
|
4162
4703
|
* </p>
|
|
@@ -4199,6 +4740,18 @@ export declare const CancelQueryResponseFilterSensitiveLog: (obj: CancelQueryRes
|
|
|
4199
4740
|
* @internal
|
|
4200
4741
|
*/
|
|
4201
4742
|
export declare const ChannelFilterSensitiveLog: (obj: Channel) => any;
|
|
4743
|
+
/**
|
|
4744
|
+
* @internal
|
|
4745
|
+
*/
|
|
4746
|
+
export declare const DestinationFilterSensitiveLog: (obj: Destination) => any;
|
|
4747
|
+
/**
|
|
4748
|
+
* @internal
|
|
4749
|
+
*/
|
|
4750
|
+
export declare const CreateChannelRequestFilterSensitiveLog: (obj: CreateChannelRequest) => any;
|
|
4751
|
+
/**
|
|
4752
|
+
* @internal
|
|
4753
|
+
*/
|
|
4754
|
+
export declare const CreateChannelResponseFilterSensitiveLog: (obj: CreateChannelResponse) => any;
|
|
4202
4755
|
/**
|
|
4203
4756
|
* @internal
|
|
4204
4757
|
*/
|
|
@@ -4215,6 +4768,14 @@ export declare const CreateTrailRequestFilterSensitiveLog: (obj: CreateTrailRequ
|
|
|
4215
4768
|
* @internal
|
|
4216
4769
|
*/
|
|
4217
4770
|
export declare const CreateTrailResponseFilterSensitiveLog: (obj: CreateTrailResponse) => any;
|
|
4771
|
+
/**
|
|
4772
|
+
* @internal
|
|
4773
|
+
*/
|
|
4774
|
+
export declare const DeleteChannelRequestFilterSensitiveLog: (obj: DeleteChannelRequest) => any;
|
|
4775
|
+
/**
|
|
4776
|
+
* @internal
|
|
4777
|
+
*/
|
|
4778
|
+
export declare const DeleteChannelResponseFilterSensitiveLog: (obj: DeleteChannelResponse) => any;
|
|
4218
4779
|
/**
|
|
4219
4780
|
* @internal
|
|
4220
4781
|
*/
|
|
@@ -4223,6 +4784,14 @@ export declare const DeleteEventDataStoreRequestFilterSensitiveLog: (obj: Delete
|
|
|
4223
4784
|
* @internal
|
|
4224
4785
|
*/
|
|
4225
4786
|
export declare const DeleteEventDataStoreResponseFilterSensitiveLog: (obj: DeleteEventDataStoreResponse) => any;
|
|
4787
|
+
/**
|
|
4788
|
+
* @internal
|
|
4789
|
+
*/
|
|
4790
|
+
export declare const DeleteResourcePolicyRequestFilterSensitiveLog: (obj: DeleteResourcePolicyRequest) => any;
|
|
4791
|
+
/**
|
|
4792
|
+
* @internal
|
|
4793
|
+
*/
|
|
4794
|
+
export declare const DeleteResourcePolicyResponseFilterSensitiveLog: (obj: DeleteResourcePolicyResponse) => any;
|
|
4226
4795
|
/**
|
|
4227
4796
|
* @internal
|
|
4228
4797
|
*/
|
|
@@ -4270,7 +4839,7 @@ export declare const GetChannelRequestFilterSensitiveLog: (obj: GetChannelReques
|
|
|
4270
4839
|
/**
|
|
4271
4840
|
* @internal
|
|
4272
4841
|
*/
|
|
4273
|
-
export declare const
|
|
4842
|
+
export declare const IngestionStatusFilterSensitiveLog: (obj: IngestionStatus) => any;
|
|
4274
4843
|
/**
|
|
4275
4844
|
* @internal
|
|
4276
4845
|
*/
|
|
@@ -4347,6 +4916,14 @@ export declare const QueryStatisticsFilterSensitiveLog: (obj: QueryStatistics) =
|
|
|
4347
4916
|
* @internal
|
|
4348
4917
|
*/
|
|
4349
4918
|
export declare const GetQueryResultsResponseFilterSensitiveLog: (obj: GetQueryResultsResponse) => any;
|
|
4919
|
+
/**
|
|
4920
|
+
* @internal
|
|
4921
|
+
*/
|
|
4922
|
+
export declare const GetResourcePolicyRequestFilterSensitiveLog: (obj: GetResourcePolicyRequest) => any;
|
|
4923
|
+
/**
|
|
4924
|
+
* @internal
|
|
4925
|
+
*/
|
|
4926
|
+
export declare const GetResourcePolicyResponseFilterSensitiveLog: (obj: GetResourcePolicyResponse) => any;
|
|
4350
4927
|
/**
|
|
4351
4928
|
* @internal
|
|
4352
4929
|
*/
|
|
@@ -4491,6 +5068,14 @@ export declare const PutInsightSelectorsRequestFilterSensitiveLog: (obj: PutInsi
|
|
|
4491
5068
|
* @internal
|
|
4492
5069
|
*/
|
|
4493
5070
|
export declare const PutInsightSelectorsResponseFilterSensitiveLog: (obj: PutInsightSelectorsResponse) => any;
|
|
5071
|
+
/**
|
|
5072
|
+
* @internal
|
|
5073
|
+
*/
|
|
5074
|
+
export declare const PutResourcePolicyRequestFilterSensitiveLog: (obj: PutResourcePolicyRequest) => any;
|
|
5075
|
+
/**
|
|
5076
|
+
* @internal
|
|
5077
|
+
*/
|
|
5078
|
+
export declare const PutResourcePolicyResponseFilterSensitiveLog: (obj: PutResourcePolicyResponse) => any;
|
|
4494
5079
|
/**
|
|
4495
5080
|
* @internal
|
|
4496
5081
|
*/
|
|
@@ -4555,6 +5140,14 @@ export declare const StopLoggingRequestFilterSensitiveLog: (obj: StopLoggingRequ
|
|
|
4555
5140
|
* @internal
|
|
4556
5141
|
*/
|
|
4557
5142
|
export declare const StopLoggingResponseFilterSensitiveLog: (obj: StopLoggingResponse) => any;
|
|
5143
|
+
/**
|
|
5144
|
+
* @internal
|
|
5145
|
+
*/
|
|
5146
|
+
export declare const UpdateChannelRequestFilterSensitiveLog: (obj: UpdateChannelRequest) => any;
|
|
5147
|
+
/**
|
|
5148
|
+
* @internal
|
|
5149
|
+
*/
|
|
5150
|
+
export declare const UpdateChannelResponseFilterSensitiveLog: (obj: UpdateChannelResponse) => any;
|
|
4558
5151
|
/**
|
|
4559
5152
|
* @internal
|
|
4560
5153
|
*/
|