Class: Aws::CloudTrail::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudTrail::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb
Overview
An API client for CloudTrail. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudTrail::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_tags(params = {}) ⇒ Struct
Adds one or more tags to a trail or event data store, up to a limit of 50.
-
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
Cancels a query if the query is not in a terminated state, such as
CANCELLED
,FAILED
,TIMED_OUT
, orFINISHED
. -
#create_event_data_store(params = {}) ⇒ Types::CreateEventDataStoreResponse
Creates a new event data store.
-
#create_trail(params = {}) ⇒ Types::CreateTrailResponse
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
-
#delete_event_data_store(params = {}) ⇒ Struct
Disables the event data store specified by
EventDataStore
, which accepts an event data store ARN. -
#delete_trail(params = {}) ⇒ Struct
Deletes a trail.
-
#describe_query(params = {}) ⇒ Types::DescribeQueryResponse
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status.
-
#describe_trails(params = {}) ⇒ Types::DescribeTrailsResponse
Retrieves settings for one or more trails associated with the current region for your account.
-
#get_event_data_store(params = {}) ⇒ Types::GetEventDataStoreResponse
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
-
#get_event_selectors(params = {}) ⇒ Types::GetEventSelectorsResponse
Describes the settings for the event selectors that you configured for your trail.
-
#get_insight_selectors(params = {}) ⇒ Types::GetInsightSelectorsResponse
Describes the settings for the Insights event selectors that you configured for your trail.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Gets event data results of a query.
-
#get_trail(params = {}) ⇒ Types::GetTrailResponse
Returns settings information for a specified trail.
-
#get_trail_status(params = {}) ⇒ Types::GetTrailStatusResponse
Returns a JSON-formatted list of information about the specified trail.
-
#list_event_data_stores(params = {}) ⇒ Types::ListEventDataStoresResponse
Returns information about all event data stores in the account, in the current region.
-
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResponse
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
-
#list_queries(params = {}) ⇒ Types::ListQueriesResponse
Returns a list of queries and query statuses for the past seven days.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags for the trail or event data store in the current region.
-
#list_trails(params = {}) ⇒ Types::ListTrailsResponse
Lists trails that are in the current account.
-
#lookup_events(params = {}) ⇒ Types::LookupEventsResponse
Looks up [management events][1] or [CloudTrail Insights events][2] that are captured by CloudTrail.
-
#put_event_selectors(params = {}) ⇒ Types::PutEventSelectorsResponse
Configures an event selector or advanced event selectors for your trail.
-
#put_insight_selectors(params = {}) ⇒ Types::PutInsightSelectorsResponse
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
-
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from a trail or event data store.
-
#restore_event_data_store(params = {}) ⇒ Types::RestoreEventDataStoreResponse
Restores a deleted event data store specified by
EventDataStore
, which accepts an event data store ARN. -
#start_logging(params = {}) ⇒ Struct
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
-
#start_query(params = {}) ⇒ Types::StartQueryResponse
Starts a CloudTrail Lake query.
-
#stop_logging(params = {}) ⇒ Struct
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
-
#update_event_data_store(params = {}) ⇒ Types::UpdateEventDataStoreResponse
Updates an event data store.
-
#update_trail(params = {}) ⇒ Types::UpdateTrailResponse
Updates trail settings that control what events you are logging, and how to handle log files.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#add_tags(params = {}) ⇒ Struct
Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).
401 402 403 404 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 401 def (params = {}, = {}) req = build_request(:add_tags, params) req.send_request() end |
#cancel_query(params = {}) ⇒ Types::CancelQueryResponse
Cancels a query if the query is not in a terminated state, such as
CANCELLED
, FAILED
, TIMED_OUT
, or FINISHED
. You must specify an
ARN value for EventDataStore
. The ID of the query that you want to
cancel is also required. When you run CancelQuery
, the query status
might show as CANCELLED
even if the operation is not yet finished.
441 442 443 444 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 441 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#create_event_data_store(params = {}) ⇒ Types::CreateEventDataStoreResponse
Creates a new event data store.
563 564 565 566 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 563 def create_event_data_store(params = {}, = {}) req = build_request(:create_event_data_store, params) req.send_request() end |
#create_trail(params = {}) ⇒ Types::CreateTrailResponse
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
737 738 739 740 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 737 def create_trail(params = {}, = {}) req = build_request(:create_trail, params) req.send_request() end |
#delete_event_data_store(params = {}) ⇒ Struct
Disables the event data store specified by EventDataStore
, which
accepts an event data store ARN. After you run DeleteEventDataStore
,
the event data store enters a PENDING_DELETION
state, and is
automatically deleted after a wait period of seven days.
TerminationProtectionEnabled
must be set to False
on the event
data store; this operation cannot work if
TerminationProtectionEnabled
is True
.
After you run DeleteEventDataStore
on an event data store, you
cannot run ListQueries
, DescribeQuery
, or GetQueryResults
on
queries that are using an event data store in a PENDING_DELETION
state. An event data store in the PENDING_DELETION
state does not
incur costs.
772 773 774 775 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 772 def delete_event_data_store(params = {}, = {}) req = build_request(:delete_event_data_store, params) req.send_request() end |
#delete_trail(params = {}) ⇒ Struct
Deletes a trail. This operation must be called from the region in
which the trail was created. DeleteTrail
cannot be called on the
shadow trails (replicated trails in other regions) of a trail that is
enabled in all regions.
799 800 801 802 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 799 def delete_trail(params = {}, = {}) req = build_request(:delete_trail, params) req.send_request() end |
#describe_query(params = {}) ⇒ Types::DescribeQueryResponse
Returns metadata about a query, including query run time in
milliseconds, number of events scanned and matched, and query status.
You must specify an ARN for EventDataStore
, and a value for
QueryID
.
847 848 849 850 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 847 def describe_query(params = {}, = {}) req = build_request(:describe_query, params) req.send_request() end |
#describe_trails(params = {}) ⇒ Types::DescribeTrailsResponse
Retrieves settings for one or more trails associated with the current region for your account.
921 922 923 924 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 921 def describe_trails(params = {}, = {}) req = build_request(:describe_trails, params) req.send_request() end |
#get_event_data_store(params = {}) ⇒ Types::GetEventDataStoreResponse
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
984 985 986 987 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 984 def get_event_data_store(params = {}, = {}) req = build_request(:get_event_data_store, params) req.send_request() end |
#get_event_selectors(params = {}) ⇒ Types::GetEventSelectorsResponse
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the resources on which you are logging data events.
For more information, see Logging Data and Management Events for Trails in the CloudTrail User Guide.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1074 def get_event_selectors(params = {}, = {}) req = build_request(:get_event_selectors, params) req.send_request() end |
#get_insight_selectors(params = {}) ⇒ Types::GetInsightSelectorsResponse
Describes the settings for the Insights event selectors that you
configured for your trail. GetInsightSelectors
shows if CloudTrail
Insights event logging is enabled on the trail, and if it is, which
insight types are enabled. If you run GetInsightSelectors
on a trail
that does not have Insights events enabled, the operation throws the
exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
1134 1135 1136 1137 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1134 def get_insight_selectors(params = {}, = {}) req = build_request(:get_insight_selectors, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse
Gets event data results of a query. You must specify the QueryID
value returned by the StartQuery
operation, and an ARN for
EventDataStore
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1192 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#get_trail(params = {}) ⇒ Types::GetTrailResponse
Returns settings information for a specified trail.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1236 def get_trail(params = {}, = {}) req = build_request(:get_trail, params) req.send_request() end |
#get_trail_status(params = {}) ⇒ Types::GetTrailStatusResponse
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
1306 1307 1308 1309 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1306 def get_trail_status(params = {}, = {}) req = build_request(:get_trail_status, params) req.send_request() end |
#list_event_data_stores(params = {}) ⇒ Types::ListEventDataStoresResponse
Returns information about all event data stores in the account, in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1368 def list_event_data_stores(params = {}, = {}) req = build_request(:list_event_data_stores, params) req.send_request() end |
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResponse
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1426 def list_public_keys(params = {}, = {}) req = build_request(:list_public_keys, params) req.send_request() end |
#list_queries(params = {}) ⇒ Types::ListQueriesResponse
Returns a list of queries and query statuses for the past seven days.
You must specify an ARN value for EventDataStore
. Optionally, to
shorten the list of results, you can specify a time range, formatted
as timestamps, by adding StartTime
and EndTime
parameters, and a
QueryStatus
value. Valid values for QueryStatus
include QUEUED
,
RUNNING
, FINISHED
, FAILED
, TIMED_OUT
, or CANCELLED
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1491 def list_queries(params = {}, = {}) req = build_request(:list_queries, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags for the trail or event data store in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1533 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_trails(params = {}) ⇒ Types::ListTrailsResponse
Lists trails that are in the current account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1572 def list_trails(params = {}, = {}) req = build_request(:list_trails, params) req.send_request() end |
#lookup_events(params = {}) ⇒ Types::LookupEventsResponse
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
Amazon Web Services access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1692 def lookup_events(params = {}, = {}) req = build_request(:lookup_events, params) req.send_request() end |
#put_event_selectors(params = {}) ⇒ Types::PutEventSelectorsResponse
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2
GetConsoleOutput
andRunInstances
API operations occur in your account.CloudTrail evaluates whether the events match your event selectors.
The
RunInstances
is a write-only event and it matches your event selector. The trail logs the event.The
GetConsoleOutput
is a read-only event that doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors
operation must be called from the region in
which the trail was created; otherwise, an
InvalidHomeRegionException
exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced
event selectors, up to a maximum of 500 values for all conditions and
selectors on a trail. You can use either AdvancedEventSelectors
or
EventSelectors
, but not both. If you apply AdvancedEventSelectors
to a trail, any existing EventSelectors
are overwritten. For more
information about advanced event selectors, see Logging data events
for trails in the CloudTrail User Guide.
1863 1864 1865 1866 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1863 def put_event_selectors(params = {}, = {}) req = build_request(:put_event_selectors, params) req.send_request() end |
#put_insight_selectors(params = {}) ⇒ Types::PutInsightSelectorsResponse
Lets you enable Insights event logging by specifying the Insights
selectors that you want to enable on an existing trail. You also use
PutInsightSelectors
to turn off Insights event logging, by passing
an empty list of insight types. The valid Insights event types in this
release are ApiErrorRateInsight
and ApiCallRateInsight
.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1909 def put_insight_selectors(params = {}, = {}) req = build_request(:put_insight_selectors, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from a trail or event data store.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1947 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#restore_event_data_store(params = {}) ⇒ Types::RestoreEventDataStoreResponse
Restores a deleted event data store specified by EventDataStore
,
which accepts an event data store ARN. You can only restore a deleted
event data store within the seven-day wait period after deletion.
Restoring an event data store can take several minutes, depending on
the size of the event data store.
2013 2014 2015 2016 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2013 def restore_event_data_store(params = {}, = {}) req = build_request(:restore_event_data_store, params) req.send_request() end |
#start_logging(params = {}) ⇒ Struct
Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2044 def start_logging(params = {}, = {}) req = build_request(:start_logging, params) req.send_request() end |
#start_query(params = {}) ⇒ Types::StartQueryResponse
Starts a CloudTrail Lake query. The required QueryStatement
parameter provides your SQL query, enclosed in single quotation marks.
2073 2074 2075 2076 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2073 def start_query(params = {}, = {}) req = build_request(:start_query, params) req.send_request() end |
#stop_logging(params = {}) ⇒ Struct
Suspends the recording of Amazon Web Services API calls and log file
delivery for the specified trail. Under most circumstances, there is
no need to use this action. You can update a trail without stopping it
first. This action is the only way to stop recording. For a trail
enabled in all regions, this operation must be called from the region
in which the trail was created, or an InvalidHomeRegionException
will occur. This operation cannot be called on the shadow trails
(replicated trails in other regions) of a trail enabled in all
regions.
2107 2108 2109 2110 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2107 def stop_logging(params = {}, = {}) req = build_request(:stop_logging, params) req.send_request() end |
#update_event_data_store(params = {}) ⇒ Types::UpdateEventDataStoreResponse
Updates an event data store. The required EventDataStore
value is an
ARN or the ID portion of the ARN. Other parameters are optional, but
at least one optional parameter must be specified, or CloudTrail
throws an error. RetentionPeriod
is in days, and valid values are
integers between 90 and 2555. By default, TerminationProtection
is
enabled. AdvancedEventSelectors
includes or excludes management and
data events in your event data store; for more information about
AdvancedEventSelectors
, see
PutEventSelectorsRequest$AdvancedEventSelectors.
2220 2221 2222 2223 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2220 def update_event_data_store(params = {}, = {}) req = build_request(:update_event_data_store, params) req.send_request() end |
#update_trail(params = {}) ⇒ Types::UpdateTrailResponse
Updates trail settings that control what events you are logging, and
how to handle log files. Changes to a trail do not require stopping
the CloudTrail service. Use this action to designate an existing
bucket for log delivery. If the existing bucket has previously been a
target for CloudTrail log files, an IAM policy exists for the bucket.
UpdateTrail
must be called from the region in which the trail was
created; otherwise, an InvalidHomeRegionException
is thrown.
2403 2404 2405 2406 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2403 def update_trail(params = {}, = {}) req = build_request(:update_trail, params) req.send_request() end |