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.
-
#disable_federation(params = {}) ⇒ Types::DisableFederationResponse
Disables Lake query federation on the specified event data store.
-
#enable_federation(params = {}) ⇒ Types::EnableFederationResponse
Enables Lake query federation on the specified event data store.
-
#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 or event data store.
-
#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_insights_metric_data(params = {}) ⇒ Types::ListInsightsMetricDataResponse
Returns Insights metrics data for trails that have enabled Insights.
-
#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 or event data store.
-
#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][1].
-
#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.
451 452 453 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 451 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).
501 502 503 504 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 501 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.
541 542 543 544 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 541 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.
617 618 619 620 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 617 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.
841 842 843 844 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 841 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.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1020 def create_trail(params = {}, = {}) req = build_request(:create_trail, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Struct
Deletes a channel.
1042 1043 1044 1045 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1042 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 and the FederationStatus
must be DISABLED
. You cannot
delete an event data store if TerminationProtectionEnabled
is True
or the FederationStatus
is ENABLED
.
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.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1078 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.
1103 1104 1105 1106 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1103 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.
1130 1131 1132 1133 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1130 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.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1155 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. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
You must specify either a QueryID
or a QueryAlias
. Specifying the
QueryAlias
parameter returns information about the last query run
for the alias.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1215 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.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1289 def describe_trails(params = {}, = {}) req = build_request(:describe_trails, params) req.send_request() end |
#disable_federation(params = {}) ⇒ Types::DisableFederationResponse
Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
1326 1327 1328 1329 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1326 def disable_federation(params = {}, = {}) req = build_request(:disable_federation, params) req.send_request() end |
#enable_federation(params = {}) ⇒ Types::EnableFederationResponse
Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.
When you enable Lake query federation, CloudTrail creates a managed
database named aws:cloudtrail
(if the database doesn't already
exist) and a managed federated table in the Glue Data Catalog. The
event data store ID is used for the table name. CloudTrail registers
the role ARN and event data store in Lake Formation, the service
responsible for allowing fine-grained access control of the federated
resources in the Glue Data Catalog.
For more information about Lake query federation, see Federate an event data store.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1393 def enable_federation(params = {}, = {}) req = build_request(:enable_federation, params) req.send_request() end |
#get_channel(params = {}) ⇒ Types::GetChannelResponse
Returns information about a specific channel.
1453 1454 1455 1456 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1453 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.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1528 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:
1623 1624 1625 1626 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1623 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1674 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 or event data store. GetInsightSelectors
shows if CloudTrail Insights event logging is enabled on the trail or
event data store, and if it is, which Insights types are enabled. If
you run GetInsightSelectors
on a trail or event data store that does
not have Insights events enabled, the operation throws the exception
InsightNotEnabledException
Specify either the EventDataStore
parameter to get Insights event
selectors for an event data store, or the TrailName
parameter to the
get Insights event selectors for a trail. You cannot specify these
parameters together.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
1753 1754 1755 1756 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1753 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1810 1811 1812 1813 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1810 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.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1843 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.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1887 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.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1957 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.
1999 2000 2001 2002 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 1999 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.
2061 2062 2063 2064 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2061 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.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2106 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.
2157 2158 2159 2160 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2157 def list_imports(params = {}, = {}) req = build_request(:list_imports, params) req.send_request() end |
#list_insights_metric_data(params = {}) ⇒ Types::ListInsightsMetricDataResponse
Returns Insights metrics data for trails that have enabled Insights.
The request must include the EventSource
, EventName
, and
InsightType
parameters.
If the InsightType
is set to ApiErrorRateInsight
, the request must
also include the ErrorCode
parameter.
The following are the available time periods for
ListInsightsMetricData
. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the ListInsightsMetricData
API operation is linked to the
cloudtrail:LookupEvents
action. To use this operation, you must have
permissions to perform the cloudtrail:LookupEvents
action.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2285 def list_insights_metric_data(params = {}, = {}) req = build_request(:list_insights_metric_data, 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2343 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.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2408 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.
2459 2460 2461 2462 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2459 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.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2498 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.
LookupEvents
returns recent Insights events for trails that enable
Insights. To view Insights events for an event data store, you can run
queries on your Insights event data store, and you can also view the
Lake dashboard for Insights.
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.
2626 2627 2628 2629 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2626 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 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.
2804 2805 2806 2807 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2804 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 or event data
store. You also use PutInsightSelectors
to turn off Insights event
logging, by passing an empty list of Insights types. The valid
Insights event types are ApiErrorRateInsight
and
ApiCallRateInsight
.
To enable Insights on an event data store, you must specify the ARNs
(or ID suffix of the ARNs) for the source event data store
(EventDataStore
) and the destination event data store
(InsightsDestination
). The source event data store logs management
events and enables Insights. The destination event data store logs
Insights events based upon the management event activity of the source
event data store. The source and destination event data stores must
belong to the same Amazon Web Services account.
To log Insights events for a trail, you must specify the name
(TrailName
) of the CloudTrail trail for which you want to change or
add Insights selectors.
To log CloudTrail Insights events on API call volume, the trail or
event data store must log write
management events. To log CloudTrail
Insights events on API error rate, the trail or event data store must
log read
or write
management events. You can call
GetEventSelectors
on a trail to check whether the trail logs
management events. You can call GetEventDataStore
on an event data
store to check whether the event data store logs management events.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
2912 2913 2914 2915 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2912 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.
2967 2968 2969 2970 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2967 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.
2995 2996 2997 2998 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 2995 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.
3036 3037 3038 3039 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3036 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.
3106 3107 3108 3109 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3106 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
.
3132 3133 3134 3135 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3132 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 for copying trail events in the
CloudTrail User Guide.
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.
3239 3240 3241 3242 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3239 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.
3270 3271 3272 3273 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3270 def start_logging(params = {}, = {}) req = build_request(:start_logging, params) req.send_request() end |
#start_query(params = {}) ⇒ Types::StartQueryResponse
Starts a CloudTrail Lake query. Use the QueryStatement
parameter to
provide your SQL query, enclosed in single quotation marks. Use the
optional DeliveryS3Uri
parameter to deliver the query results to an
S3 bucket.
StartQuery
requires you specify either the QueryStatement
parameter, or a QueryAlias
and any QueryParameters
. In the current
release, the QueryAlias
and QueryParameters
parameters are used
only for the queries that populate the CloudTrail Lake dashboards.
3318 3319 3320 3321 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3318 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
.
3344 3345 3346 3347 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3344 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.
3395 3396 3397 3398 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3395 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.
3429 3430 3431 3432 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3429 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.
3479 3480 3481 3482 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3479 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 7 and 3653 if the BillingMode
is set to
EXTENDABLE_RETENTION_PRICING
, or between 7 and 2557 if BillingMode
is set to FIXED_RETENTION_PRICING
. By default,
TerminationProtection
is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors
includes or excludes management or data events in your event data
store. For more information about AdvancedEventSelectors
, see
AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config
configuration items, Audit Manager evidence, or non-Amazon Web
Services events, AdvancedEventSelectors
includes events of that type
in your event data store.
3706 3707 3708 3709 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3706 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.
3898 3899 3900 3901 |
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/client.rb', line 3898 def update_trail(params = {}, = {}) req = build_request(:update_trail, params) req.send_request() end |