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.
NOTE: As an alternative to using 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 CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
Declaration Syntax| C# |
public interface AmazonCloudTrail : IDisposable
Members| All Members | Methods | ||||
| Icon | Member | Description |
|---|---|---|
 | BeginCreateTrail(CreateTrailRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateTrail operation.
|
| BeginDeleteTrail(DeleteTrailRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteTrail operation.
|
| BeginDescribeTrails(DescribeTrailsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeTrails operation.
|
| BeginGetTrailStatus(GetTrailStatusRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the GetTrailStatus operation.
|
| BeginStartLogging(StartLoggingRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the StartLogging operation.
|
| BeginStopLogging(StopLoggingRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the StopLogging operation.
|
| BeginUpdateTrail(UpdateTrailRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateTrail operation.
|
| CreateTrail(CreateTrailRequest) | From the command line, use create-subscription. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:
|
| DeleteTrail(DeleteTrailRequest) | Deletes a trail. |
| DescribeTrails(DescribeTrailsRequest) | Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format. |
| DescribeTrails()()()() | Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format. |
| Dispose()()()() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| EndCreateTrail(IAsyncResult) |
Finishes the asynchronous execution of the CreateTrail operation.
|
| EndDeleteTrail(IAsyncResult) |
Finishes the asynchronous execution of the DeleteTrail operation.
|
| EndDescribeTrails(IAsyncResult) |
Finishes the asynchronous execution of the DescribeTrails operation.
|
| EndGetTrailStatus(IAsyncResult) |
Finishes the asynchronous execution of the GetTrailStatus operation.
|
| EndStartLogging(IAsyncResult) |
Finishes the asynchronous execution of the StartLogging operation.
|
| EndStopLogging(IAsyncResult) |
Finishes the asynchronous execution of the StopLogging operation.
|
| EndUpdateTrail(IAsyncResult) |
Finishes the asynchronous execution of the UpdateTrail operation.
|
| GetTrailStatus(GetTrailStatusRequest) | Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail. |
| StartLogging(StartLoggingRequest) | Starts the recording of AWS API calls and log file delivery for a trail. |
| 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. |
| UpdateTrail(UpdateTrailRequest) | From the command line, use update-subscription. Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names. |