aws-sdk-cloudtrail 1.95.0 → 1.96.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 +535 -47
- data/lib/aws-sdk-cloudtrail/client_api.rb +232 -0
- data/lib/aws-sdk-cloudtrail/errors.rb +11 -0
- data/lib/aws-sdk-cloudtrail/types.rb +699 -62
- data/lib/aws-sdk-cloudtrail.rb +1 -1
- data/sig/client.rbs +139 -4
- data/sig/errors.rbs +2 -0
- data/sig/types.rbs +140 -0
- metadata +2 -2
@@ -44,11 +44,12 @@ module Aws::CloudTrail
|
|
44
44
|
#
|
45
45
|
class AccountRegisteredException < Aws::EmptyStructure; end
|
46
46
|
|
47
|
-
# Specifies the tags to add to a trail, event data store, or
|
47
|
+
# Specifies the tags to add to a trail, event data store, dashboard, or
|
48
|
+
# channel.
|
48
49
|
#
|
49
50
|
# @!attribute [rw] resource_id
|
50
|
-
# Specifies the ARN of the trail, event data store, or
|
51
|
-
# which one or more tags will be added.
|
51
|
+
# Specifies the ARN of the trail, event data store, dashboard, or
|
52
|
+
# channel to which one or more tags will be added.
|
52
53
|
#
|
53
54
|
# The format of a trail ARN is:
|
54
55
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
@@ -56,6 +57,9 @@ module Aws::CloudTrail
|
|
56
57
|
# The format of an event data store ARN is:
|
57
58
|
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
58
59
|
#
|
60
|
+
# The format of a dashboard ARN is:
|
61
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
62
|
+
#
|
59
63
|
# The format of a channel ARN is:
|
60
64
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
61
65
|
# @return [String]
|
@@ -395,11 +399,16 @@ module Aws::CloudTrail
|
|
395
399
|
# from the response of a `StartQuery` operation.
|
396
400
|
# @return [String]
|
397
401
|
#
|
402
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
403
|
+
# The account ID of the event data store owner.
|
404
|
+
# @return [String]
|
405
|
+
#
|
398
406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQueryRequest AWS API Documentation
|
399
407
|
#
|
400
408
|
class CancelQueryRequest < Struct.new(
|
401
409
|
:event_data_store,
|
402
|
-
:query_id
|
410
|
+
:query_id,
|
411
|
+
:event_data_store_owner_account_id)
|
403
412
|
SENSITIVE = []
|
404
413
|
include Aws::Structure
|
405
414
|
end
|
@@ -413,11 +422,16 @@ module Aws::CloudTrail
|
|
413
422
|
# Typically, the values shown are either `RUNNING` or `CANCELLED`.
|
414
423
|
# @return [String]
|
415
424
|
#
|
425
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
426
|
+
# The account ID of the event data store owner.
|
427
|
+
# @return [String]
|
428
|
+
#
|
416
429
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQueryResponse AWS API Documentation
|
417
430
|
#
|
418
431
|
class CancelQueryResponse < Struct.new(
|
419
432
|
:query_id,
|
420
|
-
:query_status
|
433
|
+
:query_status,
|
434
|
+
:event_data_store_owner_account_id)
|
421
435
|
SENSITIVE = []
|
422
436
|
include Aws::Structure
|
423
437
|
end
|
@@ -495,6 +509,9 @@ module Aws::CloudTrail
|
|
495
509
|
# The following is the format of an event data store ARN:
|
496
510
|
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
497
511
|
#
|
512
|
+
# The following is the format of a dashboard ARN:
|
513
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
514
|
+
#
|
498
515
|
# The following is the format of a channel ARN:
|
499
516
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
500
517
|
#
|
@@ -623,6 +640,93 @@ module Aws::CloudTrail
|
|
623
640
|
include Aws::Structure
|
624
641
|
end
|
625
642
|
|
643
|
+
# @!attribute [rw] name
|
644
|
+
# The name of the dashboard. The name must be unique to your account.
|
645
|
+
#
|
646
|
+
# To create the Highlights dashboard, the name must be
|
647
|
+
# `AWSCloudTrail-Highlights`.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] refresh_schedule
|
651
|
+
# The refresh schedule configuration for the dashboard.
|
652
|
+
#
|
653
|
+
# To create the Highlights dashboard, you must set a refresh schedule
|
654
|
+
# and set the `Status` to `ENABLED`. The `Unit` for the refresh
|
655
|
+
# schedule must be `HOURS` and the `Value` must be `6`.
|
656
|
+
# @return [Types::RefreshSchedule]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] tags_list
|
659
|
+
# A list of tags.
|
660
|
+
# @return [Array<Types::Tag>]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] termination_protection_enabled
|
663
|
+
# Specifies whether termination protection is enabled for the
|
664
|
+
# dashboard. If termination protection is enabled, you cannot delete
|
665
|
+
# the dashboard until termination protection is disabled.
|
666
|
+
# @return [Boolean]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] widgets
|
669
|
+
# An array of widgets for a custom dashboard. A custom dashboard can
|
670
|
+
# have a maximum of ten widgets.
|
671
|
+
#
|
672
|
+
# You do not need to specify widgets for the Highlights dashboard.
|
673
|
+
# @return [Array<Types::RequestWidget>]
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateDashboardRequest AWS API Documentation
|
676
|
+
#
|
677
|
+
class CreateDashboardRequest < Struct.new(
|
678
|
+
:name,
|
679
|
+
:refresh_schedule,
|
680
|
+
:tags_list,
|
681
|
+
:termination_protection_enabled,
|
682
|
+
:widgets)
|
683
|
+
SENSITIVE = []
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
687
|
+
# @!attribute [rw] dashboard_arn
|
688
|
+
# The ARN for the dashboard.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] name
|
692
|
+
# The name of the dashboard.
|
693
|
+
# @return [String]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] type
|
696
|
+
# The dashboard type.
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] widgets
|
700
|
+
# An array of widgets for the dashboard.
|
701
|
+
# @return [Array<Types::Widget>]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] tags_list
|
704
|
+
# A list of tags.
|
705
|
+
# @return [Array<Types::Tag>]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] refresh_schedule
|
708
|
+
# The refresh schedule for the dashboard, if configured.
|
709
|
+
# @return [Types::RefreshSchedule]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] termination_protection_enabled
|
712
|
+
# Indicates whether termination protection is enabled for the
|
713
|
+
# dashboard.
|
714
|
+
# @return [Boolean]
|
715
|
+
#
|
716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateDashboardResponse AWS API Documentation
|
717
|
+
#
|
718
|
+
class CreateDashboardResponse < Struct.new(
|
719
|
+
:dashboard_arn,
|
720
|
+
:name,
|
721
|
+
:type,
|
722
|
+
:widgets,
|
723
|
+
:tags_list,
|
724
|
+
:refresh_schedule,
|
725
|
+
:termination_protection_enabled)
|
726
|
+
SENSITIVE = []
|
727
|
+
include Aws::Structure
|
728
|
+
end
|
729
|
+
|
626
730
|
# @!attribute [rw] name
|
627
731
|
# The name of the event data store.
|
628
732
|
# @return [String]
|
@@ -1105,6 +1209,25 @@ module Aws::CloudTrail
|
|
1105
1209
|
include Aws::Structure
|
1106
1210
|
end
|
1107
1211
|
|
1212
|
+
# Provides information about a CloudTrail Lake dashboard.
|
1213
|
+
#
|
1214
|
+
# @!attribute [rw] dashboard_arn
|
1215
|
+
# The ARN for the dashboard.
|
1216
|
+
# @return [String]
|
1217
|
+
#
|
1218
|
+
# @!attribute [rw] type
|
1219
|
+
# The type of dashboard.
|
1220
|
+
# @return [String]
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DashboardDetail AWS API Documentation
|
1223
|
+
#
|
1224
|
+
class DashboardDetail < Struct.new(
|
1225
|
+
:dashboard_arn,
|
1226
|
+
:type)
|
1227
|
+
SENSITIVE = []
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1108
1231
|
# You can configure the `DataResource` in an `EventSelector` to log data
|
1109
1232
|
# events for the following three resource types:
|
1110
1233
|
#
|
@@ -1276,6 +1399,22 @@ module Aws::CloudTrail
|
|
1276
1399
|
#
|
1277
1400
|
class DeleteChannelResponse < Aws::EmptyStructure; end
|
1278
1401
|
|
1402
|
+
# @!attribute [rw] dashboard_id
|
1403
|
+
# The name or ARN for the dashboard.
|
1404
|
+
# @return [String]
|
1405
|
+
#
|
1406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteDashboardRequest AWS API Documentation
|
1407
|
+
#
|
1408
|
+
class DeleteDashboardRequest < Struct.new(
|
1409
|
+
:dashboard_id)
|
1410
|
+
SENSITIVE = []
|
1411
|
+
include Aws::Structure
|
1412
|
+
end
|
1413
|
+
|
1414
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteDashboardResponse AWS API Documentation
|
1415
|
+
#
|
1416
|
+
class DeleteDashboardResponse < Aws::EmptyStructure; end
|
1417
|
+
|
1279
1418
|
# @!attribute [rw] event_data_store
|
1280
1419
|
# The ARN (or the ID suffix of the ARN) of the event data store to
|
1281
1420
|
# delete.
|
@@ -1294,10 +1433,18 @@ module Aws::CloudTrail
|
|
1294
1433
|
class DeleteEventDataStoreResponse < Aws::EmptyStructure; end
|
1295
1434
|
|
1296
1435
|
# @!attribute [rw] resource_arn
|
1297
|
-
# The Amazon Resource Name (ARN) of the CloudTrail
|
1298
|
-
# deleting the resource-based policy
|
1299
|
-
#
|
1300
|
-
#
|
1436
|
+
# The Amazon Resource Name (ARN) of the CloudTrail event data store,
|
1437
|
+
# dashboard, or channel you're deleting the resource-based policy
|
1438
|
+
# from.
|
1439
|
+
#
|
1440
|
+
# Example event data store ARN format:
|
1441
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
1442
|
+
#
|
1443
|
+
# Example dashboard ARN format:
|
1444
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
1445
|
+
#
|
1446
|
+
# Example channel ARN format:
|
1447
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
1301
1448
|
# @return [String]
|
1302
1449
|
#
|
1303
1450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteResourcePolicyRequest AWS API Documentation
|
@@ -1373,12 +1520,22 @@ module Aws::CloudTrail
|
|
1373
1520
|
# The alias that identifies a query template.
|
1374
1521
|
# @return [String]
|
1375
1522
|
#
|
1523
|
+
# @!attribute [rw] refresh_id
|
1524
|
+
# The ID of the dashboard refresh.
|
1525
|
+
# @return [String]
|
1526
|
+
#
|
1527
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
1528
|
+
# The account ID of the event data store owner.
|
1529
|
+
# @return [String]
|
1530
|
+
#
|
1376
1531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQueryRequest AWS API Documentation
|
1377
1532
|
#
|
1378
1533
|
class DescribeQueryRequest < Struct.new(
|
1379
1534
|
:event_data_store,
|
1380
1535
|
:query_id,
|
1381
|
-
:query_alias
|
1536
|
+
:query_alias,
|
1537
|
+
:refresh_id,
|
1538
|
+
:event_data_store_owner_account_id)
|
1382
1539
|
SENSITIVE = []
|
1383
1540
|
include Aws::Structure
|
1384
1541
|
end
|
@@ -1425,6 +1582,10 @@ module Aws::CloudTrail
|
|
1425
1582
|
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html
|
1426
1583
|
# @return [String]
|
1427
1584
|
#
|
1585
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
1586
|
+
# The account ID of the event data store owner.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1428
1589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQueryResponse AWS API Documentation
|
1429
1590
|
#
|
1430
1591
|
class DescribeQueryResponse < Struct.new(
|
@@ -1435,7 +1596,8 @@ module Aws::CloudTrail
|
|
1435
1596
|
:error_message,
|
1436
1597
|
:delivery_s3_uri,
|
1437
1598
|
:delivery_status,
|
1438
|
-
:prompt
|
1599
|
+
:prompt,
|
1600
|
+
:event_data_store_owner_account_id)
|
1439
1601
|
SENSITIVE = []
|
1440
1602
|
include Aws::Structure
|
1441
1603
|
end
|
@@ -1916,11 +2078,16 @@ module Aws::CloudTrail
|
|
1916
2078
|
# `QueryStatement` parameter.
|
1917
2079
|
# @return [String]
|
1918
2080
|
#
|
2081
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
2082
|
+
# The account ID of the event data store owner.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
1919
2085
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GenerateQueryResponse AWS API Documentation
|
1920
2086
|
#
|
1921
2087
|
class GenerateQueryResponse < Struct.new(
|
1922
2088
|
:query_statement,
|
1923
|
-
:query_alias
|
2089
|
+
:query_alias,
|
2090
|
+
:event_data_store_owner_account_id)
|
1924
2091
|
SENSITIVE = []
|
1925
2092
|
include Aws::Structure
|
1926
2093
|
end
|
@@ -1992,6 +2159,76 @@ module Aws::CloudTrail
|
|
1992
2159
|
include Aws::Structure
|
1993
2160
|
end
|
1994
2161
|
|
2162
|
+
# @!attribute [rw] dashboard_id
|
2163
|
+
# The name or ARN for the dashboard.
|
2164
|
+
# @return [String]
|
2165
|
+
#
|
2166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetDashboardRequest AWS API Documentation
|
2167
|
+
#
|
2168
|
+
class GetDashboardRequest < Struct.new(
|
2169
|
+
:dashboard_id)
|
2170
|
+
SENSITIVE = []
|
2171
|
+
include Aws::Structure
|
2172
|
+
end
|
2173
|
+
|
2174
|
+
# @!attribute [rw] dashboard_arn
|
2175
|
+
# The ARN for the dashboard.
|
2176
|
+
# @return [String]
|
2177
|
+
#
|
2178
|
+
# @!attribute [rw] type
|
2179
|
+
# The type of dashboard.
|
2180
|
+
# @return [String]
|
2181
|
+
#
|
2182
|
+
# @!attribute [rw] status
|
2183
|
+
# The status of the dashboard.
|
2184
|
+
# @return [String]
|
2185
|
+
#
|
2186
|
+
# @!attribute [rw] widgets
|
2187
|
+
# An array of widgets for the dashboard.
|
2188
|
+
# @return [Array<Types::Widget>]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] refresh_schedule
|
2191
|
+
# The refresh schedule for the dashboard, if configured.
|
2192
|
+
# @return [Types::RefreshSchedule]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] created_timestamp
|
2195
|
+
# The timestamp that shows when the dashboard was created.
|
2196
|
+
# @return [Time]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] updated_timestamp
|
2199
|
+
# The timestamp that shows when the dashboard was last updated.
|
2200
|
+
# @return [Time]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] last_refresh_id
|
2203
|
+
# The ID of the last dashboard refresh.
|
2204
|
+
# @return [String]
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] last_refresh_failure_reason
|
2207
|
+
# Provides information about failures for the last scheduled refresh.
|
2208
|
+
# @return [String]
|
2209
|
+
#
|
2210
|
+
# @!attribute [rw] termination_protection_enabled
|
2211
|
+
# Indicates whether termination protection is enabled for the
|
2212
|
+
# dashboard.
|
2213
|
+
# @return [Boolean]
|
2214
|
+
#
|
2215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetDashboardResponse AWS API Documentation
|
2216
|
+
#
|
2217
|
+
class GetDashboardResponse < Struct.new(
|
2218
|
+
:dashboard_arn,
|
2219
|
+
:type,
|
2220
|
+
:status,
|
2221
|
+
:widgets,
|
2222
|
+
:refresh_schedule,
|
2223
|
+
:created_timestamp,
|
2224
|
+
:updated_timestamp,
|
2225
|
+
:last_refresh_id,
|
2226
|
+
:last_refresh_failure_reason,
|
2227
|
+
:termination_protection_enabled)
|
2228
|
+
SENSITIVE = []
|
2229
|
+
include Aws::Structure
|
2230
|
+
end
|
2231
|
+
|
1995
2232
|
# @!attribute [rw] event_data_store
|
1996
2233
|
# The ARN (or ID suffix of the ARN) of the event data store about
|
1997
2234
|
# which you want information.
|
@@ -2317,13 +2554,18 @@ module Aws::CloudTrail
|
|
2317
2554
|
# The maximum number of query results to display on a single page.
|
2318
2555
|
# @return [Integer]
|
2319
2556
|
#
|
2557
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
2558
|
+
# The account ID of the event data store owner.
|
2559
|
+
# @return [String]
|
2560
|
+
#
|
2320
2561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetQueryResultsRequest AWS API Documentation
|
2321
2562
|
#
|
2322
2563
|
class GetQueryResultsRequest < Struct.new(
|
2323
2564
|
:event_data_store,
|
2324
2565
|
:query_id,
|
2325
2566
|
:next_token,
|
2326
|
-
:max_query_results
|
2567
|
+
:max_query_results,
|
2568
|
+
:event_data_store_owner_account_id)
|
2327
2569
|
SENSITIVE = []
|
2328
2570
|
include Aws::Structure
|
2329
2571
|
end
|
@@ -2362,9 +2604,17 @@ module Aws::CloudTrail
|
|
2362
2604
|
end
|
2363
2605
|
|
2364
2606
|
# @!attribute [rw] resource_arn
|
2365
|
-
# The Amazon Resource Name (ARN) of the CloudTrail
|
2366
|
-
# the resource-based policy.
|
2367
|
-
#
|
2607
|
+
# The Amazon Resource Name (ARN) of the CloudTrail event data store,
|
2608
|
+
# dashboard, or channel attached to the resource-based policy.
|
2609
|
+
#
|
2610
|
+
# Example event data store ARN format:
|
2611
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
2612
|
+
#
|
2613
|
+
# Example dashboard ARN format:
|
2614
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
2615
|
+
#
|
2616
|
+
# Example channel ARN format:
|
2617
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
2368
2618
|
# @return [String]
|
2369
2619
|
#
|
2370
2620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetResourcePolicyRequest AWS API Documentation
|
@@ -2376,20 +2626,42 @@ module Aws::CloudTrail
|
|
2376
2626
|
end
|
2377
2627
|
|
2378
2628
|
# @!attribute [rw] resource_arn
|
2379
|
-
# The Amazon Resource Name (ARN) of the CloudTrail
|
2380
|
-
# resource-based policy.
|
2629
|
+
# The Amazon Resource Name (ARN) of the CloudTrail event data store,
|
2630
|
+
# dashboard, or channel attached to resource-based policy.
|
2631
|
+
#
|
2632
|
+
# Example event data store ARN format:
|
2633
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
2634
|
+
#
|
2635
|
+
# Example dashboard ARN format:
|
2636
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
2637
|
+
#
|
2638
|
+
# Example channel ARN format:
|
2639
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
2381
2640
|
# @return [String]
|
2382
2641
|
#
|
2383
2642
|
# @!attribute [rw] resource_policy
|
2384
2643
|
# A JSON-formatted string that contains the resource-based policy
|
2385
|
-
# attached to the CloudTrail channel.
|
2644
|
+
# attached to the CloudTrail event data store, dashboard, or channel.
|
2645
|
+
# @return [String]
|
2646
|
+
#
|
2647
|
+
# @!attribute [rw] delegated_admin_resource_policy
|
2648
|
+
# The default resource-based policy that is automatically generated
|
2649
|
+
# for the delegated administrator of an Organizations organization.
|
2650
|
+
# This policy will be evaluated in tandem with any policy you submit
|
2651
|
+
# for the resource. For more information about this policy, see
|
2652
|
+
# [Default resource policy for delegated administrators][1].
|
2653
|
+
#
|
2654
|
+
#
|
2655
|
+
#
|
2656
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-organizations.html#cloudtrail-lake-organizations-eds-rbp
|
2386
2657
|
# @return [String]
|
2387
2658
|
#
|
2388
2659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetResourcePolicyResponse AWS API Documentation
|
2389
2660
|
#
|
2390
2661
|
class GetResourcePolicyResponse < Struct.new(
|
2391
2662
|
:resource_arn,
|
2392
|
-
:resource_policy
|
2663
|
+
:resource_policy,
|
2664
|
+
:delegated_admin_resource_policy)
|
2393
2665
|
SENSITIVE = []
|
2394
2666
|
include Aws::Structure
|
2395
2667
|
end
|
@@ -2425,9 +2697,16 @@ module Aws::CloudTrail
|
|
2425
2697
|
# Specifies the name or the CloudTrail ARN of the trail for which you
|
2426
2698
|
# are requesting status. To get the status of a shadow trail (a
|
2427
2699
|
# replication of the trail in another Region), you must specify its
|
2428
|
-
# ARN.
|
2700
|
+
# ARN.
|
2429
2701
|
#
|
2702
|
+
# The following is the format of a trail ARN:
|
2430
2703
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2704
|
+
#
|
2705
|
+
# <note markdown="1"> If the trail is an organization trail and you are a member account
|
2706
|
+
# in the organization in Organizations, you must provide the full ARN
|
2707
|
+
# of that trail, and not just the name.
|
2708
|
+
#
|
2709
|
+
# </note>
|
2431
2710
|
# @return [String]
|
2432
2711
|
#
|
2433
2712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatusRequest AWS API Documentation
|
@@ -2798,8 +3077,13 @@ module Aws::CloudTrail
|
|
2798
3077
|
#
|
2799
3078
|
class InsufficientDependencyServiceAccessPermissionException < Aws::EmptyStructure; end
|
2800
3079
|
|
2801
|
-
#
|
2802
|
-
#
|
3080
|
+
# For the `CreateTrail` `PutInsightSelectors`, `UpdateTrail`,
|
3081
|
+
# `StartQuery`, and `StartImport` operations, this exception is thrown
|
3082
|
+
# when the policy on the S3 bucket or KMS key does not have sufficient
|
3083
|
+
# permissions for the operation.
|
3084
|
+
#
|
3085
|
+
# For all other operations, this exception is thrown when the policy for
|
3086
|
+
# the KMS key does not have sufficient permissions for the operation.
|
2803
3087
|
#
|
2804
3088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/InsufficientEncryptionPolicyException AWS API Documentation
|
2805
3089
|
#
|
@@ -3120,6 +3404,51 @@ module Aws::CloudTrail
|
|
3120
3404
|
include Aws::Structure
|
3121
3405
|
end
|
3122
3406
|
|
3407
|
+
# @!attribute [rw] name_prefix
|
3408
|
+
# Specify a name prefix to filter on.
|
3409
|
+
# @return [String]
|
3410
|
+
#
|
3411
|
+
# @!attribute [rw] type
|
3412
|
+
# Specify a dashboard type to filter on: `CUSTOM` or `MANAGED`.
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] next_token
|
3416
|
+
# A token you can use to get the next page of dashboard results.
|
3417
|
+
# @return [String]
|
3418
|
+
#
|
3419
|
+
# @!attribute [rw] max_results
|
3420
|
+
# The maximum number of dashboards to display on a single page.
|
3421
|
+
# @return [Integer]
|
3422
|
+
#
|
3423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListDashboardsRequest AWS API Documentation
|
3424
|
+
#
|
3425
|
+
class ListDashboardsRequest < Struct.new(
|
3426
|
+
:name_prefix,
|
3427
|
+
:type,
|
3428
|
+
:next_token,
|
3429
|
+
:max_results)
|
3430
|
+
SENSITIVE = []
|
3431
|
+
include Aws::Structure
|
3432
|
+
end
|
3433
|
+
|
3434
|
+
# @!attribute [rw] dashboards
|
3435
|
+
# Contains information about dashboards in the account, in the current
|
3436
|
+
# Region that match the applied filters.
|
3437
|
+
# @return [Array<Types::DashboardDetail>]
|
3438
|
+
#
|
3439
|
+
# @!attribute [rw] next_token
|
3440
|
+
# A token you can use to get the next page of dashboard results.
|
3441
|
+
# @return [String]
|
3442
|
+
#
|
3443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListDashboardsResponse AWS API Documentation
|
3444
|
+
#
|
3445
|
+
class ListDashboardsResponse < Struct.new(
|
3446
|
+
:dashboards,
|
3447
|
+
:next_token)
|
3448
|
+
SENSITIVE = []
|
3449
|
+
include Aws::Structure
|
3450
|
+
end
|
3451
|
+
|
3123
3452
|
# @!attribute [rw] next_token
|
3124
3453
|
# A token you can use to get the next page of event data store
|
3125
3454
|
# results.
|
@@ -3289,12 +3618,12 @@ module Aws::CloudTrail
|
|
3289
3618
|
# @return [Integer]
|
3290
3619
|
#
|
3291
3620
|
# @!attribute [rw] data_type
|
3292
|
-
# Type of
|
3621
|
+
# Type of data points to return. Valid values are `NonZeroData` and
|
3293
3622
|
# `FillWithZeros`. The default is `NonZeroData`.
|
3294
3623
|
# @return [String]
|
3295
3624
|
#
|
3296
3625
|
# @!attribute [rw] max_results
|
3297
|
-
# The maximum number of
|
3626
|
+
# The maximum number of data points to return. Valid values are
|
3298
3627
|
# integers from 1 to 21600. The default value is 21600.
|
3299
3628
|
# @return [Integer]
|
3300
3629
|
#
|
@@ -3496,8 +3825,8 @@ module Aws::CloudTrail
|
|
3496
3825
|
# Specifies a list of tags to return.
|
3497
3826
|
#
|
3498
3827
|
# @!attribute [rw] resource_id_list
|
3499
|
-
# Specifies a list of trail, event data store, or channel
|
3500
|
-
# tags will be listed. The list has a limit of 20 ARNs.
|
3828
|
+
# Specifies a list of trail, event data store, dashboard, or channel
|
3829
|
+
# ARNs whose tags will be listed. The list has a limit of 20 ARNs.
|
3501
3830
|
#
|
3502
3831
|
# Example trail ARN format:
|
3503
3832
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
@@ -3505,6 +3834,9 @@ module Aws::CloudTrail
|
|
3505
3834
|
# Example event data store ARN format:
|
3506
3835
|
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
3507
3836
|
#
|
3837
|
+
# Example dashboard ARN format:
|
3838
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
3839
|
+
#
|
3508
3840
|
# Example channel ARN format:
|
3509
3841
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
3510
3842
|
# @return [Array<String>]
|
@@ -3980,24 +4312,29 @@ module Aws::CloudTrail
|
|
3980
4312
|
end
|
3981
4313
|
|
3982
4314
|
# @!attribute [rw] resource_arn
|
3983
|
-
# The Amazon Resource Name (ARN) of the CloudTrail
|
3984
|
-
# the resource-based policy.
|
3985
|
-
#
|
4315
|
+
# The Amazon Resource Name (ARN) of the CloudTrail event data store,
|
4316
|
+
# dashboard, or channel attached to the resource-based policy.
|
4317
|
+
#
|
4318
|
+
# Example event data store ARN format:
|
4319
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
4320
|
+
#
|
4321
|
+
# Example dashboard ARN format:
|
4322
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
4323
|
+
#
|
4324
|
+
# Example channel ARN format:
|
4325
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
3986
4326
|
# @return [String]
|
3987
4327
|
#
|
3988
4328
|
# @!attribute [rw] resource_policy
|
3989
4329
|
# A JSON-formatted string for an Amazon Web Services resource-based
|
3990
4330
|
# policy.
|
3991
4331
|
#
|
3992
|
-
#
|
4332
|
+
# For example resource-based policies, see [CloudTrail resource-based
|
4333
|
+
# policy examples][1] in the *CloudTrail User Guide*.
|
3993
4334
|
#
|
3994
|
-
# * Contains only one action: cloudtrail-data:PutAuditEvents
|
3995
4335
|
#
|
3996
|
-
# * Contains at least one statement. The policy can have a maximum of
|
3997
|
-
# 20 statements.
|
3998
4336
|
#
|
3999
|
-
#
|
4000
|
-
# have a maximum of 50 principals.
|
4337
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html
|
4001
4338
|
# @return [String]
|
4002
4339
|
#
|
4003
4340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutResourcePolicyRequest AWS API Documentation
|
@@ -4010,20 +4347,43 @@ module Aws::CloudTrail
|
|
4010
4347
|
end
|
4011
4348
|
|
4012
4349
|
# @!attribute [rw] resource_arn
|
4013
|
-
# The Amazon Resource Name (ARN) of the CloudTrail
|
4014
|
-
# the resource-based policy.
|
4350
|
+
# The Amazon Resource Name (ARN) of the CloudTrail event data store,
|
4351
|
+
# dashboard, or channel attached to the resource-based policy.
|
4352
|
+
#
|
4353
|
+
# Example event data store ARN format:
|
4354
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
4355
|
+
#
|
4356
|
+
# Example dashboard ARN format:
|
4357
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
4358
|
+
#
|
4359
|
+
# Example channel ARN format:
|
4360
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
4015
4361
|
# @return [String]
|
4016
4362
|
#
|
4017
4363
|
# @!attribute [rw] resource_policy
|
4018
4364
|
# The JSON-formatted string of the Amazon Web Services resource-based
|
4019
|
-
# policy attached to the CloudTrail
|
4365
|
+
# policy attached to the CloudTrail event data store, dashboard, or
|
4366
|
+
# channel.
|
4367
|
+
# @return [String]
|
4368
|
+
#
|
4369
|
+
# @!attribute [rw] delegated_admin_resource_policy
|
4370
|
+
# The default resource-based policy that is automatically generated
|
4371
|
+
# for the delegated administrator of an Organizations organization.
|
4372
|
+
# This policy will be evaluated in tandem with any policy you submit
|
4373
|
+
# for the resource. For more information about this policy, see
|
4374
|
+
# [Default resource policy for delegated administrators][1].
|
4375
|
+
#
|
4376
|
+
#
|
4377
|
+
#
|
4378
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-organizations.html#cloudtrail-lake-organizations-eds-rbp
|
4020
4379
|
# @return [String]
|
4021
4380
|
#
|
4022
4381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutResourcePolicyResponse AWS API Documentation
|
4023
4382
|
#
|
4024
4383
|
class PutResourcePolicyResponse < Struct.new(
|
4025
4384
|
:resource_arn,
|
4026
|
-
:resource_policy
|
4385
|
+
:resource_policy,
|
4386
|
+
:delegated_admin_resource_policy)
|
4027
4387
|
SENSITIVE = []
|
4028
4388
|
include Aws::Structure
|
4029
4389
|
end
|
@@ -4124,6 +4484,67 @@ module Aws::CloudTrail
|
|
4124
4484
|
include Aws::Structure
|
4125
4485
|
end
|
4126
4486
|
|
4487
|
+
# The schedule for a dashboard refresh.
|
4488
|
+
#
|
4489
|
+
# @!attribute [rw] frequency
|
4490
|
+
# The frequency at which you want the dashboard refreshed.
|
4491
|
+
# @return [Types::RefreshScheduleFrequency]
|
4492
|
+
#
|
4493
|
+
# @!attribute [rw] status
|
4494
|
+
# Specifies whether the refresh schedule is enabled. Set the value to
|
4495
|
+
# `ENABLED` to enable the refresh schedule, or to `DISABLED` to turn
|
4496
|
+
# off the refresh schedule.
|
4497
|
+
# @return [String]
|
4498
|
+
#
|
4499
|
+
# @!attribute [rw] time_of_day
|
4500
|
+
# The time of day in UTC to run the schedule; for hourly only refer to
|
4501
|
+
# minutes; default is 00:00.
|
4502
|
+
# @return [String]
|
4503
|
+
#
|
4504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RefreshSchedule AWS API Documentation
|
4505
|
+
#
|
4506
|
+
class RefreshSchedule < Struct.new(
|
4507
|
+
:frequency,
|
4508
|
+
:status,
|
4509
|
+
:time_of_day)
|
4510
|
+
SENSITIVE = []
|
4511
|
+
include Aws::Structure
|
4512
|
+
end
|
4513
|
+
|
4514
|
+
# Specifies the frequency for a dashboard refresh schedule.
|
4515
|
+
#
|
4516
|
+
# For a custom dashboard, you can schedule a refresh for every 1, 6, 12,
|
4517
|
+
# or 24 hours, or every day.
|
4518
|
+
#
|
4519
|
+
# @!attribute [rw] unit
|
4520
|
+
# The unit to use for the refresh.
|
4521
|
+
#
|
4522
|
+
# For custom dashboards, the unit can be `HOURS` or `DAYS`.
|
4523
|
+
#
|
4524
|
+
# For the Highlights dashboard, the `Unit` must be `HOURS`.
|
4525
|
+
# @return [String]
|
4526
|
+
#
|
4527
|
+
# @!attribute [rw] value
|
4528
|
+
# The value for the refresh schedule.
|
4529
|
+
#
|
4530
|
+
# For custom dashboards, the following values are valid when the unit
|
4531
|
+
# is `HOURS`: `1`, `6`, `12`, `24`
|
4532
|
+
#
|
4533
|
+
# For custom dashboards, the only valid value when the unit is `DAYS`
|
4534
|
+
# is `1`.
|
4535
|
+
#
|
4536
|
+
# For the Highlights dashboard, the `Value` must be `6`.
|
4537
|
+
# @return [Integer]
|
4538
|
+
#
|
4539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RefreshScheduleFrequency AWS API Documentation
|
4540
|
+
#
|
4541
|
+
class RefreshScheduleFrequency < Struct.new(
|
4542
|
+
:unit,
|
4543
|
+
:value)
|
4544
|
+
SENSITIVE = []
|
4545
|
+
include Aws::Structure
|
4546
|
+
end
|
4547
|
+
|
4127
4548
|
# Specifies an organization member account ID as a CloudTrail delegated
|
4128
4549
|
# administrator.
|
4129
4550
|
#
|
@@ -4147,12 +4568,12 @@ module Aws::CloudTrail
|
|
4147
4568
|
#
|
4148
4569
|
class RegisterOrganizationDelegatedAdminResponse < Aws::EmptyStructure; end
|
4149
4570
|
|
4150
|
-
# Specifies the tags to remove from a trail, event data store,
|
4151
|
-
# channel.
|
4571
|
+
# Specifies the tags to remove from a trail, event data store,
|
4572
|
+
# dashboard, or channel.
|
4152
4573
|
#
|
4153
4574
|
# @!attribute [rw] resource_id
|
4154
|
-
# Specifies the ARN of the trail, event data store, or
|
4155
|
-
# which tags should be removed.
|
4575
|
+
# Specifies the ARN of the trail, event data store, dashboard, or
|
4576
|
+
# channel from which tags should be removed.
|
4156
4577
|
#
|
4157
4578
|
# Example trail ARN format:
|
4158
4579
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
@@ -4160,6 +4581,9 @@ module Aws::CloudTrail
|
|
4160
4581
|
# Example event data store ARN format:
|
4161
4582
|
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
4162
4583
|
#
|
4584
|
+
# Example dashboard ARN format:
|
4585
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
4586
|
+
#
|
4163
4587
|
# Example channel ARN format:
|
4164
4588
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
4165
4589
|
# @return [String]
|
@@ -4184,6 +4608,44 @@ module Aws::CloudTrail
|
|
4184
4608
|
#
|
4185
4609
|
class RemoveTagsResponse < Aws::EmptyStructure; end
|
4186
4610
|
|
4611
|
+
# Contains information about a widget on a CloudTrail Lake dashboard.
|
4612
|
+
#
|
4613
|
+
# @!attribute [rw] query_statement
|
4614
|
+
# The query statement for the widget. For custom dashboard widgets,
|
4615
|
+
# you can query across multiple event data stores as long as all event
|
4616
|
+
# data stores exist in your account.
|
4617
|
+
#
|
4618
|
+
# <note markdown="1"> When a query uses `?` with `eventTime`, `?` must be surrounded by
|
4619
|
+
# single quotes as follows: `'?'`.
|
4620
|
+
#
|
4621
|
+
# </note>
|
4622
|
+
# @return [String]
|
4623
|
+
#
|
4624
|
+
# @!attribute [rw] query_parameters
|
4625
|
+
# The optional query parameters. The following query parameters are
|
4626
|
+
# valid: `$StartTime$`, `$EndTime$`, and `$Period$`.
|
4627
|
+
# @return [Array<String>]
|
4628
|
+
#
|
4629
|
+
# @!attribute [rw] view_properties
|
4630
|
+
# The view properties for the widget. For more information about view
|
4631
|
+
# properties, see [ View properties for widgets ][1] in the
|
4632
|
+
# *CloudTrail User Guide*.
|
4633
|
+
#
|
4634
|
+
#
|
4635
|
+
#
|
4636
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-widget-properties.html
|
4637
|
+
# @return [Hash<String,String>]
|
4638
|
+
#
|
4639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RequestWidget AWS API Documentation
|
4640
|
+
#
|
4641
|
+
class RequestWidget < Struct.new(
|
4642
|
+
:query_statement,
|
4643
|
+
:query_parameters,
|
4644
|
+
:view_properties)
|
4645
|
+
SENSITIVE = []
|
4646
|
+
include Aws::Structure
|
4647
|
+
end
|
4648
|
+
|
4187
4649
|
# Specifies the type and name of a resource referenced by an event.
|
4188
4650
|
#
|
4189
4651
|
# @!attribute [rw] resource_type
|
@@ -4217,9 +4679,16 @@ module Aws::CloudTrail
|
|
4217
4679
|
end
|
4218
4680
|
|
4219
4681
|
# This exception is thrown when the provided resource does not exist, or
|
4220
|
-
# the ARN format of the resource is not valid.
|
4221
|
-
#
|
4222
|
-
#
|
4682
|
+
# the ARN format of the resource is not valid.
|
4683
|
+
#
|
4684
|
+
# The following is the format of an event data store ARN:
|
4685
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
4686
|
+
#
|
4687
|
+
# The following is the format of a dashboard ARN:
|
4688
|
+
# `arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash`
|
4689
|
+
#
|
4690
|
+
# The following is the format of a channel ARN:
|
4691
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
4223
4692
|
#
|
4224
4693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ResourceARNNotValidException AWS API Documentation
|
4225
4694
|
#
|
@@ -4241,16 +4710,6 @@ module Aws::CloudTrail
|
|
4241
4710
|
# This exception is thrown when the resouce-based policy has syntax
|
4242
4711
|
# errors, or contains a principal that is not valid.
|
4243
4712
|
#
|
4244
|
-
# The following are requirements for the resource policy:
|
4245
|
-
#
|
4246
|
-
# * Contains only one action: cloudtrail-data:PutAuditEvents
|
4247
|
-
#
|
4248
|
-
# * Contains at least one statement. The policy can have a maximum of 20
|
4249
|
-
# statements.
|
4250
|
-
#
|
4251
|
-
# * Each statement contains at least one principal. A statement can have
|
4252
|
-
# a maximum of 50 principals.
|
4253
|
-
#
|
4254
4713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ResourcePolicyNotValidException AWS API Documentation
|
4255
4714
|
#
|
4256
4715
|
class ResourcePolicyNotValidException < Aws::EmptyStructure; end
|
@@ -4401,6 +4860,18 @@ module Aws::CloudTrail
|
|
4401
4860
|
include Aws::Structure
|
4402
4861
|
end
|
4403
4862
|
|
4863
|
+
# This exception is thrown when the quota is exceeded. For information
|
4864
|
+
# about CloudTrail quotas, see [Service quotas][1] in the *Amazon Web
|
4865
|
+
# Services General Reference*.
|
4866
|
+
#
|
4867
|
+
#
|
4868
|
+
#
|
4869
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/ct.html#limits_cloudtrail
|
4870
|
+
#
|
4871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ServiceQuotaExceededException AWS API Documentation
|
4872
|
+
#
|
4873
|
+
class ServiceQuotaExceededException < Aws::EmptyStructure; end
|
4874
|
+
|
4404
4875
|
# Contains configuration information about the channel.
|
4405
4876
|
#
|
4406
4877
|
# @!attribute [rw] apply_to_all_regions
|
@@ -4421,6 +4892,42 @@ module Aws::CloudTrail
|
|
4421
4892
|
include Aws::Structure
|
4422
4893
|
end
|
4423
4894
|
|
4895
|
+
# @!attribute [rw] dashboard_id
|
4896
|
+
# The name or ARN of the dashboard.
|
4897
|
+
# @return [String]
|
4898
|
+
#
|
4899
|
+
# @!attribute [rw] query_parameter_values
|
4900
|
+
# The query parameter values for the dashboard
|
4901
|
+
#
|
4902
|
+
# For custom dashboards, the following query parameters are valid:
|
4903
|
+
# `$StartTime$`, `$EndTime$`, and `$Period$`.
|
4904
|
+
#
|
4905
|
+
# For managed dashboards, the following query parameters are valid:
|
4906
|
+
# `$StartTime$`, `$EndTime$`, `$Period$`, and `$EventDataStoreId$`.
|
4907
|
+
# The `$EventDataStoreId$` query parameter is required.
|
4908
|
+
# @return [Hash<String,String>]
|
4909
|
+
#
|
4910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartDashboardRefreshRequest AWS API Documentation
|
4911
|
+
#
|
4912
|
+
class StartDashboardRefreshRequest < Struct.new(
|
4913
|
+
:dashboard_id,
|
4914
|
+
:query_parameter_values)
|
4915
|
+
SENSITIVE = []
|
4916
|
+
include Aws::Structure
|
4917
|
+
end
|
4918
|
+
|
4919
|
+
# @!attribute [rw] refresh_id
|
4920
|
+
# The refresh ID for the dashboard.
|
4921
|
+
# @return [String]
|
4922
|
+
#
|
4923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartDashboardRefreshResponse AWS API Documentation
|
4924
|
+
#
|
4925
|
+
class StartDashboardRefreshResponse < Struct.new(
|
4926
|
+
:refresh_id)
|
4927
|
+
SENSITIVE = []
|
4928
|
+
include Aws::Structure
|
4929
|
+
end
|
4930
|
+
|
4424
4931
|
# @!attribute [rw] event_data_store
|
4425
4932
|
# The ARN (or ID suffix of the ARN) of the event data store for which
|
4426
4933
|
# you want to start ingestion.
|
@@ -4579,13 +5086,18 @@ module Aws::CloudTrail
|
|
4579
5086
|
# The query parameters for the specified `QueryAlias`.
|
4580
5087
|
# @return [Array<String>]
|
4581
5088
|
#
|
5089
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
5090
|
+
# The account ID of the event data store owner.
|
5091
|
+
# @return [String]
|
5092
|
+
#
|
4582
5093
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQueryRequest AWS API Documentation
|
4583
5094
|
#
|
4584
5095
|
class StartQueryRequest < Struct.new(
|
4585
5096
|
:query_statement,
|
4586
5097
|
:delivery_s3_uri,
|
4587
5098
|
:query_alias,
|
4588
|
-
:query_parameters
|
5099
|
+
:query_parameters,
|
5100
|
+
:event_data_store_owner_account_id)
|
4589
5101
|
SENSITIVE = []
|
4590
5102
|
include Aws::Structure
|
4591
5103
|
end
|
@@ -4594,10 +5106,15 @@ module Aws::CloudTrail
|
|
4594
5106
|
# The ID of the started query.
|
4595
5107
|
# @return [String]
|
4596
5108
|
#
|
5109
|
+
# @!attribute [rw] event_data_store_owner_account_id
|
5110
|
+
# The account ID of the event data store owner.
|
5111
|
+
# @return [String]
|
5112
|
+
#
|
4597
5113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQueryResponse AWS API Documentation
|
4598
5114
|
#
|
4599
5115
|
class StartQueryResponse < Struct.new(
|
4600
|
-
:query_id
|
5116
|
+
:query_id,
|
5117
|
+
:event_data_store_owner_account_id)
|
4601
5118
|
SENSITIVE = []
|
4602
5119
|
include Aws::Structure
|
4603
5120
|
end
|
@@ -4714,7 +5231,7 @@ module Aws::CloudTrail
|
|
4714
5231
|
class StopLoggingResponse < Aws::EmptyStructure; end
|
4715
5232
|
|
4716
5233
|
# A custom key-value pair associated with a resource such as a
|
4717
|
-
# CloudTrail trail, event data store, or channel.
|
5234
|
+
# CloudTrail trail, event data store, dashboard, or channel.
|
4718
5235
|
#
|
4719
5236
|
# @!attribute [rw] key
|
4720
5237
|
# The key in a key-value pair. The key must be must be no longer than
|
@@ -4736,8 +5253,8 @@ module Aws::CloudTrail
|
|
4736
5253
|
include Aws::Structure
|
4737
5254
|
end
|
4738
5255
|
|
4739
|
-
# The number of tags per trail, event data store, or channel
|
4740
|
-
# exceeded the permitted amount. Currently, the limit is 50.
|
5256
|
+
# The number of tags per trail, event data store, dashboard, or channel
|
5257
|
+
# has exceeded the permitted amount. Currently, the limit is 50.
|
4741
5258
|
#
|
4742
5259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/TagsLimitExceededException AWS API Documentation
|
4743
5260
|
#
|
@@ -4969,6 +5486,91 @@ module Aws::CloudTrail
|
|
4969
5486
|
include Aws::Structure
|
4970
5487
|
end
|
4971
5488
|
|
5489
|
+
# @!attribute [rw] dashboard_id
|
5490
|
+
# The name or ARN of the dashboard.
|
5491
|
+
# @return [String]
|
5492
|
+
#
|
5493
|
+
# @!attribute [rw] widgets
|
5494
|
+
# An array of widgets for the dashboard. A custom dashboard can have a
|
5495
|
+
# maximum of 10 widgets.
|
5496
|
+
#
|
5497
|
+
# To add new widgets, pass in an array that includes the existing
|
5498
|
+
# widgets along with any new widgets. Run the `GetDashboard` operation
|
5499
|
+
# to get the list of widgets for the dashboard.
|
5500
|
+
#
|
5501
|
+
# To remove widgets, pass in an array that includes the existing
|
5502
|
+
# widgets minus the widgets you want removed.
|
5503
|
+
# @return [Array<Types::RequestWidget>]
|
5504
|
+
#
|
5505
|
+
# @!attribute [rw] refresh_schedule
|
5506
|
+
# The refresh schedule configuration for the dashboard.
|
5507
|
+
# @return [Types::RefreshSchedule]
|
5508
|
+
#
|
5509
|
+
# @!attribute [rw] termination_protection_enabled
|
5510
|
+
# Specifies whether termination protection is enabled for the
|
5511
|
+
# dashboard. If termination protection is enabled, you cannot delete
|
5512
|
+
# the dashboard until termination protection is disabled.
|
5513
|
+
# @return [Boolean]
|
5514
|
+
#
|
5515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateDashboardRequest AWS API Documentation
|
5516
|
+
#
|
5517
|
+
class UpdateDashboardRequest < Struct.new(
|
5518
|
+
:dashboard_id,
|
5519
|
+
:widgets,
|
5520
|
+
:refresh_schedule,
|
5521
|
+
:termination_protection_enabled)
|
5522
|
+
SENSITIVE = []
|
5523
|
+
include Aws::Structure
|
5524
|
+
end
|
5525
|
+
|
5526
|
+
# @!attribute [rw] dashboard_arn
|
5527
|
+
# The ARN for the dashboard.
|
5528
|
+
# @return [String]
|
5529
|
+
#
|
5530
|
+
# @!attribute [rw] name
|
5531
|
+
# The name for the dashboard.
|
5532
|
+
# @return [String]
|
5533
|
+
#
|
5534
|
+
# @!attribute [rw] type
|
5535
|
+
# The type of dashboard.
|
5536
|
+
# @return [String]
|
5537
|
+
#
|
5538
|
+
# @!attribute [rw] widgets
|
5539
|
+
# An array of widgets for the dashboard.
|
5540
|
+
# @return [Array<Types::Widget>]
|
5541
|
+
#
|
5542
|
+
# @!attribute [rw] refresh_schedule
|
5543
|
+
# The refresh schedule for the dashboard, if configured.
|
5544
|
+
# @return [Types::RefreshSchedule]
|
5545
|
+
#
|
5546
|
+
# @!attribute [rw] termination_protection_enabled
|
5547
|
+
# Indicates whether termination protection is enabled for the
|
5548
|
+
# dashboard.
|
5549
|
+
# @return [Boolean]
|
5550
|
+
#
|
5551
|
+
# @!attribute [rw] created_timestamp
|
5552
|
+
# The timestamp that shows when the dashboard was created.
|
5553
|
+
# @return [Time]
|
5554
|
+
#
|
5555
|
+
# @!attribute [rw] updated_timestamp
|
5556
|
+
# The timestamp that shows when the dashboard was updated.
|
5557
|
+
# @return [Time]
|
5558
|
+
#
|
5559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateDashboardResponse AWS API Documentation
|
5560
|
+
#
|
5561
|
+
class UpdateDashboardResponse < Struct.new(
|
5562
|
+
:dashboard_arn,
|
5563
|
+
:name,
|
5564
|
+
:type,
|
5565
|
+
:widgets,
|
5566
|
+
:refresh_schedule,
|
5567
|
+
:termination_protection_enabled,
|
5568
|
+
:created_timestamp,
|
5569
|
+
:updated_timestamp)
|
5570
|
+
SENSITIVE = []
|
5571
|
+
include Aws::Structure
|
5572
|
+
end
|
5573
|
+
|
4972
5574
|
# @!attribute [rw] event_data_store
|
4973
5575
|
# The ARN (or the ID suffix of the ARN) of the event data store that
|
4974
5576
|
# you want to update.
|
@@ -5464,6 +6066,41 @@ module Aws::CloudTrail
|
|
5464
6066
|
include Aws::Structure
|
5465
6067
|
end
|
5466
6068
|
|
6069
|
+
# A widget on a CloudTrail Lake dashboard.
|
6070
|
+
#
|
6071
|
+
# @!attribute [rw] query_alias
|
6072
|
+
# The query alias used to identify the query for the widget.
|
6073
|
+
# @return [String]
|
6074
|
+
#
|
6075
|
+
# @!attribute [rw] query_statement
|
6076
|
+
# The SQL query statement for the widget.
|
6077
|
+
# @return [String]
|
6078
|
+
#
|
6079
|
+
# @!attribute [rw] query_parameters
|
6080
|
+
# The query parameters for the widget.
|
6081
|
+
# @return [Array<String>]
|
6082
|
+
#
|
6083
|
+
# @!attribute [rw] view_properties
|
6084
|
+
# The view properties for the widget. For more information about view
|
6085
|
+
# properties, see [ View properties for widgets ][1] in the
|
6086
|
+
# *CloudTrail User Guide*..
|
6087
|
+
#
|
6088
|
+
#
|
6089
|
+
#
|
6090
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-widget-properties.html
|
6091
|
+
# @return [Hash<String,String>]
|
6092
|
+
#
|
6093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Widget AWS API Documentation
|
6094
|
+
#
|
6095
|
+
class Widget < Struct.new(
|
6096
|
+
:query_alias,
|
6097
|
+
:query_statement,
|
6098
|
+
:query_parameters,
|
6099
|
+
:view_properties)
|
6100
|
+
SENSITIVE = []
|
6101
|
+
include Aws::Structure
|
6102
|
+
end
|
6103
|
+
|
5467
6104
|
end
|
5468
6105
|
end
|
5469
6106
|
|