@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudTrailClient extends AmazonWebServiceClient implements AWSCloudTrail
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSCloudTrailClient()
Deprecated.
|
AWSCloudTrailClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSCloudTrailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSCloudTrailClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSCloudTrailClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Adds one or more tags to a trail, up to a limit of 50.
|
static AWSCloudTrailClientBuilder |
builder() |
CreateTrailResult |
createTrail(CreateTrailRequest request)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
DeleteTrailResult |
deleteTrail(DeleteTrailRequest request)
Deletes a trail.
|
DescribeTrailsResult |
describeTrails()
Simplified method form for invoking the DescribeTrails operation.
|
DescribeTrailsResult |
describeTrails(DescribeTrailsRequest request)
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.
|
GetEventSelectorsResult |
getEventSelectors(GetEventSelectorsRequest request)
Describes the settings for the event selectors that you configured for your trail.
|
GetTrailStatusResult |
getTrailStatus(GetTrailStatusRequest request)
Returns a JSON-formatted list of information about the specified trail.
|
ListPublicKeysResult |
listPublicKeys()
Simplified method form for invoking the ListPublicKeys operation.
|
ListPublicKeysResult |
listPublicKeys(ListPublicKeysRequest request)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists the tags for the trail in the current region.
|
LookupEventsResult |
lookupEvents()
Simplified method form for invoking the LookupEvents operation.
|
LookupEventsResult |
lookupEvents(LookupEventsRequest request)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account.
|
PutEventSelectorsResult |
putEventSelectors(PutEventSelectorsRequest request)
Configures an event selector for your trail.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified tags from a trail.
|
StartLoggingResult |
startLogging(StartLoggingRequest request)
Starts the recording of AWS API calls and log file delivery for a trail.
|
StopLoggingResult |
stopLogging(StopLoggingRequest request)
Suspends the recording of AWS API calls and log file delivery for the specified trail.
|
UpdateTrailResult |
updateTrail(UpdateTrailRequest request)
Updates the settings that specify delivery of log files.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSCloudTrailClient()
AWSCloudTrailClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSCloudTrailClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSCloudTrailClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSCloudTrailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSCloudTrailClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSCloudTrailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSCloudTrailClientBuilder builder()
public AddTagsResult addTags(AddTagsRequest request)
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).
addTags in interface AWSCloudTrailaddTagsRequest - Specifies the tags to add to a trail.ResourceNotFoundException - This exception is thrown when the specified resource is not found.CloudTrailARNInvalidException - 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
ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.TagsLimitExceededException - The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.InvalidTrailNameException - 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)
InvalidTagParameterException - 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}_.:/=+\\-@]*)$.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public CreateTrailResult createTrail(CreateTrailRequest request)
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.
createTrail in interface AWSCloudTrailcreateTrailRequest - Specifies the settings for each trail.MaximumNumberOfTrailsExceededException - This exception is thrown when the maximum number of trails is reached.TrailAlreadyExistsException - This exception is thrown when the specified trail already exists.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException - This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.InvalidS3BucketNameException - This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException - This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException - This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException - This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException - 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)
TrailNotProvidedException - This exception is deprecated.InvalidParameterCombinationException - This exception is thrown when the combination of parameters provided is not valid.KmsKeyNotFoundException - 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.KmsKeyDisabledException - This exception is deprecated.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException - This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException - This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException - Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public DeleteTrailResult deleteTrail(DeleteTrailRequest request)
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.
deleteTrail in interface AWSCloudTraildeleteTrailRequest - The request that specifies the name of a trail to delete.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
InvalidHomeRegionException - 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.public DescribeTrailsResult describeTrails(DescribeTrailsRequest request)
Retrieves settings for the trail associated with the current region for your account.
describeTrails in interface AWSCloudTraildescribeTrailsRequest - Returns information about the trail.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public DescribeTrailsResult describeTrails()
AWSCloudTraildescribeTrails in interface AWSCloudTrailAWSCloudTrail.describeTrails(DescribeTrailsRequest)public GetEventSelectorsResult getEventSelectors(GetEventSelectorsRequest request)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
The S3 objects that you are logging for data events.
If your event selector includes management events.
If your event selector includes read-only events, write-only events, or all.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
getEventSelectors in interface AWSCloudTrailgetEventSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public GetTrailStatusResult getTrailStatus(GetTrailStatusRequest request)
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.
getTrailStatus in interface AWSCloudTrailgetTrailStatusRequest - The name of a trail about which you want the current status.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
public ListPublicKeysResult listPublicKeys(ListPublicKeysRequest request)
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.
listPublicKeys in interface AWSCloudTraillistPublicKeysRequest - Requests the public keys for a specified time range.InvalidTimeRangeException - 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.InvalidTokenException - Reserved for future use.public ListPublicKeysResult listPublicKeys()
AWSCloudTraillistPublicKeys in interface AWSCloudTrailAWSCloudTrail.listPublicKeys(ListPublicKeysRequest)public ListTagsResult listTags(ListTagsRequest request)
Lists the tags for the trail in the current region.
listTags in interface AWSCloudTraillistTagsRequest - Specifies a list of trail tags to return.ResourceNotFoundException - This exception is thrown when the specified resource is not found.CloudTrailARNInvalidException - 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
ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException - 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)
UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.InvalidTokenException - Reserved for future use.public LookupEventsResult lookupEvents(LookupEventsRequest request)
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
lookupEvents in interface AWSCloudTraillookupEventsRequest - Contains a request for LookupEvents.InvalidLookupAttributesException - Occurs when an invalid lookup attribute is specified.InvalidTimeRangeException - 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.InvalidMaxResultsException - This exception is thrown if the limit specified is invalid.InvalidNextTokenException - Invalid token or token that was previously used in a request with different parameters. This exception is
thrown if the token is invalid.public LookupEventsResult lookupEvents()
AWSCloudTraillookupEvents in interface AWSCloudTrailAWSCloudTrail.lookupEvents(LookupEventsRequest)public PutEventSelectorsResult putEventSelectors(PutEventSelectorsRequest request)
Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail
doesn't log the event.
The PutEventSelectors operation must be called from the region in which the trail was created;
otherwise, an InvalidHomeRegionException is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
putEventSelectors in interface AWSCloudTrailputEventSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
InvalidHomeRegionException - 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.InvalidEventSelectorsException - 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 250) 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.
UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public RemoveTagsResult removeTags(RemoveTagsRequest request)
Removes the specified tags from a trail.
removeTags in interface AWSCloudTrailremoveTagsRequest - Specifies the tags to remove from a trail.ResourceNotFoundException - This exception is thrown when the specified resource is not found.CloudTrailARNInvalidException - 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
ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.InvalidTrailNameException - 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)
InvalidTagParameterException - 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}_.:/=+\\-@]*)$.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public StartLoggingResult startLogging(StartLoggingRequest request)
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.
startLogging in interface AWSCloudTrailstartLoggingRequest - The request to CloudTrail to start logging AWS API calls for an account.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
InvalidHomeRegionException - 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.public StopLoggingResult stopLogging(StopLoggingRequest request)
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.
stopLogging in interface AWSCloudTrailstopLoggingRequest - Passes the request to CloudTrail to stop logging AWS API calls for the specified account.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - 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)
InvalidHomeRegionException - 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.public UpdateTrailResult updateTrail(UpdateTrailRequest request)
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.
updateTrail in interface AWSCloudTrailupdateTrailRequest - Specifies settings to update for the trail.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException - This exception is thrown when the policy on the SNS topic is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidS3BucketNameException - This exception is thrown when the provided S3 bucket name is not valid.InvalidS3PrefixException - This exception is thrown when the provided S3 prefix is not valid.InvalidSnsTopicNameException - This exception is thrown when the provided SNS topic name is not valid.InvalidKmsKeyIdException - This exception is thrown when the KMS key ARN is invalid.InvalidTrailNameException - 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)
TrailNotProvidedException - This exception is deprecated.InvalidParameterCombinationException - This exception is thrown when the combination of parameters provided is not valid.InvalidHomeRegionException - 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.KmsKeyNotFoundException - 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.KmsKeyDisabledException - This exception is deprecated.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail can’t be
updated.InvalidCloudWatchLogsLogGroupArnException - This exception is thrown when the provided CloudWatch log group is not valid.InvalidCloudWatchLogsRoleArnException - This exception is thrown when the provided role is not valid.CloudWatchLogsDeliveryUnavailableException - Cannot set a CloudWatch Logs delivery for this region.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AWSCloudTrailrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.