@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudTrail
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCloudTrail instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsResult |
addTags(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, up to a limit of 50.
|
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()
Simplified method form for invoking the DescribeTrails operation.
|
DescribeTrailsResult |
describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails 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 getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
GetInsightSelectorsResult |
getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
GetTrailResult |
getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
|
GetTrailStatusResult |
getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
ListPublicKeysResult |
listPublicKeys()
Simplified method form for invoking the ListPublicKeys operation.
|
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.
|
ListTrailsResult |
listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
LookupEventsResult |
lookupEvents()
Simplified method form for invoking the LookupEvents operation.
|
LookupEventsResult |
lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
PutEventSelectorsResult |
putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
PutInsightSelectorsResult |
putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
endpoint - The endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"cloudtrail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AddTagsResult addTags(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. 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 AWS Regions only from the Region in which the trail was created (also known as its home region).
addTagsRequest - 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.CreateTrailResult createTrail(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailRequest - 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 no longer in use.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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsKeyDisabledException - This exception is no longer in use.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.InvalidTagParameterException - This exception is thrown when the specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.DeleteTrailResult deleteTrail(DeleteTrailRequest deleteTrailRequest)
Deletes a trail. This operation must be called from the region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail
that is enabled in all regions.
deleteTrailRequest - 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.DescribeTrailsResult describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current region for your account.
describeTrailsRequest - 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.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)
DescribeTrailsResult describeTrails()
describeTrails(DescribeTrailsRequest)GetEventSelectorsResult getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
getEventSelectorsRequest - 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.GetInsightSelectorsResult getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the AWS CloudTrail User Guide.
getInsightSelectorsRequest - 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.InsightNotEnabledException - If you run GetInsightSelectors on a trail that does not have Insights events enabled, the
operation throws the exception InsightNotEnabledException.GetTrailResult getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
getTrailRequest - 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.GetTrailStatusResult getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
getTrailStatusRequest - 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)
UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.ListPublicKeysResult listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
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.
listPublicKeysRequest - 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.ListPublicKeysResult listPublicKeys()
listPublicKeys(ListPublicKeysRequest)ListTagsResult listTags(ListTagsRequest listTagsRequest)
Lists the tags for the trail in the current region.
listTagsRequest - 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-2: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.ListTrailsResult listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
listTrailsRequest - UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.LookupEventsResult lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:
AWS access key
Event ID
Event name
Event source
Read only
Resource name
Resource type
User name
Lookup supports the following attributes for Insights events:
Event ID
Event name
Event source
All attributes are optional. The default number of results returned is 50, 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 two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
lookupEventsRequest - 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.InvalidEventCategoryException - Occurs if an event category that is not valid is specified as a value of EventCategory.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.LookupEventsResult lookupEvents()
lookupEvents(LookupEventsRequest)PutEventSelectorsResult putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced 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 that 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 exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in AWS CloudTrail in the AWS CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data events for trails in the AWS CloudTrail User Guide.
putEventSelectorsRequest - 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 a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
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. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
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.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.PutInsightSelectorsResult putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. In this release, only ApiCallRateInsight is supported as an Insights
selector.
putInsightSelectorsRequest - 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.InvalidInsightSelectorsException - The formatting or syntax of the InsightSelectors JSON statement in your
PutInsightSelectors or GetInsightSelectors request is not valid, or the
specified insight type in the InsightSelectors statement is not a valid insight type.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail.
removeTagsRequest - 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-2: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 specified tag key or values are not valid. It can also occur if there
are duplicate tags or too many tags on the resource.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.StartLoggingResult startLogging(StartLoggingRequest startLoggingRequest)
Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
startLoggingRequest - 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.StopLoggingResult stopLogging(StopLoggingRequest stopLoggingRequest)
Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances,
there is no need to use this action. You can update a trail without stopping it first. This action is the only
way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which
the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called
on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
stopLoggingRequest - 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.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.UpdateTrailResult updateTrail(UpdateTrailRequest updateTrailRequest)
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the
CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has
previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail
must be called from the region in which the trail was created; otherwise, an
InvalidHomeRegionException is thrown.
updateTrailRequest - 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 no longer in use.InvalidEventSelectorsException - This exception is thrown when the PutEventSelectors operation is called with a number of
event selectors, advanced event selectors, or data resources that is not valid. The combination of event
selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event
selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in
all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources
can be distributed across event selectors, but the overall total cannot exceed 250.
You can:
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. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter
with a value of read-only is invalid.
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, when the S3 bucket and the KMS key are not in
the same region, or when the KMS key associated with the SNS topic either does not exist or is not in the
same region.KmsKeyDisabledException - This exception is no longer in use.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.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS
Organizations. For more information, see Enabling
Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM user or role that is used to create the organization trail is
lacking one or more required permissions for creating an organization trail in a required service. For
more information, see Prepare For Creating a Trail For Your Organization.OrganizationsNotInUseException - This exception is thrown when the request is made from an AWS account that is not a member of an
organization. To make this request, sign in using the credentials of an account that belongs to an
organization.NotOrganizationMasterAccountException - This exception is thrown when the AWS account making the request to create or update an organization
trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.OrganizationNotInAllFeaturesModeException - This exception is thrown when AWS Organizations is not configured to support all features. All features
must be enabled in AWS Organization to support creating an organization trail. For more information, see
Prepare For Creating a Trail For Your Organization.CloudTrailInvalidClientTokenIdException - This exception is thrown when a call results in the InvalidClientTokenId error code. This
can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended AWS account.void shutdown()
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 a request.
request - The originally executed request.