aws-sdk-cloudtrail 1.43.0 → 1.44.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudtrail/client.rb +713 -16
- data/lib/aws-sdk-cloudtrail/client_api.rb +478 -4
- data/lib/aws-sdk-cloudtrail/errors.rb +154 -0
- data/lib/aws-sdk-cloudtrail/types.rb +1089 -30
- data/lib/aws-sdk-cloudtrail.rb +1 -1
- metadata +2 -2
@@ -17,10 +17,10 @@ module Aws::CloudTrail
|
|
17
17
|
#
|
18
18
|
# {
|
19
19
|
# resource_id: "String", # required
|
20
|
-
# tags_list: [
|
20
|
+
# tags_list: [ # required
|
21
21
|
# {
|
22
|
-
# key: "
|
23
|
-
# value: "
|
22
|
+
# key: "TagKey", # required
|
23
|
+
# value: "TagValue",
|
24
24
|
# },
|
25
25
|
# ],
|
26
26
|
# }
|
@@ -306,6 +306,51 @@ module Aws::CloudTrail
|
|
306
306
|
include Aws::Structure
|
307
307
|
end
|
308
308
|
|
309
|
+
# @note When making an API call, you may pass CancelQueryRequest
|
310
|
+
# data as a hash:
|
311
|
+
#
|
312
|
+
# {
|
313
|
+
# event_data_store: "EventDataStoreArn", # required
|
314
|
+
# query_id: "UUID", # required
|
315
|
+
# }
|
316
|
+
#
|
317
|
+
# @!attribute [rw] event_data_store
|
318
|
+
# The ARN (or the ID suffix of the ARN) of an event data store on
|
319
|
+
# which the specified query is running.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] query_id
|
323
|
+
# The ID of the query that you want to cancel. The `QueryId` comes
|
324
|
+
# from the response of a `StartQuery` operation.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQueryRequest AWS API Documentation
|
328
|
+
#
|
329
|
+
class CancelQueryRequest < Struct.new(
|
330
|
+
:event_data_store,
|
331
|
+
:query_id)
|
332
|
+
SENSITIVE = []
|
333
|
+
include Aws::Structure
|
334
|
+
end
|
335
|
+
|
336
|
+
# @!attribute [rw] query_id
|
337
|
+
# The ID of the canceled query.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] query_status
|
341
|
+
# Shows the status of a query after a `CancelQuery` request.
|
342
|
+
# Typically, the values shown are either `RUNNING` or `CANCELLED`.
|
343
|
+
# @return [String]
|
344
|
+
#
|
345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQueryResponse AWS API Documentation
|
346
|
+
#
|
347
|
+
class CancelQueryResponse < Struct.new(
|
348
|
+
:query_id,
|
349
|
+
:query_status)
|
350
|
+
SENSITIVE = []
|
351
|
+
include Aws::Structure
|
352
|
+
end
|
353
|
+
|
309
354
|
# This exception is thrown when an operation is called with a trail ARN
|
310
355
|
# that is not valid. The following is the format of a trail ARN.
|
311
356
|
#
|
@@ -354,6 +399,162 @@ module Aws::CloudTrail
|
|
354
399
|
#
|
355
400
|
class ConflictException < Aws::EmptyStructure; end
|
356
401
|
|
402
|
+
# @note When making an API call, you may pass CreateEventDataStoreRequest
|
403
|
+
# data as a hash:
|
404
|
+
#
|
405
|
+
# {
|
406
|
+
# name: "EventDataStoreName", # required
|
407
|
+
# advanced_event_selectors: [
|
408
|
+
# {
|
409
|
+
# name: "SelectorName",
|
410
|
+
# field_selectors: [ # required
|
411
|
+
# {
|
412
|
+
# field: "SelectorField", # required
|
413
|
+
# equals: ["OperatorValue"],
|
414
|
+
# starts_with: ["OperatorValue"],
|
415
|
+
# ends_with: ["OperatorValue"],
|
416
|
+
# not_equals: ["OperatorValue"],
|
417
|
+
# not_starts_with: ["OperatorValue"],
|
418
|
+
# not_ends_with: ["OperatorValue"],
|
419
|
+
# },
|
420
|
+
# ],
|
421
|
+
# },
|
422
|
+
# ],
|
423
|
+
# multi_region_enabled: false,
|
424
|
+
# organization_enabled: false,
|
425
|
+
# retention_period: 1,
|
426
|
+
# termination_protection_enabled: false,
|
427
|
+
# tags_list: [
|
428
|
+
# {
|
429
|
+
# key: "TagKey", # required
|
430
|
+
# value: "TagValue",
|
431
|
+
# },
|
432
|
+
# ],
|
433
|
+
# }
|
434
|
+
#
|
435
|
+
# @!attribute [rw] name
|
436
|
+
# The name of the event data store.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] advanced_event_selectors
|
440
|
+
# The advanced event selectors to use to select the events for the
|
441
|
+
# data store. For more information about how to use advanced event
|
442
|
+
# selectors, see [Log events by using advanced event selectors][1] in
|
443
|
+
# the CloudTrail User Guide.
|
444
|
+
#
|
445
|
+
#
|
446
|
+
#
|
447
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced
|
448
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] multi_region_enabled
|
451
|
+
# Specifies whether the event data store includes events from all
|
452
|
+
# regions, or only from the region in which the event data store is
|
453
|
+
# created.
|
454
|
+
# @return [Boolean]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] organization_enabled
|
457
|
+
# Specifies whether an event data store collects events logged for an
|
458
|
+
# organization in Organizations.
|
459
|
+
# @return [Boolean]
|
460
|
+
#
|
461
|
+
# @!attribute [rw] retention_period
|
462
|
+
# The retention period of the event data store, in days. You can set a
|
463
|
+
# retention period of up to 2555 days, the equivalent of seven years.
|
464
|
+
# @return [Integer]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] termination_protection_enabled
|
467
|
+
# Specifies whether termination protection is enabled for the event
|
468
|
+
# data store. If termination protection is enabled, you cannot delete
|
469
|
+
# the event data store until termination protection is disabled.
|
470
|
+
# @return [Boolean]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] tags_list
|
473
|
+
# A list of tags.
|
474
|
+
# @return [Array<Types::Tag>]
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateEventDataStoreRequest AWS API Documentation
|
477
|
+
#
|
478
|
+
class CreateEventDataStoreRequest < Struct.new(
|
479
|
+
:name,
|
480
|
+
:advanced_event_selectors,
|
481
|
+
:multi_region_enabled,
|
482
|
+
:organization_enabled,
|
483
|
+
:retention_period,
|
484
|
+
:termination_protection_enabled,
|
485
|
+
:tags_list)
|
486
|
+
SENSITIVE = []
|
487
|
+
include Aws::Structure
|
488
|
+
end
|
489
|
+
|
490
|
+
# @!attribute [rw] event_data_store_arn
|
491
|
+
# The ARN of the event data store.
|
492
|
+
# @return [String]
|
493
|
+
#
|
494
|
+
# @!attribute [rw] name
|
495
|
+
# The name of the event data store.
|
496
|
+
# @return [String]
|
497
|
+
#
|
498
|
+
# @!attribute [rw] status
|
499
|
+
# The status of event data store creation.
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] advanced_event_selectors
|
503
|
+
# The advanced event selectors that were used to select the events for
|
504
|
+
# the data store.
|
505
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] multi_region_enabled
|
508
|
+
# Indicates whether the event data store collects events from all
|
509
|
+
# regions, or only from the region in which it was created.
|
510
|
+
# @return [Boolean]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] organization_enabled
|
513
|
+
# Indicates whether an event data store is collecting logged events
|
514
|
+
# for an organization in Organizations.
|
515
|
+
# @return [Boolean]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] retention_period
|
518
|
+
# The retention period of an event data store, in days.
|
519
|
+
# @return [Integer]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] termination_protection_enabled
|
522
|
+
# Indicates whether termination protection is enabled for the event
|
523
|
+
# data store.
|
524
|
+
# @return [Boolean]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] tags_list
|
527
|
+
# A list of tags.
|
528
|
+
# @return [Array<Types::Tag>]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] created_timestamp
|
531
|
+
# The timestamp that shows when the event data store was created.
|
532
|
+
# @return [Time]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] updated_timestamp
|
535
|
+
# The timestamp that shows when an event data store was updated, if
|
536
|
+
# applicable. `UpdatedTimestamp` is always either the same or newer
|
537
|
+
# than the time shown in `CreatedTimestamp`.
|
538
|
+
# @return [Time]
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateEventDataStoreResponse AWS API Documentation
|
541
|
+
#
|
542
|
+
class CreateEventDataStoreResponse < Struct.new(
|
543
|
+
:event_data_store_arn,
|
544
|
+
:name,
|
545
|
+
:status,
|
546
|
+
:advanced_event_selectors,
|
547
|
+
:multi_region_enabled,
|
548
|
+
:organization_enabled,
|
549
|
+
:retention_period,
|
550
|
+
:termination_protection_enabled,
|
551
|
+
:tags_list,
|
552
|
+
:created_timestamp,
|
553
|
+
:updated_timestamp)
|
554
|
+
SENSITIVE = []
|
555
|
+
include Aws::Structure
|
556
|
+
end
|
557
|
+
|
357
558
|
# Specifies the settings for each trail.
|
358
559
|
#
|
359
560
|
# @note When making an API call, you may pass CreateTrailRequest
|
@@ -373,8 +574,8 @@ module Aws::CloudTrail
|
|
373
574
|
# is_organization_trail: false,
|
374
575
|
# tags_list: [
|
375
576
|
# {
|
376
|
-
# key: "
|
377
|
-
# value: "
|
577
|
+
# key: "TagKey", # required
|
578
|
+
# value: "TagValue",
|
378
579
|
# },
|
379
580
|
# ],
|
380
581
|
# }
|
@@ -769,6 +970,30 @@ module Aws::CloudTrail
|
|
769
970
|
include Aws::Structure
|
770
971
|
end
|
771
972
|
|
973
|
+
# @note When making an API call, you may pass DeleteEventDataStoreRequest
|
974
|
+
# data as a hash:
|
975
|
+
#
|
976
|
+
# {
|
977
|
+
# event_data_store: "EventDataStoreArn", # required
|
978
|
+
# }
|
979
|
+
#
|
980
|
+
# @!attribute [rw] event_data_store
|
981
|
+
# The ARN (or the ID suffix of the ARN) of the event data store to
|
982
|
+
# delete.
|
983
|
+
# @return [String]
|
984
|
+
#
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteEventDataStoreRequest AWS API Documentation
|
986
|
+
#
|
987
|
+
class DeleteEventDataStoreRequest < Struct.new(
|
988
|
+
:event_data_store)
|
989
|
+
SENSITIVE = []
|
990
|
+
include Aws::Structure
|
991
|
+
end
|
992
|
+
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteEventDataStoreResponse AWS API Documentation
|
994
|
+
#
|
995
|
+
class DeleteEventDataStoreResponse < Aws::EmptyStructure; end
|
996
|
+
|
772
997
|
# The request that specifies the name of a trail to delete.
|
773
998
|
#
|
774
999
|
# @note When making an API call, you may pass DeleteTrailRequest
|
@@ -799,6 +1024,67 @@ module Aws::CloudTrail
|
|
799
1024
|
#
|
800
1025
|
class DeleteTrailResponse < Aws::EmptyStructure; end
|
801
1026
|
|
1027
|
+
# @note When making an API call, you may pass DescribeQueryRequest
|
1028
|
+
# data as a hash:
|
1029
|
+
#
|
1030
|
+
# {
|
1031
|
+
# event_data_store: "EventDataStoreArn", # required
|
1032
|
+
# query_id: "UUID", # required
|
1033
|
+
# }
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] event_data_store
|
1036
|
+
# The ARN (or the ID suffix of the ARN) of an event data store on
|
1037
|
+
# which the specified query was run.
|
1038
|
+
# @return [String]
|
1039
|
+
#
|
1040
|
+
# @!attribute [rw] query_id
|
1041
|
+
# The query ID.
|
1042
|
+
# @return [String]
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQueryRequest AWS API Documentation
|
1045
|
+
#
|
1046
|
+
class DescribeQueryRequest < Struct.new(
|
1047
|
+
:event_data_store,
|
1048
|
+
:query_id)
|
1049
|
+
SENSITIVE = []
|
1050
|
+
include Aws::Structure
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
# @!attribute [rw] query_id
|
1054
|
+
# The ID of the query.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] query_string
|
1058
|
+
# The SQL code of a query.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @!attribute [rw] query_status
|
1062
|
+
# The status of a query. Values for `QueryStatus` include `QUEUED`,
|
1063
|
+
# `RUNNING`, `FINISHED`, `FAILED`, or `CANCELLED`
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] query_statistics
|
1067
|
+
# Metadata about a query, including the number of events that were
|
1068
|
+
# matched, the total number of events scanned, the query run time in
|
1069
|
+
# milliseconds, and the query's creation time.
|
1070
|
+
# @return [Types::QueryStatisticsForDescribeQuery]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] error_message
|
1073
|
+
# The error message returned if a query failed.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQueryResponse AWS API Documentation
|
1077
|
+
#
|
1078
|
+
class DescribeQueryResponse < Struct.new(
|
1079
|
+
:query_id,
|
1080
|
+
:query_string,
|
1081
|
+
:query_status,
|
1082
|
+
:query_statistics,
|
1083
|
+
:error_message)
|
1084
|
+
SENSITIVE = []
|
1085
|
+
include Aws::Structure
|
1086
|
+
end
|
1087
|
+
|
802
1088
|
# Returns information about the trail.
|
803
1089
|
#
|
804
1090
|
# @note When making an API call, you may pass DescribeTrailsRequest
|
@@ -931,6 +1217,112 @@ module Aws::CloudTrail
|
|
931
1217
|
include Aws::Structure
|
932
1218
|
end
|
933
1219
|
|
1220
|
+
# A storage lake of event data against which you can run complex
|
1221
|
+
# SQL-based queries. An event data store can include events that you
|
1222
|
+
# have logged on your account from the last 90 to 2555 days (about three
|
1223
|
+
# months to up to seven years). To select events for an event data
|
1224
|
+
# store, use [advanced event selectors][1].
|
1225
|
+
#
|
1226
|
+
#
|
1227
|
+
#
|
1228
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] event_data_store_arn
|
1231
|
+
# The ARN of the event data store.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] name
|
1235
|
+
# The name of the event data store.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] termination_protection_enabled
|
1239
|
+
# Indicates whether the event data store is protected from
|
1240
|
+
# termination.
|
1241
|
+
# @return [Boolean]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] status
|
1244
|
+
# The status of an event data store. Values are `ENABLED` and
|
1245
|
+
# `PENDING_DELETION`.
|
1246
|
+
# @return [String]
|
1247
|
+
#
|
1248
|
+
# @!attribute [rw] advanced_event_selectors
|
1249
|
+
# The advanced event selectors that were used to select events for the
|
1250
|
+
# data store.
|
1251
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] multi_region_enabled
|
1254
|
+
# Indicates whether the event data store includes events from all
|
1255
|
+
# regions, or only from the region in which it was created.
|
1256
|
+
# @return [Boolean]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] organization_enabled
|
1259
|
+
# Indicates that an event data store is collecting logged events for
|
1260
|
+
# an organization.
|
1261
|
+
# @return [Boolean]
|
1262
|
+
#
|
1263
|
+
# @!attribute [rw] retention_period
|
1264
|
+
# The retention period, in days.
|
1265
|
+
# @return [Integer]
|
1266
|
+
#
|
1267
|
+
# @!attribute [rw] created_timestamp
|
1268
|
+
# The timestamp of the event data store's creation.
|
1269
|
+
# @return [Time]
|
1270
|
+
#
|
1271
|
+
# @!attribute [rw] updated_timestamp
|
1272
|
+
# The timestamp showing when an event data store was updated, if
|
1273
|
+
# applicable. `UpdatedTimestamp` is always either the same or newer
|
1274
|
+
# than the time shown in `CreatedTimestamp`.
|
1275
|
+
# @return [Time]
|
1276
|
+
#
|
1277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStore AWS API Documentation
|
1278
|
+
#
|
1279
|
+
class EventDataStore < Struct.new(
|
1280
|
+
:event_data_store_arn,
|
1281
|
+
:name,
|
1282
|
+
:termination_protection_enabled,
|
1283
|
+
:status,
|
1284
|
+
:advanced_event_selectors,
|
1285
|
+
:multi_region_enabled,
|
1286
|
+
:organization_enabled,
|
1287
|
+
:retention_period,
|
1288
|
+
:created_timestamp,
|
1289
|
+
:updated_timestamp)
|
1290
|
+
SENSITIVE = []
|
1291
|
+
include Aws::Structure
|
1292
|
+
end
|
1293
|
+
|
1294
|
+
# The specified event data store ARN is not valid or does not map to an
|
1295
|
+
# event data store in your account.
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStoreARNInvalidException AWS API Documentation
|
1298
|
+
#
|
1299
|
+
class EventDataStoreARNInvalidException < Aws::EmptyStructure; end
|
1300
|
+
|
1301
|
+
# An event data store with that name already exists.
|
1302
|
+
#
|
1303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStoreAlreadyExistsException AWS API Documentation
|
1304
|
+
#
|
1305
|
+
class EventDataStoreAlreadyExistsException < Aws::EmptyStructure; end
|
1306
|
+
|
1307
|
+
# Your account has used the maximum number of event data stores.
|
1308
|
+
#
|
1309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStoreMaxLimitExceededException AWS API Documentation
|
1310
|
+
#
|
1311
|
+
class EventDataStoreMaxLimitExceededException < Aws::EmptyStructure; end
|
1312
|
+
|
1313
|
+
# The specified event data store was not found.
|
1314
|
+
#
|
1315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStoreNotFoundException AWS API Documentation
|
1316
|
+
#
|
1317
|
+
class EventDataStoreNotFoundException < Aws::EmptyStructure; end
|
1318
|
+
|
1319
|
+
# The event data store cannot be deleted because termination protection
|
1320
|
+
# is enabled for it.
|
1321
|
+
#
|
1322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventDataStoreTerminationProtectedException AWS API Documentation
|
1323
|
+
#
|
1324
|
+
class EventDataStoreTerminationProtectedException < Aws::EmptyStructure; end
|
1325
|
+
|
934
1326
|
# Use event selectors to further specify the management and data event
|
935
1327
|
# settings for your trail. By default, trails created without specific
|
936
1328
|
# event selectors will be configured to log all read and write
|
@@ -1027,6 +1419,89 @@ module Aws::CloudTrail
|
|
1027
1419
|
include Aws::Structure
|
1028
1420
|
end
|
1029
1421
|
|
1422
|
+
# @note When making an API call, you may pass GetEventDataStoreRequest
|
1423
|
+
# data as a hash:
|
1424
|
+
#
|
1425
|
+
# {
|
1426
|
+
# event_data_store: "EventDataStoreArn", # required
|
1427
|
+
# }
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] event_data_store
|
1430
|
+
# The ARN (or ID suffix of the ARN) of the event data store about
|
1431
|
+
# which you want information.
|
1432
|
+
# @return [String]
|
1433
|
+
#
|
1434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventDataStoreRequest AWS API Documentation
|
1435
|
+
#
|
1436
|
+
class GetEventDataStoreRequest < Struct.new(
|
1437
|
+
:event_data_store)
|
1438
|
+
SENSITIVE = []
|
1439
|
+
include Aws::Structure
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
# @!attribute [rw] event_data_store_arn
|
1443
|
+
# The event data store Amazon Resource Number (ARN).
|
1444
|
+
# @return [String]
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] name
|
1447
|
+
# The name of the event data store.
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] status
|
1451
|
+
# The status of an event data store. Values can be `ENABLED` and
|
1452
|
+
# `PENDING_DELETION`.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] advanced_event_selectors
|
1456
|
+
# The advanced event selectors used to select events for the data
|
1457
|
+
# store.
|
1458
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] multi_region_enabled
|
1461
|
+
# Indicates whether the event data store includes events from all
|
1462
|
+
# regions, or only from the region in which it was created.
|
1463
|
+
# @return [Boolean]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] organization_enabled
|
1466
|
+
# Indicates whether an event data store is collecting logged events
|
1467
|
+
# for an organization in Organizations.
|
1468
|
+
# @return [Boolean]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] retention_period
|
1471
|
+
# The retention period of the event data store, in days.
|
1472
|
+
# @return [Integer]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] termination_protection_enabled
|
1475
|
+
# Indicates that termination protection is enabled.
|
1476
|
+
# @return [Boolean]
|
1477
|
+
#
|
1478
|
+
# @!attribute [rw] created_timestamp
|
1479
|
+
# The timestamp of the event data store's creation.
|
1480
|
+
# @return [Time]
|
1481
|
+
#
|
1482
|
+
# @!attribute [rw] updated_timestamp
|
1483
|
+
# Shows the time that an event data store was updated, if applicable.
|
1484
|
+
# `UpdatedTimestamp` is always either the same or newer than the time
|
1485
|
+
# shown in `CreatedTimestamp`.
|
1486
|
+
# @return [Time]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventDataStoreResponse AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class GetEventDataStoreResponse < Struct.new(
|
1491
|
+
:event_data_store_arn,
|
1492
|
+
:name,
|
1493
|
+
:status,
|
1494
|
+
:advanced_event_selectors,
|
1495
|
+
:multi_region_enabled,
|
1496
|
+
:organization_enabled,
|
1497
|
+
:retention_period,
|
1498
|
+
:termination_protection_enabled,
|
1499
|
+
:created_timestamp,
|
1500
|
+
:updated_timestamp)
|
1501
|
+
SENSITIVE = []
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1030
1505
|
# @note When making an API call, you may pass GetEventSelectorsRequest
|
1031
1506
|
# data as a hash:
|
1032
1507
|
#
|
@@ -1128,8 +1603,8 @@ module Aws::CloudTrail
|
|
1128
1603
|
#
|
1129
1604
|
# @!attribute [rw] insight_selectors
|
1130
1605
|
# A JSON string that contains the insight types you want to log on a
|
1131
|
-
# trail. In this release,
|
1132
|
-
# insight
|
1606
|
+
# trail. In this release, `ApiErrorRateInsight` and
|
1607
|
+
# `ApiCallRateInsight` are supported as insight types.
|
1133
1608
|
# @return [Array<Types::InsightSelector>]
|
1134
1609
|
#
|
1135
1610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetInsightSelectorsResponse AWS API Documentation
|
@@ -1141,29 +1616,100 @@ module Aws::CloudTrail
|
|
1141
1616
|
include Aws::Structure
|
1142
1617
|
end
|
1143
1618
|
|
1144
|
-
# @note When making an API call, you may pass
|
1619
|
+
# @note When making an API call, you may pass GetQueryResultsRequest
|
1145
1620
|
# data as a hash:
|
1146
1621
|
#
|
1147
1622
|
# {
|
1148
|
-
#
|
1623
|
+
# event_data_store: "EventDataStoreArn", # required
|
1624
|
+
# query_id: "UUID", # required
|
1625
|
+
# next_token: "PaginationToken",
|
1626
|
+
# max_query_results: 1,
|
1149
1627
|
# }
|
1150
1628
|
#
|
1151
|
-
# @!attribute [rw]
|
1152
|
-
# The
|
1153
|
-
#
|
1629
|
+
# @!attribute [rw] event_data_store
|
1630
|
+
# The ARN (or ID suffix of the ARN) of the event data store against
|
1631
|
+
# which the query was run.
|
1154
1632
|
# @return [String]
|
1155
1633
|
#
|
1156
|
-
#
|
1634
|
+
# @!attribute [rw] query_id
|
1635
|
+
# The ID of the query for which you want to get results.
|
1636
|
+
# @return [String]
|
1157
1637
|
#
|
1158
|
-
|
1159
|
-
|
1638
|
+
# @!attribute [rw] next_token
|
1639
|
+
# A token you can use to get the next page of query results.
|
1640
|
+
# @return [String]
|
1641
|
+
#
|
1642
|
+
# @!attribute [rw] max_query_results
|
1643
|
+
# The maximum number of query results to display on a single page.
|
1644
|
+
# @return [Integer]
|
1645
|
+
#
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetQueryResultsRequest AWS API Documentation
|
1647
|
+
#
|
1648
|
+
class GetQueryResultsRequest < Struct.new(
|
1649
|
+
:event_data_store,
|
1650
|
+
:query_id,
|
1651
|
+
:next_token,
|
1652
|
+
:max_query_results)
|
1160
1653
|
SENSITIVE = []
|
1161
1654
|
include Aws::Structure
|
1162
1655
|
end
|
1163
1656
|
|
1164
|
-
# @!attribute [rw]
|
1165
|
-
# The
|
1166
|
-
#
|
1657
|
+
# @!attribute [rw] query_status
|
1658
|
+
# The status of the query. Values include `QUEUED`, `RUNNING`,
|
1659
|
+
# `FINISHED`, `FAILED`, or `CANCELLED`.
|
1660
|
+
# @return [String]
|
1661
|
+
#
|
1662
|
+
# @!attribute [rw] query_statistics
|
1663
|
+
# Shows the count of query results.
|
1664
|
+
# @return [Types::QueryStatistics]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] query_result_rows
|
1667
|
+
# Contains the individual event results of the query.
|
1668
|
+
# @return [Array<Array<Hash<String,String>>>]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] next_token
|
1671
|
+
# A token you can use to get the next page of query results.
|
1672
|
+
# @return [String]
|
1673
|
+
#
|
1674
|
+
# @!attribute [rw] error_message
|
1675
|
+
# The error message returned if a query failed.
|
1676
|
+
# @return [String]
|
1677
|
+
#
|
1678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetQueryResultsResponse AWS API Documentation
|
1679
|
+
#
|
1680
|
+
class GetQueryResultsResponse < Struct.new(
|
1681
|
+
:query_status,
|
1682
|
+
:query_statistics,
|
1683
|
+
:query_result_rows,
|
1684
|
+
:next_token,
|
1685
|
+
:error_message)
|
1686
|
+
SENSITIVE = []
|
1687
|
+
include Aws::Structure
|
1688
|
+
end
|
1689
|
+
|
1690
|
+
# @note When making an API call, you may pass GetTrailRequest
|
1691
|
+
# data as a hash:
|
1692
|
+
#
|
1693
|
+
# {
|
1694
|
+
# name: "String", # required
|
1695
|
+
# }
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] name
|
1698
|
+
# The name or the Amazon Resource Name (ARN) of the trail for which
|
1699
|
+
# you want to retrieve settings information.
|
1700
|
+
# @return [String]
|
1701
|
+
#
|
1702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailRequest AWS API Documentation
|
1703
|
+
#
|
1704
|
+
class GetTrailRequest < Struct.new(
|
1705
|
+
:name)
|
1706
|
+
SENSITIVE = []
|
1707
|
+
include Aws::Structure
|
1708
|
+
end
|
1709
|
+
|
1710
|
+
# @!attribute [rw] trail
|
1711
|
+
# The settings for a trail.
|
1712
|
+
# @return [Types::Trail]
|
1167
1713
|
#
|
1168
1714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailResponse AWS API Documentation
|
1169
1715
|
#
|
@@ -1339,6 +1885,19 @@ module Aws::CloudTrail
|
|
1339
1885
|
include Aws::Structure
|
1340
1886
|
end
|
1341
1887
|
|
1888
|
+
# The event data store against which you ran your query is inactive.
|
1889
|
+
#
|
1890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InactiveEventDataStoreException AWS API Documentation
|
1891
|
+
#
|
1892
|
+
class InactiveEventDataStoreException < Aws::EmptyStructure; end
|
1893
|
+
|
1894
|
+
# The specified query cannot be canceled because it is in the
|
1895
|
+
# `FINISHED`, `FAILED`, or `CANCELLED` state.
|
1896
|
+
#
|
1897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InactiveQueryException AWS API Documentation
|
1898
|
+
#
|
1899
|
+
class InactiveQueryException < Aws::EmptyStructure; end
|
1900
|
+
|
1342
1901
|
# If you run `GetInsightSelectors` on a trail that does not have
|
1343
1902
|
# Insights events enabled, the operation throws the exception
|
1344
1903
|
# `InsightNotEnabledException`.
|
@@ -1358,8 +1917,8 @@ module Aws::CloudTrail
|
|
1358
1917
|
# }
|
1359
1918
|
#
|
1360
1919
|
# @!attribute [rw] insight_type
|
1361
|
-
# The type of
|
1362
|
-
#
|
1920
|
+
# The type of insights to log on a trail. `ApiCallRateInsight` and
|
1921
|
+
# `ApiErrorRateInsight` are valid insight types.
|
1363
1922
|
# @return [String]
|
1364
1923
|
#
|
1365
1924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InsightSelector AWS API Documentation
|
@@ -1418,6 +1977,18 @@ module Aws::CloudTrail
|
|
1418
1977
|
#
|
1419
1978
|
class InvalidCloudWatchLogsRoleArnException < Aws::EmptyStructure; end
|
1420
1979
|
|
1980
|
+
# A date range for the query was specified that is not valid. For more
|
1981
|
+
# information about writing a query, see [Create or edit a query][1] in
|
1982
|
+
# the *CloudTrail User Guide*.
|
1983
|
+
#
|
1984
|
+
#
|
1985
|
+
#
|
1986
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html
|
1987
|
+
#
|
1988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidDateRangeException AWS API Documentation
|
1989
|
+
#
|
1990
|
+
class InvalidDateRangeException < Aws::EmptyStructure; end
|
1991
|
+
|
1421
1992
|
# Occurs if an event category that is not valid is specified as a value
|
1422
1993
|
# of `EventCategory`.
|
1423
1994
|
#
|
@@ -1425,6 +1996,12 @@ module Aws::CloudTrail
|
|
1425
1996
|
#
|
1426
1997
|
class InvalidEventCategoryException < Aws::EmptyStructure; end
|
1427
1998
|
|
1999
|
+
# The event data store is not in a status that supports the operation.
|
2000
|
+
#
|
2001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidEventDataStoreStatusException AWS API Documentation
|
2002
|
+
#
|
2003
|
+
class InvalidEventDataStoreStatusException < Aws::EmptyStructure; end
|
2004
|
+
|
1428
2005
|
# This exception is thrown when the `PutEventSelectors` operation is
|
1429
2006
|
# called with a number of event selectors, advanced event selectors, or
|
1430
2007
|
# data resources that is not valid. The combination of event selectors
|
@@ -1504,6 +2081,30 @@ module Aws::CloudTrail
|
|
1504
2081
|
#
|
1505
2082
|
class InvalidParameterCombinationException < Aws::EmptyStructure; end
|
1506
2083
|
|
2084
|
+
# The request includes a parameter that is not valid.
|
2085
|
+
#
|
2086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidParameterException AWS API Documentation
|
2087
|
+
#
|
2088
|
+
class InvalidParameterException < Aws::EmptyStructure; end
|
2089
|
+
|
2090
|
+
# The query that was submitted has validation errors, or uses incorrect
|
2091
|
+
# syntax or unsupported keywords. For more information about writing a
|
2092
|
+
# query, see [Create or edit a query][1] in the *CloudTrail User Guide*.
|
2093
|
+
#
|
2094
|
+
#
|
2095
|
+
#
|
2096
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html
|
2097
|
+
#
|
2098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidQueryStatementException AWS API Documentation
|
2099
|
+
#
|
2100
|
+
class InvalidQueryStatementException < Aws::EmptyStructure; end
|
2101
|
+
|
2102
|
+
# The query status is not valid for the operation.
|
2103
|
+
#
|
2104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InvalidQueryStatusException AWS API Documentation
|
2105
|
+
#
|
2106
|
+
class InvalidQueryStatusException < Aws::EmptyStructure; end
|
2107
|
+
|
1507
2108
|
# This exception is thrown when the provided S3 bucket name is not
|
1508
2109
|
# valid.
|
1509
2110
|
#
|
@@ -1587,6 +2188,50 @@ module Aws::CloudTrail
|
|
1587
2188
|
#
|
1588
2189
|
class KmsKeyNotFoundException < Aws::EmptyStructure; end
|
1589
2190
|
|
2191
|
+
# @note When making an API call, you may pass ListEventDataStoresRequest
|
2192
|
+
# data as a hash:
|
2193
|
+
#
|
2194
|
+
# {
|
2195
|
+
# next_token: "PaginationToken",
|
2196
|
+
# max_results: 1,
|
2197
|
+
# }
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] next_token
|
2200
|
+
# A token you can use to get the next page of event data store
|
2201
|
+
# results.
|
2202
|
+
# @return [String]
|
2203
|
+
#
|
2204
|
+
# @!attribute [rw] max_results
|
2205
|
+
# The maximum number of event data stores to display on a single page.
|
2206
|
+
# @return [Integer]
|
2207
|
+
#
|
2208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListEventDataStoresRequest AWS API Documentation
|
2209
|
+
#
|
2210
|
+
class ListEventDataStoresRequest < Struct.new(
|
2211
|
+
:next_token,
|
2212
|
+
:max_results)
|
2213
|
+
SENSITIVE = []
|
2214
|
+
include Aws::Structure
|
2215
|
+
end
|
2216
|
+
|
2217
|
+
# @!attribute [rw] event_data_stores
|
2218
|
+
# Contains information about event data stores in the account, in the
|
2219
|
+
# current region.
|
2220
|
+
# @return [Array<Types::EventDataStore>]
|
2221
|
+
#
|
2222
|
+
# @!attribute [rw] next_token
|
2223
|
+
# A token you can use to get the next page of results.
|
2224
|
+
# @return [String]
|
2225
|
+
#
|
2226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListEventDataStoresResponse AWS API Documentation
|
2227
|
+
#
|
2228
|
+
class ListEventDataStoresResponse < Struct.new(
|
2229
|
+
:event_data_stores,
|
2230
|
+
:next_token)
|
2231
|
+
SENSITIVE = []
|
2232
|
+
include Aws::Structure
|
2233
|
+
end
|
2234
|
+
|
1590
2235
|
# Requests the public keys for a specified time range.
|
1591
2236
|
#
|
1592
2237
|
# @note When making an API call, you may pass ListPublicKeysRequest
|
@@ -1648,6 +2293,78 @@ module Aws::CloudTrail
|
|
1648
2293
|
include Aws::Structure
|
1649
2294
|
end
|
1650
2295
|
|
2296
|
+
# @note When making an API call, you may pass ListQueriesRequest
|
2297
|
+
# data as a hash:
|
2298
|
+
#
|
2299
|
+
# {
|
2300
|
+
# event_data_store: "EventDataStoreArn", # required
|
2301
|
+
# next_token: "PaginationToken",
|
2302
|
+
# max_results: 1,
|
2303
|
+
# start_time: Time.now,
|
2304
|
+
# end_time: Time.now,
|
2305
|
+
# query_status: "QUEUED", # accepts QUEUED, RUNNING, FINISHED, FAILED, CANCELLED
|
2306
|
+
# }
|
2307
|
+
#
|
2308
|
+
# @!attribute [rw] event_data_store
|
2309
|
+
# The ARN (or the ID suffix of the ARN) of an event data store on
|
2310
|
+
# which queries were run.
|
2311
|
+
# @return [String]
|
2312
|
+
#
|
2313
|
+
# @!attribute [rw] next_token
|
2314
|
+
# A token you can use to get the next page of results.
|
2315
|
+
# @return [String]
|
2316
|
+
#
|
2317
|
+
# @!attribute [rw] max_results
|
2318
|
+
# The maximum number of queries to show on a page.
|
2319
|
+
# @return [Integer]
|
2320
|
+
#
|
2321
|
+
# @!attribute [rw] start_time
|
2322
|
+
# Use with `EndTime` to bound a `ListQueries` request, and limit its
|
2323
|
+
# results to only those queries run within a specified time period.
|
2324
|
+
# @return [Time]
|
2325
|
+
#
|
2326
|
+
# @!attribute [rw] end_time
|
2327
|
+
# Use with `StartTime` to bound a `ListQueries` request, and limit its
|
2328
|
+
# results to only those queries run within a specified time period.
|
2329
|
+
# @return [Time]
|
2330
|
+
#
|
2331
|
+
# @!attribute [rw] query_status
|
2332
|
+
# The status of queries that you want to return in results. Valid
|
2333
|
+
# values for `QueryStatus` include `QUEUED`, `RUNNING`, `FINISHED`,
|
2334
|
+
# `FAILED`, or `CANCELLED`.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListQueriesRequest AWS API Documentation
|
2338
|
+
#
|
2339
|
+
class ListQueriesRequest < Struct.new(
|
2340
|
+
:event_data_store,
|
2341
|
+
:next_token,
|
2342
|
+
:max_results,
|
2343
|
+
:start_time,
|
2344
|
+
:end_time,
|
2345
|
+
:query_status)
|
2346
|
+
SENSITIVE = []
|
2347
|
+
include Aws::Structure
|
2348
|
+
end
|
2349
|
+
|
2350
|
+
# @!attribute [rw] queries
|
2351
|
+
# Lists matching query results, and shows query ID, status, and
|
2352
|
+
# creation time of each query.
|
2353
|
+
# @return [Array<Types::Query>]
|
2354
|
+
#
|
2355
|
+
# @!attribute [rw] next_token
|
2356
|
+
# A token you can use to get the next page of results.
|
2357
|
+
# @return [String]
|
2358
|
+
#
|
2359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListQueriesResponse AWS API Documentation
|
2360
|
+
#
|
2361
|
+
class ListQueriesResponse < Struct.new(
|
2362
|
+
:queries,
|
2363
|
+
:next_token)
|
2364
|
+
SENSITIVE = []
|
2365
|
+
include Aws::Structure
|
2366
|
+
end
|
2367
|
+
|
1651
2368
|
# Specifies a list of trail tags to return.
|
1652
2369
|
#
|
1653
2370
|
# @note When making an API call, you may pass ListTagsRequest
|
@@ -1868,6 +2585,13 @@ module Aws::CloudTrail
|
|
1868
2585
|
include Aws::Structure
|
1869
2586
|
end
|
1870
2587
|
|
2588
|
+
# You are already running the maximum number of concurrent queries. Wait
|
2589
|
+
# a minute for some queries to finish, and then run the query again.
|
2590
|
+
#
|
2591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/MaxConcurrentQueriesException AWS API Documentation
|
2592
|
+
#
|
2593
|
+
class MaxConcurrentQueriesException < Aws::EmptyStructure; end
|
2594
|
+
|
1871
2595
|
# This exception is thrown when the maximum number of trails is reached.
|
1872
2596
|
#
|
1873
2597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/MaximumNumberOfTrailsExceededException AWS API Documentation
|
@@ -2081,9 +2805,9 @@ module Aws::CloudTrail
|
|
2081
2805
|
# @return [String]
|
2082
2806
|
#
|
2083
2807
|
# @!attribute [rw] insight_selectors
|
2084
|
-
# A JSON string that contains the
|
2085
|
-
#
|
2086
|
-
#
|
2808
|
+
# A JSON string that contains the insight types you want to log on a
|
2809
|
+
# trail. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid
|
2810
|
+
# insight types.
|
2087
2811
|
# @return [Array<Types::InsightSelector>]
|
2088
2812
|
#
|
2089
2813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectorsRequest AWS API Documentation
|
@@ -2102,8 +2826,8 @@ module Aws::CloudTrail
|
|
2102
2826
|
#
|
2103
2827
|
# @!attribute [rw] insight_selectors
|
2104
2828
|
# A JSON string that contains the Insights event types that you want
|
2105
|
-
# to log on a trail. The valid Insights
|
2106
|
-
# `ApiCallRateInsight`.
|
2829
|
+
# to log on a trail. The valid Insights types in this release are
|
2830
|
+
# `ApiErrorRateInsight` and `ApiCallRateInsight`.
|
2107
2831
|
# @return [Array<Types::InsightSelector>]
|
2108
2832
|
#
|
2109
2833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectorsResponse AWS API Documentation
|
@@ -2115,6 +2839,88 @@ module Aws::CloudTrail
|
|
2115
2839
|
include Aws::Structure
|
2116
2840
|
end
|
2117
2841
|
|
2842
|
+
# A SQL string of criteria about events that you want to collect in an
|
2843
|
+
# event data store.
|
2844
|
+
#
|
2845
|
+
# @!attribute [rw] query_id
|
2846
|
+
# The ID of a query.
|
2847
|
+
# @return [String]
|
2848
|
+
#
|
2849
|
+
# @!attribute [rw] query_status
|
2850
|
+
# The status of the query. This can be `QUEUED`, `RUNNING`,
|
2851
|
+
# `FINISHED`, `FAILED`, or `CANCELLED`.
|
2852
|
+
# @return [String]
|
2853
|
+
#
|
2854
|
+
# @!attribute [rw] creation_time
|
2855
|
+
# The creation time of a query.
|
2856
|
+
# @return [Time]
|
2857
|
+
#
|
2858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Query AWS API Documentation
|
2859
|
+
#
|
2860
|
+
class Query < Struct.new(
|
2861
|
+
:query_id,
|
2862
|
+
:query_status,
|
2863
|
+
:creation_time)
|
2864
|
+
SENSITIVE = []
|
2865
|
+
include Aws::Structure
|
2866
|
+
end
|
2867
|
+
|
2868
|
+
# The query ID does not exist or does not map to a query.
|
2869
|
+
#
|
2870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/QueryIdNotFoundException AWS API Documentation
|
2871
|
+
#
|
2872
|
+
class QueryIdNotFoundException < Aws::EmptyStructure; end
|
2873
|
+
|
2874
|
+
# Metadata about a query, such as the number of results.
|
2875
|
+
#
|
2876
|
+
# @!attribute [rw] results_count
|
2877
|
+
# The number of results returned.
|
2878
|
+
# @return [Integer]
|
2879
|
+
#
|
2880
|
+
# @!attribute [rw] total_results_count
|
2881
|
+
# The total number of results returned by a query.
|
2882
|
+
# @return [Integer]
|
2883
|
+
#
|
2884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/QueryStatistics AWS API Documentation
|
2885
|
+
#
|
2886
|
+
class QueryStatistics < Struct.new(
|
2887
|
+
:results_count,
|
2888
|
+
:total_results_count)
|
2889
|
+
SENSITIVE = []
|
2890
|
+
include Aws::Structure
|
2891
|
+
end
|
2892
|
+
|
2893
|
+
# Gets metadata about a query, including the number of events that were
|
2894
|
+
# matched, the total number of events scanned, the query run time in
|
2895
|
+
# milliseconds, and the query's creation time.
|
2896
|
+
#
|
2897
|
+
# @!attribute [rw] events_matched
|
2898
|
+
# The number of events that matched a query.
|
2899
|
+
# @return [Integer]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] events_scanned
|
2902
|
+
# The number of events that the query scanned in the event data store.
|
2903
|
+
# @return [Integer]
|
2904
|
+
#
|
2905
|
+
# @!attribute [rw] execution_time_in_millis
|
2906
|
+
# The query's run time, in milliseconds.
|
2907
|
+
# @return [Integer]
|
2908
|
+
#
|
2909
|
+
# @!attribute [rw] creation_time
|
2910
|
+
# The creation time of the query.
|
2911
|
+
# @return [Time]
|
2912
|
+
#
|
2913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/QueryStatisticsForDescribeQuery AWS API Documentation
|
2914
|
+
#
|
2915
|
+
class QueryStatisticsForDescribeQuery < Struct.new(
|
2916
|
+
:events_matched,
|
2917
|
+
:events_scanned,
|
2918
|
+
:execution_time_in_millis,
|
2919
|
+
:creation_time)
|
2920
|
+
SENSITIVE = []
|
2921
|
+
include Aws::Structure
|
2922
|
+
end
|
2923
|
+
|
2118
2924
|
# Specifies the tags to remove from a trail.
|
2119
2925
|
#
|
2120
2926
|
# @note When making an API call, you may pass RemoveTagsRequest
|
@@ -2122,10 +2928,10 @@ module Aws::CloudTrail
|
|
2122
2928
|
#
|
2123
2929
|
# {
|
2124
2930
|
# resource_id: "String", # required
|
2125
|
-
# tags_list: [
|
2931
|
+
# tags_list: [ # required
|
2126
2932
|
# {
|
2127
|
-
# key: "
|
2128
|
-
# value: "
|
2933
|
+
# key: "TagKey", # required
|
2934
|
+
# value: "TagValue",
|
2129
2935
|
# },
|
2130
2936
|
# ],
|
2131
2937
|
# }
|
@@ -2221,6 +3027,89 @@ module Aws::CloudTrail
|
|
2221
3027
|
#
|
2222
3028
|
class ResourceTypeNotSupportedException < Aws::EmptyStructure; end
|
2223
3029
|
|
3030
|
+
# @note When making an API call, you may pass RestoreEventDataStoreRequest
|
3031
|
+
# data as a hash:
|
3032
|
+
#
|
3033
|
+
# {
|
3034
|
+
# event_data_store: "EventDataStoreArn", # required
|
3035
|
+
# }
|
3036
|
+
#
|
3037
|
+
# @!attribute [rw] event_data_store
|
3038
|
+
# The ARN (or the ID suffix of the ARN) of the event data store that
|
3039
|
+
# you want to restore.
|
3040
|
+
# @return [String]
|
3041
|
+
#
|
3042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RestoreEventDataStoreRequest AWS API Documentation
|
3043
|
+
#
|
3044
|
+
class RestoreEventDataStoreRequest < Struct.new(
|
3045
|
+
:event_data_store)
|
3046
|
+
SENSITIVE = []
|
3047
|
+
include Aws::Structure
|
3048
|
+
end
|
3049
|
+
|
3050
|
+
# @!attribute [rw] event_data_store_arn
|
3051
|
+
# The event data store ARN.
|
3052
|
+
# @return [String]
|
3053
|
+
#
|
3054
|
+
# @!attribute [rw] name
|
3055
|
+
# The name of the event data store.
|
3056
|
+
# @return [String]
|
3057
|
+
#
|
3058
|
+
# @!attribute [rw] status
|
3059
|
+
# The status of the event data store.
|
3060
|
+
# @return [String]
|
3061
|
+
#
|
3062
|
+
# @!attribute [rw] advanced_event_selectors
|
3063
|
+
# The advanced event selectors that were used to select events.
|
3064
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] multi_region_enabled
|
3067
|
+
# Indicates whether the event data store is collecting events from all
|
3068
|
+
# regions, or only from the region in which the event data store was
|
3069
|
+
# created.
|
3070
|
+
# @return [Boolean]
|
3071
|
+
#
|
3072
|
+
# @!attribute [rw] organization_enabled
|
3073
|
+
# Indicates whether an event data store is collecting logged events
|
3074
|
+
# for an organization in Organizations.
|
3075
|
+
# @return [Boolean]
|
3076
|
+
#
|
3077
|
+
# @!attribute [rw] retention_period
|
3078
|
+
# The retention period, in days.
|
3079
|
+
# @return [Integer]
|
3080
|
+
#
|
3081
|
+
# @!attribute [rw] termination_protection_enabled
|
3082
|
+
# Indicates that termination protection is enabled and the event data
|
3083
|
+
# store cannot be automatically deleted.
|
3084
|
+
# @return [Boolean]
|
3085
|
+
#
|
3086
|
+
# @!attribute [rw] created_timestamp
|
3087
|
+
# The timestamp of an event data store's creation.
|
3088
|
+
# @return [Time]
|
3089
|
+
#
|
3090
|
+
# @!attribute [rw] updated_timestamp
|
3091
|
+
# The timestamp that shows when an event data store was updated, if
|
3092
|
+
# applicable. `UpdatedTimestamp` is always either the same or newer
|
3093
|
+
# than the time shown in `CreatedTimestamp`.
|
3094
|
+
# @return [Time]
|
3095
|
+
#
|
3096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RestoreEventDataStoreResponse AWS API Documentation
|
3097
|
+
#
|
3098
|
+
class RestoreEventDataStoreResponse < Struct.new(
|
3099
|
+
:event_data_store_arn,
|
3100
|
+
:name,
|
3101
|
+
:status,
|
3102
|
+
:advanced_event_selectors,
|
3103
|
+
:multi_region_enabled,
|
3104
|
+
:organization_enabled,
|
3105
|
+
:retention_period,
|
3106
|
+
:termination_protection_enabled,
|
3107
|
+
:created_timestamp,
|
3108
|
+
:updated_timestamp)
|
3109
|
+
SENSITIVE = []
|
3110
|
+
include Aws::Structure
|
3111
|
+
end
|
3112
|
+
|
2224
3113
|
# This exception is thrown when the specified S3 bucket does not exist.
|
2225
3114
|
#
|
2226
3115
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/S3BucketDoesNotExistException AWS API Documentation
|
@@ -2260,6 +3149,37 @@ module Aws::CloudTrail
|
|
2260
3149
|
#
|
2261
3150
|
class StartLoggingResponse < Aws::EmptyStructure; end
|
2262
3151
|
|
3152
|
+
# @note When making an API call, you may pass StartQueryRequest
|
3153
|
+
# data as a hash:
|
3154
|
+
#
|
3155
|
+
# {
|
3156
|
+
# query_statement: "QueryStatement", # required
|
3157
|
+
# }
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] query_statement
|
3160
|
+
# The SQL code of your query.
|
3161
|
+
# @return [String]
|
3162
|
+
#
|
3163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQueryRequest AWS API Documentation
|
3164
|
+
#
|
3165
|
+
class StartQueryRequest < Struct.new(
|
3166
|
+
:query_statement)
|
3167
|
+
SENSITIVE = []
|
3168
|
+
include Aws::Structure
|
3169
|
+
end
|
3170
|
+
|
3171
|
+
# @!attribute [rw] query_id
|
3172
|
+
# The ID of the started query.
|
3173
|
+
# @return [String]
|
3174
|
+
#
|
3175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQueryResponse AWS API Documentation
|
3176
|
+
#
|
3177
|
+
class StartQueryResponse < Struct.new(
|
3178
|
+
:query_id)
|
3179
|
+
SENSITIVE = []
|
3180
|
+
include Aws::Structure
|
3181
|
+
end
|
3182
|
+
|
2263
3183
|
# Passes the request to CloudTrail to stop logging Amazon Web Services
|
2264
3184
|
# API calls for the specified account.
|
2265
3185
|
#
|
@@ -2300,8 +3220,8 @@ module Aws::CloudTrail
|
|
2300
3220
|
# data as a hash:
|
2301
3221
|
#
|
2302
3222
|
# {
|
2303
|
-
# key: "
|
2304
|
-
# value: "
|
3223
|
+
# key: "TagKey", # required
|
3224
|
+
# value: "TagValue",
|
2305
3225
|
# }
|
2306
3226
|
#
|
2307
3227
|
# @!attribute [rw] key
|
@@ -2500,6 +3420,145 @@ module Aws::CloudTrail
|
|
2500
3420
|
#
|
2501
3421
|
class UnsupportedOperationException < Aws::EmptyStructure; end
|
2502
3422
|
|
3423
|
+
# @note When making an API call, you may pass UpdateEventDataStoreRequest
|
3424
|
+
# data as a hash:
|
3425
|
+
#
|
3426
|
+
# {
|
3427
|
+
# event_data_store: "EventDataStoreArn", # required
|
3428
|
+
# name: "EventDataStoreName",
|
3429
|
+
# advanced_event_selectors: [
|
3430
|
+
# {
|
3431
|
+
# name: "SelectorName",
|
3432
|
+
# field_selectors: [ # required
|
3433
|
+
# {
|
3434
|
+
# field: "SelectorField", # required
|
3435
|
+
# equals: ["OperatorValue"],
|
3436
|
+
# starts_with: ["OperatorValue"],
|
3437
|
+
# ends_with: ["OperatorValue"],
|
3438
|
+
# not_equals: ["OperatorValue"],
|
3439
|
+
# not_starts_with: ["OperatorValue"],
|
3440
|
+
# not_ends_with: ["OperatorValue"],
|
3441
|
+
# },
|
3442
|
+
# ],
|
3443
|
+
# },
|
3444
|
+
# ],
|
3445
|
+
# multi_region_enabled: false,
|
3446
|
+
# organization_enabled: false,
|
3447
|
+
# retention_period: 1,
|
3448
|
+
# termination_protection_enabled: false,
|
3449
|
+
# }
|
3450
|
+
#
|
3451
|
+
# @!attribute [rw] event_data_store
|
3452
|
+
# The ARN (or the ID suffix of the ARN) of the event data store that
|
3453
|
+
# you want to update.
|
3454
|
+
# @return [String]
|
3455
|
+
#
|
3456
|
+
# @!attribute [rw] name
|
3457
|
+
# The event data store name.
|
3458
|
+
# @return [String]
|
3459
|
+
#
|
3460
|
+
# @!attribute [rw] advanced_event_selectors
|
3461
|
+
# The advanced event selectors used to select events for the event
|
3462
|
+
# data store.
|
3463
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
3464
|
+
#
|
3465
|
+
# @!attribute [rw] multi_region_enabled
|
3466
|
+
# Specifies whether an event data store collects events from all
|
3467
|
+
# regions, or only from the region in which it was created.
|
3468
|
+
# @return [Boolean]
|
3469
|
+
#
|
3470
|
+
# @!attribute [rw] organization_enabled
|
3471
|
+
# Specifies whether an event data store collects events logged for an
|
3472
|
+
# organization in Organizations.
|
3473
|
+
# @return [Boolean]
|
3474
|
+
#
|
3475
|
+
# @!attribute [rw] retention_period
|
3476
|
+
# The retention period, in days.
|
3477
|
+
# @return [Integer]
|
3478
|
+
#
|
3479
|
+
# @!attribute [rw] termination_protection_enabled
|
3480
|
+
# Indicates that termination protection is enabled and the event data
|
3481
|
+
# store cannot be automatically deleted.
|
3482
|
+
# @return [Boolean]
|
3483
|
+
#
|
3484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateEventDataStoreRequest AWS API Documentation
|
3485
|
+
#
|
3486
|
+
class UpdateEventDataStoreRequest < Struct.new(
|
3487
|
+
:event_data_store,
|
3488
|
+
:name,
|
3489
|
+
:advanced_event_selectors,
|
3490
|
+
:multi_region_enabled,
|
3491
|
+
:organization_enabled,
|
3492
|
+
:retention_period,
|
3493
|
+
:termination_protection_enabled)
|
3494
|
+
SENSITIVE = []
|
3495
|
+
include Aws::Structure
|
3496
|
+
end
|
3497
|
+
|
3498
|
+
# @!attribute [rw] event_data_store_arn
|
3499
|
+
# The ARN of the event data store.
|
3500
|
+
# @return [String]
|
3501
|
+
#
|
3502
|
+
# @!attribute [rw] name
|
3503
|
+
# The name of the event data store.
|
3504
|
+
# @return [String]
|
3505
|
+
#
|
3506
|
+
# @!attribute [rw] status
|
3507
|
+
# The status of an event data store. Values can be `ENABLED` and
|
3508
|
+
# `PENDING_DELETION`.
|
3509
|
+
# @return [String]
|
3510
|
+
#
|
3511
|
+
# @!attribute [rw] advanced_event_selectors
|
3512
|
+
# The advanced event selectors that are applied to the event data
|
3513
|
+
# store.
|
3514
|
+
# @return [Array<Types::AdvancedEventSelector>]
|
3515
|
+
#
|
3516
|
+
# @!attribute [rw] multi_region_enabled
|
3517
|
+
# Indicates whether the event data store includes events from all
|
3518
|
+
# regions, or only from the region in which it was created.
|
3519
|
+
# @return [Boolean]
|
3520
|
+
#
|
3521
|
+
# @!attribute [rw] organization_enabled
|
3522
|
+
# Indicates whether an event data store is collecting logged events
|
3523
|
+
# for an organization in Organizations.
|
3524
|
+
# @return [Boolean]
|
3525
|
+
#
|
3526
|
+
# @!attribute [rw] retention_period
|
3527
|
+
# The retention period, in days.
|
3528
|
+
# @return [Integer]
|
3529
|
+
#
|
3530
|
+
# @!attribute [rw] termination_protection_enabled
|
3531
|
+
# Indicates whether termination protection is enabled for the event
|
3532
|
+
# data store.
|
3533
|
+
# @return [Boolean]
|
3534
|
+
#
|
3535
|
+
# @!attribute [rw] created_timestamp
|
3536
|
+
# The timestamp that shows when an event data store was first created.
|
3537
|
+
# @return [Time]
|
3538
|
+
#
|
3539
|
+
# @!attribute [rw] updated_timestamp
|
3540
|
+
# The timestamp that shows when the event data store was last updated.
|
3541
|
+
# `UpdatedTimestamp` is always either the same or newer than the time
|
3542
|
+
# shown in `CreatedTimestamp`.
|
3543
|
+
# @return [Time]
|
3544
|
+
#
|
3545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateEventDataStoreResponse AWS API Documentation
|
3546
|
+
#
|
3547
|
+
class UpdateEventDataStoreResponse < Struct.new(
|
3548
|
+
:event_data_store_arn,
|
3549
|
+
:name,
|
3550
|
+
:status,
|
3551
|
+
:advanced_event_selectors,
|
3552
|
+
:multi_region_enabled,
|
3553
|
+
:organization_enabled,
|
3554
|
+
:retention_period,
|
3555
|
+
:termination_protection_enabled,
|
3556
|
+
:created_timestamp,
|
3557
|
+
:updated_timestamp)
|
3558
|
+
SENSITIVE = []
|
3559
|
+
include Aws::Structure
|
3560
|
+
end
|
3561
|
+
|
2503
3562
|
# Specifies settings to update for the trail.
|
2504
3563
|
#
|
2505
3564
|
# @note When making an API call, you may pass UpdateTrailRequest
|