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.
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.
See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
Namespace: Amazon.CloudTrail
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonCloudTrailClient : AmazonServiceClient IAmazonCloudTrail, IDisposable
The AmazonCloudTrailClient type exposes the following members
Name | Description | |
---|---|---|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
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.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonCloudTrailClient(AWSCredentials) | Constructs AmazonCloudTrailClient with AWS Credentials | |
AmazonCloudTrailClient(AWSCredentials, RegionEndpoint) | Constructs AmazonCloudTrailClient with AWS Credentials | |
AmazonCloudTrailClient(AWSCredentials, AmazonCloudTrailConfig) | Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object. | |
AmazonCloudTrailClient(string, string) | Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key | |
AmazonCloudTrailClient(string, string, RegionEndpoint) | Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key | |
AmazonCloudTrailClient(string, string, AmazonCloudTrailConfig) | Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. | |
AmazonCloudTrailClient(string, string, string) | Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key | |
AmazonCloudTrailClient(string, string, string, RegionEndpoint) | Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key | |
AmazonCloudTrailClient(string, string, string, AmazonCloudTrailConfig) | Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. |
Name | Description | |
---|---|---|
AddTags(AddTagsRequest) | Adds one or more tags to a trail, up to a limit of 10. 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). | |
AddTagsAsync(AddTagsRequest, CancellationToken) | Initiates the asynchronous execution of the AddTags operation. | |
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. | |
CreateTrailAsync(CreateTrailRequest, CancellationToken) | Initiates the asynchronous execution of the CreateTrail operation. | |
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.
|
|
DeleteTrailAsync(DeleteTrailRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteTrail operation. | |
DescribeTrails() | Retrieves settings for the trail associated with the current region for your account. | |
DescribeTrails(DescribeTrailsRequest) | Retrieves settings for the trail associated with the current region for your account. | |
DescribeTrailsAsync(DescribeTrailsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeTrails operation. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
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) | Initiates the asynchronous execution of the GetTrailStatus operation. | |
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.
|
|
ListPublicKeysAsync(ListPublicKeysRequest, CancellationToken) | Initiates the asynchronous execution of the ListPublicKeys operation. | |
ListTags(ListTagsRequest) |
Lists the tags for the specified trail or trails in the current region.
Lists the tags for the trail in the current region. |
|
ListTagsAsync(ListTagsRequest, CancellationToken) | Initiates the asynchronous execution of the ListTags operation. | |
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
five different attributes: time range (defined by a start time and end time), user
name, event name, resource type, and resource name. All attributes are optional. The
maximum number of attributes that can be specified in any one lookup request are time
range and one other attribute. 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.
|
|
LookupEventsAsync(LookupEventsRequest, CancellationToken) | Initiates the asynchronous execution of the LookupEvents operation. | |
RemoveTags(RemoveTagsRequest) | Removes the specified tags from a trail. | |
RemoveTagsAsync(RemoveTagsRequest, CancellationToken) | Initiates the asynchronous execution of the RemoveTags operation. | |
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. | |
StartLoggingAsync(StartLoggingRequest, CancellationToken) | Initiates the asynchronous execution of the StartLogging operation. | |
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.
|
|
StopLoggingAsync(StopLoggingRequest, CancellationToken) | Initiates the asynchronous execution of the StopLogging operation. | |
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.
|
|
UpdateTrailAsync(UpdateTrailRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateTrail operation. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8