com.amazonaws.services.cloudtrail

Interface AWSCloudTrail

All Known Subinterfaces:

AWSCloudTrailAsync

All Known Implementing Classes:

AWSCloudTrailAsyncClient, AWSCloudTrailClient

public interface AWSCloudTrail

Interface for accessing AWSCloudTrail. 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.

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.

Method Summary

Methods

Modifier and Type	Method and Description
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Adds one or more tags to a trail, up to a limit of 10.
CreateTrailResult	createTrail(CreateTrailRequest createTrailRequest) Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
DeleteTrailResult	deleteTrail(DeleteTrailRequest deleteTrailRequest) Deletes a trail.
DescribeTrailsResult	describeTrails() Retrieves settings for the trail associated with the current region for your account.
DescribeTrailsResult	describeTrails(DescribeTrailsRequest describeTrailsRequest) Retrieves settings for the trail associated with the current region for your account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetTrailStatusResult	getTrailStatus(GetTrailStatusRequest getTrailStatusRequest) Returns a JSON-formatted list of information about the specified trail.
ListPublicKeysResult	listPublicKeys() Returns all public keys whose private keys were used to sign the digest files within the specified time range.
ListPublicKeysResult	listPublicKeys(ListPublicKeysRequest listPublicKeysRequest) Returns all public keys whose private keys were used to sign the digest files within the specified time range.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Lists the tags for the trail in the current region.
LookupEventsResult	lookupEvents() Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
LookupEventsResult	lookupEvents(LookupEventsRequest lookupEventsRequest) Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes the specified tags from a trail.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cloudtrail.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartLoggingResult	startLogging(StartLoggingRequest startLoggingRequest) Starts the recording of AWS API calls and log file delivery for a trail.
StopLoggingResult	stopLogging(StopLoggingRequest stopLoggingRequest) Suspends the recording of AWS API calls and log file delivery for the specified trail.
UpdateTrailResult	updateTrail(UpdateTrailRequest updateTrailRequest) Updates the settings that specify delivery of log files.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://cloudtrail.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudtrail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudtrail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

listTags

ListTagsResult listTags(ListTagsRequest listTagsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Lists the tags for the trail in the current region.

Parameters:

listTagsRequest - Container for the necessary parameters to execute the ListTags service method on AWSCloudTrail.

Returns:

The response from the ListTags service method, as returned by AWSCloudTrail.

Throws:

ResourceTypeNotSupportedException

ResourceNotFoundException

UnsupportedOperationException

CloudTrailARNInvalidException

InvalidTrailNameException

InvalidTokenException

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

getTrailStatus

GetTrailStatusResult getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

getTrailStatusRequest - Container for the necessary parameters to execute the GetTrailStatus service method on AWSCloudTrail.

Returns:

The response from the GetTrailStatus service method, as returned by AWSCloudTrail.

Throws:

InvalidTrailNameException

TrailNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

removeTags

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Removes the specified tags from a trail.

Parameters:

removeTagsRequest - Container for the necessary parameters to execute the RemoveTags service method on AWSCloudTrail.

Returns:

The response from the RemoveTags service method, as returned by AWSCloudTrail.

Throws:

ResourceTypeNotSupportedException

ResourceNotFoundException

UnsupportedOperationException

CloudTrailARNInvalidException

InvalidTrailNameException

InvalidTagParameterException

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

deleteTrail

DeleteTrailResult deleteTrail(DeleteTrailRequest deleteTrailRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Deletes a trail. This operation must be called from the region in which the trail was created.

Parameters:

deleteTrailRequest - Container for the necessary parameters to execute the DeleteTrail service method on AWSCloudTrail.

Returns:

The response from the DeleteTrail service method, as returned by AWSCloudTrail.

Throws:

InvalidTrailNameException

TrailNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

lookupEvents

LookupEventsResult lookupEvents(LookupEventsRequest lookupEventsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

IMPORTANT:The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

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

Parameters:

lookupEventsRequest - Container for the necessary parameters to execute the LookupEvents service method on AWSCloudTrail.

Returns:

The response from the LookupEvents service method, as returned by AWSCloudTrail.

Throws:

InvalidMaxResultsException

InvalidNextTokenException

InvalidLookupAttributesException

InvalidTimeRangeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

createTrail

CreateTrailResult createTrail(CreateTrailRequest createTrailRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Parameters:

createTrailRequest - Container for the necessary parameters to execute the CreateTrail service method on AWSCloudTrail.

Returns:

The response from the CreateTrail service method, as returned by AWSCloudTrail.

Throws:

InsufficientEncryptionPolicyException

InvalidTrailNameException

InvalidCloudWatchLogsLogGroupArnException

TrailAlreadyExistsException

InvalidS3BucketNameException

KmsKeyDisabledException

TrailNotProvidedException

InvalidSnsTopicNameException

S3BucketDoesNotExistException

UnsupportedOperationException

KmsKeyNotFoundException

InvalidS3PrefixException

InvalidCloudWatchLogsRoleArnException

MaximumNumberOfTrailsExceededException

InvalidKmsKeyIdException

InsufficientSnsTopicPolicyException

CloudWatchLogsDeliveryUnavailableException

OperationNotPermittedException

InsufficientS3BucketPolicyException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

updateTrail

UpdateTrailResult updateTrail(UpdateTrailRequest updateTrailRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

Parameters:

updateTrailRequest - Container for the necessary parameters to execute the UpdateTrail service method on AWSCloudTrail.

Returns:

The response from the UpdateTrail service method, as returned by AWSCloudTrail.

Throws:

InsufficientEncryptionPolicyException

InvalidTrailNameException

InvalidCloudWatchLogsLogGroupArnException

InvalidS3BucketNameException

KmsKeyDisabledException

TrailNotProvidedException

InvalidSnsTopicNameException

S3BucketDoesNotExistException

UnsupportedOperationException

KmsKeyNotFoundException

InvalidCloudWatchLogsRoleArnException

InvalidS3PrefixException

InvalidKmsKeyIdException

InsufficientSnsTopicPolicyException

CloudWatchLogsDeliveryUnavailableException

OperationNotPermittedException

TrailNotFoundException

InsufficientS3BucketPolicyException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

stopLogging

StopLoggingResult stopLogging(StopLoggingRequest stopLoggingRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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.

Parameters:

stopLoggingRequest - Container for the necessary parameters to execute the StopLogging service method on AWSCloudTrail.

Returns:

The response from the StopLogging service method, as returned by AWSCloudTrail.

Throws:

InvalidTrailNameException

TrailNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

describeTrails

DescribeTrailsResult describeTrails(DescribeTrailsRequest describeTrailsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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

Parameters:

describeTrailsRequest - Container for the necessary parameters to execute the DescribeTrails service method on AWSCloudTrail.

Returns:

The response from the DescribeTrails service method, as returned by AWSCloudTrail.

Throws:

UnsupportedOperationException

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

listPublicKeys

ListPublicKeysResult listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

NOTE: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.

Parameters:

listPublicKeysRequest - Container for the necessary parameters to execute the ListPublicKeys service method on AWSCloudTrail.

Returns:

The response from the ListPublicKeys service method, as returned by AWSCloudTrail.

Throws:

UnsupportedOperationException

InvalidTokenException

OperationNotPermittedException

InvalidTimeRangeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

addTags

AddTagsResult addTags(AddTagsRequest addTagsRequest)
                      throws AmazonServiceException,
                             AmazonClientException

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.

Parameters:

addTagsRequest - Container for the necessary parameters to execute the AddTags service method on AWSCloudTrail.

Returns:

The response from the AddTags service method, as returned by AWSCloudTrail.

Throws:

ResourceTypeNotSupportedException

TagsLimitExceededException

ResourceNotFoundException

UnsupportedOperationException

CloudTrailARNInvalidException

InvalidTrailNameException

InvalidTagParameterException

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

startLogging

StartLoggingResult startLogging(StartLoggingRequest startLoggingRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Starts the recording of AWS API calls and log file delivery for a trail.

Parameters:

startLoggingRequest - Container for the necessary parameters to execute the StartLogging service method on AWSCloudTrail.

Returns:

The response from the StartLogging service method, as returned by AWSCloudTrail.

Throws:

InvalidTrailNameException

TrailNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

lookupEvents

LookupEventsResult lookupEvents()
                                throws AmazonServiceException,
                                       AmazonClientException

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.

IMPORTANT:The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

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

Returns:

The response from the LookupEvents service method, as returned by AWSCloudTrail.

Throws:

InvalidMaxResultsException

InvalidNextTokenException

InvalidLookupAttributesException

InvalidTimeRangeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

describeTrails

DescribeTrailsResult describeTrails()
                                    throws AmazonServiceException,
                                           AmazonClientException

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

Returns:

The response from the DescribeTrails service method, as returned by AWSCloudTrail.

Throws:

UnsupportedOperationException

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

listPublicKeys

ListPublicKeysResult listPublicKeys()
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

NOTE: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.

Returns:

The response from the ListPublicKeys service method, as returned by AWSCloudTrail.

Throws:

UnsupportedOperationException

InvalidTokenException

OperationNotPermittedException

InvalidTimeRangeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.