@aws-sdk/client-cloudtrail 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +491 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -9,6 +9,7 @@ export declare class AccountHasOngoingImportException extends __BaseException {
9
9
  readonly name: "AccountHasOngoingImportException";
10
10
  readonly $fault: "client";
11
11
  /**
12
+ * @public
12
13
  * <p>Brief description of the exception returned by the request.</p>
13
14
  */
14
15
  Message?: string;
@@ -26,6 +27,7 @@ export declare class AccountNotFoundException extends __BaseException {
26
27
  readonly name: "AccountNotFoundException";
27
28
  readonly $fault: "client";
28
29
  /**
30
+ * @public
29
31
  * <p>Brief description of the exception returned by the request.</p>
30
32
  */
31
33
  Message?: string;
@@ -42,6 +44,7 @@ export declare class AccountNotRegisteredException extends __BaseException {
42
44
  readonly name: "AccountNotRegisteredException";
43
45
  readonly $fault: "client";
44
46
  /**
47
+ * @public
45
48
  * <p>Brief description of the exception returned by the request.</p>
46
49
  */
47
50
  Message?: string;
@@ -59,6 +62,7 @@ export declare class AccountRegisteredException extends __BaseException {
59
62
  readonly name: "AccountRegisteredException";
60
63
  readonly $fault: "client";
61
64
  /**
65
+ * @public
62
66
  * <p>Brief description of the exception returned by the request.</p>
63
67
  */
64
68
  Message?: string;
@@ -74,11 +78,13 @@ export declare class AccountRegisteredException extends __BaseException {
74
78
  */
75
79
  export interface Tag {
76
80
  /**
81
+ * @public
77
82
  * <p>The key in a key-value pair. The key must be must be no longer than 128 Unicode
78
83
  * characters. The key must be unique for the resource to which it applies.</p>
79
84
  */
80
85
  Key: string | undefined;
81
86
  /**
87
+ * @public
82
88
  * <p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode
83
89
  * characters.</p>
84
90
  */
@@ -90,6 +96,7 @@ export interface Tag {
90
96
  */
91
97
  export interface AddTagsRequest {
92
98
  /**
99
+ * @public
93
100
  * <p>Specifies the ARN of the trail, event data store, or channel to which one or more tags will be
94
101
  * added.</p>
95
102
  * <p>The format of a trail ARN is:
@@ -104,6 +111,7 @@ export interface AddTagsRequest {
104
111
  */
105
112
  ResourceId: string | undefined;
106
113
  /**
114
+ * @public
107
115
  * <p>Contains a list of tags, up to a limit of 50</p>
108
116
  */
109
117
  TagsList: Tag[] | undefined;
@@ -123,6 +131,7 @@ export declare class ChannelARNInvalidException extends __BaseException {
123
131
  readonly name: "ChannelARNInvalidException";
124
132
  readonly $fault: "client";
125
133
  /**
134
+ * @public
126
135
  * <p>Brief description of the exception returned by the request.</p>
127
136
  */
128
137
  Message?: string;
@@ -139,6 +148,7 @@ export declare class ChannelNotFoundException extends __BaseException {
139
148
  readonly name: "ChannelNotFoundException";
140
149
  readonly $fault: "client";
141
150
  /**
151
+ * @public
142
152
  * <p>Brief description of the exception returned by the request.</p>
143
153
  */
144
154
  Message?: string;
@@ -166,6 +176,7 @@ export declare class CloudTrailARNInvalidException extends __BaseException {
166
176
  readonly name: "CloudTrailARNInvalidException";
167
177
  readonly $fault: "client";
168
178
  /**
179
+ * @public
169
180
  * <p>Brief description of the exception returned by the request.</p>
170
181
  */
171
182
  Message?: string;
@@ -185,6 +196,7 @@ export declare class ConflictException extends __BaseException {
185
196
  readonly name: "ConflictException";
186
197
  readonly $fault: "client";
187
198
  /**
199
+ * @public
188
200
  * <p>Brief description of the exception returned by the request.</p>
189
201
  */
190
202
  Message?: string;
@@ -202,6 +214,7 @@ export declare class EventDataStoreARNInvalidException extends __BaseException {
202
214
  readonly name: "EventDataStoreARNInvalidException";
203
215
  readonly $fault: "client";
204
216
  /**
217
+ * @public
205
218
  * <p>Brief description of the exception returned by the request.</p>
206
219
  */
207
220
  Message?: string;
@@ -218,6 +231,7 @@ export declare class EventDataStoreNotFoundException extends __BaseException {
218
231
  readonly name: "EventDataStoreNotFoundException";
219
232
  readonly $fault: "client";
220
233
  /**
234
+ * @public
221
235
  * <p>Brief description of the exception returned by the request.</p>
222
236
  */
223
237
  Message?: string;
@@ -234,6 +248,7 @@ export declare class InactiveEventDataStoreException extends __BaseException {
234
248
  readonly name: "InactiveEventDataStoreException";
235
249
  readonly $fault: "client";
236
250
  /**
251
+ * @public
237
252
  * <p>Brief description of the exception returned by the request.</p>
238
253
  */
239
254
  Message?: string;
@@ -251,6 +266,7 @@ export declare class InvalidTagParameterException extends __BaseException {
251
266
  readonly name: "InvalidTagParameterException";
252
267
  readonly $fault: "client";
253
268
  /**
269
+ * @public
254
270
  * <p>Brief description of the exception returned by the request.</p>
255
271
  */
256
272
  Message?: string;
@@ -287,6 +303,7 @@ export declare class InvalidTrailNameException extends __BaseException {
287
303
  readonly name: "InvalidTrailNameException";
288
304
  readonly $fault: "client";
289
305
  /**
306
+ * @public
290
307
  * <p>Brief description of the exception returned by the request.</p>
291
308
  */
292
309
  Message?: string;
@@ -304,6 +321,7 @@ export declare class NoManagementAccountSLRExistsException extends __BaseExcepti
304
321
  readonly name: "NoManagementAccountSLRExistsException";
305
322
  readonly $fault: "client";
306
323
  /**
324
+ * @public
307
325
  * <p>Brief description of the exception returned by the request.</p>
308
326
  */
309
327
  Message?: string;
@@ -322,6 +340,7 @@ export declare class NotOrganizationMasterAccountException extends __BaseExcepti
322
340
  readonly name: "NotOrganizationMasterAccountException";
323
341
  readonly $fault: "client";
324
342
  /**
343
+ * @public
325
344
  * <p>Brief description of the exception returned by the request.</p>
326
345
  */
327
346
  Message?: string;
@@ -338,6 +357,7 @@ export declare class OperationNotPermittedException extends __BaseException {
338
357
  readonly name: "OperationNotPermittedException";
339
358
  readonly $fault: "client";
340
359
  /**
360
+ * @public
341
361
  * <p>Brief description of the exception returned by the request.</p>
342
362
  */
343
363
  Message?: string;
@@ -354,6 +374,7 @@ export declare class ResourceNotFoundException extends __BaseException {
354
374
  readonly name: "ResourceNotFoundException";
355
375
  readonly $fault: "client";
356
376
  /**
377
+ * @public
357
378
  * <p>Brief description of the exception returned by the request.</p>
358
379
  */
359
380
  Message?: string;
@@ -370,6 +391,7 @@ export declare class ResourceTypeNotSupportedException extends __BaseException {
370
391
  readonly name: "ResourceTypeNotSupportedException";
371
392
  readonly $fault: "client";
372
393
  /**
394
+ * @public
373
395
  * <p>Brief description of the exception returned by the request.</p>
374
396
  */
375
397
  Message?: string;
@@ -387,6 +409,7 @@ export declare class TagsLimitExceededException extends __BaseException {
387
409
  readonly name: "TagsLimitExceededException";
388
410
  readonly $fault: "client";
389
411
  /**
412
+ * @public
390
413
  * <p>Brief description of the exception returned by the request.</p>
391
414
  */
392
415
  Message?: string;
@@ -403,6 +426,7 @@ export declare class UnsupportedOperationException extends __BaseException {
403
426
  readonly name: "UnsupportedOperationException";
404
427
  readonly $fault: "client";
405
428
  /**
429
+ * @public
406
430
  * <p>Brief description of the exception returned by the request.</p>
407
431
  */
408
432
  Message?: string;
@@ -417,6 +441,7 @@ export declare class UnsupportedOperationException extends __BaseException {
417
441
  */
418
442
  export interface AdvancedFieldSelector {
419
443
  /**
444
+ * @public
420
445
  * <p> A field in a CloudTrail event record on which to filter events to be logged. For
421
446
  * event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for
422
447
  * selecting events as filtering is not supported. </p>
@@ -811,6 +836,7 @@ export interface AdvancedFieldSelector {
811
836
  */
812
837
  Field: string | undefined;
813
838
  /**
839
+ * @public
814
840
  * <p> An operator that includes events that match the exact value of the event record field
815
841
  * specified as the value of <code>Field</code>. This is the only valid operator that you can
816
842
  * use with the <code>readOnly</code>, <code>eventCategory</code>, and
@@ -818,26 +844,31 @@ export interface AdvancedFieldSelector {
818
844
  */
819
845
  Equals?: string[];
820
846
  /**
847
+ * @public
821
848
  * <p>An operator that includes events that match the first few characters of the event record
822
849
  * field specified as the value of <code>Field</code>.</p>
823
850
  */
824
851
  StartsWith?: string[];
825
852
  /**
853
+ * @public
826
854
  * <p>An operator that includes events that match the last few characters of the event record
827
855
  * field specified as the value of <code>Field</code>.</p>
828
856
  */
829
857
  EndsWith?: string[];
830
858
  /**
859
+ * @public
831
860
  * <p> An operator that excludes events that match the exact value of the event record field
832
861
  * specified as the value of <code>Field</code>. </p>
833
862
  */
834
863
  NotEquals?: string[];
835
864
  /**
865
+ * @public
836
866
  * <p> An operator that excludes events that match the first few characters of the event
837
867
  * record field specified as the value of <code>Field</code>. </p>
838
868
  */
839
869
  NotStartsWith?: string[];
840
870
  /**
871
+ * @public
841
872
  * <p> An operator that excludes events that match the last few characters of the event record
842
873
  * field specified as the value of <code>Field</code>. </p>
843
874
  */
@@ -884,11 +915,13 @@ export interface AdvancedFieldSelector {
884
915
  */
885
916
  export interface AdvancedEventSelector {
886
917
  /**
918
+ * @public
887
919
  * <p>An optional, descriptive name for an advanced event selector, such as "Log data events
888
920
  * for only two S3 buckets".</p>
889
921
  */
890
922
  Name?: string;
891
923
  /**
924
+ * @public
892
925
  * <p>Contains all selector statements in an advanced event selector.</p>
893
926
  */
894
927
  FieldSelectors: AdvancedFieldSelector[] | undefined;
@@ -898,6 +931,7 @@ export interface AdvancedEventSelector {
898
931
  */
899
932
  export interface CancelQueryRequest {
900
933
  /**
934
+ * @public
901
935
  * @deprecated
902
936
  *
903
937
  * <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
@@ -905,6 +939,7 @@ export interface CancelQueryRequest {
905
939
  */
906
940
  EventDataStore?: string;
907
941
  /**
942
+ * @public
908
943
  * <p>The ID of the query that you want to cancel. The <code>QueryId</code> comes from the
909
944
  * response of a <code>StartQuery</code> operation.</p>
910
945
  */
@@ -931,10 +966,12 @@ export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];
931
966
  */
932
967
  export interface CancelQueryResponse {
933
968
  /**
969
+ * @public
934
970
  * <p>The ID of the canceled query.</p>
935
971
  */
936
972
  QueryId: string | undefined;
937
973
  /**
974
+ * @public
938
975
  * <p>Shows the status of a query after a <code>CancelQuery</code> request. Typically, the
939
976
  * values shown are either <code>RUNNING</code> or <code>CANCELLED</code>.</p>
940
977
  */
@@ -949,6 +986,7 @@ export declare class InactiveQueryException extends __BaseException {
949
986
  readonly name: "InactiveQueryException";
950
987
  readonly $fault: "client";
951
988
  /**
989
+ * @public
952
990
  * <p>Brief description of the exception returned by the request.</p>
953
991
  */
954
992
  Message?: string;
@@ -965,6 +1003,7 @@ export declare class InvalidParameterException extends __BaseException {
965
1003
  readonly name: "InvalidParameterException";
966
1004
  readonly $fault: "client";
967
1005
  /**
1006
+ * @public
968
1007
  * <p>Brief description of the exception returned by the request.</p>
969
1008
  */
970
1009
  Message?: string;
@@ -981,6 +1020,7 @@ export declare class QueryIdNotFoundException extends __BaseException {
981
1020
  readonly name: "QueryIdNotFoundException";
982
1021
  readonly $fault: "client";
983
1022
  /**
1023
+ * @public
984
1024
  * <p>Brief description of the exception returned by the request.</p>
985
1025
  */
986
1026
  Message?: string;
@@ -998,6 +1038,7 @@ export declare class CannotDelegateManagementAccountException extends __BaseExce
998
1038
  readonly name: "CannotDelegateManagementAccountException";
999
1039
  readonly $fault: "client";
1000
1040
  /**
1041
+ * @public
1001
1042
  * <p>Brief description of the exception returned by the request.</p>
1002
1043
  */
1003
1044
  Message?: string;
@@ -1012,10 +1053,12 @@ export declare class CannotDelegateManagementAccountException extends __BaseExce
1012
1053
  */
1013
1054
  export interface Channel {
1014
1055
  /**
1056
+ * @public
1015
1057
  * <p>The Amazon Resource Name (ARN) of a channel.</p>
1016
1058
  */
1017
1059
  ChannelArn?: string;
1018
1060
  /**
1061
+ * @public
1019
1062
  * <p> The name of the CloudTrail channel. For service-linked channels, the name is
1020
1063
  * <code>aws-service-channel/service-name/custom-suffix</code> where
1021
1064
  * <code>service-name</code> represents the name of the Amazon Web Services service that
@@ -1034,6 +1077,7 @@ export declare class ChannelAlreadyExistsException extends __BaseException {
1034
1077
  readonly name: "ChannelAlreadyExistsException";
1035
1078
  readonly $fault: "client";
1036
1079
  /**
1080
+ * @public
1037
1081
  * <p>Brief description of the exception returned by the request.</p>
1038
1082
  */
1039
1083
  Message?: string;
@@ -1051,6 +1095,7 @@ export declare class ChannelExistsForEDSException extends __BaseException {
1051
1095
  readonly name: "ChannelExistsForEDSException";
1052
1096
  readonly $fault: "client";
1053
1097
  /**
1098
+ * @public
1054
1099
  * <p>Brief description of the exception returned by the request.</p>
1055
1100
  */
1056
1101
  Message?: string;
@@ -1069,6 +1114,7 @@ export declare class ChannelMaxLimitExceededException extends __BaseException {
1069
1114
  readonly name: "ChannelMaxLimitExceededException";
1070
1115
  readonly $fault: "client";
1071
1116
  /**
1117
+ * @public
1072
1118
  * <p>Brief description of the exception returned by the request.</p>
1073
1119
  */
1074
1120
  Message?: string;
@@ -1095,11 +1141,13 @@ export type DestinationType = (typeof DestinationType)[keyof typeof DestinationT
1095
1141
  */
1096
1142
  export interface Destination {
1097
1143
  /**
1144
+ * @public
1098
1145
  * <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,
1099
1146
  * the value is <code>AWS_SERVICE</code>. </p>
1100
1147
  */
1101
1148
  Type: DestinationType | string | undefined;
1102
1149
  /**
1150
+ * @public
1103
1151
  * <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.
1104
1152
  * For service-linked channels, the location is the name of the Amazon Web Services service.</p>
1105
1153
  */
@@ -1110,10 +1158,12 @@ export interface Destination {
1110
1158
  */
1111
1159
  export interface CreateChannelRequest {
1112
1160
  /**
1161
+ * @public
1113
1162
  * <p>The name of the channel.</p>
1114
1163
  */
1115
1164
  Name: string | undefined;
1116
1165
  /**
1166
+ * @public
1117
1167
  * <p>The name of the partner or external event source. You cannot change this name after you create the
1118
1168
  * channel. A maximum of one channel is allowed per source.</p>
1119
1169
  * <p>
@@ -1123,10 +1173,12 @@ export interface CreateChannelRequest {
1123
1173
  */
1124
1174
  Source: string | undefined;
1125
1175
  /**
1176
+ * @public
1126
1177
  * <p>One or more event data stores to which events arriving through a channel will be logged.</p>
1127
1178
  */
1128
1179
  Destinations: Destination[] | undefined;
1129
1180
  /**
1181
+ * @public
1130
1182
  * <p>A list of tags.</p>
1131
1183
  */
1132
1184
  Tags?: Tag[];
@@ -1136,22 +1188,27 @@ export interface CreateChannelRequest {
1136
1188
  */
1137
1189
  export interface CreateChannelResponse {
1138
1190
  /**
1191
+ * @public
1139
1192
  * <p>The Amazon Resource Name (ARN) of the new channel.</p>
1140
1193
  */
1141
1194
  ChannelArn?: string;
1142
1195
  /**
1196
+ * @public
1143
1197
  * <p>The name of the new channel.</p>
1144
1198
  */
1145
1199
  Name?: string;
1146
1200
  /**
1201
+ * @public
1147
1202
  * <p>The partner or external event source name.</p>
1148
1203
  */
1149
1204
  Source?: string;
1150
1205
  /**
1206
+ * @public
1151
1207
  * <p>The event data stores that log the events arriving through the channel.</p>
1152
1208
  */
1153
1209
  Destinations?: Destination[];
1154
1210
  /**
1211
+ * @public
1155
1212
  * <p>A list of tags.</p>
1156
1213
  */
1157
1214
  Tags?: Tag[];
@@ -1165,6 +1222,7 @@ export declare class InvalidEventDataStoreCategoryException extends __BaseExcept
1165
1222
  readonly name: "InvalidEventDataStoreCategoryException";
1166
1223
  readonly $fault: "client";
1167
1224
  /**
1225
+ * @public
1168
1226
  * <p>Brief description of the exception returned by the request.</p>
1169
1227
  */
1170
1228
  Message?: string;
@@ -1181,6 +1239,7 @@ export declare class InvalidSourceException extends __BaseException {
1181
1239
  readonly name: "InvalidSourceException";
1182
1240
  readonly $fault: "client";
1183
1241
  /**
1242
+ * @public
1184
1243
  * <p>Brief description of the exception returned by the request.</p>
1185
1244
  */
1186
1245
  Message?: string;
@@ -1197,6 +1256,7 @@ export declare class CloudTrailAccessNotEnabledException extends __BaseException
1197
1256
  readonly name: "CloudTrailAccessNotEnabledException";
1198
1257
  readonly $fault: "client";
1199
1258
  /**
1259
+ * @public
1200
1260
  * <p>Brief description of the exception returned by the request.</p>
1201
1261
  */
1202
1262
  Message?: string;
@@ -1210,10 +1270,12 @@ export declare class CloudTrailAccessNotEnabledException extends __BaseException
1210
1270
  */
1211
1271
  export interface CreateEventDataStoreRequest {
1212
1272
  /**
1273
+ * @public
1213
1274
  * <p>The name of the event data store.</p>
1214
1275
  */
1215
1276
  Name: string | undefined;
1216
1277
  /**
1278
+ * @public
1217
1279
  * <p>The advanced event selectors to use to select the events for the data store. You can
1218
1280
  * configure up to five advanced event selectors for each event data store.</p>
1219
1281
  * <p> For more information about how to use advanced event selectors to log CloudTrail
@@ -1224,31 +1286,37 @@ export interface CreateEventDataStoreRequest {
1224
1286
  */
1225
1287
  AdvancedEventSelectors?: AdvancedEventSelector[];
1226
1288
  /**
1289
+ * @public
1227
1290
  * <p>Specifies whether the event data store includes events from all Regions, or only from
1228
1291
  * the Region in which the event data store is created.</p>
1229
1292
  */
1230
1293
  MultiRegionEnabled?: boolean;
1231
1294
  /**
1295
+ * @public
1232
1296
  * <p>Specifies whether an event data store collects events logged for an organization in
1233
1297
  * Organizations.</p>
1234
1298
  */
1235
1299
  OrganizationEnabled?: boolean;
1236
1300
  /**
1301
+ * @public
1237
1302
  * <p>The retention period of the event data store, in days. You can set a retention period of
1238
1303
  * up to 2557 days, the equivalent of seven years.</p>
1239
1304
  */
1240
1305
  RetentionPeriod?: number;
1241
1306
  /**
1307
+ * @public
1242
1308
  * <p>Specifies whether termination protection is enabled for the event data store. If
1243
1309
  * termination protection is enabled, you cannot delete the event data store until termination
1244
1310
  * protection is disabled.</p>
1245
1311
  */
1246
1312
  TerminationProtectionEnabled?: boolean;
1247
1313
  /**
1314
+ * @public
1248
1315
  * <p>A list of tags.</p>
1249
1316
  */
1250
1317
  TagsList?: Tag[];
1251
1318
  /**
1319
+ * @public
1252
1320
  * <p>Specifies the KMS key ID to use to encrypt the events delivered by
1253
1321
  * CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a
1254
1322
  * fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique
@@ -1290,6 +1358,7 @@ export interface CreateEventDataStoreRequest {
1290
1358
  */
1291
1359
  KmsKeyId?: string;
1292
1360
  /**
1361
+ * @public
1293
1362
  * <p>Specifies whether the event data store should start ingesting live events. The default is true.</p>
1294
1363
  */
1295
1364
  StartIngestion?: boolean;
@@ -1315,55 +1384,67 @@ export type EventDataStoreStatus = (typeof EventDataStoreStatus)[keyof typeof Ev
1315
1384
  */
1316
1385
  export interface CreateEventDataStoreResponse {
1317
1386
  /**
1387
+ * @public
1318
1388
  * <p>The ARN of the event data store.</p>
1319
1389
  */
1320
1390
  EventDataStoreArn?: string;
1321
1391
  /**
1392
+ * @public
1322
1393
  * <p>The name of the event data store.</p>
1323
1394
  */
1324
1395
  Name?: string;
1325
1396
  /**
1397
+ * @public
1326
1398
  * <p>The status of event data store creation.</p>
1327
1399
  */
1328
1400
  Status?: EventDataStoreStatus | string;
1329
1401
  /**
1402
+ * @public
1330
1403
  * <p>The advanced event selectors that were used to select the events for the data
1331
1404
  * store.</p>
1332
1405
  */
1333
1406
  AdvancedEventSelectors?: AdvancedEventSelector[];
1334
1407
  /**
1408
+ * @public
1335
1409
  * <p>Indicates whether the event data store collects events from all Regions, or only from
1336
1410
  * the Region in which it was created.</p>
1337
1411
  */
1338
1412
  MultiRegionEnabled?: boolean;
1339
1413
  /**
1414
+ * @public
1340
1415
  * <p>Indicates whether an event data store is collecting logged events for an organization in
1341
1416
  * Organizations.</p>
1342
1417
  */
1343
1418
  OrganizationEnabled?: boolean;
1344
1419
  /**
1420
+ * @public
1345
1421
  * <p>The retention period of an event data store, in days.</p>
1346
1422
  */
1347
1423
  RetentionPeriod?: number;
1348
1424
  /**
1425
+ * @public
1349
1426
  * <p>Indicates whether termination protection is enabled for the event data store.</p>
1350
1427
  */
1351
1428
  TerminationProtectionEnabled?: boolean;
1352
1429
  /**
1430
+ * @public
1353
1431
  * <p>A list of tags.</p>
1354
1432
  */
1355
1433
  TagsList?: Tag[];
1356
1434
  /**
1435
+ * @public
1357
1436
  * <p>The timestamp that shows when the event data store was created.</p>
1358
1437
  */
1359
1438
  CreatedTimestamp?: Date;
1360
1439
  /**
1440
+ * @public
1361
1441
  * <p>The timestamp that shows when an event data store was updated, if applicable.
1362
1442
  * <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
1363
1443
  * <code>CreatedTimestamp</code>.</p>
1364
1444
  */
1365
1445
  UpdatedTimestamp?: Date;
1366
1446
  /**
1447
+ * @public
1367
1448
  * <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
1368
1449
  * following format.</p>
1369
1450
  * <p>
@@ -1380,6 +1461,7 @@ export declare class EventDataStoreAlreadyExistsException extends __BaseExceptio
1380
1461
  readonly name: "EventDataStoreAlreadyExistsException";
1381
1462
  readonly $fault: "client";
1382
1463
  /**
1464
+ * @public
1383
1465
  * <p>Brief description of the exception returned by the request.</p>
1384
1466
  */
1385
1467
  Message?: string;
@@ -1396,6 +1478,7 @@ export declare class EventDataStoreMaxLimitExceededException extends __BaseExcep
1396
1478
  readonly name: "EventDataStoreMaxLimitExceededException";
1397
1479
  readonly $fault: "client";
1398
1480
  /**
1481
+ * @public
1399
1482
  * <p>Brief description of the exception returned by the request.</p>
1400
1483
  */
1401
1484
  Message?: string;
@@ -1414,6 +1497,7 @@ export declare class InsufficientDependencyServiceAccessPermissionException exte
1414
1497
  readonly name: "InsufficientDependencyServiceAccessPermissionException";
1415
1498
  readonly $fault: "client";
1416
1499
  /**
1500
+ * @public
1417
1501
  * <p>Brief description of the exception returned by the request.</p>
1418
1502
  */
1419
1503
  Message?: string;
@@ -1431,6 +1515,7 @@ export declare class InsufficientEncryptionPolicyException extends __BaseExcepti
1431
1515
  readonly name: "InsufficientEncryptionPolicyException";
1432
1516
  readonly $fault: "client";
1433
1517
  /**
1518
+ * @public
1434
1519
  * <p>Brief description of the exception returned by the request.</p>
1435
1520
  */
1436
1521
  Message?: string;
@@ -1474,6 +1559,7 @@ export declare class InvalidEventSelectorsException extends __BaseException {
1474
1559
  readonly name: "InvalidEventSelectorsException";
1475
1560
  readonly $fault: "client";
1476
1561
  /**
1562
+ * @public
1477
1563
  * <p>Brief description of the exception returned by the request.</p>
1478
1564
  */
1479
1565
  Message?: string;
@@ -1490,6 +1576,7 @@ export declare class InvalidKmsKeyIdException extends __BaseException {
1490
1576
  readonly name: "InvalidKmsKeyIdException";
1491
1577
  readonly $fault: "client";
1492
1578
  /**
1579
+ * @public
1493
1580
  * <p>Brief description of the exception returned by the request.</p>
1494
1581
  */
1495
1582
  Message?: string;
@@ -1507,6 +1594,7 @@ export declare class KmsException extends __BaseException {
1507
1594
  readonly name: "KmsException";
1508
1595
  readonly $fault: "client";
1509
1596
  /**
1597
+ * @public
1510
1598
  * <p>Brief description of the exception returned by the request.</p>
1511
1599
  */
1512
1600
  Message?: string;
@@ -1525,6 +1613,7 @@ export declare class KmsKeyNotFoundException extends __BaseException {
1525
1613
  readonly name: "KmsKeyNotFoundException";
1526
1614
  readonly $fault: "client";
1527
1615
  /**
1616
+ * @public
1528
1617
  * <p>Brief description of the exception returned by the request.</p>
1529
1618
  */
1530
1619
  Message?: string;
@@ -1543,6 +1632,7 @@ export declare class OrganizationNotInAllFeaturesModeException extends __BaseExc
1543
1632
  readonly name: "OrganizationNotInAllFeaturesModeException";
1544
1633
  readonly $fault: "client";
1545
1634
  /**
1635
+ * @public
1546
1636
  * <p>Brief description of the exception returned by the request.</p>
1547
1637
  */
1548
1638
  Message?: string;
@@ -1561,6 +1651,7 @@ export declare class OrganizationsNotInUseException extends __BaseException {
1561
1651
  readonly name: "OrganizationsNotInUseException";
1562
1652
  readonly $fault: "client";
1563
1653
  /**
1654
+ * @public
1564
1655
  * <p>Brief description of the exception returned by the request.</p>
1565
1656
  */
1566
1657
  Message?: string;
@@ -1579,6 +1670,7 @@ export declare class CloudTrailInvalidClientTokenIdException extends __BaseExcep
1579
1670
  readonly name: "CloudTrailInvalidClientTokenIdException";
1580
1671
  readonly $fault: "client";
1581
1672
  /**
1673
+ * @public
1582
1674
  * <p>Brief description of the exception returned by the request.</p>
1583
1675
  */
1584
1676
  Message?: string;
@@ -1595,6 +1687,7 @@ export declare class CloudWatchLogsDeliveryUnavailableException extends __BaseEx
1595
1687
  readonly name: "CloudWatchLogsDeliveryUnavailableException";
1596
1688
  readonly $fault: "client";
1597
1689
  /**
1690
+ * @public
1598
1691
  * <p>Brief description of the exception returned by the request.</p>
1599
1692
  */
1600
1693
  Message?: string;
@@ -1609,6 +1702,7 @@ export declare class CloudWatchLogsDeliveryUnavailableException extends __BaseEx
1609
1702
  */
1610
1703
  export interface CreateTrailRequest {
1611
1704
  /**
1705
+ * @public
1612
1706
  * <p>Specifies the name of the trail. The name must meet the following requirements:</p>
1613
1707
  * <ul>
1614
1708
  * <li>
@@ -1632,34 +1726,40 @@ export interface CreateTrailRequest {
1632
1726
  */
1633
1727
  Name: string | undefined;
1634
1728
  /**
1729
+ * @public
1635
1730
  * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
1636
1731
  * See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
1637
1732
  * Bucket Naming Requirements</a>.</p>
1638
1733
  */
1639
1734
  S3BucketName: string | undefined;
1640
1735
  /**
1736
+ * @public
1641
1737
  * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
1642
1738
  * 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
1643
1739
  * characters.</p>
1644
1740
  */
1645
1741
  S3KeyPrefix?: string;
1646
1742
  /**
1743
+ * @public
1647
1744
  * <p>Specifies the name of the Amazon SNS topic defined for notification of log file
1648
1745
  * delivery. The maximum length is 256 characters.</p>
1649
1746
  */
1650
1747
  SnsTopicName?: string;
1651
1748
  /**
1749
+ * @public
1652
1750
  * <p>Specifies whether the trail is publishing events from global services such as IAM to the
1653
1751
  * log files.</p>
1654
1752
  */
1655
1753
  IncludeGlobalServiceEvents?: boolean;
1656
1754
  /**
1755
+ * @public
1657
1756
  * <p>Specifies whether the trail is created in the current Region or in all Regions. The
1658
1757
  * default is false, which creates a trail only in the Region where you are signed in. As a
1659
1758
  * best practice, consider creating trails that log events in all Regions.</p>
1660
1759
  */
1661
1760
  IsMultiRegionTrail?: boolean;
1662
1761
  /**
1762
+ * @public
1663
1763
  * <p>Specifies whether log file integrity validation is enabled. The default is false.</p>
1664
1764
  * <note>
1665
1765
  * <p>When you disable log file integrity validation, the chain of digest files is broken
@@ -1673,6 +1773,7 @@ export interface CreateTrailRequest {
1673
1773
  */
1674
1774
  EnableLogFileValidation?: boolean;
1675
1775
  /**
1776
+ * @public
1676
1777
  * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
1677
1778
  * represents the log group to which CloudTrail logs will be delivered. You must use a
1678
1779
  * log group that exists in your account.</p>
@@ -1680,11 +1781,13 @@ export interface CreateTrailRequest {
1680
1781
  */
1681
1782
  CloudWatchLogsLogGroupArn?: string;
1682
1783
  /**
1784
+ * @public
1683
1785
  * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
1684
1786
  * log group. You must use a role that exists in your account.</p>
1685
1787
  */
1686
1788
  CloudWatchLogsRoleArn?: string;
1687
1789
  /**
1790
+ * @public
1688
1791
  * <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
1689
1792
  * specified ARN to an alias, a fully specified ARN to a key, or a globally unique
1690
1793
  * identifier.</p>
@@ -1717,12 +1820,14 @@ export interface CreateTrailRequest {
1717
1820
  */
1718
1821
  KmsKeyId?: string;
1719
1822
  /**
1823
+ * @public
1720
1824
  * <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,
1721
1825
  * and cannot be true unless the call is made on behalf of an Amazon Web Services account that
1722
1826
  * is the management account or delegated administrator account for an organization in Organizations.</p>
1723
1827
  */
1724
1828
  IsOrganizationTrail?: boolean;
1725
1829
  /**
1830
+ * @public
1726
1831
  * <p>A list of tags.</p>
1727
1832
  */
1728
1833
  TagsList?: Tag[];
@@ -1734,26 +1839,31 @@ export interface CreateTrailRequest {
1734
1839
  */
1735
1840
  export interface CreateTrailResponse {
1736
1841
  /**
1842
+ * @public
1737
1843
  * <p>Specifies the name of the trail.</p>
1738
1844
  */
1739
1845
  Name?: string;
1740
1846
  /**
1847
+ * @public
1741
1848
  * <p>Specifies the name of the Amazon S3 bucket designated for publishing log
1742
1849
  * files.</p>
1743
1850
  */
1744
1851
  S3BucketName?: string;
1745
1852
  /**
1853
+ * @public
1746
1854
  * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
1747
1855
  * 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>
1748
1856
  */
1749
1857
  S3KeyPrefix?: string;
1750
1858
  /**
1859
+ * @public
1751
1860
  * @deprecated
1752
1861
  *
1753
1862
  * <p>This field is no longer in use. Use <code>SnsTopicARN</code>.</p>
1754
1863
  */
1755
1864
  SnsTopicName?: string;
1756
1865
  /**
1866
+ * @public
1757
1867
  * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
1758
1868
  * notifications when log files are delivered. The format of a topic ARN is:</p>
1759
1869
  * <p>
@@ -1762,15 +1872,18 @@ export interface CreateTrailResponse {
1762
1872
  */
1763
1873
  SnsTopicARN?: string;
1764
1874
  /**
1875
+ * @public
1765
1876
  * <p>Specifies whether the trail is publishing events from global services such as IAM to the
1766
1877
  * log files.</p>
1767
1878
  */
1768
1879
  IncludeGlobalServiceEvents?: boolean;
1769
1880
  /**
1881
+ * @public
1770
1882
  * <p>Specifies whether the trail exists in one Region or in all Regions.</p>
1771
1883
  */
1772
1884
  IsMultiRegionTrail?: boolean;
1773
1885
  /**
1886
+ * @public
1774
1887
  * <p>Specifies the ARN of the trail that was created. The format of a trail ARN is:</p>
1775
1888
  * <p>
1776
1889
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
@@ -1778,20 +1891,24 @@ export interface CreateTrailResponse {
1778
1891
  */
1779
1892
  TrailARN?: string;
1780
1893
  /**
1894
+ * @public
1781
1895
  * <p>Specifies whether log file integrity validation is enabled.</p>
1782
1896
  */
1783
1897
  LogFileValidationEnabled?: boolean;
1784
1898
  /**
1899
+ * @public
1785
1900
  * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
1786
1901
  * logs will be delivered.</p>
1787
1902
  */
1788
1903
  CloudWatchLogsLogGroupArn?: string;
1789
1904
  /**
1905
+ * @public
1790
1906
  * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
1791
1907
  * log group.</p>
1792
1908
  */
1793
1909
  CloudWatchLogsRoleArn?: string;
1794
1910
  /**
1911
+ * @public
1795
1912
  * <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
1796
1913
  * following format.</p>
1797
1914
  * <p>
@@ -1800,6 +1917,7 @@ export interface CreateTrailResponse {
1800
1917
  */
1801
1918
  KmsKeyId?: string;
1802
1919
  /**
1920
+ * @public
1803
1921
  * <p>Specifies whether the trail is an organization trail.</p>
1804
1922
  */
1805
1923
  IsOrganizationTrail?: boolean;
@@ -1812,6 +1930,7 @@ export declare class InsufficientS3BucketPolicyException extends __BaseException
1812
1930
  readonly name: "InsufficientS3BucketPolicyException";
1813
1931
  readonly $fault: "client";
1814
1932
  /**
1933
+ * @public
1815
1934
  * <p>Brief description of the exception returned by the request.</p>
1816
1935
  */
1817
1936
  Message?: string;
@@ -1829,6 +1948,7 @@ export declare class InsufficientSnsTopicPolicyException extends __BaseException
1829
1948
  readonly name: "InsufficientSnsTopicPolicyException";
1830
1949
  readonly $fault: "client";
1831
1950
  /**
1951
+ * @public
1832
1952
  * <p>Brief description of the exception returned by the request.</p>
1833
1953
  */
1834
1954
  Message?: string;
@@ -1846,6 +1966,7 @@ export declare class InvalidCloudWatchLogsLogGroupArnException extends __BaseExc
1846
1966
  readonly name: "InvalidCloudWatchLogsLogGroupArnException";
1847
1967
  readonly $fault: "client";
1848
1968
  /**
1969
+ * @public
1849
1970
  * <p>Brief description of the exception returned by the request.</p>
1850
1971
  */
1851
1972
  Message?: string;
@@ -1862,6 +1983,7 @@ export declare class InvalidCloudWatchLogsRoleArnException extends __BaseExcepti
1862
1983
  readonly name: "InvalidCloudWatchLogsRoleArnException";
1863
1984
  readonly $fault: "client";
1864
1985
  /**
1986
+ * @public
1865
1987
  * <p>Brief description of the exception returned by the request.</p>
1866
1988
  */
1867
1989
  Message?: string;
@@ -1879,6 +2001,7 @@ export declare class InvalidParameterCombinationException extends __BaseExceptio
1879
2001
  readonly name: "InvalidParameterCombinationException";
1880
2002
  readonly $fault: "client";
1881
2003
  /**
2004
+ * @public
1882
2005
  * <p>Brief description of the exception returned by the request.</p>
1883
2006
  */
1884
2007
  Message?: string;
@@ -1895,6 +2018,7 @@ export declare class InvalidS3BucketNameException extends __BaseException {
1895
2018
  readonly name: "InvalidS3BucketNameException";
1896
2019
  readonly $fault: "client";
1897
2020
  /**
2021
+ * @public
1898
2022
  * <p>Brief description of the exception returned by the request.</p>
1899
2023
  */
1900
2024
  Message?: string;
@@ -1911,6 +2035,7 @@ export declare class InvalidS3PrefixException extends __BaseException {
1911
2035
  readonly name: "InvalidS3PrefixException";
1912
2036
  readonly $fault: "client";
1913
2037
  /**
2038
+ * @public
1914
2039
  * <p>Brief description of the exception returned by the request.</p>
1915
2040
  */
1916
2041
  Message?: string;
@@ -1927,6 +2052,7 @@ export declare class InvalidSnsTopicNameException extends __BaseException {
1927
2052
  readonly name: "InvalidSnsTopicNameException";
1928
2053
  readonly $fault: "client";
1929
2054
  /**
2055
+ * @public
1930
2056
  * <p>Brief description of the exception returned by the request.</p>
1931
2057
  */
1932
2058
  Message?: string;
@@ -1945,6 +2071,7 @@ export declare class KmsKeyDisabledException extends __BaseException {
1945
2071
  readonly name: "KmsKeyDisabledException";
1946
2072
  readonly $fault: "client";
1947
2073
  /**
2074
+ * @public
1948
2075
  * <p>Brief description of the exception returned by the request.</p>
1949
2076
  */
1950
2077
  Message?: string;
@@ -1961,6 +2088,7 @@ export declare class MaximumNumberOfTrailsExceededException extends __BaseExcept
1961
2088
  readonly name: "MaximumNumberOfTrailsExceededException";
1962
2089
  readonly $fault: "client";
1963
2090
  /**
2091
+ * @public
1964
2092
  * <p>Brief description of the exception returned by the request.</p>
1965
2093
  */
1966
2094
  Message?: string;
@@ -1977,6 +2105,7 @@ export declare class S3BucketDoesNotExistException extends __BaseException {
1977
2105
  readonly name: "S3BucketDoesNotExistException";
1978
2106
  readonly $fault: "client";
1979
2107
  /**
2108
+ * @public
1980
2109
  * <p>Brief description of the exception returned by the request.</p>
1981
2110
  */
1982
2111
  Message?: string;
@@ -1993,6 +2122,7 @@ export declare class TrailAlreadyExistsException extends __BaseException {
1993
2122
  readonly name: "TrailAlreadyExistsException";
1994
2123
  readonly $fault: "client";
1995
2124
  /**
2125
+ * @public
1996
2126
  * <p>Brief description of the exception returned by the request.</p>
1997
2127
  */
1998
2128
  Message?: string;
@@ -2009,6 +2139,7 @@ export declare class TrailNotProvidedException extends __BaseException {
2009
2139
  readonly name: "TrailNotProvidedException";
2010
2140
  readonly $fault: "client";
2011
2141
  /**
2142
+ * @public
2012
2143
  * <p>Brief description of the exception returned by the request.</p>
2013
2144
  */
2014
2145
  Message?: string;
@@ -2022,6 +2153,7 @@ export declare class TrailNotProvidedException extends __BaseException {
2022
2153
  */
2023
2154
  export interface DeleteChannelRequest {
2024
2155
  /**
2156
+ * @public
2025
2157
  * <p>The ARN or the <code>UUID</code> value of the channel that you want to delete.</p>
2026
2158
  */
2027
2159
  Channel: string | undefined;
@@ -2036,6 +2168,7 @@ export interface DeleteChannelResponse {
2036
2168
  */
2037
2169
  export interface DeleteEventDataStoreRequest {
2038
2170
  /**
2171
+ * @public
2039
2172
  * <p>The ARN (or the ID suffix of the ARN) of the event data store to delete.</p>
2040
2173
  */
2041
2174
  EventDataStore: string | undefined;
@@ -2054,6 +2187,7 @@ export declare class EventDataStoreHasOngoingImportException extends __BaseExcep
2054
2187
  readonly name: "EventDataStoreHasOngoingImportException";
2055
2188
  readonly $fault: "client";
2056
2189
  /**
2190
+ * @public
2057
2191
  * <p>Brief description of the exception returned by the request.</p>
2058
2192
  */
2059
2193
  Message?: string;
@@ -2071,6 +2205,7 @@ export declare class EventDataStoreTerminationProtectedException extends __BaseE
2071
2205
  readonly name: "EventDataStoreTerminationProtectedException";
2072
2206
  readonly $fault: "client";
2073
2207
  /**
2208
+ * @public
2074
2209
  * <p>Brief description of the exception returned by the request.</p>
2075
2210
  */
2076
2211
  Message?: string;
@@ -2084,6 +2219,7 @@ export declare class EventDataStoreTerminationProtectedException extends __BaseE
2084
2219
  */
2085
2220
  export interface DeleteResourcePolicyRequest {
2086
2221
  /**
2222
+ * @public
2087
2223
  * <p>
2088
2224
  * The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from.
2089
2225
  * The following is the format of a resource ARN:
@@ -2108,6 +2244,7 @@ export declare class ResourceARNNotValidException extends __BaseException {
2108
2244
  readonly name: "ResourceARNNotValidException";
2109
2245
  readonly $fault: "client";
2110
2246
  /**
2247
+ * @public
2111
2248
  * <p>Brief description of the exception returned by the request.</p>
2112
2249
  */
2113
2250
  Message?: string;
@@ -2126,6 +2263,7 @@ export declare class ResourcePolicyNotFoundException extends __BaseException {
2126
2263
  readonly name: "ResourcePolicyNotFoundException";
2127
2264
  readonly $fault: "client";
2128
2265
  /**
2266
+ * @public
2129
2267
  * <p>Brief description of the exception returned by the request.</p>
2130
2268
  */
2131
2269
  Message?: string;
@@ -2140,6 +2278,7 @@ export declare class ResourcePolicyNotFoundException extends __BaseException {
2140
2278
  */
2141
2279
  export interface DeleteTrailRequest {
2142
2280
  /**
2281
+ * @public
2143
2282
  * <p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The
2144
2283
  * following is the format of a trail ARN.
2145
2284
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
@@ -2163,6 +2302,7 @@ export declare class InvalidHomeRegionException extends __BaseException {
2163
2302
  readonly name: "InvalidHomeRegionException";
2164
2303
  readonly $fault: "client";
2165
2304
  /**
2305
+ * @public
2166
2306
  * <p>Brief description of the exception returned by the request.</p>
2167
2307
  */
2168
2308
  Message?: string;
@@ -2179,6 +2319,7 @@ export declare class TrailNotFoundException extends __BaseException {
2179
2319
  readonly name: "TrailNotFoundException";
2180
2320
  readonly $fault: "client";
2181
2321
  /**
2322
+ * @public
2182
2323
  * <p>Brief description of the exception returned by the request.</p>
2183
2324
  */
2184
2325
  Message?: string;
@@ -2195,6 +2336,7 @@ export declare class TrailNotFoundException extends __BaseException {
2195
2336
  */
2196
2337
  export interface DeregisterOrganizationDelegatedAdminRequest {
2197
2338
  /**
2339
+ * @public
2198
2340
  * <p>A delegated administrator account ID. This is a member account in an organization that
2199
2341
  * is currently designated as a delegated administrator.</p>
2200
2342
  */
@@ -2215,6 +2357,7 @@ export declare class NotOrganizationManagementAccountException extends __BaseExc
2215
2357
  readonly name: "NotOrganizationManagementAccountException";
2216
2358
  readonly $fault: "client";
2217
2359
  /**
2360
+ * @public
2218
2361
  * <p>Brief description of the exception returned by the request.</p>
2219
2362
  */
2220
2363
  Message?: string;
@@ -2228,6 +2371,7 @@ export declare class NotOrganizationManagementAccountException extends __BaseExc
2228
2371
  */
2229
2372
  export interface DescribeQueryRequest {
2230
2373
  /**
2374
+ * @public
2231
2375
  * @deprecated
2232
2376
  *
2233
2377
  * <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified
@@ -2235,10 +2379,12 @@ export interface DescribeQueryRequest {
2235
2379
  */
2236
2380
  EventDataStore?: string;
2237
2381
  /**
2382
+ * @public
2238
2383
  * <p>The query ID.</p>
2239
2384
  */
2240
2385
  QueryId?: string;
2241
2386
  /**
2387
+ * @public
2242
2388
  * <p>
2243
2389
  * The alias that identifies a query template.
2244
2390
  * </p>
@@ -2272,24 +2418,29 @@ export type DeliveryStatus = (typeof DeliveryStatus)[keyof typeof DeliveryStatus
2272
2418
  */
2273
2419
  export interface QueryStatisticsForDescribeQuery {
2274
2420
  /**
2421
+ * @public
2275
2422
  * <p>The number of events that matched a query.</p>
2276
2423
  */
2277
2424
  EventsMatched?: number;
2278
2425
  /**
2426
+ * @public
2279
2427
  * <p>The number of events that the query scanned in the event data store.</p>
2280
2428
  */
2281
2429
  EventsScanned?: number;
2282
2430
  /**
2431
+ * @public
2283
2432
  * <p>The total bytes that the query scanned in the event data store. This value matches the
2284
2433
  * number of bytes for which your account is billed for the query, unless the query is still
2285
2434
  * running.</p>
2286
2435
  */
2287
2436
  BytesScanned?: number;
2288
2437
  /**
2438
+ * @public
2289
2439
  * <p>The query's run time, in milliseconds.</p>
2290
2440
  */
2291
2441
  ExecutionTimeInMillis?: number;
2292
2442
  /**
2443
+ * @public
2293
2444
  * <p>The creation time of the query.</p>
2294
2445
  */
2295
2446
  CreationTime?: Date;
@@ -2299,14 +2450,17 @@ export interface QueryStatisticsForDescribeQuery {
2299
2450
  */
2300
2451
  export interface DescribeQueryResponse {
2301
2452
  /**
2453
+ * @public
2302
2454
  * <p>The ID of the query.</p>
2303
2455
  */
2304
2456
  QueryId?: string;
2305
2457
  /**
2458
+ * @public
2306
2459
  * <p>The SQL code of a query.</p>
2307
2460
  */
2308
2461
  QueryString?: string;
2309
2462
  /**
2463
+ * @public
2310
2464
  * <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>,
2311
2465
  * <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>,
2312
2466
  * <code>TIMED_OUT</code>, or <code>CANCELLED</code>
@@ -2314,21 +2468,25 @@ export interface DescribeQueryResponse {
2314
2468
  */
2315
2469
  QueryStatus?: QueryStatus | string;
2316
2470
  /**
2471
+ * @public
2317
2472
  * <p>Metadata about a query, including the number of events that were matched, the total
2318
2473
  * number of events scanned, the query run time in milliseconds, and the query's creation
2319
2474
  * time.</p>
2320
2475
  */
2321
2476
  QueryStatistics?: QueryStatisticsForDescribeQuery;
2322
2477
  /**
2478
+ * @public
2323
2479
  * <p>The error message returned if a query failed.</p>
2324
2480
  */
2325
2481
  ErrorMessage?: string;
2326
2482
  /**
2483
+ * @public
2327
2484
  * <p>The URI for the S3 bucket where CloudTrail delivered query results, if
2328
2485
  * applicable.</p>
2329
2486
  */
2330
2487
  DeliveryS3Uri?: string;
2331
2488
  /**
2489
+ * @public
2332
2490
  * <p>The delivery status.</p>
2333
2491
  */
2334
2492
  DeliveryStatus?: DeliveryStatus | string;
@@ -2339,6 +2497,7 @@ export interface DescribeQueryResponse {
2339
2497
  */
2340
2498
  export interface DescribeTrailsRequest {
2341
2499
  /**
2500
+ * @public
2342
2501
  * <p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The
2343
2502
  * format of a trail ARN is:</p>
2344
2503
  * <p>
@@ -2366,6 +2525,7 @@ export interface DescribeTrailsRequest {
2366
2525
  */
2367
2526
  trailNameList?: string[];
2368
2527
  /**
2528
+ * @public
2369
2529
  * <p>Specifies whether to include shadow trails in the response. A shadow trail is the
2370
2530
  * replication in a Region of a trail that was created in a different Region, or in the case
2371
2531
  * of an organization trail, the replication of an organization trail in member accounts. If
@@ -2380,29 +2540,34 @@ export interface DescribeTrailsRequest {
2380
2540
  */
2381
2541
  export interface Trail {
2382
2542
  /**
2543
+ * @public
2383
2544
  * <p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is
2384
2545
  * 128 characters.</p>
2385
2546
  */
2386
2547
  Name?: string;
2387
2548
  /**
2549
+ * @public
2388
2550
  * <p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail
2389
2551
  * files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
2390
2552
  * Bucket Naming Requirements</a>.</p>
2391
2553
  */
2392
2554
  S3BucketName?: string;
2393
2555
  /**
2556
+ * @public
2394
2557
  * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
2395
2558
  * 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
2396
2559
  * characters.</p>
2397
2560
  */
2398
2561
  S3KeyPrefix?: string;
2399
2562
  /**
2563
+ * @public
2400
2564
  * @deprecated
2401
2565
  *
2402
2566
  * <p>This field is no longer in use. Use <code>SnsTopicARN</code>.</p>
2403
2567
  */
2404
2568
  SnsTopicName?: string;
2405
2569
  /**
2570
+ * @public
2406
2571
  * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
2407
2572
  * notifications when log files are delivered. The following is the format of a topic
2408
2573
  * ARN.</p>
@@ -2412,19 +2577,23 @@ export interface Trail {
2412
2577
  */
2413
2578
  SnsTopicARN?: string;
2414
2579
  /**
2580
+ * @public
2415
2581
  * <p>Set to <b>True</b> to include Amazon Web Services API calls
2416
2582
  * from Amazon Web Services global services such as IAM. Otherwise, <b>False</b>.</p>
2417
2583
  */
2418
2584
  IncludeGlobalServiceEvents?: boolean;
2419
2585
  /**
2586
+ * @public
2420
2587
  * <p>Specifies whether the trail exists only in one Region or exists in all Regions.</p>
2421
2588
  */
2422
2589
  IsMultiRegionTrail?: boolean;
2423
2590
  /**
2591
+ * @public
2424
2592
  * <p>The Region in which the trail was created.</p>
2425
2593
  */
2426
2594
  HomeRegion?: string;
2427
2595
  /**
2596
+ * @public
2428
2597
  * <p>Specifies the ARN of the trail. The following is the format of a trail ARN.</p>
2429
2598
  * <p>
2430
2599
  * <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>
@@ -2432,20 +2601,24 @@ export interface Trail {
2432
2601
  */
2433
2602
  TrailARN?: string;
2434
2603
  /**
2604
+ * @public
2435
2605
  * <p>Specifies whether log file validation is enabled.</p>
2436
2606
  */
2437
2607
  LogFileValidationEnabled?: boolean;
2438
2608
  /**
2609
+ * @public
2439
2610
  * <p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log
2440
2611
  * group to which CloudTrail logs will be delivered.</p>
2441
2612
  */
2442
2613
  CloudWatchLogsLogGroupArn?: string;
2443
2614
  /**
2615
+ * @public
2444
2616
  * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
2445
2617
  * log group.</p>
2446
2618
  */
2447
2619
  CloudWatchLogsRoleArn?: string;
2448
2620
  /**
2621
+ * @public
2449
2622
  * <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
2450
2623
  * following format.</p>
2451
2624
  * <p>
@@ -2454,15 +2627,18 @@ export interface Trail {
2454
2627
  */
2455
2628
  KmsKeyId?: string;
2456
2629
  /**
2630
+ * @public
2457
2631
  * <p>Specifies if the trail has custom event selectors.</p>
2458
2632
  */
2459
2633
  HasCustomEventSelectors?: boolean;
2460
2634
  /**
2635
+ * @public
2461
2636
  * <p>Specifies whether a trail has insight types specified in an <code>InsightSelector</code>
2462
2637
  * list.</p>
2463
2638
  */
2464
2639
  HasInsightSelectors?: boolean;
2465
2640
  /**
2641
+ * @public
2466
2642
  * <p>Specifies whether the trail is an organization trail.</p>
2467
2643
  */
2468
2644
  IsOrganizationTrail?: boolean;
@@ -2474,6 +2650,7 @@ export interface Trail {
2474
2650
  */
2475
2651
  export interface DescribeTrailsResponse {
2476
2652
  /**
2653
+ * @public
2477
2654
  * <p>The list of trail objects. Trail objects with string values are only returned if values
2478
2655
  * for the objects exist in a trail's configuration. For example, <code>SNSTopicName</code>
2479
2656
  * and <code>SNSTopicARN</code> are only returned in results if a trail is configured to send
@@ -2488,6 +2665,7 @@ export interface DescribeTrailsResponse {
2488
2665
  */
2489
2666
  export interface GetChannelRequest {
2490
2667
  /**
2668
+ * @public
2491
2669
  * <p>The ARN or <code>UUID</code> of a channel.</p>
2492
2670
  */
2493
2671
  Channel: string | undefined;
@@ -2499,22 +2677,27 @@ export interface GetChannelRequest {
2499
2677
  */
2500
2678
  export interface IngestionStatus {
2501
2679
  /**
2680
+ * @public
2502
2681
  * <p>The time stamp of the most recent successful ingestion of events for the channel.</p>
2503
2682
  */
2504
2683
  LatestIngestionSuccessTime?: Date;
2505
2684
  /**
2685
+ * @public
2506
2686
  * <p>The event ID of the most recent successful ingestion of events.</p>
2507
2687
  */
2508
2688
  LatestIngestionSuccessEventID?: string;
2509
2689
  /**
2690
+ * @public
2510
2691
  * <p>The error code for the most recent failure to ingest events.</p>
2511
2692
  */
2512
2693
  LatestIngestionErrorCode?: string;
2513
2694
  /**
2695
+ * @public
2514
2696
  * <p>The time stamp of the most recent attempt to ingest events on the channel.</p>
2515
2697
  */
2516
2698
  LatestIngestionAttemptTime?: Date;
2517
2699
  /**
2700
+ * @public
2518
2701
  * <p>The event ID of the most recent attempt to ingest events.</p>
2519
2702
  */
2520
2703
  LatestIngestionAttemptEventID?: string;
@@ -2525,10 +2708,12 @@ export interface IngestionStatus {
2525
2708
  */
2526
2709
  export interface SourceConfig {
2527
2710
  /**
2711
+ * @public
2528
2712
  * <p> Specifies whether the channel applies to a single Region or to all Regions.</p>
2529
2713
  */
2530
2714
  ApplyToAllRegions?: boolean;
2531
2715
  /**
2716
+ * @public
2532
2717
  * <p> The advanced event selectors that are configured for the channel.</p>
2533
2718
  */
2534
2719
  AdvancedEventSelectors?: AdvancedEventSelector[];
@@ -2538,10 +2723,12 @@ export interface SourceConfig {
2538
2723
  */
2539
2724
  export interface GetChannelResponse {
2540
2725
  /**
2726
+ * @public
2541
2727
  * <p>The ARN of an channel returned by a <code>GetChannel</code> request.</p>
2542
2728
  */
2543
2729
  ChannelArn?: string;
2544
2730
  /**
2731
+ * @public
2545
2732
  * <p> The name of the CloudTrail channel. For service-linked channels, the name is
2546
2733
  * <code>aws-service-channel/service-name/custom-suffix</code> where
2547
2734
  * <code>service-name</code> represents the name of the Amazon Web Services service that
@@ -2550,21 +2737,25 @@ export interface GetChannelResponse {
2550
2737
  */
2551
2738
  Name?: string;
2552
2739
  /**
2740
+ * @public
2553
2741
  * <p>The source for the CloudTrail channel.</p>
2554
2742
  */
2555
2743
  Source?: string;
2556
2744
  /**
2745
+ * @public
2557
2746
  * <p> Provides information about the advanced event selectors configured for the channel, and
2558
2747
  * whether the channel applies to all Regions or a single Region. </p>
2559
2748
  */
2560
2749
  SourceConfig?: SourceConfig;
2561
2750
  /**
2751
+ * @public
2562
2752
  * <p>The destinations for the channel. For channels created for integrations,
2563
2753
  * the destinations are the event data stores that log events arriving through the channel.
2564
2754
  * For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.</p>
2565
2755
  */
2566
2756
  Destinations?: Destination[];
2567
2757
  /**
2758
+ * @public
2568
2759
  * <p>A table showing information about the most recent successful and failed attempts
2569
2760
  * to ingest events.</p>
2570
2761
  */
@@ -2575,6 +2766,7 @@ export interface GetChannelResponse {
2575
2766
  */
2576
2767
  export interface GetEventDataStoreRequest {
2577
2768
  /**
2769
+ * @public
2578
2770
  * <p>The ARN (or ID suffix of the ARN) of the event data store about which you want
2579
2771
  * information.</p>
2580
2772
  */
@@ -2585,50 +2777,61 @@ export interface GetEventDataStoreRequest {
2585
2777
  */
2586
2778
  export interface GetEventDataStoreResponse {
2587
2779
  /**
2780
+ * @public
2588
2781
  * <p>The event data store Amazon Resource Number (ARN).</p>
2589
2782
  */
2590
2783
  EventDataStoreArn?: string;
2591
2784
  /**
2785
+ * @public
2592
2786
  * <p>The name of the event data store.</p>
2593
2787
  */
2594
2788
  Name?: string;
2595
2789
  /**
2790
+ * @public
2596
2791
  * <p>The status of an event data store.</p>
2597
2792
  */
2598
2793
  Status?: EventDataStoreStatus | string;
2599
2794
  /**
2795
+ * @public
2600
2796
  * <p>The advanced event selectors used to select events for the data store.</p>
2601
2797
  */
2602
2798
  AdvancedEventSelectors?: AdvancedEventSelector[];
2603
2799
  /**
2800
+ * @public
2604
2801
  * <p>Indicates whether the event data store includes events from all Regions, or only from
2605
2802
  * the Region in which it was created.</p>
2606
2803
  */
2607
2804
  MultiRegionEnabled?: boolean;
2608
2805
  /**
2806
+ * @public
2609
2807
  * <p>Indicates whether an event data store is collecting logged events for an organization in
2610
2808
  * Organizations.</p>
2611
2809
  */
2612
2810
  OrganizationEnabled?: boolean;
2613
2811
  /**
2812
+ * @public
2614
2813
  * <p>The retention period of the event data store, in days.</p>
2615
2814
  */
2616
2815
  RetentionPeriod?: number;
2617
2816
  /**
2817
+ * @public
2618
2818
  * <p>Indicates that termination protection is enabled.</p>
2619
2819
  */
2620
2820
  TerminationProtectionEnabled?: boolean;
2621
2821
  /**
2822
+ * @public
2622
2823
  * <p>The timestamp of the event data store's creation.</p>
2623
2824
  */
2624
2825
  CreatedTimestamp?: Date;
2625
2826
  /**
2827
+ * @public
2626
2828
  * <p>Shows the time that an event data store was updated, if applicable.
2627
2829
  * <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
2628
2830
  * <code>CreatedTimestamp</code>.</p>
2629
2831
  */
2630
2832
  UpdatedTimestamp?: Date;
2631
2833
  /**
2834
+ * @public
2632
2835
  * <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
2633
2836
  * following format.</p>
2634
2837
  * <p>
@@ -2642,6 +2845,7 @@ export interface GetEventDataStoreResponse {
2642
2845
  */
2643
2846
  export interface GetEventSelectorsRequest {
2644
2847
  /**
2848
+ * @public
2645
2849
  * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
2646
2850
  * must meet the following requirements:</p>
2647
2851
  * <ul>
@@ -2734,6 +2938,7 @@ export interface GetEventSelectorsRequest {
2734
2938
  */
2735
2939
  export interface DataResource {
2736
2940
  /**
2941
+ * @public
2737
2942
  * <p>The resource type in which you want to log data events. You can specify the following
2738
2943
  * <i>basic</i> event selector resource types:</p>
2739
2944
  * <ul>
@@ -2842,6 +3047,7 @@ export interface DataResource {
2842
3047
  */
2843
3048
  Type?: string;
2844
3049
  /**
3050
+ * @public
2845
3051
  * <p>An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified
2846
3052
  * objects.</p>
2847
3053
  * <ul>
@@ -2917,6 +3123,7 @@ export type ReadWriteType = (typeof ReadWriteType)[keyof typeof ReadWriteType];
2917
3123
  */
2918
3124
  export interface EventSelector {
2919
3125
  /**
3126
+ * @public
2920
3127
  * <p>Specify if you want your trail to log read-only events, write-only events, or all. For
2921
3128
  * example, the EC2 <code>GetConsoleOutput</code> is a read-only API operation and
2922
3129
  * <code>RunInstances</code> is a write-only API operation.</p>
@@ -2924,6 +3131,7 @@ export interface EventSelector {
2924
3131
  */
2925
3132
  ReadWriteType?: ReadWriteType | string;
2926
3133
  /**
3134
+ * @public
2927
3135
  * <p>Specify if you want your event selector to include management events for your
2928
3136
  * trail.</p>
2929
3137
  * <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
@@ -2935,6 +3143,7 @@ export interface EventSelector {
2935
3143
  */
2936
3144
  IncludeManagementEvents?: boolean;
2937
3145
  /**
3146
+ * @public
2938
3147
  * <p>CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors.
2939
3148
  * You can specify up to 250 resources for an individual event selector, but the total number
2940
3149
  * of data resources cannot exceed 250 across all event selectors in a trail. This limit does
@@ -2945,6 +3154,7 @@ export interface EventSelector {
2945
3154
  */
2946
3155
  DataResources?: DataResource[];
2947
3156
  /**
3157
+ * @public
2948
3158
  * <p>An optional list of service event sources from which you do not want management events
2949
3159
  * to be logged on your trail. In this release, the list can be empty (disables the filter),
2950
3160
  * or it can filter out Key Management Service or Amazon RDS Data API events by
@@ -2960,14 +3170,17 @@ export interface EventSelector {
2960
3170
  */
2961
3171
  export interface GetEventSelectorsResponse {
2962
3172
  /**
3173
+ * @public
2963
3174
  * <p>The specified trail ARN that has the event selectors.</p>
2964
3175
  */
2965
3176
  TrailARN?: string;
2966
3177
  /**
3178
+ * @public
2967
3179
  * <p>The event selectors that are configured for the trail.</p>
2968
3180
  */
2969
3181
  EventSelectors?: EventSelector[];
2970
3182
  /**
3183
+ * @public
2971
3184
  * <p> The advanced event selectors that are configured for the trail. </p>
2972
3185
  */
2973
3186
  AdvancedEventSelectors?: AdvancedEventSelector[];
@@ -2977,6 +3190,7 @@ export interface GetEventSelectorsResponse {
2977
3190
  */
2978
3191
  export interface GetImportRequest {
2979
3192
  /**
3193
+ * @public
2980
3194
  * <p> The ID for the import. </p>
2981
3195
  */
2982
3196
  ImportId: string | undefined;
@@ -2987,14 +3201,17 @@ export interface GetImportRequest {
2987
3201
  */
2988
3202
  export interface S3ImportSource {
2989
3203
  /**
3204
+ * @public
2990
3205
  * <p> The URI for the source S3 bucket. </p>
2991
3206
  */
2992
3207
  S3LocationUri: string | undefined;
2993
3208
  /**
3209
+ * @public
2994
3210
  * <p> The Region associated with the source S3 bucket. </p>
2995
3211
  */
2996
3212
  S3BucketRegion: string | undefined;
2997
3213
  /**
3214
+ * @public
2998
3215
  * <p> The IAM ARN role used to access the source S3 bucket. </p>
2999
3216
  */
3000
3217
  S3BucketAccessRoleArn: string | undefined;
@@ -3005,6 +3222,7 @@ export interface S3ImportSource {
3005
3222
  */
3006
3223
  export interface ImportSource {
3007
3224
  /**
3225
+ * @public
3008
3226
  * <p> The source S3 bucket. </p>
3009
3227
  */
3010
3228
  S3: S3ImportSource | undefined;
@@ -3017,22 +3235,27 @@ export interface ImportSource {
3017
3235
  */
3018
3236
  export interface ImportStatistics {
3019
3237
  /**
3238
+ * @public
3020
3239
  * <p> The number of S3 prefixes found for the import. </p>
3021
3240
  */
3022
3241
  PrefixesFound?: number;
3023
3242
  /**
3243
+ * @public
3024
3244
  * <p> The number of S3 prefixes that completed import. </p>
3025
3245
  */
3026
3246
  PrefixesCompleted?: number;
3027
3247
  /**
3248
+ * @public
3028
3249
  * <p>The number of log files that completed import.</p>
3029
3250
  */
3030
3251
  FilesCompleted?: number;
3031
3252
  /**
3253
+ * @public
3032
3254
  * <p> The number of trail events imported into the event data store. </p>
3033
3255
  */
3034
3256
  EventsCompleted?: number;
3035
3257
  /**
3258
+ * @public
3036
3259
  * <p> The number of failed entries. </p>
3037
3260
  */
3038
3261
  FailedEntries?: number;
@@ -3057,42 +3280,51 @@ export type ImportStatus = (typeof ImportStatus)[keyof typeof ImportStatus];
3057
3280
  */
3058
3281
  export interface GetImportResponse {
3059
3282
  /**
3283
+ * @public
3060
3284
  * <p> The ID of the import. </p>
3061
3285
  */
3062
3286
  ImportId?: string;
3063
3287
  /**
3288
+ * @public
3064
3289
  * <p> The ARN of the destination event data store. </p>
3065
3290
  */
3066
3291
  Destinations?: string[];
3067
3292
  /**
3293
+ * @public
3068
3294
  * <p> The source S3 bucket. </p>
3069
3295
  */
3070
3296
  ImportSource?: ImportSource;
3071
3297
  /**
3298
+ * @public
3072
3299
  * <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
3073
3300
  * limit imported trail events to only those events logged within a specified time period.
3074
3301
  * </p>
3075
3302
  */
3076
3303
  StartEventTime?: Date;
3077
3304
  /**
3305
+ * @public
3078
3306
  * <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
3079
3307
  * limit imported trail events to only those events logged within a specified time period.
3080
3308
  * </p>
3081
3309
  */
3082
3310
  EndEventTime?: Date;
3083
3311
  /**
3312
+ * @public
3084
3313
  * <p> The status of the import. </p>
3085
3314
  */
3086
3315
  ImportStatus?: ImportStatus | string;
3087
3316
  /**
3317
+ * @public
3088
3318
  * <p> The timestamp of the import's creation. </p>
3089
3319
  */
3090
3320
  CreatedTimestamp?: Date;
3091
3321
  /**
3322
+ * @public
3092
3323
  * <p> The timestamp of when the import was updated. </p>
3093
3324
  */
3094
3325
  UpdatedTimestamp?: Date;
3095
3326
  /**
3327
+ * @public
3096
3328
  * <p> Provides statistics for the import. CloudTrail does not update import statistics
3097
3329
  * in real-time. Returned values for parameters such as <code>EventsCompleted</code> may be
3098
3330
  * lower than the actual value, because CloudTrail updates statistics incrementally
@@ -3108,6 +3340,7 @@ export declare class ImportNotFoundException extends __BaseException {
3108
3340
  readonly name: "ImportNotFoundException";
3109
3341
  readonly $fault: "client";
3110
3342
  /**
3343
+ * @public
3111
3344
  * <p>Brief description of the exception returned by the request.</p>
3112
3345
  */
3113
3346
  Message?: string;
@@ -3121,6 +3354,7 @@ export declare class ImportNotFoundException extends __BaseException {
3121
3354
  */
3122
3355
  export interface GetInsightSelectorsRequest {
3123
3356
  /**
3357
+ * @public
3124
3358
  * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
3125
3359
  * must meet the following requirements:</p>
3126
3360
  * <ul>
@@ -3167,6 +3401,7 @@ export type InsightType = (typeof InsightType)[keyof typeof InsightType];
3167
3401
  */
3168
3402
  export interface InsightSelector {
3169
3403
  /**
3404
+ * @public
3170
3405
  * <p>The type of Insights events to log on a trail. <code>ApiCallRateInsight</code> and
3171
3406
  * <code>ApiErrorRateInsight</code> are valid Insight types.</p>
3172
3407
  * <p>The <code>ApiCallRateInsight</code> Insights type analyzes write-only
@@ -3182,11 +3417,13 @@ export interface InsightSelector {
3182
3417
  */
3183
3418
  export interface GetInsightSelectorsResponse {
3184
3419
  /**
3420
+ * @public
3185
3421
  * <p>The Amazon Resource Name (ARN) of a trail for which you want to get Insights
3186
3422
  * selectors.</p>
3187
3423
  */
3188
3424
  TrailARN?: string;
3189
3425
  /**
3426
+ * @public
3190
3427
  * <p>A JSON string that contains the insight types you want to log on a trail. In this
3191
3428
  * release, <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code> are supported
3192
3429
  * as insight types.</p>
@@ -3203,6 +3440,7 @@ export declare class InsightNotEnabledException extends __BaseException {
3203
3440
  readonly name: "InsightNotEnabledException";
3204
3441
  readonly $fault: "client";
3205
3442
  /**
3443
+ * @public
3206
3444
  * <p>Brief description of the exception returned by the request.</p>
3207
3445
  */
3208
3446
  Message?: string;
@@ -3216,6 +3454,7 @@ export declare class InsightNotEnabledException extends __BaseException {
3216
3454
  */
3217
3455
  export interface GetQueryResultsRequest {
3218
3456
  /**
3457
+ * @public
3219
3458
  * @deprecated
3220
3459
  *
3221
3460
  * <p>The ARN (or ID suffix of the ARN) of the event data store against which the query was
@@ -3223,14 +3462,17 @@ export interface GetQueryResultsRequest {
3223
3462
  */
3224
3463
  EventDataStore?: string;
3225
3464
  /**
3465
+ * @public
3226
3466
  * <p>The ID of the query for which you want to get results.</p>
3227
3467
  */
3228
3468
  QueryId: string | undefined;
3229
3469
  /**
3470
+ * @public
3230
3471
  * <p>A token you can use to get the next page of query results.</p>
3231
3472
  */
3232
3473
  NextToken?: string;
3233
3474
  /**
3475
+ * @public
3234
3476
  * <p>The maximum number of query results to display on a single page.</p>
3235
3477
  */
3236
3478
  MaxQueryResults?: number;
@@ -3241,14 +3483,17 @@ export interface GetQueryResultsRequest {
3241
3483
  */
3242
3484
  export interface QueryStatistics {
3243
3485
  /**
3486
+ * @public
3244
3487
  * <p>The number of results returned.</p>
3245
3488
  */
3246
3489
  ResultsCount?: number;
3247
3490
  /**
3491
+ * @public
3248
3492
  * <p>The total number of results returned by a query.</p>
3249
3493
  */
3250
3494
  TotalResultsCount?: number;
3251
3495
  /**
3496
+ * @public
3252
3497
  * <p>The total bytes that the query scanned in the event data store. This value matches the
3253
3498
  * number of bytes for which your account is billed for the query, unless the query is still
3254
3499
  * running.</p>
@@ -3260,24 +3505,29 @@ export interface QueryStatistics {
3260
3505
  */
3261
3506
  export interface GetQueryResultsResponse {
3262
3507
  /**
3508
+ * @public
3263
3509
  * <p>The status of the query. Values include <code>QUEUED</code>, <code>RUNNING</code>,
3264
3510
  * <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
3265
3511
  * <code>CANCELLED</code>.</p>
3266
3512
  */
3267
3513
  QueryStatus?: QueryStatus | string;
3268
3514
  /**
3515
+ * @public
3269
3516
  * <p>Shows the count of query results.</p>
3270
3517
  */
3271
3518
  QueryStatistics?: QueryStatistics;
3272
3519
  /**
3520
+ * @public
3273
3521
  * <p>Contains the individual event results of the query.</p>
3274
3522
  */
3275
3523
  QueryResultRows?: Record<string, string>[][];
3276
3524
  /**
3525
+ * @public
3277
3526
  * <p>A token you can use to get the next page of query results.</p>
3278
3527
  */
3279
3528
  NextToken?: string;
3280
3529
  /**
3530
+ * @public
3281
3531
  * <p>The error message returned if a query failed.</p>
3282
3532
  */
3283
3533
  ErrorMessage?: string;
@@ -3290,6 +3540,7 @@ export declare class InvalidMaxResultsException extends __BaseException {
3290
3540
  readonly name: "InvalidMaxResultsException";
3291
3541
  readonly $fault: "client";
3292
3542
  /**
3543
+ * @public
3293
3544
  * <p>Brief description of the exception returned by the request.</p>
3294
3545
  */
3295
3546
  Message?: string;
@@ -3307,6 +3558,7 @@ export declare class InvalidNextTokenException extends __BaseException {
3307
3558
  readonly name: "InvalidNextTokenException";
3308
3559
  readonly $fault: "client";
3309
3560
  /**
3561
+ * @public
3310
3562
  * <p>Brief description of the exception returned by the request.</p>
3311
3563
  */
3312
3564
  Message?: string;
@@ -3320,6 +3572,7 @@ export declare class InvalidNextTokenException extends __BaseException {
3320
3572
  */
3321
3573
  export interface GetResourcePolicyRequest {
3322
3574
  /**
3575
+ * @public
3323
3576
  * <p>
3324
3577
  * The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
3325
3578
  * The following is the format of a resource ARN:
@@ -3333,12 +3586,14 @@ export interface GetResourcePolicyRequest {
3333
3586
  */
3334
3587
  export interface GetResourcePolicyResponse {
3335
3588
  /**
3589
+ * @public
3336
3590
  * <p>
3337
3591
  * The Amazon Resource Name (ARN) of the CloudTrail channel attached to resource-based policy.
3338
3592
  * </p>
3339
3593
  */
3340
3594
  ResourceArn?: string;
3341
3595
  /**
3596
+ * @public
3342
3597
  * <p>
3343
3598
  * A JSON-formatted string that contains the resource-based policy attached to the CloudTrail channel.
3344
3599
  * </p>
@@ -3350,6 +3605,7 @@ export interface GetResourcePolicyResponse {
3350
3605
  */
3351
3606
  export interface GetTrailRequest {
3352
3607
  /**
3608
+ * @public
3353
3609
  * <p>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve
3354
3610
  * settings information.</p>
3355
3611
  */
@@ -3360,6 +3616,7 @@ export interface GetTrailRequest {
3360
3616
  */
3361
3617
  export interface GetTrailResponse {
3362
3618
  /**
3619
+ * @public
3363
3620
  * <p>The settings for a trail.</p>
3364
3621
  */
3365
3622
  Trail?: Trail;
@@ -3370,6 +3627,7 @@ export interface GetTrailResponse {
3370
3627
  */
3371
3628
  export interface GetTrailStatusRequest {
3372
3629
  /**
3630
+ * @public
3373
3631
  * <p>Specifies the name or the CloudTrail ARN of the trail for which you are
3374
3632
  * requesting status. To get the status of a shadow trail (a replication of the trail in
3375
3633
  * another Region), you must specify its ARN. The following is the format of a trail
@@ -3387,11 +3645,13 @@ export interface GetTrailStatusRequest {
3387
3645
  */
3388
3646
  export interface GetTrailStatusResponse {
3389
3647
  /**
3648
+ * @public
3390
3649
  * <p>Whether the CloudTrail trail is currently logging Amazon Web Services API
3391
3650
  * calls.</p>
3392
3651
  */
3393
3652
  IsLogging?: boolean;
3394
3653
  /**
3654
+ * @public
3395
3655
  * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
3396
3656
  * 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
3397
3657
  * Responses</a> in the Amazon S3 API Reference. </p>
@@ -3404,6 +3664,7 @@ export interface GetTrailStatusResponse {
3404
3664
  */
3405
3665
  LatestDeliveryError?: string;
3406
3666
  /**
3667
+ * @public
3407
3668
  * <p>Displays any Amazon SNS error that CloudTrail encountered when attempting
3408
3669
  * to send a notification. For more information about Amazon SNS errors, see the
3409
3670
  * <a href="https://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon SNS
@@ -3411,41 +3672,49 @@ export interface GetTrailStatusResponse {
3411
3672
  */
3412
3673
  LatestNotificationError?: string;
3413
3674
  /**
3675
+ * @public
3414
3676
  * <p>Specifies the date and time that CloudTrail last delivered log files to an
3415
3677
  * account's Amazon S3 bucket.</p>
3416
3678
  */
3417
3679
  LatestDeliveryTime?: Date;
3418
3680
  /**
3681
+ * @public
3419
3682
  * <p>Specifies the date and time of the most recent Amazon SNS notification that
3420
3683
  * CloudTrail has written a new log file to an account's Amazon S3
3421
3684
  * bucket.</p>
3422
3685
  */
3423
3686
  LatestNotificationTime?: Date;
3424
3687
  /**
3688
+ * @public
3425
3689
  * <p>Specifies the most recent date and time when CloudTrail started recording API
3426
3690
  * calls for an Amazon Web Services account.</p>
3427
3691
  */
3428
3692
  StartLoggingTime?: Date;
3429
3693
  /**
3694
+ * @public
3430
3695
  * <p>Specifies the most recent date and time when CloudTrail stopped recording API
3431
3696
  * calls for an Amazon Web Services account.</p>
3432
3697
  */
3433
3698
  StopLoggingTime?: Date;
3434
3699
  /**
3700
+ * @public
3435
3701
  * <p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting
3436
3702
  * to deliver logs to CloudWatch Logs.</p>
3437
3703
  */
3438
3704
  LatestCloudWatchLogsDeliveryError?: string;
3439
3705
  /**
3706
+ * @public
3440
3707
  * <p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>
3441
3708
  */
3442
3709
  LatestCloudWatchLogsDeliveryTime?: Date;
3443
3710
  /**
3711
+ * @public
3444
3712
  * <p>Specifies the date and time that CloudTrail last delivered a digest file to an
3445
3713
  * account's Amazon S3 bucket.</p>
3446
3714
  */
3447
3715
  LatestDigestDeliveryTime?: Date;
3448
3716
  /**
3717
+ * @public
3449
3718
  * <p>Displays any Amazon S3 error that CloudTrail encountered when attempting
3450
3719
  * 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
3451
3720
  * Responses</a> in the Amazon S3 API Reference. </p>
@@ -3458,26 +3727,32 @@ export interface GetTrailStatusResponse {
3458
3727
  */
3459
3728
  LatestDigestDeliveryError?: string;
3460
3729
  /**
3730
+ * @public
3461
3731
  * <p>This field is no longer in use.</p>
3462
3732
  */
3463
3733
  LatestDeliveryAttemptTime?: string;
3464
3734
  /**
3735
+ * @public
3465
3736
  * <p>This field is no longer in use.</p>
3466
3737
  */
3467
3738
  LatestNotificationAttemptTime?: string;
3468
3739
  /**
3740
+ * @public
3469
3741
  * <p>This field is no longer in use.</p>
3470
3742
  */
3471
3743
  LatestNotificationAttemptSucceeded?: string;
3472
3744
  /**
3745
+ * @public
3473
3746
  * <p>This field is no longer in use.</p>
3474
3747
  */
3475
3748
  LatestDeliveryAttemptSucceeded?: string;
3476
3749
  /**
3750
+ * @public
3477
3751
  * <p>This field is no longer in use.</p>
3478
3752
  */
3479
3753
  TimeLoggingStarted?: string;
3480
3754
  /**
3755
+ * @public
3481
3756
  * <p>This field is no longer in use.</p>
3482
3757
  */
3483
3758
  TimeLoggingStopped?: string;
@@ -3487,10 +3762,12 @@ export interface GetTrailStatusResponse {
3487
3762
  */
3488
3763
  export interface ListChannelsRequest {
3489
3764
  /**
3765
+ * @public
3490
3766
  * <p> The maximum number of CloudTrail channels to display on a single page. </p>
3491
3767
  */
3492
3768
  MaxResults?: number;
3493
3769
  /**
3770
+ * @public
3494
3771
  * <p>The token to use to get the next page of results after a previous API call. This token
3495
3772
  * must be passed in with the same parameters that were specified in the original call. For
3496
3773
  * example, if the original call specified an AttributeKey of 'Username' with a value of
@@ -3503,10 +3780,12 @@ export interface ListChannelsRequest {
3503
3780
  */
3504
3781
  export interface ListChannelsResponse {
3505
3782
  /**
3783
+ * @public
3506
3784
  * <p> The list of channels in the account. </p>
3507
3785
  */
3508
3786
  Channels?: Channel[];
3509
3787
  /**
3788
+ * @public
3510
3789
  * <p>The token to use to get the next page of results after a previous API call.</p>
3511
3790
  */
3512
3791
  NextToken?: string;
@@ -3516,10 +3795,12 @@ export interface ListChannelsResponse {
3516
3795
  */
3517
3796
  export interface ListEventDataStoresRequest {
3518
3797
  /**
3798
+ * @public
3519
3799
  * <p>A token you can use to get the next page of event data store results.</p>
3520
3800
  */
3521
3801
  NextToken?: string;
3522
3802
  /**
3803
+ * @public
3523
3804
  * <p>The maximum number of event data stores to display on a single page.</p>
3524
3805
  */
3525
3806
  MaxResults?: number;
@@ -3533,14 +3814,17 @@ export interface ListEventDataStoresRequest {
3533
3814
  */
3534
3815
  export interface EventDataStore {
3535
3816
  /**
3817
+ * @public
3536
3818
  * <p>The ARN of the event data store.</p>
3537
3819
  */
3538
3820
  EventDataStoreArn?: string;
3539
3821
  /**
3822
+ * @public
3540
3823
  * <p>The name of the event data store.</p>
3541
3824
  */
3542
3825
  Name?: string;
3543
3826
  /**
3827
+ * @public
3544
3828
  * @deprecated
3545
3829
  *
3546
3830
  * <p>Indicates whether the event data store is protected from
@@ -3548,12 +3832,14 @@ export interface EventDataStore {
3548
3832
  */
3549
3833
  TerminationProtectionEnabled?: boolean;
3550
3834
  /**
3835
+ * @public
3551
3836
  * @deprecated
3552
3837
  *
3553
3838
  * <p>The status of an event data store.</p>
3554
3839
  */
3555
3840
  Status?: EventDataStoreStatus | string;
3556
3841
  /**
3842
+ * @public
3557
3843
  * @deprecated
3558
3844
  *
3559
3845
  * <p>The advanced event selectors that were used to select
@@ -3561,6 +3847,7 @@ export interface EventDataStore {
3561
3847
  */
3562
3848
  AdvancedEventSelectors?: AdvancedEventSelector[];
3563
3849
  /**
3850
+ * @public
3564
3851
  * @deprecated
3565
3852
  *
3566
3853
  * <p>Indicates whether the event data store includes events
@@ -3568,6 +3855,7 @@ export interface EventDataStore {
3568
3855
  */
3569
3856
  MultiRegionEnabled?: boolean;
3570
3857
  /**
3858
+ * @public
3571
3859
  * @deprecated
3572
3860
  *
3573
3861
  * <p>Indicates that an event data store is collecting logged
@@ -3575,18 +3863,21 @@ export interface EventDataStore {
3575
3863
  */
3576
3864
  OrganizationEnabled?: boolean;
3577
3865
  /**
3866
+ * @public
3578
3867
  * @deprecated
3579
3868
  *
3580
3869
  * <p>The retention period, in days.</p>
3581
3870
  */
3582
3871
  RetentionPeriod?: number;
3583
3872
  /**
3873
+ * @public
3584
3874
  * @deprecated
3585
3875
  *
3586
3876
  * <p>The timestamp of the event data store's creation.</p>
3587
3877
  */
3588
3878
  CreatedTimestamp?: Date;
3589
3879
  /**
3880
+ * @public
3590
3881
  * @deprecated
3591
3882
  *
3592
3883
  * <p>The timestamp showing when an event data store was
@@ -3600,11 +3891,13 @@ export interface EventDataStore {
3600
3891
  */
3601
3892
  export interface ListEventDataStoresResponse {
3602
3893
  /**
3894
+ * @public
3603
3895
  * <p>Contains information about event data stores in the account, in the current
3604
3896
  * Region.</p>
3605
3897
  */
3606
3898
  EventDataStores?: EventDataStore[];
3607
3899
  /**
3900
+ * @public
3608
3901
  * <p>A token you can use to get the next page of results.</p>
3609
3902
  */
3610
3903
  NextToken?: string;
@@ -3614,14 +3907,17 @@ export interface ListEventDataStoresResponse {
3614
3907
  */
3615
3908
  export interface ListImportFailuresRequest {
3616
3909
  /**
3910
+ * @public
3617
3911
  * <p> The ID of the import. </p>
3618
3912
  */
3619
3913
  ImportId: string | undefined;
3620
3914
  /**
3915
+ * @public
3621
3916
  * <p> The maximum number of failures to display on a single page. </p>
3622
3917
  */
3623
3918
  MaxResults?: number;
3624
3919
  /**
3920
+ * @public
3625
3921
  * <p> A token you can use to get the next page of import failures. </p>
3626
3922
  */
3627
3923
  NextToken?: string;
@@ -3645,22 +3941,27 @@ export type ImportFailureStatus = (typeof ImportFailureStatus)[keyof typeof Impo
3645
3941
  */
3646
3942
  export interface ImportFailureListItem {
3647
3943
  /**
3944
+ * @public
3648
3945
  * <p> The location of the failure in the S3 bucket. </p>
3649
3946
  */
3650
3947
  Location?: string;
3651
3948
  /**
3949
+ * @public
3652
3950
  * <p> The status of the import. </p>
3653
3951
  */
3654
3952
  Status?: ImportFailureStatus | string;
3655
3953
  /**
3954
+ * @public
3656
3955
  * <p> The type of import error. </p>
3657
3956
  */
3658
3957
  ErrorType?: string;
3659
3958
  /**
3959
+ * @public
3660
3960
  * <p> Provides the reason the import failed. </p>
3661
3961
  */
3662
3962
  ErrorMessage?: string;
3663
3963
  /**
3964
+ * @public
3664
3965
  * <p> When the import was last updated. </p>
3665
3966
  */
3666
3967
  LastUpdatedTime?: Date;
@@ -3670,10 +3971,12 @@ export interface ImportFailureListItem {
3670
3971
  */
3671
3972
  export interface ListImportFailuresResponse {
3672
3973
  /**
3974
+ * @public
3673
3975
  * <p> Contains information about the import failures. </p>
3674
3976
  */
3675
3977
  Failures?: ImportFailureListItem[];
3676
3978
  /**
3979
+ * @public
3677
3980
  * <p> A token you can use to get the next page of results. </p>
3678
3981
  */
3679
3982
  NextToken?: string;
@@ -3683,18 +3986,22 @@ export interface ListImportFailuresResponse {
3683
3986
  */
3684
3987
  export interface ListImportsRequest {
3685
3988
  /**
3989
+ * @public
3686
3990
  * <p> The maximum number of imports to display on a single page. </p>
3687
3991
  */
3688
3992
  MaxResults?: number;
3689
3993
  /**
3994
+ * @public
3690
3995
  * <p> The ARN of the destination event data store. </p>
3691
3996
  */
3692
3997
  Destination?: string;
3693
3998
  /**
3999
+ * @public
3694
4000
  * <p> The status of the import. </p>
3695
4001
  */
3696
4002
  ImportStatus?: ImportStatus | string;
3697
4003
  /**
4004
+ * @public
3698
4005
  * <p> A token you can use to get the next page of import results. </p>
3699
4006
  */
3700
4007
  NextToken?: string;
@@ -3705,22 +4012,27 @@ export interface ListImportsRequest {
3705
4012
  */
3706
4013
  export interface ImportsListItem {
3707
4014
  /**
4015
+ * @public
3708
4016
  * <p> The ID of the import. </p>
3709
4017
  */
3710
4018
  ImportId?: string;
3711
4019
  /**
4020
+ * @public
3712
4021
  * <p> The status of the import. </p>
3713
4022
  */
3714
4023
  ImportStatus?: ImportStatus | string;
3715
4024
  /**
4025
+ * @public
3716
4026
  * <p> The ARN of the destination event data store. </p>
3717
4027
  */
3718
4028
  Destinations?: string[];
3719
4029
  /**
4030
+ * @public
3720
4031
  * <p> The timestamp of the import's creation. </p>
3721
4032
  */
3722
4033
  CreatedTimestamp?: Date;
3723
4034
  /**
4035
+ * @public
3724
4036
  * <p> The timestamp of the import's last update. </p>
3725
4037
  */
3726
4038
  UpdatedTimestamp?: Date;
@@ -3730,10 +4042,12 @@ export interface ImportsListItem {
3730
4042
  */
3731
4043
  export interface ListImportsResponse {
3732
4044
  /**
4045
+ * @public
3733
4046
  * <p> The list of returned imports. </p>
3734
4047
  */
3735
4048
  Imports?: ImportsListItem[];
3736
4049
  /**
4050
+ * @public
3737
4051
  * <p> A token you can use to get the next page of import results. </p>
3738
4052
  */
3739
4053
  NextToken?: string;
@@ -3747,6 +4061,7 @@ export declare class InvalidTimeRangeException extends __BaseException {
3747
4061
  readonly name: "InvalidTimeRangeException";
3748
4062
  readonly $fault: "client";
3749
4063
  /**
4064
+ * @public
3750
4065
  * <p>Brief description of the exception returned by the request.</p>
3751
4066
  */
3752
4067
  Message?: string;
@@ -3763,6 +4078,7 @@ export declare class InvalidTokenException extends __BaseException {
3763
4078
  readonly name: "InvalidTokenException";
3764
4079
  readonly $fault: "client";
3765
4080
  /**
4081
+ * @public
3766
4082
  * <p>Brief description of the exception returned by the request.</p>
3767
4083
  */
3768
4084
  Message?: string;
@@ -3777,17 +4093,20 @@ export declare class InvalidTokenException extends __BaseException {
3777
4093
  */
3778
4094
  export interface ListPublicKeysRequest {
3779
4095
  /**
4096
+ * @public
3780
4097
  * <p>Optionally specifies, in UTC, the start of the time range to look up public keys for
3781
4098
  * CloudTrail digest files. If not specified, the current time is used, and the
3782
4099
  * current public key is returned.</p>
3783
4100
  */
3784
4101
  StartTime?: Date;
3785
4102
  /**
4103
+ * @public
3786
4104
  * <p>Optionally specifies, in UTC, the end of the time range to look up public keys for
3787
4105
  * CloudTrail digest files. If not specified, the current time is used.</p>
3788
4106
  */
3789
4107
  EndTime?: Date;
3790
4108
  /**
4109
+ * @public
3791
4110
  * <p>Reserved for future use.</p>
3792
4111
  */
3793
4112
  NextToken?: string;
@@ -3798,18 +4117,22 @@ export interface ListPublicKeysRequest {
3798
4117
  */
3799
4118
  export interface PublicKey {
3800
4119
  /**
4120
+ * @public
3801
4121
  * <p>The DER encoded public key value in PKCS#1 format.</p>
3802
4122
  */
3803
4123
  Value?: Uint8Array;
3804
4124
  /**
4125
+ * @public
3805
4126
  * <p>The starting time of validity of the public key.</p>
3806
4127
  */
3807
4128
  ValidityStartTime?: Date;
3808
4129
  /**
4130
+ * @public
3809
4131
  * <p>The ending time of validity of the public key.</p>
3810
4132
  */
3811
4133
  ValidityEndTime?: Date;
3812
4134
  /**
4135
+ * @public
3813
4136
  * <p>The fingerprint of the public key.</p>
3814
4137
  */
3815
4138
  Fingerprint?: string;
@@ -3821,6 +4144,7 @@ export interface PublicKey {
3821
4144
  */
3822
4145
  export interface ListPublicKeysResponse {
3823
4146
  /**
4147
+ * @public
3824
4148
  * <p>Contains an array of PublicKey objects.</p>
3825
4149
  * <note>
3826
4150
  * <p>The returned public keys may have validity time ranges that overlap.</p>
@@ -3828,6 +4152,7 @@ export interface ListPublicKeysResponse {
3828
4152
  */
3829
4153
  PublicKeyList?: PublicKey[];
3830
4154
  /**
4155
+ * @public
3831
4156
  * <p>Reserved for future use.</p>
3832
4157
  */
3833
4158
  NextToken?: string;
@@ -3842,6 +4167,7 @@ export declare class InvalidDateRangeException extends __BaseException {
3842
4167
  readonly name: "InvalidDateRangeException";
3843
4168
  readonly $fault: "client";
3844
4169
  /**
4170
+ * @public
3845
4171
  * <p>Brief description of the exception returned by the request.</p>
3846
4172
  */
3847
4173
  Message?: string;
@@ -3858,6 +4184,7 @@ export declare class InvalidQueryStatusException extends __BaseException {
3858
4184
  readonly name: "InvalidQueryStatusException";
3859
4185
  readonly $fault: "client";
3860
4186
  /**
4187
+ * @public
3861
4188
  * <p>Brief description of the exception returned by the request.</p>
3862
4189
  */
3863
4190
  Message?: string;
@@ -3871,29 +4198,35 @@ export declare class InvalidQueryStatusException extends __BaseException {
3871
4198
  */
3872
4199
  export interface ListQueriesRequest {
3873
4200
  /**
4201
+ * @public
3874
4202
  * <p>The ARN (or the ID suffix of the ARN) of an event data store on which queries were
3875
4203
  * run.</p>
3876
4204
  */
3877
4205
  EventDataStore: string | undefined;
3878
4206
  /**
4207
+ * @public
3879
4208
  * <p>A token you can use to get the next page of results.</p>
3880
4209
  */
3881
4210
  NextToken?: string;
3882
4211
  /**
4212
+ * @public
3883
4213
  * <p>The maximum number of queries to show on a page.</p>
3884
4214
  */
3885
4215
  MaxResults?: number;
3886
4216
  /**
4217
+ * @public
3887
4218
  * <p>Use with <code>EndTime</code> to bound a <code>ListQueries</code> request, and limit its
3888
4219
  * results to only those queries run within a specified time period.</p>
3889
4220
  */
3890
4221
  StartTime?: Date;
3891
4222
  /**
4223
+ * @public
3892
4224
  * <p>Use with <code>StartTime</code> to bound a <code>ListQueries</code> request, and limit
3893
4225
  * its results to only those queries run within a specified time period.</p>
3894
4226
  */
3895
4227
  EndTime?: Date;
3896
4228
  /**
4229
+ * @public
3897
4230
  * <p>The status of queries that you want to return in results. Valid values for
3898
4231
  * <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>,
3899
4232
  * <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
@@ -3908,16 +4241,19 @@ export interface ListQueriesRequest {
3908
4241
  */
3909
4242
  export interface Query {
3910
4243
  /**
4244
+ * @public
3911
4245
  * <p>The ID of a query.</p>
3912
4246
  */
3913
4247
  QueryId?: string;
3914
4248
  /**
4249
+ * @public
3915
4250
  * <p>The status of the query. This can be <code>QUEUED</code>, <code>RUNNING</code>,
3916
4251
  * <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or
3917
4252
  * <code>CANCELLED</code>.</p>
3918
4253
  */
3919
4254
  QueryStatus?: QueryStatus | string;
3920
4255
  /**
4256
+ * @public
3921
4257
  * <p>The creation time of a query.</p>
3922
4258
  */
3923
4259
  CreationTime?: Date;
@@ -3927,11 +4263,13 @@ export interface Query {
3927
4263
  */
3928
4264
  export interface ListQueriesResponse {
3929
4265
  /**
4266
+ * @public
3930
4267
  * <p>Lists matching query results, and shows query ID, status, and creation time of each
3931
4268
  * query.</p>
3932
4269
  */
3933
4270
  Queries?: Query[];
3934
4271
  /**
4272
+ * @public
3935
4273
  * <p>A token you can use to get the next page of results.</p>
3936
4274
  */
3937
4275
  NextToken?: string;
@@ -3942,6 +4280,7 @@ export interface ListQueriesResponse {
3942
4280
  */
3943
4281
  export interface ListTagsRequest {
3944
4282
  /**
4283
+ * @public
3945
4284
  * <p>Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list
3946
4285
  * has a limit of 20 ARNs.</p>
3947
4286
  * <p> Example trail ARN format:
@@ -3956,6 +4295,7 @@ export interface ListTagsRequest {
3956
4295
  */
3957
4296
  ResourceIdList: string[] | undefined;
3958
4297
  /**
4298
+ * @public
3959
4299
  * <p>Reserved for future use.</p>
3960
4300
  */
3961
4301
  NextToken?: string;
@@ -3966,10 +4306,12 @@ export interface ListTagsRequest {
3966
4306
  */
3967
4307
  export interface ResourceTag {
3968
4308
  /**
4309
+ * @public
3969
4310
  * <p>Specifies the ARN of the resource.</p>
3970
4311
  */
3971
4312
  ResourceId?: string;
3972
4313
  /**
4314
+ * @public
3973
4315
  * <p>A list of tags.</p>
3974
4316
  */
3975
4317
  TagsList?: Tag[];
@@ -3981,10 +4323,12 @@ export interface ResourceTag {
3981
4323
  */
3982
4324
  export interface ListTagsResponse {
3983
4325
  /**
4326
+ * @public
3984
4327
  * <p>A list of resource tags.</p>
3985
4328
  */
3986
4329
  ResourceTagList?: ResourceTag[];
3987
4330
  /**
4331
+ * @public
3988
4332
  * <p>Reserved for future use.</p>
3989
4333
  */
3990
4334
  NextToken?: string;
@@ -3994,6 +4338,7 @@ export interface ListTagsResponse {
3994
4338
  */
3995
4339
  export interface ListTrailsRequest {
3996
4340
  /**
4341
+ * @public
3997
4342
  * <p>The token to use to get the next page of results after a previous API call. This token
3998
4343
  * must be passed in with the same parameters that were specified in the original call. For
3999
4344
  * example, if the original call specified an AttributeKey of 'Username' with a value of
@@ -4008,14 +4353,17 @@ export interface ListTrailsRequest {
4008
4353
  */
4009
4354
  export interface TrailInfo {
4010
4355
  /**
4356
+ * @public
4011
4357
  * <p>The ARN of a trail.</p>
4012
4358
  */
4013
4359
  TrailARN?: string;
4014
4360
  /**
4361
+ * @public
4015
4362
  * <p>The name of a trail.</p>
4016
4363
  */
4017
4364
  Name?: string;
4018
4365
  /**
4366
+ * @public
4019
4367
  * <p>The Amazon Web Services Region in which a trail was created.</p>
4020
4368
  */
4021
4369
  HomeRegion?: string;
@@ -4025,10 +4373,12 @@ export interface TrailInfo {
4025
4373
  */
4026
4374
  export interface ListTrailsResponse {
4027
4375
  /**
4376
+ * @public
4028
4377
  * <p>Returns the name, ARN, and home Region of trails in the current account.</p>
4029
4378
  */
4030
4379
  Trails?: TrailInfo[];
4031
4380
  /**
4381
+ * @public
4032
4382
  * <p>The token to use to get the next page of results after a previous API call. If the token
4033
4383
  * does not appear, there are no more results to return. The token must be passed in with the
4034
4384
  * same parameters as the previous call. For example, if the original call specified an
@@ -4046,6 +4396,7 @@ export declare class InvalidEventCategoryException extends __BaseException {
4046
4396
  readonly name: "InvalidEventCategoryException";
4047
4397
  readonly $fault: "client";
4048
4398
  /**
4399
+ * @public
4049
4400
  * <p>Brief description of the exception returned by the request.</p>
4050
4401
  */
4051
4402
  Message?: string;
@@ -4062,6 +4413,7 @@ export declare class InvalidLookupAttributesException extends __BaseException {
4062
4413
  readonly name: "InvalidLookupAttributesException";
4063
4414
  readonly $fault: "client";
4064
4415
  /**
4416
+ * @public
4065
4417
  * <p>Brief description of the exception returned by the request.</p>
4066
4418
  */
4067
4419
  Message?: string;
@@ -4105,10 +4457,12 @@ export type LookupAttributeKey = (typeof LookupAttributeKey)[keyof typeof Lookup
4105
4457
  */
4106
4458
  export interface LookupAttribute {
4107
4459
  /**
4460
+ * @public
4108
4461
  * <p>Specifies an attribute on which to filter the events returned.</p>
4109
4462
  */
4110
4463
  AttributeKey: LookupAttributeKey | string | undefined;
4111
4464
  /**
4465
+ * @public
4112
4466
  * <p>Specifies a value for the specified AttributeKey.</p>
4113
4467
  */
4114
4468
  AttributeValue: string | undefined;
@@ -4119,21 +4473,25 @@ export interface LookupAttribute {
4119
4473
  */
4120
4474
  export interface LookupEventsRequest {
4121
4475
  /**
4476
+ * @public
4122
4477
  * <p>Contains a list of lookup attributes. Currently the list can contain only one
4123
4478
  * item.</p>
4124
4479
  */
4125
4480
  LookupAttributes?: LookupAttribute[];
4126
4481
  /**
4482
+ * @public
4127
4483
  * <p>Specifies that only events that occur after or at the specified time are returned. If
4128
4484
  * the specified start time is after the specified end time, an error is returned.</p>
4129
4485
  */
4130
4486
  StartTime?: Date;
4131
4487
  /**
4488
+ * @public
4132
4489
  * <p>Specifies that only events that occur before or at the specified time are returned. If
4133
4490
  * the specified end time is before the specified start time, an error is returned.</p>
4134
4491
  */
4135
4492
  EndTime?: Date;
4136
4493
  /**
4494
+ * @public
4137
4495
  * <p>Specifies the event category. If you do not specify an event category, events of the
4138
4496
  * category are not returned in the response. For example, if you do not specify
4139
4497
  * <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are
@@ -4141,11 +4499,13 @@ export interface LookupEventsRequest {
4141
4499
  */
4142
4500
  EventCategory?: EventCategory | string;
4143
4501
  /**
4502
+ * @public
4144
4503
  * <p>The number of events to return. Possible values are 1 through 50. The default is
4145
4504
  * 50.</p>
4146
4505
  */
4147
4506
  MaxResults?: number;
4148
4507
  /**
4508
+ * @public
4149
4509
  * <p>The token to use to get the next page of results after a previous API call. This token
4150
4510
  * must be passed in with the same parameters that were specified in the original call. For
4151
4511
  * example, if the original call specified an AttributeKey of 'Username' with a value of
@@ -4159,12 +4519,14 @@ export interface LookupEventsRequest {
4159
4519
  */
4160
4520
  export interface Resource {
4161
4521
  /**
4522
+ * @public
4162
4523
  * <p>The type of a resource referenced by the event returned. When the resource type cannot
4163
4524
  * 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
4164
4525
  * 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>
4165
4526
  */
4166
4527
  ResourceType?: string;
4167
4528
  /**
4529
+ * @public
4168
4530
  * <p>The name of the resource referenced by the event returned. These are user-created names
4169
4531
  * whose values will depend on the environment. For example, the resource name might be
4170
4532
  * "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2
@@ -4179,41 +4541,50 @@ export interface Resource {
4179
4541
  */
4180
4542
  export interface Event {
4181
4543
  /**
4544
+ * @public
4182
4545
  * <p>The CloudTrail ID of the event returned.</p>
4183
4546
  */
4184
4547
  EventId?: string;
4185
4548
  /**
4549
+ * @public
4186
4550
  * <p>The name of the event returned.</p>
4187
4551
  */
4188
4552
  EventName?: string;
4189
4553
  /**
4554
+ * @public
4190
4555
  * <p>Information about whether the event is a write event or a read event. </p>
4191
4556
  */
4192
4557
  ReadOnly?: string;
4193
4558
  /**
4559
+ * @public
4194
4560
  * <p>The Amazon Web Services access key ID that was used to sign the request. If the request
4195
4561
  * was made with temporary security credentials, this is the access key ID of the temporary
4196
4562
  * credentials.</p>
4197
4563
  */
4198
4564
  AccessKeyId?: string;
4199
4565
  /**
4566
+ * @public
4200
4567
  * <p>The date and time of the event returned.</p>
4201
4568
  */
4202
4569
  EventTime?: Date;
4203
4570
  /**
4571
+ * @public
4204
4572
  * <p>The Amazon Web Services service to which the request was made.</p>
4205
4573
  */
4206
4574
  EventSource?: string;
4207
4575
  /**
4576
+ * @public
4208
4577
  * <p>A user name or role name of the requester that called the API in the event
4209
4578
  * returned.</p>
4210
4579
  */
4211
4580
  Username?: string;
4212
4581
  /**
4582
+ * @public
4213
4583
  * <p>A list of resources referenced by the event returned.</p>
4214
4584
  */
4215
4585
  Resources?: Resource[];
4216
4586
  /**
4587
+ * @public
4217
4588
  * <p>A JSON string that contains a representation of the event returned.</p>
4218
4589
  */
4219
4590
  CloudTrailEvent?: string;
@@ -4224,11 +4595,13 @@ export interface Event {
4224
4595
  */
4225
4596
  export interface LookupEventsResponse {
4226
4597
  /**
4598
+ * @public
4227
4599
  * <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
4228
4600
  * first.</p>
4229
4601
  */
4230
4602
  Events?: Event[];
4231
4603
  /**
4604
+ * @public
4232
4605
  * <p>The token to use to get the next page of results after a previous API call. If the token
4233
4606
  * does not appear, there are no more results to return. The token must be passed in with the
4234
4607
  * same parameters as the previous call. For example, if the original call specified an
@@ -4242,6 +4615,7 @@ export interface LookupEventsResponse {
4242
4615
  */
4243
4616
  export interface PutEventSelectorsRequest {
4244
4617
  /**
4618
+ * @public
4245
4619
  * <p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string
4246
4620
  * must meet the following requirements:</p>
4247
4621
  * <ul>
@@ -4270,6 +4644,7 @@ export interface PutEventSelectorsRequest {
4270
4644
  */
4271
4645
  TrailName: string | undefined;
4272
4646
  /**
4647
+ * @public
4273
4648
  * <p>Specifies the settings for your event selectors. You can configure up to five event
4274
4649
  * selectors for a trail. You can use either <code>EventSelectors</code> or
4275
4650
  * <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not
@@ -4278,6 +4653,7 @@ export interface PutEventSelectorsRequest {
4278
4653
  */
4279
4654
  EventSelectors?: EventSelector[];
4280
4655
  /**
4656
+ * @public
4281
4657
  * <p> Specifies the settings for advanced event selectors. You can add advanced event
4282
4658
  * selectors, and conditions for your advanced event selectors, up to a maximum of 500 values
4283
4659
  * for all conditions and selectors on a trail. You can use either
@@ -4293,6 +4669,7 @@ export interface PutEventSelectorsRequest {
4293
4669
  */
4294
4670
  export interface PutEventSelectorsResponse {
4295
4671
  /**
4672
+ * @public
4296
4673
  * <p>Specifies the ARN of the trail that was updated with event selectors. The following is
4297
4674
  * the format of a trail ARN.</p>
4298
4675
  * <p>
@@ -4301,10 +4678,12 @@ export interface PutEventSelectorsResponse {
4301
4678
  */
4302
4679
  TrailARN?: string;
4303
4680
  /**
4681
+ * @public
4304
4682
  * <p>Specifies the event selectors configured for your trail.</p>
4305
4683
  */
4306
4684
  EventSelectors?: EventSelector[];
4307
4685
  /**
4686
+ * @public
4308
4687
  * <p>Specifies the advanced event selectors configured for your trail.</p>
4309
4688
  */
4310
4689
  AdvancedEventSelectors?: AdvancedEventSelector[];
@@ -4320,6 +4699,7 @@ export declare class InvalidInsightSelectorsException extends __BaseException {
4320
4699
  readonly name: "InvalidInsightSelectorsException";
4321
4700
  readonly $fault: "client";
4322
4701
  /**
4702
+ * @public
4323
4703
  * <p>Brief description of the exception returned by the request.</p>
4324
4704
  */
4325
4705
  Message?: string;
@@ -4333,11 +4713,13 @@ export declare class InvalidInsightSelectorsException extends __BaseException {
4333
4713
  */
4334
4714
  export interface PutInsightSelectorsRequest {
4335
4715
  /**
4716
+ * @public
4336
4717
  * <p>The name of the CloudTrail trail for which you want to change or add Insights
4337
4718
  * selectors.</p>
4338
4719
  */
4339
4720
  TrailName: string | undefined;
4340
4721
  /**
4722
+ * @public
4341
4723
  * <p>A JSON string that contains the insight types you want to log on a trail.
4342
4724
  * <code>ApiCallRateInsight</code> and <code>ApiErrorRateInsight</code> are valid Insight
4343
4725
  * types.</p>
@@ -4354,11 +4736,13 @@ export interface PutInsightSelectorsRequest {
4354
4736
  */
4355
4737
  export interface PutInsightSelectorsResponse {
4356
4738
  /**
4739
+ * @public
4357
4740
  * <p>The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights
4358
4741
  * selectors.</p>
4359
4742
  */
4360
4743
  TrailARN?: string;
4361
4744
  /**
4745
+ * @public
4362
4746
  * <p>A JSON string that contains the Insights event types that you want to log on a trail.
4363
4747
  * The valid Insights types in this release are <code>ApiErrorRateInsight</code> and
4364
4748
  * <code>ApiCallRateInsight</code>.</p>
@@ -4370,6 +4754,7 @@ export interface PutInsightSelectorsResponse {
4370
4754
  */
4371
4755
  export interface PutResourcePolicyRequest {
4372
4756
  /**
4757
+ * @public
4373
4758
  * <p>
4374
4759
  * The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
4375
4760
  * The following is the format of a resource ARN:
@@ -4378,6 +4763,7 @@ export interface PutResourcePolicyRequest {
4378
4763
  */
4379
4764
  ResourceArn: string | undefined;
4380
4765
  /**
4766
+ * @public
4381
4767
  * <p>
4382
4768
  * A JSON-formatted string for an Amazon Web Services resource-based policy.
4383
4769
  * </p>
@@ -4407,12 +4793,14 @@ export interface PutResourcePolicyRequest {
4407
4793
  */
4408
4794
  export interface PutResourcePolicyResponse {
4409
4795
  /**
4796
+ * @public
4410
4797
  * <p>
4411
4798
  * The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.
4412
4799
  * </p>
4413
4800
  */
4414
4801
  ResourceArn?: string;
4415
4802
  /**
4803
+ * @public
4416
4804
  * <p>
4417
4805
  * The JSON-formatted string of the Amazon Web Services resource-based policy attached to the CloudTrail channel.
4418
4806
  * </p>
@@ -4447,6 +4835,7 @@ export declare class ResourcePolicyNotValidException extends __BaseException {
4447
4835
  readonly name: "ResourcePolicyNotValidException";
4448
4836
  readonly $fault: "client";
4449
4837
  /**
4838
+ * @public
4450
4839
  * <p>Brief description of the exception returned by the request.</p>
4451
4840
  */
4452
4841
  Message?: string;
@@ -4464,6 +4853,7 @@ export declare class DelegatedAdminAccountLimitExceededException extends __BaseE
4464
4853
  readonly name: "DelegatedAdminAccountLimitExceededException";
4465
4854
  readonly $fault: "client";
4466
4855
  /**
4856
+ * @public
4467
4857
  * <p>Brief description of the exception returned by the request.</p>
4468
4858
  */
4469
4859
  Message?: string;
@@ -4479,6 +4869,7 @@ export declare class DelegatedAdminAccountLimitExceededException extends __BaseE
4479
4869
  */
4480
4870
  export interface RegisterOrganizationDelegatedAdminRequest {
4481
4871
  /**
4872
+ * @public
4482
4873
  * <p>An organization member account ID that you want to designate as a delegated
4483
4874
  * administrator.</p>
4484
4875
  */
@@ -4496,6 +4887,7 @@ export interface RegisterOrganizationDelegatedAdminResponse {
4496
4887
  */
4497
4888
  export interface RemoveTagsRequest {
4498
4889
  /**
4890
+ * @public
4499
4891
  * <p>Specifies the ARN of the trail, event data store, or channel from which tags should be
4500
4892
  * removed.</p>
4501
4893
  * <p> Example trail ARN format:
@@ -4510,6 +4902,7 @@ export interface RemoveTagsRequest {
4510
4902
  */
4511
4903
  ResourceId: string | undefined;
4512
4904
  /**
4905
+ * @public
4513
4906
  * <p>Specifies a list of tags to be removed.</p>
4514
4907
  */
4515
4908
  TagsList: Tag[] | undefined;
@@ -4529,6 +4922,7 @@ export declare class InvalidEventDataStoreStatusException extends __BaseExceptio
4529
4922
  readonly name: "InvalidEventDataStoreStatusException";
4530
4923
  readonly $fault: "client";
4531
4924
  /**
4925
+ * @public
4532
4926
  * <p>Brief description of the exception returned by the request.</p>
4533
4927
  */
4534
4928
  Message?: string;
@@ -4542,6 +4936,7 @@ export declare class InvalidEventDataStoreStatusException extends __BaseExceptio
4542
4936
  */
4543
4937
  export interface RestoreEventDataStoreRequest {
4544
4938
  /**
4939
+ * @public
4545
4940
  * <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
4546
4941
  * restore.</p>
4547
4942
  */
@@ -4552,51 +4947,62 @@ export interface RestoreEventDataStoreRequest {
4552
4947
  */
4553
4948
  export interface RestoreEventDataStoreResponse {
4554
4949
  /**
4950
+ * @public
4555
4951
  * <p>The event data store ARN.</p>
4556
4952
  */
4557
4953
  EventDataStoreArn?: string;
4558
4954
  /**
4955
+ * @public
4559
4956
  * <p>The name of the event data store.</p>
4560
4957
  */
4561
4958
  Name?: string;
4562
4959
  /**
4960
+ * @public
4563
4961
  * <p>The status of the event data store.</p>
4564
4962
  */
4565
4963
  Status?: EventDataStoreStatus | string;
4566
4964
  /**
4965
+ * @public
4567
4966
  * <p>The advanced event selectors that were used to select events.</p>
4568
4967
  */
4569
4968
  AdvancedEventSelectors?: AdvancedEventSelector[];
4570
4969
  /**
4970
+ * @public
4571
4971
  * <p>Indicates whether the event data store is collecting events from all Regions, or only
4572
4972
  * from the Region in which the event data store was created.</p>
4573
4973
  */
4574
4974
  MultiRegionEnabled?: boolean;
4575
4975
  /**
4976
+ * @public
4576
4977
  * <p>Indicates whether an event data store is collecting logged events for an organization in
4577
4978
  * Organizations.</p>
4578
4979
  */
4579
4980
  OrganizationEnabled?: boolean;
4580
4981
  /**
4982
+ * @public
4581
4983
  * <p>The retention period, in days.</p>
4582
4984
  */
4583
4985
  RetentionPeriod?: number;
4584
4986
  /**
4987
+ * @public
4585
4988
  * <p>Indicates that termination protection is enabled and the event data store cannot be
4586
4989
  * automatically deleted.</p>
4587
4990
  */
4588
4991
  TerminationProtectionEnabled?: boolean;
4589
4992
  /**
4993
+ * @public
4590
4994
  * <p>The timestamp of an event data store's creation.</p>
4591
4995
  */
4592
4996
  CreatedTimestamp?: Date;
4593
4997
  /**
4998
+ * @public
4594
4999
  * <p>The timestamp that shows when an event data store was updated, if applicable.
4595
5000
  * <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
4596
5001
  * <code>CreatedTimestamp</code>.</p>
4597
5002
  */
4598
5003
  UpdatedTimestamp?: Date;
4599
5004
  /**
5005
+ * @public
4600
5006
  * <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
4601
5007
  * following format.</p>
4602
5008
  * <p>
@@ -4610,6 +5016,7 @@ export interface RestoreEventDataStoreResponse {
4610
5016
  */
4611
5017
  export interface StartEventDataStoreIngestionRequest {
4612
5018
  /**
5019
+ * @public
4613
5020
  * <p>The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.</p>
4614
5021
  */
4615
5022
  EventDataStore: string | undefined;
@@ -4628,6 +5035,7 @@ export declare class InvalidImportSourceException extends __BaseException {
4628
5035
  readonly name: "InvalidImportSourceException";
4629
5036
  readonly $fault: "client";
4630
5037
  /**
5038
+ * @public
4631
5039
  * <p>Brief description of the exception returned by the request.</p>
4632
5040
  */
4633
5041
  Message?: string;
@@ -4641,15 +5049,18 @@ export declare class InvalidImportSourceException extends __BaseException {
4641
5049
  */
4642
5050
  export interface StartImportRequest {
4643
5051
  /**
5052
+ * @public
4644
5053
  * <p> The ARN of the destination event data store. Use this parameter for a new import.
4645
5054
  * </p>
4646
5055
  */
4647
5056
  Destinations?: string[];
4648
5057
  /**
5058
+ * @public
4649
5059
  * <p> The source S3 bucket for the import. Use this parameter for a new import. </p>
4650
5060
  */
4651
5061
  ImportSource?: ImportSource;
4652
5062
  /**
5063
+ * @public
4653
5064
  * <p> Use with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
4654
5065
  * limit imported trail events to only those events logged within a specified time period.
4655
5066
  * When you specify a time range, CloudTrail checks the prefix and log file names to
@@ -4658,6 +5069,7 @@ export interface StartImportRequest {
4658
5069
  */
4659
5070
  StartEventTime?: Date;
4660
5071
  /**
5072
+ * @public
4661
5073
  * <p> Use with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
4662
5074
  * limit imported trail events to only those events logged within a specified time period.
4663
5075
  * When you specify a time range, CloudTrail checks the prefix and log file names to
@@ -4666,6 +5078,7 @@ export interface StartImportRequest {
4666
5078
  */
4667
5079
  EndEventTime?: Date;
4668
5080
  /**
5081
+ * @public
4669
5082
  * <p> The ID of the import. Use this parameter when you are retrying an import. </p>
4670
5083
  */
4671
5084
  ImportId?: string;
@@ -4675,40 +5088,48 @@ export interface StartImportRequest {
4675
5088
  */
4676
5089
  export interface StartImportResponse {
4677
5090
  /**
5091
+ * @public
4678
5092
  * <p> The ID of the import. </p>
4679
5093
  */
4680
5094
  ImportId?: string;
4681
5095
  /**
5096
+ * @public
4682
5097
  * <p> The ARN of the destination event data store. </p>
4683
5098
  */
4684
5099
  Destinations?: string[];
4685
5100
  /**
5101
+ * @public
4686
5102
  * <p> The source S3 bucket for the import. </p>
4687
5103
  */
4688
5104
  ImportSource?: ImportSource;
4689
5105
  /**
5106
+ * @public
4690
5107
  * <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
4691
5108
  * limit imported trail events to only those events logged within a specified time period.
4692
5109
  * </p>
4693
5110
  */
4694
5111
  StartEventTime?: Date;
4695
5112
  /**
5113
+ * @public
4696
5114
  * <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
4697
5115
  * limit imported trail events to only those events logged within a specified time period.
4698
5116
  * </p>
4699
5117
  */
4700
5118
  EndEventTime?: Date;
4701
5119
  /**
5120
+ * @public
4702
5121
  * <p> Shows the status of the import after a <code>StartImport</code> request. An import
4703
5122
  * finishes with a status of <code>COMPLETED</code> if there were no failures, or
4704
5123
  * <code>FAILED</code> if there were failures. </p>
4705
5124
  */
4706
5125
  ImportStatus?: ImportStatus | string;
4707
5126
  /**
5127
+ * @public
4708
5128
  * <p> The timestamp for the import's creation. </p>
4709
5129
  */
4710
5130
  CreatedTimestamp?: Date;
4711
5131
  /**
5132
+ * @public
4712
5133
  * <p> The timestamp of the import's last update, if applicable. </p>
4713
5134
  */
4714
5135
  UpdatedTimestamp?: Date;
@@ -4720,6 +5141,7 @@ export interface StartImportResponse {
4720
5141
  */
4721
5142
  export interface StartLoggingRequest {
4722
5143
  /**
5144
+ * @public
4723
5145
  * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
4724
5146
  * logs Amazon Web Services API calls. The following is the format of a trail ARN.</p>
4725
5147
  * <p>
@@ -4745,6 +5167,7 @@ export declare class InvalidQueryStatementException extends __BaseException {
4745
5167
  readonly name: "InvalidQueryStatementException";
4746
5168
  readonly $fault: "client";
4747
5169
  /**
5170
+ * @public
4748
5171
  * <p>Brief description of the exception returned by the request.</p>
4749
5172
  */
4750
5173
  Message?: string;
@@ -4762,6 +5185,7 @@ export declare class MaxConcurrentQueriesException extends __BaseException {
4762
5185
  readonly name: "MaxConcurrentQueriesException";
4763
5186
  readonly $fault: "client";
4764
5187
  /**
5188
+ * @public
4765
5189
  * <p>Brief description of the exception returned by the request.</p>
4766
5190
  */
4767
5191
  Message?: string;
@@ -4775,20 +5199,24 @@ export declare class MaxConcurrentQueriesException extends __BaseException {
4775
5199
  */
4776
5200
  export interface StartQueryRequest {
4777
5201
  /**
5202
+ * @public
4778
5203
  * <p>The SQL code of your query.</p>
4779
5204
  */
4780
5205
  QueryStatement?: string;
4781
5206
  /**
5207
+ * @public
4782
5208
  * <p> The URI for the S3 bucket where CloudTrail delivers the query results. </p>
4783
5209
  */
4784
5210
  DeliveryS3Uri?: string;
4785
5211
  /**
5212
+ * @public
4786
5213
  * <p>
4787
5214
  * The alias that identifies a query template.
4788
5215
  * </p>
4789
5216
  */
4790
5217
  QueryAlias?: string;
4791
5218
  /**
5219
+ * @public
4792
5220
  * <p>
4793
5221
  * The query parameters for the specified <code>QueryAlias</code>.
4794
5222
  * </p>
@@ -4800,6 +5228,7 @@ export interface StartQueryRequest {
4800
5228
  */
4801
5229
  export interface StartQueryResponse {
4802
5230
  /**
5231
+ * @public
4803
5232
  * <p>The ID of the started query.</p>
4804
5233
  */
4805
5234
  QueryId?: string;
@@ -4809,6 +5238,7 @@ export interface StartQueryResponse {
4809
5238
  */
4810
5239
  export interface StopEventDataStoreIngestionRequest {
4811
5240
  /**
5241
+ * @public
4812
5242
  * <p>The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.</p>
4813
5243
  */
4814
5244
  EventDataStore: string | undefined;
@@ -4823,6 +5253,7 @@ export interface StopEventDataStoreIngestionResponse {
4823
5253
  */
4824
5254
  export interface StopImportRequest {
4825
5255
  /**
5256
+ * @public
4826
5257
  * <p> The ID of the import. </p>
4827
5258
  */
4828
5259
  ImportId: string | undefined;
@@ -4832,42 +5263,51 @@ export interface StopImportRequest {
4832
5263
  */
4833
5264
  export interface StopImportResponse {
4834
5265
  /**
5266
+ * @public
4835
5267
  * <p> The ID for the import. </p>
4836
5268
  */
4837
5269
  ImportId?: string;
4838
5270
  /**
5271
+ * @public
4839
5272
  * <p> The source S3 bucket for the import. </p>
4840
5273
  */
4841
5274
  ImportSource?: ImportSource;
4842
5275
  /**
5276
+ * @public
4843
5277
  * <p> The ARN of the destination event data store. </p>
4844
5278
  */
4845
5279
  Destinations?: string[];
4846
5280
  /**
5281
+ * @public
4847
5282
  * <p> The status of the import. </p>
4848
5283
  */
4849
5284
  ImportStatus?: ImportStatus | string;
4850
5285
  /**
5286
+ * @public
4851
5287
  * <p> The timestamp of the import's creation. </p>
4852
5288
  */
4853
5289
  CreatedTimestamp?: Date;
4854
5290
  /**
5291
+ * @public
4855
5292
  * <p> The timestamp of the import's last update. </p>
4856
5293
  */
4857
5294
  UpdatedTimestamp?: Date;
4858
5295
  /**
5296
+ * @public
4859
5297
  * <p> Used with <code>EndEventTime</code> to bound a <code>StartImport</code> request, and
4860
5298
  * limit imported trail events to only those events logged within a specified time period.
4861
5299
  * </p>
4862
5300
  */
4863
5301
  StartEventTime?: Date;
4864
5302
  /**
5303
+ * @public
4865
5304
  * <p> Used with <code>StartEventTime</code> to bound a <code>StartImport</code> request, and
4866
5305
  * limit imported trail events to only those events logged within a specified time period.
4867
5306
  * </p>
4868
5307
  */
4869
5308
  EndEventTime?: Date;
4870
5309
  /**
5310
+ * @public
4871
5311
  * <p> Returns information on the stopped import. </p>
4872
5312
  */
4873
5313
  ImportStatistics?: ImportStatistics;
@@ -4879,6 +5319,7 @@ export interface StopImportResponse {
4879
5319
  */
4880
5320
  export interface StopLoggingRequest {
4881
5321
  /**
5322
+ * @public
4882
5323
  * <p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
4883
5324
  * will stop logging Amazon Web Services API calls. The following is the format of a trail
4884
5325
  * ARN.</p>
@@ -4900,14 +5341,17 @@ export interface StopLoggingResponse {
4900
5341
  */
4901
5342
  export interface UpdateChannelRequest {
4902
5343
  /**
5344
+ * @public
4903
5345
  * <p>The ARN or ID (the ARN suffix) of the channel that you want to update.</p>
4904
5346
  */
4905
5347
  Channel: string | undefined;
4906
5348
  /**
5349
+ * @public
4907
5350
  * <p>The ARNs of event data stores that you want to log events arriving through the channel.</p>
4908
5351
  */
4909
5352
  Destinations?: Destination[];
4910
5353
  /**
5354
+ * @public
4911
5355
  * <p>
4912
5356
  * Changes the name of the channel.
4913
5357
  * </p>
@@ -4919,18 +5363,22 @@ export interface UpdateChannelRequest {
4919
5363
  */
4920
5364
  export interface UpdateChannelResponse {
4921
5365
  /**
5366
+ * @public
4922
5367
  * <p>The ARN of the channel that was updated.</p>
4923
5368
  */
4924
5369
  ChannelArn?: string;
4925
5370
  /**
5371
+ * @public
4926
5372
  * <p>The name of the channel that was updated.</p>
4927
5373
  */
4928
5374
  Name?: string;
4929
5375
  /**
5376
+ * @public
4930
5377
  * <p>The event source of the channel that was updated.</p>
4931
5378
  */
4932
5379
  Source?: string;
4933
5380
  /**
5381
+ * @public
4934
5382
  * <p>The event data stores that log events arriving through the channel.</p>
4935
5383
  */
4936
5384
  Destinations?: Destination[];
@@ -4940,39 +5388,47 @@ export interface UpdateChannelResponse {
4940
5388
  */
4941
5389
  export interface UpdateEventDataStoreRequest {
4942
5390
  /**
5391
+ * @public
4943
5392
  * <p>The ARN (or the ID suffix of the ARN) of the event data store that you want to
4944
5393
  * update.</p>
4945
5394
  */
4946
5395
  EventDataStore: string | undefined;
4947
5396
  /**
5397
+ * @public
4948
5398
  * <p>The event data store name.</p>
4949
5399
  */
4950
5400
  Name?: string;
4951
5401
  /**
5402
+ * @public
4952
5403
  * <p>The advanced event selectors used to select events for the event data store. You can
4953
5404
  * configure up to five advanced event selectors for each event data store.</p>
4954
5405
  */
4955
5406
  AdvancedEventSelectors?: AdvancedEventSelector[];
4956
5407
  /**
5408
+ * @public
4957
5409
  * <p>Specifies whether an event data store collects events from all Regions, or only from the
4958
5410
  * Region in which it was created.</p>
4959
5411
  */
4960
5412
  MultiRegionEnabled?: boolean;
4961
5413
  /**
5414
+ * @public
4962
5415
  * <p>Specifies whether an event data store collects events logged for an organization in
4963
5416
  * Organizations.</p>
4964
5417
  */
4965
5418
  OrganizationEnabled?: boolean;
4966
5419
  /**
5420
+ * @public
4967
5421
  * <p>The retention period, in days.</p>
4968
5422
  */
4969
5423
  RetentionPeriod?: number;
4970
5424
  /**
5425
+ * @public
4971
5426
  * <p>Indicates that termination protection is enabled and the event data store cannot be
4972
5427
  * automatically deleted.</p>
4973
5428
  */
4974
5429
  TerminationProtectionEnabled?: boolean;
4975
5430
  /**
5431
+ * @public
4976
5432
  * <p>Specifies the KMS key ID to use to encrypt the events delivered by
4977
5433
  * CloudTrail. The value can be an alias name prefixed by <code>alias/</code>, a
4978
5434
  * fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique
@@ -5019,50 +5475,61 @@ export interface UpdateEventDataStoreRequest {
5019
5475
  */
5020
5476
  export interface UpdateEventDataStoreResponse {
5021
5477
  /**
5478
+ * @public
5022
5479
  * <p>The ARN of the event data store.</p>
5023
5480
  */
5024
5481
  EventDataStoreArn?: string;
5025
5482
  /**
5483
+ * @public
5026
5484
  * <p>The name of the event data store.</p>
5027
5485
  */
5028
5486
  Name?: string;
5029
5487
  /**
5488
+ * @public
5030
5489
  * <p>The status of an event data store.</p>
5031
5490
  */
5032
5491
  Status?: EventDataStoreStatus | string;
5033
5492
  /**
5493
+ * @public
5034
5494
  * <p>The advanced event selectors that are applied to the event data store.</p>
5035
5495
  */
5036
5496
  AdvancedEventSelectors?: AdvancedEventSelector[];
5037
5497
  /**
5498
+ * @public
5038
5499
  * <p>Indicates whether the event data store includes events from all Regions, or only from
5039
5500
  * the Region in which it was created.</p>
5040
5501
  */
5041
5502
  MultiRegionEnabled?: boolean;
5042
5503
  /**
5504
+ * @public
5043
5505
  * <p>Indicates whether an event data store is collecting logged events for an organization in
5044
5506
  * Organizations.</p>
5045
5507
  */
5046
5508
  OrganizationEnabled?: boolean;
5047
5509
  /**
5510
+ * @public
5048
5511
  * <p>The retention period, in days.</p>
5049
5512
  */
5050
5513
  RetentionPeriod?: number;
5051
5514
  /**
5515
+ * @public
5052
5516
  * <p>Indicates whether termination protection is enabled for the event data store.</p>
5053
5517
  */
5054
5518
  TerminationProtectionEnabled?: boolean;
5055
5519
  /**
5520
+ * @public
5056
5521
  * <p>The timestamp that shows when an event data store was first created.</p>
5057
5522
  */
5058
5523
  CreatedTimestamp?: Date;
5059
5524
  /**
5525
+ * @public
5060
5526
  * <p>The timestamp that shows when the event data store was last updated.
5061
5527
  * <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in
5062
5528
  * <code>CreatedTimestamp</code>.</p>
5063
5529
  */
5064
5530
  UpdatedTimestamp?: Date;
5065
5531
  /**
5532
+ * @public
5066
5533
  * <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
5067
5534
  * following format.</p>
5068
5535
  * <p>
@@ -5077,6 +5544,7 @@ export interface UpdateEventDataStoreResponse {
5077
5544
  */
5078
5545
  export interface UpdateTrailRequest {
5079
5546
  /**
5547
+ * @public
5080
5548
  * <p>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the
5081
5549
  * string must meet the following requirements:</p>
5082
5550
  * <ul>
@@ -5105,27 +5573,32 @@ export interface UpdateTrailRequest {
5105
5573
  */
5106
5574
  Name: string | undefined;
5107
5575
  /**
5576
+ * @public
5108
5577
  * <p>Specifies the name of the Amazon S3 bucket designated for publishing log files.
5109
5578
  * See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3
5110
5579
  * Bucket Naming Requirements</a>.</p>
5111
5580
  */
5112
5581
  S3BucketName?: string;
5113
5582
  /**
5583
+ * @public
5114
5584
  * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
5115
5585
  * 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
5116
5586
  * characters.</p>
5117
5587
  */
5118
5588
  S3KeyPrefix?: string;
5119
5589
  /**
5590
+ * @public
5120
5591
  * <p>Specifies the name of the Amazon SNS topic defined for notification of log file
5121
5592
  * delivery. The maximum length is 256 characters.</p>
5122
5593
  */
5123
5594
  SnsTopicName?: string;
5124
5595
  /**
5596
+ * @public
5125
5597
  * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
5126
5598
  */
5127
5599
  IncludeGlobalServiceEvents?: boolean;
5128
5600
  /**
5601
+ * @public
5129
5602
  * <p>Specifies whether the trail applies only to the current Region or to all Regions. The
5130
5603
  * default is false. If the trail exists only in the current Region and this value is set to
5131
5604
  * true, shadow trails (replications of the trail) will be created in the other Regions. If
@@ -5135,6 +5608,7 @@ export interface UpdateTrailRequest {
5135
5608
  */
5136
5609
  IsMultiRegionTrail?: boolean;
5137
5610
  /**
5611
+ * @public
5138
5612
  * <p>Specifies whether log file validation is enabled. The default is false.</p>
5139
5613
  * <note>
5140
5614
  * <p>When you disable log file integrity validation, the chain of digest files is broken
@@ -5148,6 +5622,7 @@ export interface UpdateTrailRequest {
5148
5622
  */
5149
5623
  EnableLogFileValidation?: boolean;
5150
5624
  /**
5625
+ * @public
5151
5626
  * <p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that
5152
5627
  * represents the log group to which CloudTrail logs are delivered. You must use a log
5153
5628
  * group that exists in your account.</p>
@@ -5155,11 +5630,13 @@ export interface UpdateTrailRequest {
5155
5630
  */
5156
5631
  CloudWatchLogsLogGroupArn?: string;
5157
5632
  /**
5633
+ * @public
5158
5634
  * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
5159
5635
  * log group. You must use a role that exists in your account.</p>
5160
5636
  */
5161
5637
  CloudWatchLogsRoleArn?: string;
5162
5638
  /**
5639
+ * @public
5163
5640
  * <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
5164
5641
  * an alias, a fully specified ARN to a key, or a globally unique identifier.</p>
5165
5642
  * <p>CloudTrail also supports KMS multi-Region keys. For more
@@ -5183,6 +5660,7 @@ export interface UpdateTrailRequest {
5183
5660
  */
5184
5661
  KmsKeyId?: string;
5185
5662
  /**
5663
+ * @public
5186
5664
  * <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,
5187
5665
  * and cannot be true unless the call is made on behalf of an Amazon Web Services account that
5188
5666
  * 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
@@ -5200,26 +5678,31 @@ export interface UpdateTrailRequest {
5200
5678
  */
5201
5679
  export interface UpdateTrailResponse {
5202
5680
  /**
5681
+ * @public
5203
5682
  * <p>Specifies the name of the trail.</p>
5204
5683
  */
5205
5684
  Name?: string;
5206
5685
  /**
5686
+ * @public
5207
5687
  * <p>Specifies the name of the Amazon S3 bucket designated for publishing log
5208
5688
  * files.</p>
5209
5689
  */
5210
5690
  S3BucketName?: string;
5211
5691
  /**
5692
+ * @public
5212
5693
  * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you
5213
5694
  * 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>
5214
5695
  */
5215
5696
  S3KeyPrefix?: string;
5216
5697
  /**
5698
+ * @public
5217
5699
  * @deprecated
5218
5700
  *
5219
5701
  * <p>This field is no longer in use. Use <code>SnsTopicARN</code>.</p>
5220
5702
  */
5221
5703
  SnsTopicName?: string;
5222
5704
  /**
5705
+ * @public
5223
5706
  * <p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
5224
5707
  * notifications when log files are delivered. The following is the format of a topic
5225
5708
  * ARN.</p>
@@ -5229,14 +5712,17 @@ export interface UpdateTrailResponse {
5229
5712
  */
5230
5713
  SnsTopicARN?: string;
5231
5714
  /**
5715
+ * @public
5232
5716
  * <p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>
5233
5717
  */
5234
5718
  IncludeGlobalServiceEvents?: boolean;
5235
5719
  /**
5720
+ * @public
5236
5721
  * <p>Specifies whether the trail exists in one Region or in all Regions.</p>
5237
5722
  */
5238
5723
  IsMultiRegionTrail?: boolean;
5239
5724
  /**
5725
+ * @public
5240
5726
  * <p>Specifies the ARN of the trail that was updated. The following is the format of a trail
5241
5727
  * ARN.</p>
5242
5728
  * <p>
@@ -5245,20 +5731,24 @@ export interface UpdateTrailResponse {
5245
5731
  */
5246
5732
  TrailARN?: string;
5247
5733
  /**
5734
+ * @public
5248
5735
  * <p>Specifies whether log file integrity validation is enabled.</p>
5249
5736
  */
5250
5737
  LogFileValidationEnabled?: boolean;
5251
5738
  /**
5739
+ * @public
5252
5740
  * <p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
5253
5741
  * logs are delivered.</p>
5254
5742
  */
5255
5743
  CloudWatchLogsLogGroupArn?: string;
5256
5744
  /**
5745
+ * @public
5257
5746
  * <p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's
5258
5747
  * log group.</p>
5259
5748
  */
5260
5749
  CloudWatchLogsRoleArn?: string;
5261
5750
  /**
5751
+ * @public
5262
5752
  * <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
5263
5753
  * following format.</p>
5264
5754
  * <p>
@@ -5267,6 +5757,7 @@ export interface UpdateTrailResponse {
5267
5757
  */
5268
5758
  KmsKeyId?: string;
5269
5759
  /**
5760
+ * @public
5270
5761
  * <p>Specifies whether the trail is an organization trail.</p>
5271
5762
  */
5272
5763
  IsOrganizationTrail?: boolean;