aws-sdk-cloudtrail 1.60.0 → 1.62.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudtrail/client.rb +161 -71
- data/lib/aws-sdk-cloudtrail/client_api.rb +62 -2
- data/lib/aws-sdk-cloudtrail/endpoints.rb +28 -0
- data/lib/aws-sdk-cloudtrail/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-cloudtrail/types.rb +153 -64
- data/lib/aws-sdk-cloudtrail.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6240f69b330164bda213408a5ce5ed3d7ba9582b60572b3afa82d109a498cdc6
|
4
|
+
data.tar.gz: 0fa14ff83c8ea9aa7c3951825cd20457eb66c566395582805bce412010fd1c2b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 14045e4930af4b1da780abf31e71d24de607291873435443ed3f4b1c433d34f9ec2745cfae562e5af354d73d579b1dbf05fedba3654274c090612aa423f9833b
|
7
|
+
data.tar.gz: 113a4d05421a25631fed6d0cfab5250a51c65f346796418dbd34ba1ec387fb3539ce973e909058a3a3653b4d802fa406ce57d5328e1cbc858d3dee5b4069a482
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.62.0 (2023-06-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This feature allows users to view dashboards for CloudTrail Lake event data stores.
|
8
|
+
|
9
|
+
1.61.0 (2023-06-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This feature allows users to start and stop event ingestion on a CloudTrail Lake event data store.
|
13
|
+
|
4
14
|
1.60.0 (2023-05-31)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.62.0
|
@@ -391,7 +391,7 @@ module Aws::CloudTrail
|
|
391
391
|
# specified key and a value of null. You can tag a trail or event data
|
392
392
|
# store that applies to all Amazon Web Services Regions only from the
|
393
393
|
# Region in which the trail or event data store was created (also known
|
394
|
-
# as its home
|
394
|
+
# as its home Region).
|
395
395
|
#
|
396
396
|
# @option params [required, String] :resource_id
|
397
397
|
# Specifies the ARN of the trail, event data store, or channel to which
|
@@ -401,7 +401,7 @@ module Aws::CloudTrail
|
|
401
401
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
402
402
|
#
|
403
403
|
# The format of an event data store ARN is:
|
404
|
-
# `arn:aws:cloudtrail:us-east-2:
|
404
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
405
405
|
#
|
406
406
|
# The format of a channel ARN is:
|
407
407
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
@@ -580,7 +580,7 @@ module Aws::CloudTrail
|
|
580
580
|
#
|
581
581
|
# @option params [Boolean] :multi_region_enabled
|
582
582
|
# Specifies whether the event data store includes events from all
|
583
|
-
#
|
583
|
+
# Regions, or only from the Region in which the event data store is
|
584
584
|
# created.
|
585
585
|
#
|
586
586
|
# @option params [Boolean] :organization_enabled
|
@@ -631,6 +631,10 @@ module Aws::CloudTrail
|
|
631
631
|
#
|
632
632
|
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html
|
633
633
|
#
|
634
|
+
# @option params [Boolean] :start_ingestion
|
635
|
+
# Specifies whether the event data store should start ingesting live
|
636
|
+
# events. The default is true.
|
637
|
+
#
|
634
638
|
# @return [Types::CreateEventDataStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
635
639
|
#
|
636
640
|
# * {Types::CreateEventDataStoreResponse#event_data_store_arn #event_data_store_arn} => String
|
@@ -677,13 +681,14 @@ module Aws::CloudTrail
|
|
677
681
|
# },
|
678
682
|
# ],
|
679
683
|
# kms_key_id: "EventDataStoreKmsKeyId",
|
684
|
+
# start_ingestion: false,
|
680
685
|
# })
|
681
686
|
#
|
682
687
|
# @example Response structure
|
683
688
|
#
|
684
689
|
# resp.event_data_store_arn #=> String
|
685
690
|
# resp.name #=> String
|
686
|
-
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION"
|
691
|
+
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
|
687
692
|
# resp.advanced_event_selectors #=> Array
|
688
693
|
# resp.advanced_event_selectors[0].name #=> String
|
689
694
|
# resp.advanced_event_selectors[0].field_selectors #=> Array
|
@@ -766,10 +771,10 @@ module Aws::CloudTrail
|
|
766
771
|
# such as IAM to the log files.
|
767
772
|
#
|
768
773
|
# @option params [Boolean] :is_multi_region_trail
|
769
|
-
# Specifies whether the trail is created in the current
|
770
|
-
#
|
771
|
-
#
|
772
|
-
# trails that log events in all
|
774
|
+
# Specifies whether the trail is created in the current Region or in all
|
775
|
+
# Regions. The default is false, which creates a trail only in the
|
776
|
+
# Region where you are signed in. As a best practice, consider creating
|
777
|
+
# trails that log events in all Regions.
|
773
778
|
#
|
774
779
|
# @option params [Boolean] :enable_log_file_validation
|
775
780
|
# Specifies whether log file integrity validation is enabled. The
|
@@ -980,10 +985,10 @@ module Aws::CloudTrail
|
|
980
985
|
req.send_request(options)
|
981
986
|
end
|
982
987
|
|
983
|
-
# Deletes a trail. This operation must be called from the
|
988
|
+
# Deletes a trail. This operation must be called from the Region in
|
984
989
|
# which the trail was created. `DeleteTrail` cannot be called on the
|
985
|
-
# shadow trails (replicated trails in other
|
986
|
-
# enabled in all
|
990
|
+
# shadow trails (replicated trails in other Regions) of a trail that is
|
991
|
+
# enabled in all Regions.
|
987
992
|
#
|
988
993
|
# @option params [required, String] :name
|
989
994
|
# Specifies the name or the CloudTrail ARN of the trail to be deleted.
|
@@ -1034,16 +1039,23 @@ module Aws::CloudTrail
|
|
1034
1039
|
|
1035
1040
|
# Returns metadata about a query, including query run time in
|
1036
1041
|
# milliseconds, number of events scanned and matched, and query status.
|
1037
|
-
#
|
1038
|
-
#
|
1042
|
+
# If the query results were delivered to an S3 bucket, the response also
|
1043
|
+
# provides the S3 URI and the delivery status.
|
1044
|
+
#
|
1045
|
+
# You must specify either a `QueryID` or a `QueryAlias`. Specifying the
|
1046
|
+
# `QueryAlias` parameter returns information about the last query run
|
1047
|
+
# for the alias.
|
1039
1048
|
#
|
1040
1049
|
# @option params [String] :event_data_store
|
1041
1050
|
# The ARN (or the ID suffix of the ARN) of an event data store on which
|
1042
1051
|
# the specified query was run.
|
1043
1052
|
#
|
1044
|
-
# @option params [
|
1053
|
+
# @option params [String] :query_id
|
1045
1054
|
# The query ID.
|
1046
1055
|
#
|
1056
|
+
# @option params [String] :query_alias
|
1057
|
+
# The alias that identifies a query template.
|
1058
|
+
#
|
1047
1059
|
# @return [Types::DescribeQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1048
1060
|
#
|
1049
1061
|
# * {Types::DescribeQueryResponse#query_id #query_id} => String
|
@@ -1058,7 +1070,8 @@ module Aws::CloudTrail
|
|
1058
1070
|
#
|
1059
1071
|
# resp = client.describe_query({
|
1060
1072
|
# event_data_store: "EventDataStoreArn",
|
1061
|
-
# query_id: "UUID",
|
1073
|
+
# query_id: "UUID",
|
1074
|
+
# query_alias: "QueryAlias",
|
1062
1075
|
# })
|
1063
1076
|
#
|
1064
1077
|
# @example Response structure
|
@@ -1085,7 +1098,7 @@ module Aws::CloudTrail
|
|
1085
1098
|
end
|
1086
1099
|
|
1087
1100
|
# Retrieves settings for one or more trails associated with the current
|
1088
|
-
#
|
1101
|
+
# Region for your account.
|
1089
1102
|
#
|
1090
1103
|
# @option params [Array<String>] :trail_name_list
|
1091
1104
|
# Specifies a list of trail names, trail ARNs, or both, of the trails to
|
@@ -1094,29 +1107,29 @@ module Aws::CloudTrail
|
|
1094
1107
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
1095
1108
|
#
|
1096
1109
|
# If an empty list is specified, information for the trail in the
|
1097
|
-
# current
|
1110
|
+
# current Region is returned.
|
1098
1111
|
#
|
1099
1112
|
# * If an empty list is specified and `IncludeShadowTrails` is false,
|
1100
|
-
# then information for all trails in the current
|
1113
|
+
# then information for all trails in the current Region is returned.
|
1101
1114
|
#
|
1102
1115
|
# * If an empty list is specified and IncludeShadowTrails is null or
|
1103
|
-
# true, then information for all trails in the current
|
1104
|
-
# associated shadow trails in other
|
1116
|
+
# true, then information for all trails in the current Region and any
|
1117
|
+
# associated shadow trails in other Regions is returned.
|
1105
1118
|
#
|
1106
1119
|
# <note markdown="1"> If one or more trail names are specified, information is returned only
|
1107
1120
|
# if the names match the names of trails belonging only to the current
|
1108
|
-
#
|
1109
|
-
# another
|
1121
|
+
# Region and current account. To return information about a trail in
|
1122
|
+
# another Region, you must specify its trail ARN.
|
1110
1123
|
#
|
1111
1124
|
# </note>
|
1112
1125
|
#
|
1113
1126
|
# @option params [Boolean] :include_shadow_trails
|
1114
1127
|
# Specifies whether to include shadow trails in the response. A shadow
|
1115
|
-
# trail is the replication in a
|
1116
|
-
# different
|
1128
|
+
# trail is the replication in a Region of a trail that was created in a
|
1129
|
+
# different Region, or in the case of an organization trail, the
|
1117
1130
|
# replication of an organization trail in member accounts. If you do not
|
1118
1131
|
# include shadow trails, organization trails in a member account and
|
1119
|
-
#
|
1132
|
+
# Region replication trails will not be returned. The default is true.
|
1120
1133
|
#
|
1121
1134
|
# @return [Types::DescribeTrailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1122
1135
|
#
|
@@ -1249,7 +1262,7 @@ module Aws::CloudTrail
|
|
1249
1262
|
#
|
1250
1263
|
# resp.event_data_store_arn #=> String
|
1251
1264
|
# resp.name #=> String
|
1252
|
-
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION"
|
1265
|
+
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
|
1253
1266
|
# resp.advanced_event_selectors #=> Array
|
1254
1267
|
# resp.advanced_event_selectors[0].name #=> String
|
1255
1268
|
# resp.advanced_event_selectors[0].field_selectors #=> Array
|
@@ -1490,8 +1503,7 @@ module Aws::CloudTrail
|
|
1490
1503
|
end
|
1491
1504
|
|
1492
1505
|
# Gets event data results of a query. You must specify the `QueryID`
|
1493
|
-
# value returned by the `StartQuery` operation
|
1494
|
-
# `EventDataStore`.
|
1506
|
+
# value returned by the `StartQuery` operation.
|
1495
1507
|
#
|
1496
1508
|
# @option params [String] :event_data_store
|
1497
1509
|
# The ARN (or ID suffix of the ARN) of the event data store against
|
@@ -1627,14 +1639,14 @@ module Aws::CloudTrail
|
|
1627
1639
|
# Returns a JSON-formatted list of information about the specified
|
1628
1640
|
# trail. Fields include information on delivery errors, Amazon SNS and
|
1629
1641
|
# Amazon S3 errors, and start and stop logging times for each trail.
|
1630
|
-
# This operation returns trail status from a single
|
1631
|
-
# trail status from all
|
1632
|
-
#
|
1642
|
+
# This operation returns trail status from a single Region. To return
|
1643
|
+
# trail status from all Regions, you must call the operation on each
|
1644
|
+
# Region.
|
1633
1645
|
#
|
1634
1646
|
# @option params [required, String] :name
|
1635
1647
|
# Specifies the name or the CloudTrail ARN of the trail for which you
|
1636
1648
|
# are requesting status. To get the status of a shadow trail (a
|
1637
|
-
# replication of the trail in another
|
1649
|
+
# replication of the trail in another Region), you must specify its ARN.
|
1638
1650
|
# The following is the format of a trail ARN.
|
1639
1651
|
#
|
1640
1652
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
@@ -1737,7 +1749,7 @@ module Aws::CloudTrail
|
|
1737
1749
|
end
|
1738
1750
|
|
1739
1751
|
# Returns information about all event data stores in the account, in the
|
1740
|
-
# current
|
1752
|
+
# current Region.
|
1741
1753
|
#
|
1742
1754
|
# @option params [String] :next_token
|
1743
1755
|
# A token you can use to get the next page of event data store results.
|
@@ -1765,7 +1777,7 @@ module Aws::CloudTrail
|
|
1765
1777
|
# resp.event_data_stores[0].event_data_store_arn #=> String
|
1766
1778
|
# resp.event_data_stores[0].name #=> String
|
1767
1779
|
# resp.event_data_stores[0].termination_protection_enabled #=> Boolean
|
1768
|
-
# resp.event_data_stores[0].status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION"
|
1780
|
+
# resp.event_data_stores[0].status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
|
1769
1781
|
# resp.event_data_stores[0].advanced_event_selectors #=> Array
|
1770
1782
|
# resp.event_data_stores[0].advanced_event_selectors[0].name #=> String
|
1771
1783
|
# resp.event_data_stores[0].advanced_event_selectors[0].field_selectors #=> Array
|
@@ -1899,10 +1911,10 @@ module Aws::CloudTrail
|
|
1899
1911
|
# to validate digest files that were signed with its corresponding
|
1900
1912
|
# private key.
|
1901
1913
|
#
|
1902
|
-
# <note markdown="1"> CloudTrail uses different private and public key pairs per
|
1903
|
-
# Each digest file is signed with a private key unique to its
|
1904
|
-
# When you validate a digest file from a specific
|
1905
|
-
# in the same
|
1914
|
+
# <note markdown="1"> CloudTrail uses different private and public key pairs per Region.
|
1915
|
+
# Each digest file is signed with a private key unique to its Region.
|
1916
|
+
# When you validate a digest file from a specific Region, you must look
|
1917
|
+
# in the same Region for its corresponding public key.
|
1906
1918
|
#
|
1907
1919
|
# </note>
|
1908
1920
|
#
|
@@ -2017,13 +2029,22 @@ module Aws::CloudTrail
|
|
2017
2029
|
req.send_request(options)
|
2018
2030
|
end
|
2019
2031
|
|
2020
|
-
# Lists the tags for the
|
2021
|
-
# current
|
2032
|
+
# Lists the tags for the specified trails, event data stores, or
|
2033
|
+
# channels in the current Region.
|
2022
2034
|
#
|
2023
2035
|
# @option params [required, Array<String>] :resource_id_list
|
2024
2036
|
# Specifies a list of trail, event data store, or channel ARNs whose
|
2025
2037
|
# tags will be listed. The list has a limit of 20 ARNs.
|
2026
2038
|
#
|
2039
|
+
# Example trail ARN format:
|
2040
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2041
|
+
#
|
2042
|
+
# Example event data store ARN format:
|
2043
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
2044
|
+
#
|
2045
|
+
# Example channel ARN format:
|
2046
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
2047
|
+
#
|
2027
2048
|
# @option params [String] :next_token
|
2028
2049
|
# Reserved for future use.
|
2029
2050
|
#
|
@@ -2100,7 +2121,7 @@ module Aws::CloudTrail
|
|
2100
2121
|
|
2101
2122
|
# Looks up [management events][1] or [CloudTrail Insights events][2]
|
2102
2123
|
# that are captured by CloudTrail. You can look up events that occurred
|
2103
|
-
# in a
|
2124
|
+
# in a Region within the last 90 days. Lookup supports the following
|
2104
2125
|
# attributes for management events:
|
2105
2126
|
#
|
2106
2127
|
# * Amazon Web Services access key
|
@@ -2132,7 +2153,7 @@ module Aws::CloudTrail
|
|
2132
2153
|
# you can use to get the next page of results.
|
2133
2154
|
#
|
2134
2155
|
# The rate of lookup requests is limited to two per second, per account,
|
2135
|
-
# per
|
2156
|
+
# per Region. If this limit is exceeded, a throttling error occurs.
|
2136
2157
|
#
|
2137
2158
|
#
|
2138
2159
|
#
|
@@ -2252,7 +2273,7 @@ module Aws::CloudTrail
|
|
2252
2273
|
# 5. The `GetConsoleOutput` is a read-only event that doesn't match
|
2253
2274
|
# your event selector. The trail doesn't log the event.
|
2254
2275
|
#
|
2255
|
-
# The `PutEventSelectors` operation must be called from the
|
2276
|
+
# The `PutEventSelectors` operation must be called from the Region in
|
2256
2277
|
# which the trail was created; otherwise, an
|
2257
2278
|
# `InvalidHomeRegionException` exception is thrown.
|
2258
2279
|
#
|
@@ -2545,7 +2566,7 @@ module Aws::CloudTrail
|
|
2545
2566
|
# `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
|
2546
2567
|
#
|
2547
2568
|
# Example event data store ARN format:
|
2548
|
-
# `arn:aws:cloudtrail:us-east-2:
|
2569
|
+
# `arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE`
|
2549
2570
|
#
|
2550
2571
|
# Example channel ARN format:
|
2551
2572
|
# `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890`
|
@@ -2610,7 +2631,7 @@ module Aws::CloudTrail
|
|
2610
2631
|
#
|
2611
2632
|
# resp.event_data_store_arn #=> String
|
2612
2633
|
# resp.name #=> String
|
2613
|
-
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION"
|
2634
|
+
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
|
2614
2635
|
# resp.advanced_event_selectors #=> Array
|
2615
2636
|
# resp.advanced_event_selectors[0].name #=> String
|
2616
2637
|
# resp.advanced_event_selectors[0].field_selectors #=> Array
|
@@ -2644,6 +2665,32 @@ module Aws::CloudTrail
|
|
2644
2665
|
req.send_request(options)
|
2645
2666
|
end
|
2646
2667
|
|
2668
|
+
# Starts the ingestion of live events on an event data store specified
|
2669
|
+
# as either an ARN or the ID portion of the ARN. To start ingestion, the
|
2670
|
+
# event data store `Status` must be `STOPPED_INGESTION` and the
|
2671
|
+
# `eventCategory` must be `Management`, `Data`, or `ConfigurationItem`.
|
2672
|
+
#
|
2673
|
+
# @option params [required, String] :event_data_store
|
2674
|
+
# The ARN (or ID suffix of the ARN) of the event data store for which
|
2675
|
+
# you want to start ingestion.
|
2676
|
+
#
|
2677
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2678
|
+
#
|
2679
|
+
# @example Request syntax with placeholder values
|
2680
|
+
#
|
2681
|
+
# resp = client.start_event_data_store_ingestion({
|
2682
|
+
# event_data_store: "EventDataStoreArn", # required
|
2683
|
+
# })
|
2684
|
+
#
|
2685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartEventDataStoreIngestion AWS API Documentation
|
2686
|
+
#
|
2687
|
+
# @overload start_event_data_store_ingestion(params = {})
|
2688
|
+
# @param [Hash] params ({})
|
2689
|
+
def start_event_data_store_ingestion(params = {}, options = {})
|
2690
|
+
req = build_request(:start_event_data_store_ingestion, params)
|
2691
|
+
req.send_request(options)
|
2692
|
+
end
|
2693
|
+
|
2647
2694
|
# Starts an import of logged trail events from a source S3 bucket to a
|
2648
2695
|
# destination event data store. By default, CloudTrail only imports
|
2649
2696
|
# events contained in the S3 bucket's `CloudTrail` prefix and the
|
@@ -2751,11 +2798,11 @@ module Aws::CloudTrail
|
|
2751
2798
|
end
|
2752
2799
|
|
2753
2800
|
# Starts the recording of Amazon Web Services API calls and log file
|
2754
|
-
# delivery for a trail. For a trail that is enabled in all
|
2755
|
-
# operation must be called from the
|
2801
|
+
# delivery for a trail. For a trail that is enabled in all Regions, this
|
2802
|
+
# operation must be called from the Region in which the trail was
|
2756
2803
|
# created. This operation cannot be called on the shadow trails
|
2757
|
-
# (replicated trails in other
|
2758
|
-
#
|
2804
|
+
# (replicated trails in other Regions) of a trail that is enabled in all
|
2805
|
+
# Regions.
|
2759
2806
|
#
|
2760
2807
|
# @option params [required, String] :name
|
2761
2808
|
# Specifies the name or the CloudTrail ARN of the trail for which
|
@@ -2781,17 +2828,28 @@ module Aws::CloudTrail
|
|
2781
2828
|
req.send_request(options)
|
2782
2829
|
end
|
2783
2830
|
|
2784
|
-
# Starts a CloudTrail Lake query.
|
2785
|
-
#
|
2786
|
-
#
|
2787
|
-
#
|
2831
|
+
# Starts a CloudTrail Lake query. Use the `QueryStatement` parameter to
|
2832
|
+
# provide your SQL query, enclosed in single quotation marks. Use the
|
2833
|
+
# optional `DeliveryS3Uri` parameter to deliver the query results to an
|
2834
|
+
# S3 bucket.
|
2788
2835
|
#
|
2789
|
-
#
|
2836
|
+
# `StartQuery` requires you specify either the `QueryStatement`
|
2837
|
+
# parameter, or a `QueryAlias` and any `QueryParameters`. In the current
|
2838
|
+
# release, the `QueryAlias` and `QueryParameters` parameters are used
|
2839
|
+
# only for the queries that populate the CloudTrail Lake dashboards.
|
2840
|
+
#
|
2841
|
+
# @option params [String] :query_statement
|
2790
2842
|
# The SQL code of your query.
|
2791
2843
|
#
|
2792
2844
|
# @option params [String] :delivery_s3_uri
|
2793
2845
|
# The URI for the S3 bucket where CloudTrail delivers the query results.
|
2794
2846
|
#
|
2847
|
+
# @option params [String] :query_alias
|
2848
|
+
# The alias that identifies a query template.
|
2849
|
+
#
|
2850
|
+
# @option params [Array<String>] :query_parameters
|
2851
|
+
# The query parameters for the specified `QueryAlias`.
|
2852
|
+
#
|
2795
2853
|
# @return [Types::StartQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2796
2854
|
#
|
2797
2855
|
# * {Types::StartQueryResponse#query_id #query_id} => String
|
@@ -2799,8 +2857,10 @@ module Aws::CloudTrail
|
|
2799
2857
|
# @example Request syntax with placeholder values
|
2800
2858
|
#
|
2801
2859
|
# resp = client.start_query({
|
2802
|
-
# query_statement: "QueryStatement",
|
2860
|
+
# query_statement: "QueryStatement",
|
2803
2861
|
# delivery_s3_uri: "DeliveryS3Uri",
|
2862
|
+
# query_alias: "QueryAlias",
|
2863
|
+
# query_parameters: ["QueryParameter"],
|
2804
2864
|
# })
|
2805
2865
|
#
|
2806
2866
|
# @example Response structure
|
@@ -2816,6 +2876,32 @@ module Aws::CloudTrail
|
|
2816
2876
|
req.send_request(options)
|
2817
2877
|
end
|
2818
2878
|
|
2879
|
+
# Stops the ingestion of live events on an event data store specified as
|
2880
|
+
# either an ARN or the ID portion of the ARN. To stop ingestion, the
|
2881
|
+
# event data store `Status` must be `ENABLED` and the `eventCategory`
|
2882
|
+
# must be `Management`, `Data`, or `ConfigurationItem`.
|
2883
|
+
#
|
2884
|
+
# @option params [required, String] :event_data_store
|
2885
|
+
# The ARN (or ID suffix of the ARN) of the event data store for which
|
2886
|
+
# you want to stop ingestion.
|
2887
|
+
#
|
2888
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2889
|
+
#
|
2890
|
+
# @example Request syntax with placeholder values
|
2891
|
+
#
|
2892
|
+
# resp = client.stop_event_data_store_ingestion({
|
2893
|
+
# event_data_store: "EventDataStoreArn", # required
|
2894
|
+
# })
|
2895
|
+
#
|
2896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopEventDataStoreIngestion AWS API Documentation
|
2897
|
+
#
|
2898
|
+
# @overload stop_event_data_store_ingestion(params = {})
|
2899
|
+
# @param [Hash] params ({})
|
2900
|
+
def stop_event_data_store_ingestion(params = {}, options = {})
|
2901
|
+
req = build_request(:stop_event_data_store_ingestion, params)
|
2902
|
+
req.send_request(options)
|
2903
|
+
end
|
2904
|
+
|
2819
2905
|
# Stops a specified import.
|
2820
2906
|
#
|
2821
2907
|
# @option params [required, String] :import_id
|
@@ -2871,11 +2957,11 @@ module Aws::CloudTrail
|
|
2871
2957
|
# delivery for the specified trail. Under most circumstances, there is
|
2872
2958
|
# no need to use this action. You can update a trail without stopping it
|
2873
2959
|
# first. This action is the only way to stop recording. For a trail
|
2874
|
-
# enabled in all
|
2960
|
+
# enabled in all Regions, this operation must be called from the Region
|
2875
2961
|
# in which the trail was created, or an `InvalidHomeRegionException`
|
2876
2962
|
# will occur. This operation cannot be called on the shadow trails
|
2877
|
-
# (replicated trails in other
|
2878
|
-
#
|
2963
|
+
# (replicated trails in other Regions) of a trail enabled in all
|
2964
|
+
# Regions.
|
2879
2965
|
#
|
2880
2966
|
# @option params [required, String] :name
|
2881
2967
|
# Specifies the name or the CloudTrail ARN of the trail for which
|
@@ -2961,12 +3047,16 @@ module Aws::CloudTrail
|
|
2961
3047
|
# For event data stores for CloudTrail events, `AdvancedEventSelectors`
|
2962
3048
|
# includes or excludes management and data events in your event data
|
2963
3049
|
# store. For more information about `AdvancedEventSelectors`, see
|
2964
|
-
#
|
3050
|
+
# [AdvancedEventSelectors][1].
|
2965
3051
|
#
|
2966
3052
|
# For event data stores for Config configuration items, Audit Manager
|
2967
3053
|
# evidence, or non-Amazon Web Services events, `AdvancedEventSelectors`
|
2968
3054
|
# includes events of that type in your event data store.
|
2969
3055
|
#
|
3056
|
+
#
|
3057
|
+
#
|
3058
|
+
# [1]: https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html
|
3059
|
+
#
|
2970
3060
|
# @option params [required, String] :event_data_store
|
2971
3061
|
# The ARN (or the ID suffix of the ARN) of the event data store that you
|
2972
3062
|
# want to update.
|
@@ -2981,7 +3071,7 @@ module Aws::CloudTrail
|
|
2981
3071
|
#
|
2982
3072
|
# @option params [Boolean] :multi_region_enabled
|
2983
3073
|
# Specifies whether an event data store collects events from all
|
2984
|
-
#
|
3074
|
+
# Regions, or only from the Region in which it was created.
|
2985
3075
|
#
|
2986
3076
|
# @option params [Boolean] :organization_enabled
|
2987
3077
|
# Specifies whether an event data store collects events logged for an
|
@@ -3072,7 +3162,7 @@ module Aws::CloudTrail
|
|
3072
3162
|
#
|
3073
3163
|
# resp.event_data_store_arn #=> String
|
3074
3164
|
# resp.name #=> String
|
3075
|
-
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION"
|
3165
|
+
# resp.status #=> String, one of "CREATED", "ENABLED", "PENDING_DELETION", "STARTING_INGESTION", "STOPPING_INGESTION", "STOPPED_INGESTION"
|
3076
3166
|
# resp.advanced_event_selectors #=> Array
|
3077
3167
|
# resp.advanced_event_selectors[0].name #=> String
|
3078
3168
|
# resp.advanced_event_selectors[0].field_selectors #=> Array
|
@@ -3111,7 +3201,7 @@ module Aws::CloudTrail
|
|
3111
3201
|
# the CloudTrail service. Use this action to designate an existing
|
3112
3202
|
# bucket for log delivery. If the existing bucket has previously been a
|
3113
3203
|
# target for CloudTrail log files, an IAM policy exists for the bucket.
|
3114
|
-
# `UpdateTrail` must be called from the
|
3204
|
+
# `UpdateTrail` must be called from the Region in which the trail was
|
3115
3205
|
# created; otherwise, an `InvalidHomeRegionException` is thrown.
|
3116
3206
|
#
|
3117
3207
|
# @option params [required, String] :name
|
@@ -3161,14 +3251,14 @@ module Aws::CloudTrail
|
|
3161
3251
|
# such as IAM to the log files.
|
3162
3252
|
#
|
3163
3253
|
# @option params [Boolean] :is_multi_region_trail
|
3164
|
-
# Specifies whether the trail applies only to the current
|
3165
|
-
# all
|
3166
|
-
# current
|
3167
|
-
# (replications of the trail) will be created in the other
|
3168
|
-
# the trail exists in all
|
3169
|
-
# trail will remain in the
|
3170
|
-
# trails in other
|
3171
|
-
# using trails that log events in all
|
3254
|
+
# Specifies whether the trail applies only to the current Region or to
|
3255
|
+
# all Regions. The default is false. If the trail exists only in the
|
3256
|
+
# current Region and this value is set to true, shadow trails
|
3257
|
+
# (replications of the trail) will be created in the other Regions. If
|
3258
|
+
# the trail exists in all Regions and this value is set to false, the
|
3259
|
+
# trail will remain in the Region where it was created, and its shadow
|
3260
|
+
# trails in other Regions will be deleted. As a best practice, consider
|
3261
|
+
# using trails that log events in all Regions.
|
3172
3262
|
#
|
3173
3263
|
# @option params [Boolean] :enable_log_file_validation
|
3174
3264
|
# Specifies whether log file validation is enabled. The default is
|
@@ -3306,7 +3396,7 @@ module Aws::CloudTrail
|
|
3306
3396
|
params: params,
|
3307
3397
|
config: config)
|
3308
3398
|
context[:gem_name] = 'aws-sdk-cloudtrail'
|
3309
|
-
context[:gem_version] = '1.
|
3399
|
+
context[:gem_version] = '1.62.0'
|
3310
3400
|
Seahorse::Client::Request.new(handlers, context)
|
3311
3401
|
end
|
3312
3402
|
|