AWS SDK Version 3 for .NET
API Reference

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.

Implementation for accessing CloudTrail AWS CloudTrail

This 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 AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS 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 AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudTrail.AmazonCloudTrailClient

Namespace: Amazon.CloudTrail
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCloudTrailClient : AmazonServiceClient
         IAmazonCloudTrail, IAmazonService, IDisposable

The AmazonCloudTrailClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudTrailClient()

Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudTrailClient(RegionEndpoint)

Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudTrailClient(AmazonCloudTrailConfig)

Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudTrailClient(AWSCredentials)

Constructs AmazonCloudTrailClient with AWS Credentials

Public Method AmazonCloudTrailClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCloudTrailClient with AWS Credentials

Public Method AmazonCloudTrailClient(AWSCredentials, AmazonCloudTrailConfig)

Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object.

Public Method AmazonCloudTrailClient(string, string)

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudTrailClient(string, string, RegionEndpoint)

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudTrailClient(string, string, AmazonCloudTrailConfig)

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.

Public Method AmazonCloudTrailClient(string, string, string)

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudTrailClient(string, string, string, RegionEndpoint)

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudTrailClient(string, string, string, AmazonCloudTrailConfig)

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddTags(AddTagsRequest)

Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

Public Method AddTagsAsync(AddTagsRequest, CancellationToken)

Initiates the asynchronous execution of the AddTags operation.

Public Method CreateTrail(CreateTrailRequest)

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

Public Method CreateTrailAsync(CreateTrailRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTrail operation.

Public Method DeleteTrail(DeleteTrailRequest)

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.

Public Method DeleteTrailAsync(DeleteTrailRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTrail operation.

Public Method DescribeTrails()

Retrieves settings for the trail associated with the current region for your account.

Public Method DescribeTrails(DescribeTrailsRequest)

Retrieves settings for the trail associated with the current region for your account.

Public Method DescribeTrailsAsync(CancellationToken)

Retrieves settings for the trail associated with the current region for your account.

Public Method DescribeTrailsAsync(DescribeTrailsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTrails operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method 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:

  • The S3 objects that you are logging for data events.

  • If your event selector includes management events.

  • If your event selector includes read-only events, write-only events, or all.

For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

Public Method GetEventSelectorsAsync(GetEventSelectorsRequest, CancellationToken)

Initiates the asynchronous execution of the GetEventSelectors operation.

Public Method 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.

Public Method GetTrailStatusAsync(GetTrailStatusRequest, CancellationToken)

Initiates the asynchronous execution of the GetTrailStatus operation.

Public Method 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/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

Public Method ListPublicKeysAsync(ListPublicKeysRequest, CancellationToken)

Initiates the asynchronous execution of the ListPublicKeys operation.

Public Method ListTags(ListTagsRequest)

Lists the tags for the trail in the current region.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

Public Method LookupEvents(LookupEventsRequest)

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:

  • Event ID

  • Event name

  • Event source

  • Resource name

  • Resource type

  • User name

All attributes are optional. The default number of results returned is 10, 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 one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

Public Method LookupEventsAsync(LookupEventsRequest, CancellationToken)

Initiates the asynchronous execution of the LookupEvents operation.

Public Method PutEventSelectors(PutEventSelectorsRequest)

Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the 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

  1. You create an event selector for a trail and specify that you want write-only events.

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

  5. The GetConsoleOutput is a read-only event but it 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 is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

Public Method PutEventSelectorsAsync(PutEventSelectorsRequest, CancellationToken)

Initiates the asynchronous execution of the PutEventSelectors operation.

Public Method RemoveTags(RemoveTagsRequest)

Removes the specified tags from a trail.

Public Method RemoveTagsAsync(RemoveTagsRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTags operation.

Public Method StartLogging(StartLoggingRequest)

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Public Method StartLoggingAsync(StartLoggingRequest, CancellationToken)

Initiates the asynchronous execution of the StartLogging operation.

Public Method StopLogging(StopLoggingRequest)

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

Public Method StopLoggingAsync(StopLoggingRequest, CancellationToken)

Initiates the asynchronous execution of the StopLogging operation.

Public Method UpdateTrail(UpdateTrailRequest)

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

Public Method UpdateTrailAsync(UpdateTrailRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTrail operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms