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, up to a limit of 50.
-
#create_trail(params = {}) ⇒ Types::CreateTrailResponse
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
-
#delete_trail(params = {}) ⇒ Struct
Deletes a trail.
-
#describe_trails(params = {}) ⇒ Types::DescribeTrailsResponse
Retrieves settings for one or more trails associated with the current region for your account.
-
#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_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_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_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags for the trail 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.
-
#start_logging(params = {}) ⇒ Struct
Starts the recording of AWS API calls and log file delivery for a trail.
-
#stop_logging(params = {}) ⇒ Struct
Suspends the recording of AWS API calls and log file delivery for the specified trail.
-
#update_trail(params = {}) ⇒ Types::UpdateTrailResponse
Updates the settings that specify delivery of 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.
334 335 336 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#add_tags(params = {}) ⇒ Struct
Adds one or more tags to a trail, 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 that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).
376 377 378 379 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 376 def (params = {}, = {}) req = build_request(:add_tags, 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.
542 543 544 545 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 542 def create_trail(params = {}, = {}) req = build_request(:create_trail, 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.
569 570 571 572 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 569 def delete_trail(params = {}, = {}) req = build_request(:delete_trail, 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.
643 644 645 646 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 643 def describe_trails(params = {}, = {}) req = build_request(:describe_trails, 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 Amazon S3 objects or AWS Lambda functions that you are logging for data events.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
733 734 735 736 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 733 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 AWS CloudTrail User Guide.
793 794 795 796 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 793 def get_insight_selectors(params = {}, = {}) req = build_request(:get_insight_selectors, params) req.send_request() end |
#get_trail(params = {}) ⇒ Types::GetTrailResponse
Returns settings information for a specified trail.
837 838 839 840 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 837 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.
907 908 909 910 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 907 def get_trail_status(params = {}, = {}) req = build_request(:get_trail_status, 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.
965 966 967 968 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 965 def list_public_keys(params = {}, = {}) req = build_request(:list_public_keys, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags for the trail in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1008 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.
1047 1048 1049 1050 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1047 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:
AWS 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.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1167 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 AWS CloudTrail in the AWS 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 AWS CloudTrail User Guide.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1338 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. In this release, only
ApiCallRateInsight
is supported as an Insights selector.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1384 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.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1418 def (params = {}, = {}) req = build_request(:remove_tags, params) req.send_request() end |
#start_logging(params = {}) ⇒ Struct
Starts the recording of AWS 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.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1447 def start_logging(params = {}, = {}) req = build_request(:start_logging, params) req.send_request() end |
#stop_logging(params = {}) ⇒ Struct
Suspends the recording of AWS 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.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1480 def stop_logging(params = {}, = {}) req = build_request(:stop_logging, params) req.send_request() end |
#update_trail(params = {}) ⇒ Types::UpdateTrailResponse
Updates the settings that specify delivery of 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1655 def update_trail(params = {}, = {}) req = build_request(:update_trail, params) req.send_request() end |