C# Class Amazon.CloudTrail.AmazonCloudTrailClient

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: AmazonServiceClient, IAmazonCloudTrail
Show file Open project: aws/aws-sdk-net

Public Methods

Method Description
AddTags ( AddTagsRequest request ) : AddTagsResponse

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).
AddTagsAsync ( AddTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the AddTags operation.
AmazonCloudTrailClient ( ) : System

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 credentials ) : System

Constructs AmazonCloudTrailClient with AWS Credentials
AmazonCloudTrailClient ( AWSCredentials credentials, AmazonCloudTrailConfig clientConfig ) : System

Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object.
AmazonCloudTrailClient ( AWSCredentials credentials, RegionEndpoint region ) : System

Constructs AmazonCloudTrailClient with AWS Credentials
AmazonCloudTrailClient ( AmazonCloudTrailConfig config ) : System

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 region ) : System

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 ( string awsAccessKeyId, string awsSecretAccessKey ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudTrailConfig clientConfig ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.
AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudTrailConfig clientConfig ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.
AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
BeginAddTags ( AddTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the AddTags operation.
BeginCreateTrail ( CreateTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the CreateTrail operation.
BeginDeleteTrail ( DeleteTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DeleteTrail operation.
BeginDescribeTrails ( DescribeTrailsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the DescribeTrails operation.
BeginGetEventSelectors ( GetEventSelectorsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetEventSelectors operation.
BeginGetTrailStatus ( GetTrailStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the GetTrailStatus operation.
BeginListPublicKeys ( ListPublicKeysRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListPublicKeys operation.
BeginListTags ( ListTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the ListTags operation.
BeginLookupEvents ( LookupEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the LookupEvents operation.
BeginPutEventSelectors ( PutEventSelectorsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the PutEventSelectors operation.
BeginRemoveTags ( RemoveTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the RemoveTags operation.
BeginStartLogging ( StartLoggingRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the StartLogging operation.
BeginStopLogging ( StopLoggingRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the StopLogging operation.
BeginUpdateTrail ( UpdateTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult

Initiates the asynchronous execution of the UpdateTrail operation.
CreateTrail ( CreateTrailRequest request ) : CreateTrailResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the CreateTrail operation.
DeleteTrail ( DeleteTrailRequest request ) : DeleteTrailResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DeleteTrail operation.
DescribeTrails ( ) : DescribeTrailsResponse

Retrieves settings for the trail associated with the current region for your account.
DescribeTrails ( DescribeTrailsRequest request ) : DescribeTrailsResponse

Retrieves settings for the trail associated with the current region for your account.
DescribeTrailsAsync ( DescribeTrailsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the DescribeTrails operation.
DescribeTrailsAsync ( System cancellationToken = default(CancellationToken) ) : Task

Retrieves settings for the trail associated with the current region for your account.
EndAddTags ( IAsyncResult asyncResult ) : AddTagsResponse

Finishes the asynchronous execution of the AddTags operation.
EndCreateTrail ( IAsyncResult asyncResult ) : CreateTrailResponse

Finishes the asynchronous execution of the CreateTrail operation.
EndDeleteTrail ( IAsyncResult asyncResult ) : DeleteTrailResponse

Finishes the asynchronous execution of the DeleteTrail operation.
EndDescribeTrails ( IAsyncResult asyncResult ) : DescribeTrailsResponse

Finishes the asynchronous execution of the DescribeTrails operation.
EndGetEventSelectors ( IAsyncResult asyncResult ) : GetEventSelectorsResponse

Finishes the asynchronous execution of the GetEventSelectors operation.
EndGetTrailStatus ( IAsyncResult asyncResult ) : GetTrailStatusResponse

Finishes the asynchronous execution of the GetTrailStatus operation.
EndListPublicKeys ( IAsyncResult asyncResult ) : ListPublicKeysResponse

Finishes the asynchronous execution of the ListPublicKeys operation.
EndListTags ( IAsyncResult asyncResult ) : ListTagsResponse

Finishes the asynchronous execution of the ListTags operation.
EndLookupEvents ( IAsyncResult asyncResult ) : Amazon.CloudTrail.Model.LookupEventsResponse

Finishes the asynchronous execution of the LookupEvents operation.
EndPutEventSelectors ( IAsyncResult asyncResult ) : PutEventSelectorsResponse

Finishes the asynchronous execution of the PutEventSelectors operation.
EndRemoveTags ( IAsyncResult asyncResult ) : RemoveTagsResponse

Finishes the asynchronous execution of the RemoveTags operation.
EndStartLogging ( IAsyncResult asyncResult ) : StartLoggingResponse

Finishes the asynchronous execution of the StartLogging operation.
EndStopLogging ( IAsyncResult asyncResult ) : StopLoggingResponse

Finishes the asynchronous execution of the StopLogging operation.
EndUpdateTrail ( IAsyncResult asyncResult ) : UpdateTrailResponse

Finishes the asynchronous execution of the UpdateTrail operation.
GetEventSelectors ( GetEventSelectorsRequest request ) : GetEventSelectorsResponse

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 Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

GetEventSelectorsAsync ( GetEventSelectorsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetEventSelectors operation.
GetTrailStatus ( GetTrailStatusRequest request ) : 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.
GetTrailStatusAsync ( GetTrailStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the GetTrailStatus operation.
ListPublicKeys ( ListPublicKeysRequest request ) : 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.

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.

ListPublicKeysAsync ( ListPublicKeysRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListPublicKeys operation.
ListTags ( ListTagsRequest request ) : ListTagsResponse

Lists the tags for the trail in the current region.
ListTagsAsync ( ListTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the ListTags operation.
LookupEvents ( LookupEventsRequest request ) : Amazon.CloudTrail.Model.LookupEventsResponse

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

  • 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.

LookupEventsAsync ( LookupEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the LookupEvents operation.
PutEventSelectors ( PutEventSelectorsRequest request ) : PutEventSelectorsResponse

Configures an event selector for your trail. Use event selectors to specify the type of events that you want your trail to log. 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 Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

PutEventSelectorsAsync ( PutEventSelectorsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the PutEventSelectors operation.
RemoveTags ( RemoveTagsRequest request ) : RemoveTagsResponse

Removes the specified tags from a trail.
RemoveTagsAsync ( RemoveTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the RemoveTags operation.
StartLogging ( StartLoggingRequest request ) : StartLoggingResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the StartLogging operation.
StopLogging ( StopLoggingRequest request ) : StopLoggingResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the StopLogging operation.
UpdateTrail ( UpdateTrailRequest request ) : UpdateTrailResponse

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 request, System cancellationToken = default(CancellationToken) ) : Task

Initiates the asynchronous execution of the UpdateTrail operation.

Protected Methods

Method Description
CreateSigner ( ) : AbstractAWSSigner

Creates the signer for the service.
Dispose ( bool disposing ) : void

Disposes the service client.

Method Details

AddTags() public method

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).
/// This exception is thrown when an operation is called with an invalid trail ARN. The /// format of a trail ARN is: /// /// /// /// arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail /// /// /// This exception is thrown when the key or value specified for the tag does not match /// the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the specified resource is not found. /// /// This exception is thrown when the specified resource type is not supported by CloudTrail. /// /// The number of tags per trail has exceeded the permitted amount. Currently, the limit /// is 50. /// /// This exception is thrown when the requested operation is not supported. ///
public AddTags ( AddTagsRequest request ) : AddTagsResponse
request Amazon.CloudTrail.Model.AddTagsRequest Container for the necessary parameters to execute the AddTags service method.
return AddTagsResponse

AddTagsAsync() public method

Initiates the asynchronous execution of the AddTags operation.
public AddTagsAsync ( AddTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.AddTagsRequest Container for the necessary parameters to execute the AddTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

AmazonCloudTrailClient() public method

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>
public AmazonCloudTrailClient ( ) : System
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Credentials
public AmazonCloudTrailClient ( AWSCredentials credentials ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object.
public AmazonCloudTrailClient ( AWSCredentials credentials, AmazonCloudTrailConfig clientConfig ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
clientConfig AmazonCloudTrailConfig The AmazonCloudTrailClient Configuration Object
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Credentials
public AmazonCloudTrailClient ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials Amazon.Runtime.AWSCredentials AWS Credentials
region RegionEndpoint The region to connect.
return System

AmazonCloudTrailClient() public method

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>
public AmazonCloudTrailClient ( AmazonCloudTrailConfig config ) : System
config AmazonCloudTrailConfig The AmazonCloudTrailClient Configuration Object
return System

AmazonCloudTrailClient() public method

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>
public AmazonCloudTrailClient ( RegionEndpoint region ) : System
region RegionEndpoint The region to connect.
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, AmazonCloudTrailConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
clientConfig AmazonCloudTrailConfig The AmazonCloudTrailClient Configuration Object
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
region RegionEndpoint The region to connect.
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object.
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonCloudTrailConfig clientConfig ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
clientConfig AmazonCloudTrailConfig The AmazonCloudTrailClient Configuration Object
return System

AmazonCloudTrailClient() public method

Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key
public AmazonCloudTrailClient ( string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region ) : System
awsAccessKeyId string AWS Access Key ID
awsSecretAccessKey string AWS Secret Access Key
awsSessionToken string AWS Session Token
region RegionEndpoint The region to connect.
return System

BeginAddTags() public method

Initiates the asynchronous execution of the AddTags operation.
public BeginAddTags ( AddTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.AddTagsRequest Container for the necessary parameters to execute the AddTags operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginCreateTrail() public method

Initiates the asynchronous execution of the CreateTrail operation.
public BeginCreateTrail ( CreateTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.CreateTrailRequest Container for the necessary parameters to execute the CreateTrail operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDeleteTrail() public method

Initiates the asynchronous execution of the DeleteTrail operation.
public BeginDeleteTrail ( DeleteTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.DeleteTrailRequest Container for the necessary parameters to execute the DeleteTrail operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginDescribeTrails() public method

Initiates the asynchronous execution of the DescribeTrails operation.
public BeginDescribeTrails ( DescribeTrailsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.DescribeTrailsRequest Container for the necessary parameters to execute the DescribeTrails operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetEventSelectors() public method

Initiates the asynchronous execution of the GetEventSelectors operation.
public BeginGetEventSelectors ( GetEventSelectorsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.GetEventSelectorsRequest Container for the necessary parameters to execute the GetEventSelectors operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginGetTrailStatus() public method

Initiates the asynchronous execution of the GetTrailStatus operation.
public BeginGetTrailStatus ( GetTrailStatusRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.GetTrailStatusRequest Container for the necessary parameters to execute the GetTrailStatus operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListPublicKeys() public method

Initiates the asynchronous execution of the ListPublicKeys operation.
public BeginListPublicKeys ( ListPublicKeysRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.ListPublicKeysRequest Container for the necessary parameters to execute the ListPublicKeys operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginListTags() public method

Initiates the asynchronous execution of the ListTags operation.
public BeginListTags ( ListTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.ListTagsRequest Container for the necessary parameters to execute the ListTags operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginLookupEvents() public method

Initiates the asynchronous execution of the LookupEvents operation.
public BeginLookupEvents ( LookupEventsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.LookupEventsRequest Container for the necessary parameters to execute the LookupEvents operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginPutEventSelectors() public method

Initiates the asynchronous execution of the PutEventSelectors operation.
public BeginPutEventSelectors ( PutEventSelectorsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.PutEventSelectorsRequest Container for the necessary parameters to execute the PutEventSelectors operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginRemoveTags() public method

Initiates the asynchronous execution of the RemoveTags operation.
public BeginRemoveTags ( RemoveTagsRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.RemoveTagsRequest Container for the necessary parameters to execute the RemoveTags operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginStartLogging() public method

Initiates the asynchronous execution of the StartLogging operation.
public BeginStartLogging ( StartLoggingRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.StartLoggingRequest Container for the necessary parameters to execute the StartLogging operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginStopLogging() public method

Initiates the asynchronous execution of the StopLogging operation.
public BeginStopLogging ( StopLoggingRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.StopLoggingRequest Container for the necessary parameters to execute the StopLogging operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

BeginUpdateTrail() public method

Initiates the asynchronous execution of the UpdateTrail operation.
public BeginUpdateTrail ( UpdateTrailRequest request, AsyncCallback callback, object state ) : IAsyncResult
request Amazon.CloudTrail.Model.UpdateTrailRequest Container for the necessary parameters to execute the UpdateTrail operation on AmazonCloudTrailClient.
callback AsyncCallback An AsyncCallback delegate that is invoked when the operation completes.
state object A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property.
return IAsyncResult

CreateSigner() protected method

Creates the signer for the service.
protected CreateSigner ( ) : AbstractAWSSigner
return Amazon.Runtime.Internal.Auth.AbstractAWSSigner

CreateTrail() public method

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.
/// Cannot set a CloudWatch Logs delivery for this region. /// /// This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. /// /// This exception is thrown when the policy on the S3 bucket is not sufficient. /// /// This exception is thrown when the policy on the SNS topic is not sufficient. /// /// This exception is thrown when the provided CloudWatch log group is not valid. /// /// This exception is thrown when the provided role is not valid. /// /// This exception is thrown when the KMS key ARN is invalid. /// /// This exception is thrown when the combination of parameters provided is not valid. /// /// This exception is thrown when the provided S3 bucket name is not valid. /// /// This exception is thrown when the provided S3 prefix is not valid. /// /// This exception is thrown when the provided SNS topic name is not valid. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when there is an issue with the specified KMS key and the /// trail can’t be updated. /// /// This exception is deprecated. /// /// This exception is thrown when the KMS key does not exist, or when the S3 bucket and /// the KMS key are not in the same region. /// /// This exception is thrown when the maximum number of trails is reached. /// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the specified S3 bucket does not exist. /// /// This exception is thrown when the specified trail already exists. /// /// This exception is deprecated. /// /// This exception is thrown when the requested operation is not supported. ///
public CreateTrail ( CreateTrailRequest request ) : CreateTrailResponse
request Amazon.CloudTrail.Model.CreateTrailRequest Container for the necessary parameters to execute the CreateTrail service method.
return Amazon.CloudTrail.Model.CreateTrailResponse

CreateTrailAsync() public method

Initiates the asynchronous execution of the CreateTrail operation.
public CreateTrailAsync ( CreateTrailRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.CreateTrailRequest Container for the necessary parameters to execute the CreateTrail operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DeleteTrail() public method

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.
/// This exception is thrown when an operation is called on a trail from a region other /// than the region in which the trail was created. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the trail with the given name is not found. ///
public DeleteTrail ( DeleteTrailRequest request ) : DeleteTrailResponse
request Amazon.CloudTrail.Model.DeleteTrailRequest Container for the necessary parameters to execute the DeleteTrail service method.
return Amazon.CloudTrail.Model.DeleteTrailResponse

DeleteTrailAsync() public method

Initiates the asynchronous execution of the DeleteTrail operation.
public DeleteTrailAsync ( DeleteTrailRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.DeleteTrailRequest Container for the necessary parameters to execute the DeleteTrail operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrails() public method

Retrieves settings for the trail associated with the current region for your account.
/// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the requested operation is not supported. ///
public DescribeTrails ( ) : DescribeTrailsResponse
return Amazon.CloudTrail.Model.DescribeTrailsResponse

DescribeTrails() public method

Retrieves settings for the trail associated with the current region for your account.
/// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the requested operation is not supported. ///
public DescribeTrails ( DescribeTrailsRequest request ) : DescribeTrailsResponse
request Amazon.CloudTrail.Model.DescribeTrailsRequest Container for the necessary parameters to execute the DescribeTrails service method.
return Amazon.CloudTrail.Model.DescribeTrailsResponse

DescribeTrailsAsync() public method

Initiates the asynchronous execution of the DescribeTrails operation.
public DescribeTrailsAsync ( DescribeTrailsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.DescribeTrailsRequest Container for the necessary parameters to execute the DescribeTrails operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

DescribeTrailsAsync() public method

Retrieves settings for the trail associated with the current region for your account.
/// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the requested operation is not supported. ///
public DescribeTrailsAsync ( System cancellationToken = default(CancellationToken) ) : Task
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

Dispose() protected method

Disposes the service client.
protected Dispose ( bool disposing ) : void
disposing bool
return void

EndAddTags() public method

Finishes the asynchronous execution of the AddTags operation.
public EndAddTags ( IAsyncResult asyncResult ) : AddTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginAddTags.
return AddTagsResponse

EndCreateTrail() public method

Finishes the asynchronous execution of the CreateTrail operation.
public EndCreateTrail ( IAsyncResult asyncResult ) : CreateTrailResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginCreateTrail.
return Amazon.CloudTrail.Model.CreateTrailResponse

EndDeleteTrail() public method

Finishes the asynchronous execution of the DeleteTrail operation.
public EndDeleteTrail ( IAsyncResult asyncResult ) : DeleteTrailResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDeleteTrail.
return Amazon.CloudTrail.Model.DeleteTrailResponse

EndDescribeTrails() public method

Finishes the asynchronous execution of the DescribeTrails operation.
public EndDescribeTrails ( IAsyncResult asyncResult ) : DescribeTrailsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginDescribeTrails.
return Amazon.CloudTrail.Model.DescribeTrailsResponse

EndGetEventSelectors() public method

Finishes the asynchronous execution of the GetEventSelectors operation.
public EndGetEventSelectors ( IAsyncResult asyncResult ) : GetEventSelectorsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetEventSelectors.
return Amazon.CloudTrail.Model.GetEventSelectorsResponse

EndGetTrailStatus() public method

Finishes the asynchronous execution of the GetTrailStatus operation.
public EndGetTrailStatus ( IAsyncResult asyncResult ) : GetTrailStatusResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginGetTrailStatus.
return Amazon.CloudTrail.Model.GetTrailStatusResponse

EndListPublicKeys() public method

Finishes the asynchronous execution of the ListPublicKeys operation.
public EndListPublicKeys ( IAsyncResult asyncResult ) : ListPublicKeysResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListPublicKeys.
return Amazon.CloudTrail.Model.ListPublicKeysResponse

EndListTags() public method

Finishes the asynchronous execution of the ListTags operation.
public EndListTags ( IAsyncResult asyncResult ) : ListTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginListTags.
return Amazon.CloudTrail.Model.ListTagsResponse

EndLookupEvents() public method

Finishes the asynchronous execution of the LookupEvents operation.
public EndLookupEvents ( IAsyncResult asyncResult ) : Amazon.CloudTrail.Model.LookupEventsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginLookupEvents.
return Amazon.CloudTrail.Model.LookupEventsResponse

EndPutEventSelectors() public method

Finishes the asynchronous execution of the PutEventSelectors operation.
public EndPutEventSelectors ( IAsyncResult asyncResult ) : PutEventSelectorsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginPutEventSelectors.
return Amazon.CloudTrail.Model.PutEventSelectorsResponse

EndRemoveTags() public method

Finishes the asynchronous execution of the RemoveTags operation.
public EndRemoveTags ( IAsyncResult asyncResult ) : RemoveTagsResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginRemoveTags.
return RemoveTagsResponse

EndStartLogging() public method

Finishes the asynchronous execution of the StartLogging operation.
public EndStartLogging ( IAsyncResult asyncResult ) : StartLoggingResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginStartLogging.
return Amazon.CloudTrail.Model.StartLoggingResponse

EndStopLogging() public method

Finishes the asynchronous execution of the StopLogging operation.
public EndStopLogging ( IAsyncResult asyncResult ) : StopLoggingResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginStopLogging.
return Amazon.CloudTrail.Model.StopLoggingResponse

EndUpdateTrail() public method

Finishes the asynchronous execution of the UpdateTrail operation.
public EndUpdateTrail ( IAsyncResult asyncResult ) : UpdateTrailResponse
asyncResult IAsyncResult The IAsyncResult returned by the call to BeginUpdateTrail.
return Amazon.CloudTrail.Model.UpdateTrailResponse

GetEventSelectors() public method

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 Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

/// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the trail with the given name is not found. /// /// This exception is thrown when the requested operation is not supported. ///
public GetEventSelectors ( GetEventSelectorsRequest request ) : GetEventSelectorsResponse
request Amazon.CloudTrail.Model.GetEventSelectorsRequest Container for the necessary parameters to execute the GetEventSelectors service method.
return Amazon.CloudTrail.Model.GetEventSelectorsResponse

GetEventSelectorsAsync() public method

Initiates the asynchronous execution of the GetEventSelectors operation.
public GetEventSelectorsAsync ( GetEventSelectorsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.GetEventSelectorsRequest Container for the necessary parameters to execute the GetEventSelectors operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

GetTrailStatus() public method

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.
/// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the trail with the given name is not found. ///
public GetTrailStatus ( GetTrailStatusRequest request ) : GetTrailStatusResponse
request Amazon.CloudTrail.Model.GetTrailStatusRequest Container for the necessary parameters to execute the GetTrailStatus service method.
return Amazon.CloudTrail.Model.GetTrailStatusResponse

GetTrailStatusAsync() public method

Initiates the asynchronous execution of the GetTrailStatus operation.
public GetTrailStatusAsync ( GetTrailStatusRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.GetTrailStatusRequest Container for the necessary parameters to execute the GetTrailStatus operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListPublicKeys() public method

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.

/// Occurs if the timestamp values are invalid. Either the start time occurs after the /// end time or the time range is outside the range of possible values. /// /// Reserved for future use. /// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the requested operation is not supported. ///
public ListPublicKeys ( ListPublicKeysRequest request ) : ListPublicKeysResponse
request Amazon.CloudTrail.Model.ListPublicKeysRequest Container for the necessary parameters to execute the ListPublicKeys service method.
return Amazon.CloudTrail.Model.ListPublicKeysResponse

ListPublicKeysAsync() public method

Initiates the asynchronous execution of the ListPublicKeys operation.
public ListPublicKeysAsync ( ListPublicKeysRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.ListPublicKeysRequest Container for the necessary parameters to execute the ListPublicKeys operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

ListTags() public method

Lists the tags for the trail in the current region.
/// This exception is thrown when an operation is called with an invalid trail ARN. The /// format of a trail ARN is: /// /// /// /// arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail /// /// /// Reserved for future use. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the specified resource is not found. /// /// This exception is thrown when the specified resource type is not supported by CloudTrail. /// /// This exception is thrown when the requested operation is not supported. ///
public ListTags ( ListTagsRequest request ) : ListTagsResponse
request Amazon.CloudTrail.Model.ListTagsRequest Container for the necessary parameters to execute the ListTags service method.
return Amazon.CloudTrail.Model.ListTagsResponse

ListTagsAsync() public method

Initiates the asynchronous execution of the ListTags operation.
public ListTagsAsync ( ListTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.ListTagsRequest Container for the necessary parameters to execute the ListTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

LookupEvents() public method

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

  • 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.

/// Occurs when an invalid lookup attribute is specified. /// /// This exception is thrown if the limit specified is invalid. /// /// Invalid token or token that was previously used in a request with different parameters. /// This exception is thrown if the token is invalid. /// /// Occurs if the timestamp values are invalid. Either the start time occurs after the /// end time or the time range is outside the range of possible values. ///
public LookupEvents ( LookupEventsRequest request ) : Amazon.CloudTrail.Model.LookupEventsResponse
request Amazon.CloudTrail.Model.LookupEventsRequest Container for the necessary parameters to execute the LookupEvents service method.
return Amazon.CloudTrail.Model.LookupEventsResponse

LookupEventsAsync() public method

Initiates the asynchronous execution of the LookupEvents operation.
public LookupEventsAsync ( LookupEventsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.LookupEventsRequest Container for the necessary parameters to execute the LookupEvents operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

PutEventSelectors() public method

Configures an event selector for your trail. Use event selectors to specify the type of events that you want your trail to log. 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 Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

/// This exception is thrown when the PutEventSelectors operation is called /// with an invalid number of event selectors, data resources, or an invalid value for /// a parameter: /// ///
  • /// /// Specify a valid number of event selectors (1 to 5) for a trail. /// ///
  • /// /// Specify a valid number of data resources (1 to 50) for an event selector. /// ///
  • /// /// Specify a valid value for a parameter. For example, specifying the ReadWriteType /// parameter with a value of read-only is invalid. /// ///
/// /// This exception is thrown when an operation is called on a trail from a region other /// than the region in which the trail was created. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the trail with the given name is not found. /// /// This exception is thrown when the requested operation is not supported. ///
public PutEventSelectors ( PutEventSelectorsRequest request ) : PutEventSelectorsResponse
request Amazon.CloudTrail.Model.PutEventSelectorsRequest Container for the necessary parameters to execute the PutEventSelectors service method.
return Amazon.CloudTrail.Model.PutEventSelectorsResponse

PutEventSelectorsAsync() public method

Initiates the asynchronous execution of the PutEventSelectors operation.
public PutEventSelectorsAsync ( PutEventSelectorsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.PutEventSelectorsRequest Container for the necessary parameters to execute the PutEventSelectors operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

RemoveTags() public method

Removes the specified tags from a trail.
/// This exception is thrown when an operation is called with an invalid trail ARN. The /// format of a trail ARN is: /// /// /// /// arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail /// /// /// This exception is thrown when the key or value specified for the tag does not match /// the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the specified resource is not found. /// /// This exception is thrown when the specified resource type is not supported by CloudTrail. /// /// This exception is thrown when the requested operation is not supported. ///
public RemoveTags ( RemoveTagsRequest request ) : RemoveTagsResponse
request Amazon.CloudTrail.Model.RemoveTagsRequest Container for the necessary parameters to execute the RemoveTags service method.
return RemoveTagsResponse

RemoveTagsAsync() public method

Initiates the asynchronous execution of the RemoveTags operation.
public RemoveTagsAsync ( RemoveTagsRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.RemoveTagsRequest Container for the necessary parameters to execute the RemoveTags operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

StartLogging() public method

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.
/// This exception is thrown when an operation is called on a trail from a region other /// than the region in which the trail was created. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the trail with the given name is not found. ///
public StartLogging ( StartLoggingRequest request ) : StartLoggingResponse
request Amazon.CloudTrail.Model.StartLoggingRequest Container for the necessary parameters to execute the StartLogging service method.
return Amazon.CloudTrail.Model.StartLoggingResponse

StartLoggingAsync() public method

Initiates the asynchronous execution of the StartLogging operation.
public StartLoggingAsync ( StartLoggingRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.StartLoggingRequest Container for the necessary parameters to execute the StartLogging operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

StopLogging() public method

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.
/// This exception is thrown when an operation is called on a trail from a region other /// than the region in which the trail was created. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when the trail with the given name is not found. ///
public StopLogging ( StopLoggingRequest request ) : StopLoggingResponse
request Amazon.CloudTrail.Model.StopLoggingRequest Container for the necessary parameters to execute the StopLogging service method.
return Amazon.CloudTrail.Model.StopLoggingResponse

StopLoggingAsync() public method

Initiates the asynchronous execution of the StopLogging operation.
public StopLoggingAsync ( StopLoggingRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.StopLoggingRequest Container for the necessary parameters to execute the StopLogging operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task

UpdateTrail() public method

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.
/// Cannot set a CloudWatch Logs delivery for this region. /// /// This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. /// /// This exception is thrown when the policy on the S3 bucket is not sufficient. /// /// This exception is thrown when the policy on the SNS topic is not sufficient. /// /// This exception is thrown when the provided CloudWatch log group is not valid. /// /// This exception is thrown when the provided role is not valid. /// /// This exception is thrown when an operation is called on a trail from a region other /// than the region in which the trail was created. /// /// This exception is thrown when the KMS key ARN is invalid. /// /// This exception is thrown when the combination of parameters provided is not valid. /// /// This exception is thrown when the provided S3 bucket name is not valid. /// /// This exception is thrown when the provided S3 prefix is not valid. /// /// This exception is thrown when the provided SNS topic name is not valid. /// /// This exception is thrown when the provided trail name is not valid. Trail names must /// meet the following requirements: /// ///
  • /// /// Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), /// or dashes (-) /// ///
  • /// /// Start with a letter or number, and end with a letter or number /// ///
  • /// /// Be between 3 and 128 characters /// ///
  • /// /// Have no adjacent periods, underscores or dashes. Names like my-_namespace /// and my--namespace are invalid. /// ///
  • /// /// Not be in IP address format (for example, 192.168.5.4) /// ///
/// /// This exception is thrown when there is an issue with the specified KMS key and the /// trail can’t be updated. /// /// This exception is deprecated. /// /// This exception is thrown when the KMS key does not exist, or when the S3 bucket and /// the KMS key are not in the same region. /// /// This exception is thrown when the requested operation is not permitted. /// /// This exception is thrown when the specified S3 bucket does not exist. /// /// This exception is thrown when the trail with the given name is not found. /// /// This exception is deprecated. /// /// This exception is thrown when the requested operation is not supported. ///
public UpdateTrail ( UpdateTrailRequest request ) : UpdateTrailResponse
request Amazon.CloudTrail.Model.UpdateTrailRequest Container for the necessary parameters to execute the UpdateTrail service method.
return Amazon.CloudTrail.Model.UpdateTrailResponse

UpdateTrailAsync() public method

Initiates the asynchronous execution of the UpdateTrail operation.
public UpdateTrailAsync ( UpdateTrailRequest request, System cancellationToken = default(CancellationToken) ) : Task
request Amazon.CloudTrail.Model.UpdateTrailRequest Container for the necessary parameters to execute the UpdateTrail operation.
cancellationToken System /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return Task