@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 Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services 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 Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services 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, event data store, or channel, up to a limit of 50.
|
static AWSCloudTrailClientBuilder |
builder() |
CancelQueryResult |
cancelQuery(CancelQueryRequest request)
Cancels a query if the query is not in a terminated state, such as
CANCELLED, FAILED,
TIMED_OUT, or FINISHED. |
CreateChannelResult |
createChannel(CreateChannelRequest request)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
CreateEventDataStoreResult |
createEventDataStore(CreateEventDataStoreRequest request)
Creates a new event data store.
|
CreateTrailResult |
createTrail(CreateTrailRequest request)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
DeleteChannelResult |
deleteChannel(DeleteChannelRequest request)
Deletes a channel.
|
DeleteEventDataStoreResult |
deleteEventDataStore(DeleteEventDataStoreRequest request)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource-based policy attached to the CloudTrail channel.
|
DeleteTrailResult |
deleteTrail(DeleteTrailRequest request)
Deletes a trail.
|
DeregisterOrganizationDelegatedAdminResult |
deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest request)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
DescribeQueryResult |
describeQuery(DescribeQueryRequest request)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status.
|
DescribeTrailsResult |
describeTrails()
Simplified method form for invoking the DescribeTrails operation.
|
DescribeTrailsResult |
describeTrails(DescribeTrailsRequest request)
Retrieves settings for one or more trails associated with the current Region for your account.
|
DisableFederationResult |
disableFederation(DisableFederationRequest request)
Disables Lake query federation on the specified event data store.
|
EnableFederationResult |
enableFederation(EnableFederationRequest request)
Enables Lake query federation on the specified event data store.
|
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.
|
GetChannelResult |
getChannel(GetChannelRequest request)
Returns information about a specific channel.
|
GetEventDataStoreResult |
getEventDataStore(GetEventDataStoreRequest request)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
GetEventSelectorsResult |
getEventSelectors(GetEventSelectorsRequest request)
Describes the settings for the event selectors that you configured for your trail.
|
GetImportResult |
getImport(GetImportRequest request)
Returns information about a specific import.
|
GetInsightSelectorsResult |
getInsightSelectors(GetInsightSelectorsRequest request)
Describes the settings for the Insights event selectors that you configured for your trail or event data store.
|
GetQueryResultsResult |
getQueryResults(GetQueryResultsRequest request)
Gets event data results of a query.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest request)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
GetTrailResult |
getTrail(GetTrailRequest request)
Returns settings information for a specified trail.
|
GetTrailStatusResult |
getTrailStatus(GetTrailStatusRequest request)
Returns a JSON-formatted list of information about the specified trail.
|
ListChannelsResult |
listChannels(ListChannelsRequest request)
Lists the channels in the current account, and their source names.
|
ListEventDataStoresResult |
listEventDataStores(ListEventDataStoresRequest request)
Returns information about all event data stores in the account, in the current Region.
|
ListImportFailuresResult |
listImportFailures(ListImportFailuresRequest request)
Returns a list of failures for the specified import.
|
ListImportsResult |
listImports(ListImportsRequest request)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
ListInsightsMetricDataResult |
listInsightsMetricData(ListInsightsMetricDataRequest request)
Returns Insights metrics data for trails that have enabled Insights.
|
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.
|
ListQueriesResult |
listQueries(ListQueriesRequest request)
Returns a list of queries and query statuses for the past seven days.
|
ListTagsResult |
listTags(ListTagsRequest request)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
ListTrailsResult |
listTrails(ListTrailsRequest request)
Lists trails that are in the current account.
|
LookupEventsResult |
lookupEvents()
Simplified method form for invoking the LookupEvents operation.
|
LookupEventsResult |
lookupEvents(LookupEventsRequest request)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
PutEventSelectorsResult |
putEventSelectors(PutEventSelectorsRequest request)
Configures an event selector or advanced event selectors for your trail.
|
PutInsightSelectorsResult |
putInsightSelectors(PutInsightSelectorsRequest request)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail or event data store.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event
source outside of Amazon Web Services.
|
RegisterOrganizationDelegatedAdminResult |
registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest request)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified tags from a trail, event data store, or channel.
|
RestoreEventDataStoreResult |
restoreEventDataStore(RestoreEventDataStoreRequest request)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartEventDataStoreIngestionResult |
startEventDataStoreIngestion(StartEventDataStoreIngestionRequest request)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
StartImportResult |
startImport(StartImportRequest request)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
StartLoggingResult |
startLogging(StartLoggingRequest request)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
StartQueryResult |
startQuery(StartQueryRequest request)
Starts a CloudTrail Lake query.
|
StopEventDataStoreIngestionResult |
stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest request)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
StopImportResult |
stopImport(StopImportRequest request)
Stops a specified import.
|
StopLoggingResult |
stopLogging(StopLoggingRequest request)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
UpdateChannelResult |
updateChannel(UpdateChannelRequest request)
Updates a channel specified by a required channel ARN or UUID.
|
UpdateEventDataStoreResult |
updateEventDataStore(UpdateEventDataStoreRequest request)
Updates an event data store.
|
UpdateTrailResult |
updateTrail(UpdateTrailRequest request)
Updates trail settings that control what events you are logging, and how to handle log files.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@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, event data store, or channel, 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; 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 or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).
addTags in interface AWSCloudTrailaddTagsRequest - Specifies the tags to add to a trail, event data store, or channel.ResourceNotFoundException - This exception is thrown when the specified resource is not found.CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.TagsLimitExceededException - The number of tags per trail, event data store, or channel 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 not valid.
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.InactiveEventDataStoreException - The event data store is inactive.EventDataStoreNotFoundException - The specified event data store was not found.ChannelNotFoundException - This exception is thrown when CloudTrail cannot find the specified channel.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.public CancelQueryResult cancelQuery(CancelQueryRequest request)
Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED,
TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore.
The ID of the query that you want to cancel is also required. When you run CancelQuery, the query
status might show as CANCELLED even if the operation is not yet finished.
cancelQuery in interface AWSCloudTrailcancelQueryRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InactiveEventDataStoreException - The event data store is inactive.InactiveQueryException - The specified query cannot be canceled because it is in the FINISHED, FAILED,
TIMED_OUT, or CANCELLED state.InvalidParameterException - The request includes a parameter that is not valid.QueryIdNotFoundException - The query ID does not exist or does not map to a query.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.public CreateChannelResult createChannel(CreateChannelRequest request)
Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
createChannel in interface AWSCloudTrailcreateChannelRequest - ChannelMaxLimitExceededException - This exception is thrown when the maximum number of channels limit is exceeded.InvalidSourceException - This exception is thrown when the specified value of Source is not valid.ChannelAlreadyExistsException - This exception is thrown when the provided channel already exists.EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidEventDataStoreCategoryException - This exception is thrown when event categories of specified event data stores are not valid.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.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.TagsLimitExceededException - The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently,
the limit is 50.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public CreateEventDataStoreResult createEventDataStore(CreateEventDataStoreRequest request)
Creates a new event data store.
createEventDataStore in interface AWSCloudTrailcreateEventDataStoreRequest - EventDataStoreAlreadyExistsException - An event data store with that name already exists.EventDataStoreMaxLimitExceededException - Your account has used the maximum number of event data stores.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 not valid.
InvalidParameterException - The request includes a parameter that is not valid.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.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.InvalidKmsKeyIdException - This exception is thrown when the KMS key ARN 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 Amazon SNS topic either does not exist or is not
in the same Region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail or event data
store can't be updated.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public CreateTrailResult createTrail(CreateTrailRequest request)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
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 Amazon SNS topic is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.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 not valid.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
TrailNotProvidedException - This exception is no longer in use.TagsLimitExceededException - The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently,
the limit is 50.InvalidParameterCombinationException - This exception is thrown when the combination of parameters provided is not valid.InvalidParameterException - The request includes a parameter that 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 Amazon 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 or event data
store can't be updated.InvalidCloudWatchLogsLogGroupArnException - This exception is thrown when the provided CloudWatch Logs 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 CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.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 Amazon Web Services account.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.public DeleteChannelResult deleteChannel(DeleteChannelRequest request)
Deletes a channel.
deleteChannel in interface AWSCloudTraildeleteChannelRequest - ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.ChannelNotFoundException - This exception is thrown when CloudTrail cannot find the specified channel.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public DeleteEventDataStoreResult deleteEventDataStore(DeleteEventDataStoreRequest request)
Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION
state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled
must be set to False on the event data store and the FederationStatus must be
DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is
True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
DescribeQuery, or GetQueryResults on queries that are using an event data store in a
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not
incur costs.
deleteEventDataStore in interface AWSCloudTraildeleteEventDataStoreRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.EventDataStoreTerminationProtectedException - The event data store cannot be deleted because termination protection is enabled for it.EventDataStoreHasOngoingImportException - This exception is thrown when you try to update or delete an event data store that currently has an
import in progress.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.ChannelExistsForEDSException - This exception is thrown when the specified event data store cannot yet be deleted because it is in use
by a channel.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.EventDataStoreFederationEnabledException - You cannot delete the event data store because Lake query federation is enabled. To delete the event data
store, run the DisableFederation operation to disable Lake query federation on the event
data store.public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource-based policy attached to the CloudTrail channel.
deleteResourcePolicy in interface AWSCloudTraildeleteResourcePolicyRequest - ResourceARNNotValidException - This exception is thrown when the provided resource does not exist, or the ARN format of the resource is
not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.ResourceNotFoundException - This exception is thrown when the specified resource is not found.ResourcePolicyNotFoundException - This exception is thrown when the specified resource policy is not found.ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public DeregisterOrganizationDelegatedAdminResult deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest request)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
deregisterOrganizationDelegatedAdmin in interface AWSCloudTrailderegisterOrganizationDelegatedAdminRequest - Removes CloudTrail delegated administrator permissions from a specified member account in an organization
that is currently designated as a delegated administrator.AccountNotFoundException - This exception is thrown when the specified account is not found or not part of an organization.AccountNotRegisteredException - This exception is thrown when the specified account is not registered as the CloudTrail delegated
administrator.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.InvalidParameterException - The request includes a parameter that is not valid.NotOrganizationManagementAccountException - This exception is thrown when the account making the request is not the organization's management
account.OrganizationNotInAllFeaturesModeException - This exception is thrown when Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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.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 DescribeQueryResult describeQuery(DescribeQueryRequest request)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
You must specify either a QueryID or a QueryAlias. Specifying the
QueryAlias parameter returns information about the last query run for the alias.
describeQuery in interface AWSCloudTraildescribeQueryRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.QueryIdNotFoundException - The query ID does not exist or does not map to a query.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public DescribeTrailsResult describeTrails(DescribeTrailsRequest request)
Retrieves settings for one or more trails 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.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public DescribeTrailsResult describeTrails()
AWSCloudTraildescribeTrails in interface AWSCloudTrailAWSCloudTrail.describeTrails(DescribeTrailsRequest)public DisableFederationResult disableFederation(DisableFederationRequest request)
Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
disableFederation in interface AWSCloudTraildisableFederationRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidParameterException - The request includes a parameter that is not valid.InactiveEventDataStoreException - The event data store is inactive.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.ConcurrentModificationException - You are trying to update a resource when another request is in progress. Allow sufficient wait time for
the previous request to complete, then retry your request.AccessDeniedException - You do not have sufficient access to perform this action.public EnableFederationResult enableFederation(EnableFederationRequest request)
Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.
When you enable Lake query federation, CloudTrail creates a managed database named aws:cloudtrail
(if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data
store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake
Formation, the service responsible for allowing fine-grained access control of the federated resources in the
Glue Data Catalog.
For more information about Lake query federation, see Federate an event data store.
enableFederation in interface AWSCloudTrailenableFederationRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidParameterException - The request includes a parameter that is not valid.InactiveEventDataStoreException - The event data store is inactive.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.ConcurrentModificationException - You are trying to update a resource when another request is in progress. Allow sufficient wait time for
the previous request to complete, then retry your request.AccessDeniedException - You do not have sufficient access to perform this action.EventDataStoreFederationEnabledException - You cannot delete the event data store because Lake query federation is enabled. To delete the event data
store, run the DisableFederation operation to disable Lake query federation on the event
data store.public GetChannelResult getChannel(GetChannelRequest request)
Returns information about a specific channel.
getChannel in interface AWSCloudTrailgetChannelRequest - ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.ChannelNotFoundException - This exception is thrown when CloudTrail cannot find the specified channel.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public GetEventDataStoreResult getEventDataStore(GetEventDataStoreRequest request)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
getEventDataStore in interface AWSCloudTrailgetEventDataStoreRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.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:
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 resources on which you are logging data events.
For more information about logging management and data events, see the following topics in the 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public GetImportResult getImport(GetImportRequest request)
Returns information about a specific import.
getImport in interface AWSCloudTrailgetImportRequest - ImportNotFoundException - The specified import was not found.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public GetInsightSelectorsResult getInsightSelectors(GetInsightSelectorsRequest request)
Describes the settings for the Insights event selectors that you configured for your trail or event data store.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data
store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or
event data store that does not have Insights events enabled, the operation throws the exception
InsightNotEnabledException
Specify either the EventDataStore parameter to get Insights event selectors for an event data store,
or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these
parameters together.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
getInsightSelectors in interface AWSCloudTrailgetInsightSelectorsRequest - InvalidParameterException - The request includes a parameter that is not valid.InvalidParameterCombinationException - This exception is thrown when the combination of parameters provided is not valid.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
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 or event data store that does not have Insights
events enabled, the operation throws the exception InsightNotEnabledException.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.ThrottlingException - This exception is thrown when the request rate exceeds the limit.public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
getQueryResults in interface AWSCloudTrailgetQueryResultsRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InactiveEventDataStoreException - The event data store is inactive.InvalidMaxResultsException - This exception is thrown if the limit specified is not valid.InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.InvalidParameterException - The request includes a parameter that is not valid.QueryIdNotFoundException - The query ID does not exist or does not map to a query.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
getResourcePolicy in interface AWSCloudTrailgetResourcePolicyRequest - ResourceARNNotValidException - This exception is thrown when the provided resource does not exist, or the ARN format of the resource is
not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.ResourceNotFoundException - This exception is thrown when the specified resource is not found.ResourcePolicyNotFoundException - This exception is thrown when the specified resource policy is not found.ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public GetTrailResult getTrail(GetTrailRequest request)
Returns settings information for a specified trail.
getTrail in interface AWSCloudTrailgetTrailRequest - CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
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 not valid.
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.CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
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 not valid.
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 ListChannelsResult listChannels(ListChannelsRequest request)
Lists the channels in the current account, and their source names.
listChannels in interface AWSCloudTraillistChannelsRequest - InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public ListEventDataStoresResult listEventDataStores(ListEventDataStoresRequest request)
Returns information about all event data stores in the account, in the current Region.
listEventDataStores in interface AWSCloudTraillistEventDataStoresRequest - InvalidMaxResultsException - This exception is thrown if the limit specified is not valid.InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public ListImportFailuresResult listImportFailures(ListImportFailuresRequest request)
Returns a list of failures for the specified import.
listImportFailures in interface AWSCloudTraillistImportFailuresRequest - InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.InvalidParameterException - The request includes a parameter that is not valid.public ListImportsResult listImports(ListImportsRequest request)
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
listImports in interface AWSCloudTraillistImportsRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public ListInsightsMetricDataResult listInsightsMetricData(ListInsightsMetricDataRequest request)
Returns Insights metrics data for trails that have enabled Insights. The request must include the
EventSource, EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the
ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the ListInsightsMetricData API operation is linked to the
cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the
cloudtrail:LookupEvents action.
listInsightsMetricData in interface AWSCloudTraillistInsightsMetricDataRequest - InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.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 and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific 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 not valid. 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 ListQueriesResult listQueries(ListQueriesRequest request)
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for
EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted
as timestamps, by adding StartTime and EndTime parameters, and a
QueryStatus value. Valid values for QueryStatus include QUEUED,
RUNNING, FINISHED, FAILED, TIMED_OUT, or
CANCELLED.
listQueries in interface AWSCloudTraillistQueriesRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InactiveEventDataStoreException - The event data store is inactive.InvalidDateRangeException - A date range for the query was specified that is not valid. Be sure that the start time is
chronologically before the end time. For more information about writing a query, see Create or
edit a query in the CloudTrail User Guide.InvalidMaxResultsException - This exception is thrown if the limit specified is not valid.InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.InvalidParameterException - The request includes a parameter that is not valid.InvalidQueryStatusException - The query status is not valid for the operation.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public ListTagsResult listTags(ListTagsRequest request)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
listTags in interface AWSCloudTraillistTagsRequest - Specifies a list of 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 ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
InactiveEventDataStoreException - The event data store is inactive.EventDataStoreNotFoundException - The specified event data store was not found.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.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public ListTrailsResult listTrails(ListTrailsRequest request)
Lists trails that are in the current account.
listTrails in interface AWSCloudTraillistTrailsRequest - 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 LookupEventsResult lookupEvents(LookupEventsRequest request)
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.
LookupEvents returns recent Insights events for trails that enable Insights. To view Insights events
for an event data store, you can run queries on your Insights event data store, and you can also view the Lake
dashboard for Insights.
Lookup supports the following attributes for management events:
Amazon Web Services 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.
lookupEvents in interface AWSCloudTraillookupEventsRequest - Contains a request for LookupEvents.InvalidLookupAttributesException - Occurs when a lookup attribute is specified that is not valid.InvalidTimeRangeException - Occurs if the timestamp values are not valid. 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 not valid.InvalidNextTokenException - A token that is not valid, or a token that was previously used in a request with different parameters.
This exception is thrown if the token is not valid.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.public LookupEventsResult lookupEvents()
AWSCloudTraillookupEvents in interface AWSCloudTrailAWSCloudTrail.lookupEvents(LookupEventsRequest)public PutEventSelectorsResult putEventSelectors(PutEventSelectorsRequest request)
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. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide. 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 management events, Logging data events, and Quotas in CloudTrail in the 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 in the 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
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 not valid.
ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public PutInsightSelectorsResult putInsightSelectors(PutInsightSelectorsRequest request)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail or event data store. You also use PutInsightSelectors to turn off Insights event
logging, by passing an empty list of Insights types. The valid Insights event types are
ApiErrorRateInsight and ApiCallRateInsight.
To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source
event data store (EventDataStore) and the destination event data store (
InsightsDestination). The source event data store logs management events and enables Insights. The
destination event data store logs Insights events based upon the management event activity of the source event
data store. The source and destination event data stores must belong to the same Amazon Web Services account.
To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail
for which you want to change or add Insights selectors.
To log CloudTrail Insights events on API call volume, the trail or event data store must log write
management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log
read or write management events. You can call GetEventSelectors on a trail
to check whether the trail logs management events. You can call GetEventDataStore on an event data
store to check whether the event data store logs management events.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
putInsightSelectors in interface AWSCloudTrailputInsightSelectorsRequest - InvalidParameterException - The request includes a parameter that is not valid.InvalidParameterCombinationException - This exception is thrown when the combination of parameters provided is not valid.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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
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 - For PutInsightSelectors, this exception is thrown when the formatting or syntax of the
InsightSelectors JSON statement is not valid, or the specified InsightType in
the InsightSelectors statement is not valid. Valid values for InsightType are
ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data
store, the destination event data store specified by the InsightsDestination parameter must
log Insights events and the source event data store specified by the EventDataStore
parameter must log management events.
For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data
store and the updated advanced event selectors are not compatible with the configured
InsightSelectors. If the InsightSelectors includes an InsightType of
ApiCallRateInsight, the source event data store must log write management
events. If the InsightSelectors includes an InsightType of
ApiErrorRateInsight, the source event data store must log management events.
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 does not have sufficient permissions
for the operation.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail or event data
store can't be updated.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.ThrottlingException - This exception is thrown when the request rate exceeds the limit.public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
putResourcePolicy in interface AWSCloudTrailputResourcePolicyRequest - ResourceARNNotValidException - This exception is thrown when the provided resource does not exist, or the ARN format of the resource is
not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.ResourcePolicyNotValidException - This exception is thrown when the resouce-based policy has syntax errors, or contains a principal that is
not valid.
The following are requirements for the resource policy:
Contains only one action: cloudtrail-data:PutAuditEvents
Contains at least one statement. The policy can have a maximum of 20 statements.
Each statement contains at least one principal. A statement can have a maximum of 50 principals.
ResourceNotFoundException - This exception is thrown when the specified resource is not found.ResourceTypeNotSupportedException - This exception is thrown when the specified resource type is not supported by CloudTrail.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public RegisterOrganizationDelegatedAdminResult registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest request)
Registers an organization’s member account as the CloudTrail delegated administrator.
registerOrganizationDelegatedAdmin in interface AWSCloudTrailregisterOrganizationDelegatedAdminRequest - Specifies an organization member account ID as a CloudTrail delegated administrator.AccountRegisteredException - This exception is thrown when the account is already registered as the CloudTrail delegated
administrator.AccountNotFoundException - This exception is thrown when the specified account is not found or not part of an organization.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.InvalidParameterException - The request includes a parameter that is not valid.CannotDelegateManagementAccountException - This exception is thrown when the management account of an organization is registered as the CloudTrail
delegated administrator.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.DelegatedAdminAccountLimitExceededException - This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.NotOrganizationManagementAccountException - This exception is thrown when the account making the request is not the organization's management
account.OrganizationNotInAllFeaturesModeException - This exception is thrown when Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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.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, event data store, or channel.
removeTags in interface AWSCloudTrailremoveTagsRequest - Specifies the tags to remove from a trail, event data store, or channel.ResourceNotFoundException - This exception is thrown when the specified resource is not found.CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.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 not valid.
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.InactiveEventDataStoreException - The event data store is inactive.EventDataStoreNotFoundException - The specified event data store was not found.ChannelNotFoundException - This exception is thrown when CloudTrail cannot find the specified channel.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public RestoreEventDataStoreResult restoreEventDataStore(RestoreEventDataStoreRequest request)
Restores a deleted event data store specified by EventDataStore, which accepts an event data store
ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring
an event data store can take several minutes, depending on the size of the event data store.
restoreEventDataStore in interface AWSCloudTrailrestoreEventDataStoreRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.EventDataStoreMaxLimitExceededException - Your account has used the maximum number of event data stores.InvalidEventDataStoreStatusException - The event data store is not in a status that supports the operation.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.OrganizationNotInAllFeaturesModeException - This exception is thrown when Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.public StartEventDataStoreIngestionResult startEventDataStoreIngestion(StartEventDataStoreIngestionRequest request)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the
eventCategory must be Management, Data, or ConfigurationItem.
startEventDataStoreIngestion in interface AWSCloudTrailstartEventDataStoreIngestionRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidEventDataStoreStatusException - The event data store is not in a status that supports the operation.InvalidParameterException - The request includes a parameter that is not valid.InvalidEventDataStoreCategoryException - This exception is thrown when event categories of specified event data stores are not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public StartImportResult startImport(StartImportRequest request)
Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default,
CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes
inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If
you want to import CloudTrail events contained in another prefix, you must include the prefix in the
S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and ImportSource parameters are required.
Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more
information about disabling ACLs, see Controlling ownership of
objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization.
startImport in interface AWSCloudTrailstartImportRequest - AccountHasOngoingImportException - This exception is thrown when you start a new import and a previous import is still in progress.EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidEventDataStoreStatusException - The event data store is not in a status that supports the operation.InvalidEventDataStoreCategoryException - This exception is thrown when event categories of specified event data stores are not valid.InactiveEventDataStoreException - The event data store is inactive.InvalidImportSourceException - This exception is thrown when the provided source S3 bucket is not valid for import.ImportNotFoundException - The specified import was not found.InvalidParameterException - The request includes a parameter that is not valid.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public StartLoggingResult startLogging(StartLoggingRequest request)
Starts the recording of Amazon Web Services 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 Amazon Web Services API calls for an account.CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.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 not valid.
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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public StartQueryResult startQuery(StartQueryRequest request)
Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed
in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to
an S3 bucket.
StartQuery requires you specify either the QueryStatement parameter, or a
QueryAlias and any QueryParameters. In the current release, the QueryAlias
and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake
dashboards.
startQuery in interface AWSCloudTrailstartQueryRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.InvalidQueryStatementException - The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For
more information about writing a query, see Create or
edit a query in the CloudTrail User Guide.MaxConcurrentQueriesException - You are already running the maximum number of concurrent queries. The maximum number of concurrent
queries is 10. Wait a minute for some queries to finish, and then run the query again.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.InvalidS3PrefixException - This exception is thrown when the provided S3 prefix is not valid.InvalidS3BucketNameException - This exception is thrown when the provided S3 bucket name is not valid.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.public StopEventDataStoreIngestionResult stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest request)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To stop ingestion, the event data store Status must be ENABLED and the
eventCategory must be Management, Data, or ConfigurationItem.
stopEventDataStoreIngestion in interface AWSCloudTrailstopEventDataStoreIngestionRequest - EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidEventDataStoreStatusException - The event data store is not in a status that supports the operation.InvalidParameterException - The request includes a parameter that is not valid.InvalidEventDataStoreCategoryException - This exception is thrown when event categories of specified event data stores are not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.NotOrganizationMasterAccountException - This exception is thrown when the Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public StopImportResult stopImport(StopImportRequest request)
Stops a specified import.
stopImport in interface AWSCloudTrailstopImportRequest - ImportNotFoundException - The specified import was not found.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public StopLoggingResult stopLogging(StopLoggingRequest request)
Suspends the recording of Amazon Web Services 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 Amazon Web Services 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 not valid.
Not be in IP address format (for example, 192.168.5.4)
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.public UpdateChannelResult updateChannel(UpdateChannelRequest request)
Updates a channel specified by a required channel ARN or UUID.
updateChannel in interface AWSCloudTrailupdateChannelRequest - ChannelARNInvalidException - This exception is thrown when the specified value of ChannelARN is not valid.ChannelNotFoundException - This exception is thrown when CloudTrail cannot find the specified channel.ChannelAlreadyExistsException - This exception is thrown when the provided channel already exists.EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.InvalidEventDataStoreCategoryException - This exception is thrown when event categories of specified event data stores are not valid.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.public UpdateEventDataStoreResult updateEventDataStore(UpdateEventDataStoreRequest request)
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the
ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws
an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the
BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if
BillingMode is set to FIXED_RETENTION_PRICING. By default,
TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management
or data events in your event data store. For more information about AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or
non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event
data store.
updateEventDataStore in interface AWSCloudTrailupdateEventDataStoreRequest - EventDataStoreAlreadyExistsException - An event data store with that name already exists.EventDataStoreARNInvalidException - The specified event data store ARN is not valid or does not map to an event data store in your account.EventDataStoreNotFoundException - The specified event data store was not found.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 not valid.
InvalidInsightSelectorsException - For PutInsightSelectors, this exception is thrown when the formatting or syntax of the
InsightSelectors JSON statement is not valid, or the specified InsightType in
the InsightSelectors statement is not valid. Valid values for InsightType are
ApiCallRateInsight and ApiErrorRateInsight. To enable Insights on an event data
store, the destination event data store specified by the InsightsDestination parameter must
log Insights events and the source event data store specified by the EventDataStore
parameter must log management events.
For UpdateEventDataStore, this exception is thrown if Insights are enabled on the event data
store and the updated advanced event selectors are not compatible with the configured
InsightSelectors. If the InsightSelectors includes an InsightType of
ApiCallRateInsight, the source event data store must log write management
events. If the InsightSelectors includes an InsightType of
ApiErrorRateInsight, the source event data store must log management events.
EventDataStoreHasOngoingImportException - This exception is thrown when you try to update or delete an event data store that currently has an
import in progress.InactiveEventDataStoreException - The event data store is inactive.InvalidParameterException - The request includes a parameter that is not valid.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.InvalidKmsKeyIdException - This exception is thrown when the KMS key ARN 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 Amazon SNS topic either does not exist or is not
in the same Region.KmsException - This exception is thrown when there is an issue with the specified KMS key and the trail or event data
store can't be updated.CloudTrailAccessNotEnabledException - This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.OrganizationNotInAllFeaturesModeException - This exception is thrown when Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.public UpdateTrailResult updateTrail(UpdateTrailRequest request)
Updates trail settings that control what events you are logging, and how to handle 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 Amazon SNS topic is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions
for the operation.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 not valid.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 not valid.
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 not valid.
CloudTrailARNInvalidException - This exception is thrown when an operation is called with an ARN that is not valid.
The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
ConflictException - This exception is thrown when the specified resource is not ready for an operation. This can occur when
you try to run an operation on a resource before CloudTrail has time to fully load the resource, or
because another operation is modifying the resource. If this exception occurs, wait a few minutes, and
then try the operation again.ThrottlingException - This exception is thrown when the request rate exceeds the limit.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 Amazon 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 or event data
store can't be updated.InvalidCloudWatchLogsLogGroupArnException - This exception is thrown when the provided CloudWatch Logs 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 CloudTrail and Organizations.
For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.InsufficientDependencyServiceAccessPermissionException - This exception is thrown when the IAM identity that is used to create the organization resource lacks one
or more required permissions for creating an organization resource in a required service.OrganizationsNotInUseException - This exception is thrown when the request is made from an Amazon Web Services 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 Amazon Web Services account making the request to create or update an
organization trail or event data store is not the management account for an organization in
Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.OrganizationNotInAllFeaturesModeException - This exception is thrown when Organizations is not configured to support all features. All features must
be enabled in Organizations to support creating an organization trail or event data store.NoManagementAccountSLRExistsException - This exception is thrown when the management account does not have a service-linked role.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 Amazon Web Services account.InvalidParameterException - The request includes a parameter that is not valid.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 requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSCloudTrailshutdown in class AmazonWebServiceClient