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, event data store, or channel, 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_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel for CloudTrail to ingest events from a partner or external source.
-
#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_channel(params = {}) ⇒ Struct
Deletes a channel.
-
#delete_event_data_store(params = {}) ⇒ Struct
Disables the event data store specified by
EventDataStore
, which accepts an event data store ARN. -
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource-based policy attached to the CloudTrail channel.
-
#delete_trail(params = {}) ⇒ Struct
Deletes a trail.
-
#deregister_organization_delegated_admin(params = {}) ⇒ Struct
Removes CloudTrail delegated administrator permissions from a member account in an organization.
-
#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_channel(params = {}) ⇒ Types::GetChannelResponse
Returns information about a specific channel.
-
#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_import(params = {}) ⇒ Types::GetImportResponse
Returns information about a specific import.
-
#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_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
-
#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_channels(params = {}) ⇒ Types::ListChannelsResponse
Lists the channels in the current account, and their source names.
-
#list_event_data_stores(params = {}) ⇒ Types::ListEventDataStoresResponse
Returns information about all event data stores in the account, in the current Region.
-
#list_import_failures(params = {}) ⇒ Types::ListImportFailuresResponse
Returns a list of failures for the specified import.
-
#list_imports(params = {}) ⇒ Types::ListImportsResponse
Returns information on all imports, or a select set of imports by
ImportStatus
orDestination
. -
#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 specified trails, event data stores, or channels 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.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services.
-
#register_organization_delegated_admin(params = {}) ⇒ Struct
Registers an organization’s member account as the CloudTrail delegated administrator.
-
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from a trail, event data store, or channel.
-
#restore_event_data_store(params = {}) ⇒ Types::RestoreEventDataStoreResponse
Restores a deleted event data store specified by
EventDataStore
, which accepts an event data store ARN. -
#start_event_data_store_ingestion(params = {}) ⇒ Struct
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
-
#start_import(params = {}) ⇒ Types::StartImportResponse
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
-
#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_event_data_store_ingestion(params = {}) ⇒ Struct
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN.
-
#stop_import(params = {}) ⇒ Types::StopImportResponse
Stops a specified import.
-
#stop_logging(params = {}) ⇒ Struct
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates a channel specified by a required channel ARN or UUID.
-
#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.
380 381 382 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 380 def initialize(*args) super end |
Instance Method Details
#add_tags(params = {}) ⇒ Struct
Adds one or more tags to a trail, event data store, or channel, 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; 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).
430 431 432 433 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 430 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.
470 471 472 473 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 470 def cancel_query(params = {}, = {}) req = build_request(:cancel_query, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
546 547 548 549 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 546 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_event_data_store(params = {}) ⇒ Types::CreateEventDataStoreResponse
Creates a new event data store.
723 724 725 726 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 723 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.
901 902 903 904 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 901 def create_trail(params = {}, = {}) req = build_request(:create_trail, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes a channel.
923 924 925 926 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 923 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, 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.
958 959 960 961 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 958 def delete_event_data_store(params = {}, = {}) req = build_request(:delete_event_data_store, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource-based policy attached to the CloudTrail channel.
983 984 985 986 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 983 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, 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.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1010 def delete_trail(params = {}, = {}) req = build_request(:delete_trail, params) req.send_request() end |
#deregister_organization_delegated_admin(params = {}) ⇒ Struct
Removes CloudTrail delegated administrator permissions from a member account in an organization.
1035 1036 1037 1038 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1035 def deregister_organization_delegated_admin(params = {}, = {}) req = build_request(:deregister_organization_delegated_admin, 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
.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1087 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.
1161 1162 1163 1164 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1161 def describe_trails(params = {}, = {}) req = build_request(:describe_trails, params) req.send_request() end |
#get_channel(params = {}) ⇒ Types::GetChannelResponse
Returns information about a specific channel.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1221 def get_channel(params = {}, = {}) req = build_request(:get_channel, 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.
1286 1287 1288 1289 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1286 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 about logging management and data events, see the following topics in the CloudTrail User Guide:
1381 1382 1383 1384 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1381 def get_event_selectors(params = {}, = {}) req = build_request(:get_event_selectors, params) req.send_request() end |
#get_import(params = {}) ⇒ Types::GetImportResponse
Returns information about a specific import.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1432 def get_import(params = {}, = {}) req = build_request(:get_import, 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.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1492 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.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1550 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
1583 1584 1585 1586 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1583 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_trail(params = {}) ⇒ Types::GetTrailResponse
Returns settings information for a specified trail.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1627 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.
1697 1698 1699 1700 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1697 def get_trail_status(params = {}, = {}) req = build_request(:get_trail_status, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Lists the channels in the current account, and their source names.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1739 def list_channels(params = {}, = {}) req = build_request(:list_channels, 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.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1801 def list_event_data_stores(params = {}, = {}) req = build_request(:list_event_data_stores, params) req.send_request() end |
#list_import_failures(params = {}) ⇒ Types::ListImportFailuresResponse
Returns a list of failures for the specified import.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1846 def list_import_failures(params = {}, = {}) req = build_request(:list_import_failures, params) req.send_request() end |
#list_imports(params = {}) ⇒ Types::ListImportsResponse
Returns information on all imports, or a select set of imports by
ImportStatus
or Destination
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1897 1898 1899 1900 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1897 def list_imports(params = {}, = {}) req = build_request(:list_imports, 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.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1955 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.
2020 2021 2022 2023 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2020 def list_queries(params = {}, = {}) req = build_request(:list_queries, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags for the specified trails, event data stores, or channels in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2071 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.
2110 2111 2112 2113 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2110 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.
2230 2231 2232 2233 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2230 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. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide. 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 management events, Logging data events, 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 in the CloudTrail User Guide.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2408 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
.
To log CloudTrail Insights events on API call volume, the trail must
log write
management events. To log CloudTrail Insights events on
API error rate, the trail must log read
or write
management
events. You can call GetEventSelectors
on a trail to check whether
the trail logs management events.
2468 2469 2470 2471 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2468 def put_insight_selectors(params = {}, = {}) req = build_request(:put_insight_selectors, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
2523 2524 2525 2526 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2523 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#register_organization_delegated_admin(params = {}) ⇒ Struct
Registers an organization’s member account as the CloudTrail delegated administrator.
2547 2548 2549 2550 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2547 def register_organization_delegated_admin(params = {}, = {}) req = build_request(:register_organization_delegated_admin, params) req.send_request() end |
#remove_tags(params = {}) ⇒ Struct
Removes the specified tags from a trail, event data store, or channel.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2588 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.
2656 2657 2658 2659 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2656 def restore_event_data_store(params = {}, = {}) req = build_request(:restore_event_data_store, params) req.send_request() end |
#start_event_data_store_ingestion(params = {}) ⇒ Struct
Starts the ingestion of live events on an event data store specified
as either an ARN or the ID portion of the ARN. To start ingestion, the
event data store Status
must be STOPPED_INGESTION
and the
eventCategory
must be Management
, Data
, or ConfigurationItem
.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2682 def start_event_data_store_ingestion(params = {}, = {}) req = build_request(:start_event_data_store_ingestion, params) req.send_request() end |
#start_import(params = {}) ⇒ Types::StartImportResponse
Starts an import of logged trail events from a source S3 bucket to a
destination event data store. By default, CloudTrail only imports
events contained in the S3 bucket's CloudTrail
prefix and the
prefixes inside the CloudTrail
prefix, and does not check prefixes
for other Amazon Web Services services. If you want to import
CloudTrail events contained in another prefix, you must include the
prefix in the S3LocationUri
. For more considerations about importing
trail events, see Considerations.
When you start a new import, the Destinations
and ImportSource
parameters are required. Before starting a new import, disable any
access control lists (ACLs) attached to the source S3 bucket. For more
information about disabling ACLs, see Controlling ownership of
objects and disabling ACLs for your bucket.
When you retry an import, the ImportID
parameter is required.
2788 2789 2790 2791 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2788 def start_import(params = {}, = {}) req = build_request(:start_import, 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.
2819 2820 2821 2822 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2819 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.
Use the optional DeliveryS3Uri
parameter to deliver the query
results to an S3 bucket.
2854 2855 2856 2857 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2854 def start_query(params = {}, = {}) req = build_request(:start_query, params) req.send_request() end |
#stop_event_data_store_ingestion(params = {}) ⇒ Struct
Stops the ingestion of live events on an event data store specified as
either an ARN or the ID portion of the ARN. To stop ingestion, the
event data store Status
must be ENABLED
and the eventCategory
must be Management
, Data
, or ConfigurationItem
.
2880 2881 2882 2883 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2880 def stop_event_data_store_ingestion(params = {}, = {}) req = build_request(:stop_event_data_store_ingestion, params) req.send_request() end |
#stop_import(params = {}) ⇒ Types::StopImportResponse
Stops a specified import.
2931 2932 2933 2934 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2931 def stop_import(params = {}, = {}) req = build_request(:stop_import, 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.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2965 def stop_logging(params = {}, = {}) req = build_request(:stop_logging, params) req.send_request() end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates a channel specified by a required channel ARN or UUID.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3015 def update_channel(params = {}, = {}) req = build_request(:update_channel, 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 2557. By default, TerminationProtection
is
enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors
includes or excludes management and data events in your event data
store. For more information about AdvancedEventSelectors
, see
PutEventSelectorsRequest$AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager
evidence, or non-Amazon Web Services events, AdvancedEventSelectors
includes events of that type in your event data store.
3170 3171 3172 3173 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3170 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.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3357 def update_trail(params = {}, = {}) req = build_request(:update_trail, params) req.send_request() end |