AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Interface for accessing CloudTrail
CloudTrailThis is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
Namespace: Amazon.CloudTrail
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z
public interface IAmazonCloudTrail IAmazonService, IDisposable
The IAmazonCloudTrail type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.CloudTrail.Model.ICloudTrailPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
AddTags(AddTagsRequest) |
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). |
|
AddTagsAsync(AddTagsRequest, CancellationToken) |
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). |
|
CancelQuery(CancelQueryRequest) |
Cancels a query if the query is not in a terminated state, such as |
|
CancelQueryAsync(CancelQueryRequest, CancellationToken) |
Cancels a query if the query is not in a terminated state, such as |
|
CreateChannel(CreateChannelRequest) |
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. |
|
CreateChannelAsync(CreateChannelRequest, CancellationToken) |
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. |
|
CreateEventDataStore(CreateEventDataStoreRequest) |
Creates a new event data store. |
|
CreateEventDataStoreAsync(CreateEventDataStoreRequest, CancellationToken) |
Creates a new event data store. |
|
CreateTrail(CreateTrailRequest) |
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. |
|
CreateTrailAsync(CreateTrailRequest, CancellationToken) |
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. |
|
DeleteChannel(DeleteChannelRequest) |
Deletes a channel. |
|
DeleteChannelAsync(DeleteChannelRequest, CancellationToken) |
Deletes a channel. |
|
DeleteEventDataStore(DeleteEventDataStoreRequest) |
Disables the event data store specified by
After you run |
|
DeleteEventDataStoreAsync(DeleteEventDataStoreRequest, CancellationToken) |
Disables the event data store specified by
After you run |
|
DeleteResourcePolicy(DeleteResourcePolicyRequest) |
Deletes the resource-based policy attached to the CloudTrail channel. |
|
DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken) |
Deletes the resource-based policy attached to the CloudTrail channel. |
|
DeleteTrail(DeleteTrailRequest) |
Deletes a trail. This operation must be called from the Region in which the trail
was created. |
|
DeleteTrailAsync(DeleteTrailRequest, CancellationToken) |
Deletes a trail. This operation must be called from the Region in which the trail
was created. |
|
DeregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest) |
Removes CloudTrail delegated administrator permissions from a member account in an organization. |
|
DeregisterOrganizationDelegatedAdminAsync(DeregisterOrganizationDelegatedAdminRequest, CancellationToken) |
Removes CloudTrail delegated administrator permissions from a member account in an organization. |
|
DescribeQuery(DescribeQueryRequest) |
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 |
|
DescribeQueryAsync(DescribeQueryRequest, CancellationToken) |
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 |
|
DescribeTrails() |
Retrieves settings for one or more trails associated with the current Region for your account. |
|
DescribeTrails(DescribeTrailsRequest) |
Retrieves settings for one or more trails associated with the current Region for your account. |
|
DescribeTrailsAsync(CancellationToken) |
Retrieves settings for one or more trails associated with the current Region for your account. |
|
DescribeTrailsAsync(DescribeTrailsRequest, CancellationToken) |
Retrieves settings for one or more trails associated with the current Region for your account. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisableFederation(DisableFederationRequest) |
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. |
|
DisableFederationAsync(DisableFederationRequest, CancellationToken) |
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. |
|
EnableFederation(EnableFederationRequest) |
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
For more information about Lake query federation, see Federate an event data store. |
|
EnableFederationAsync(EnableFederationRequest, CancellationToken) |
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
For more information about Lake query federation, see Federate an event data store. |
|
GetChannel(GetChannelRequest) |
Returns information about a specific channel. |
|
GetChannelAsync(GetChannelRequest, CancellationToken) |
Returns information about a specific channel. |
|
GetEventDataStore(GetEventDataStoreRequest) |
Returns information about an event data store specified as either an ARN or the ID portion of the ARN. |
|
GetEventDataStoreAsync(GetEventDataStoreRequest, CancellationToken) |
Returns information about an event data store specified as either an ARN or the ID portion of the ARN. |
|
GetEventSelectors(GetEventSelectorsRequest) |
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
For more information about logging management and data events, see the following topics in the CloudTrail User Guide: |
|
GetEventSelectorsAsync(GetEventSelectorsRequest, CancellationToken) |
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
For more information about logging management and data events, see the following topics in the CloudTrail User Guide: |
|
GetImport(GetImportRequest) |
Returns information about a specific import. |
|
GetImportAsync(GetImportRequest, CancellationToken) |
Returns information about a specific import. |
|
GetInsightSelectors(GetInsightSelectorsRequest) |
Describes the settings for the Insights event selectors that you configured for your
trail or event data store.
Specify either the For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide. |
|
GetInsightSelectorsAsync(GetInsightSelectorsRequest, CancellationToken) |
Describes the settings for the Insights event selectors that you configured for your
trail or event data store.
Specify either the For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide. |
|
GetQueryResults(GetQueryResultsRequest) |
Gets event data results of a query. You must specify the |
|
GetQueryResultsAsync(GetQueryResultsRequest, CancellationToken) |
Gets event data results of a query. You must specify the |
|
GetResourcePolicy(GetResourcePolicyRequest) |
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. |
|
GetResourcePolicyAsync(GetResourcePolicyRequest, CancellationToken) |
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. |
|
GetTrail(GetTrailRequest) |
Returns settings information for a specified trail. |
|
GetTrailAsync(GetTrailRequest, CancellationToken) |
Returns settings information for a specified trail. |
|
GetTrailStatus(GetTrailStatusRequest) |
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. |
|
GetTrailStatusAsync(GetTrailStatusRequest, CancellationToken) |
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. |
|
ListChannels(ListChannelsRequest) |
Lists the channels in the current account, and their source names. |
|
ListChannelsAsync(ListChannelsRequest, CancellationToken) |
Lists the channels in the current account, and their source names. |
|
ListEventDataStores(ListEventDataStoresRequest) |
Returns information about all event data stores in the account, in the current Region. |
|
ListEventDataStoresAsync(ListEventDataStoresRequest, CancellationToken) |
Returns information about all event data stores in the account, in the current Region. |
|
ListImportFailures(ListImportFailuresRequest) |
Returns a list of failures for the specified import. |
|
ListImportFailuresAsync(ListImportFailuresRequest, CancellationToken) |
Returns a list of failures for the specified import. |
|
ListImports(ListImportsRequest) |
Returns information on all imports, or a select set of imports by |
|
ListImportsAsync(ListImportsRequest, CancellationToken) |
Returns information on all imports, or a select set of imports by |
|
ListInsightsMetricData(ListInsightsMetricDataRequest) |
Returns Insights metrics data for trails that have enabled Insights. The request must
include the
If the
The following are the available time periods for
Access to the |
|
ListInsightsMetricDataAsync(ListInsightsMetricDataRequest, CancellationToken) |
Returns Insights metrics data for trails that have enabled Insights. The request must
include the
If the
The following are the available time periods for
Access to the |
|
ListPublicKeys(ListPublicKeysRequest) |
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.
CloudTrail uses different private and public key pairs per Region. Each digest file
is signed with a private key unique to its Region. When you validate a digest file
from a specific Region, you must look in the same Region for its corresponding public
key.
|
|
ListPublicKeysAsync(ListPublicKeysRequest, CancellationToken) |
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.
CloudTrail uses different private and public key pairs per Region. Each digest file
is signed with a private key unique to its Region. When you validate a digest file
from a specific Region, you must look in the same Region for its corresponding public
key.
|
|
ListQueries(ListQueriesRequest) |
Returns a list of queries and query statuses for the past seven days. You must specify
an ARN value for |
|
ListQueriesAsync(ListQueriesRequest, CancellationToken) |
Returns a list of queries and query statuses for the past seven days. You must specify
an ARN value for |
|
ListTags(ListTagsRequest) |
Lists the tags for the specified trails, event data stores, or channels in the current Region. |
|
ListTagsAsync(ListTagsRequest, CancellationToken) |
Lists the tags for the specified trails, event data stores, or channels in the current Region. |
|
ListTrails(ListTrailsRequest) |
Lists trails that are in the current account. |
|
ListTrailsAsync(ListTrailsRequest, CancellationToken) |
Lists trails that are in the current account. |
|
LookupEvents(LookupEventsRequest) |
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:
Lookup supports the following attributes for Insights events:
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. |
|
LookupEventsAsync(LookupEventsRequest, CancellationToken) |
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:
Lookup supports the following attributes for Insights events:
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. |
|
PutEventSelectors(PutEventSelectorsRequest) |
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
The 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 |
|
PutEventSelectorsAsync(PutEventSelectorsRequest, CancellationToken) |
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
The 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 |
|
PutInsightSelectors(PutInsightSelectorsRequest) |
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
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 (
To log Insights events for a trail, you must specify the name (
To log CloudTrail Insights events on API call volume, the trail or event data store
must log For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide. |
|
PutInsightSelectorsAsync(PutInsightSelectorsRequest, CancellationToken) |
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
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 (
To log Insights events for a trail, you must specify the name (
To log CloudTrail Insights events on API call volume, the trail or event data store
must log For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide. |
|
PutResourcePolicy(PutResourcePolicyRequest) |
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. |
|
PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken) |
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. |
|
RegisterOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest) |
Registers an organization’s member account as the CloudTrail delegated administrator. |
|
RegisterOrganizationDelegatedAdminAsync(RegisterOrganizationDelegatedAdminRequest, CancellationToken) |
Registers an organization’s member account as the CloudTrail delegated administrator. |
|
RemoveTags(RemoveTagsRequest) |
Removes the specified tags from a trail, event data store, or channel. |
|
RemoveTagsAsync(RemoveTagsRequest, CancellationToken) |
Removes the specified tags from a trail, event data store, or channel. |
|
RestoreEventDataStore(RestoreEventDataStoreRequest) |
Restores a deleted event data store specified by |
|
RestoreEventDataStoreAsync(RestoreEventDataStoreRequest, CancellationToken) |
Restores a deleted event data store specified by |
|
StartEventDataStoreIngestion(StartEventDataStoreIngestionRequest) |
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 |
|
StartEventDataStoreIngestionAsync(StartEventDataStoreIngestionRequest, CancellationToken) |
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 |
|
StartImport(StartImportRequest) |
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
When you start a new import, the
When you retry an import, the If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization. |
|
StartImportAsync(StartImportRequest, CancellationToken) |
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
When you start a new import, the
When you retry an import, the If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization. |
|
StartLogging(StartLoggingRequest) |
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. |
|
StartLoggingAsync(StartLoggingRequest, CancellationToken) |
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. |
|
StartQuery(StartQueryRequest) |
Starts a CloudTrail Lake query. Use the
|
|
StartQueryAsync(StartQueryRequest, CancellationToken) |
Starts a CloudTrail Lake query. Use the
|
|
StopEventDataStoreIngestion(StopEventDataStoreIngestionRequest) |
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 |
|
StopEventDataStoreIngestionAsync(StopEventDataStoreIngestionRequest, CancellationToken) |
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 |
|
StopImport(StopImportRequest) |
Stops a specified import. |
|
StopImportAsync(StopImportRequest, CancellationToken) |
Stops a specified import. |
|
StopLogging(StopLoggingRequest) |
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 |
|
StopLoggingAsync(StopLoggingRequest, CancellationToken) |
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 |
|
UpdateChannel(UpdateChannelRequest) |
Updates a channel specified by a required channel ARN or UUID. |
|
UpdateChannelAsync(UpdateChannelRequest, CancellationToken) |
Updates a channel specified by a required channel ARN or UUID. |
|
UpdateEventDataStore(UpdateEventDataStoreRequest) |
Updates an event data store. The required
For event data stores for CloudTrail events,
For event data stores for CloudTrail Insights events, Config configuration items,
Audit Manager evidence, or non-Amazon Web Services events, |
|
UpdateEventDataStoreAsync(UpdateEventDataStoreRequest, CancellationToken) |
Updates an event data store. The required
For event data stores for CloudTrail events,
For event data stores for CloudTrail Insights events, Config configuration items,
Audit Manager evidence, or non-Amazon Web Services events, |
|
UpdateTrail(UpdateTrailRequest) |
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. |
|
UpdateTrailAsync(UpdateTrailRequest, CancellationToken) |
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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5