@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudTrailClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
|
static CloudTrailClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudTrailClient. |
default CancelQueryResponse |
cancelQuery(CancelQueryRequest cancelQueryRequest)
Cancels a query if the query is not in a terminated state, such as
CANCELLED, FAILED,
TIMED_OUT, or FINISHED. |
default CancelQueryResponse |
cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)
Cancels a query if the query is not in a terminated state, such as
CANCELLED, FAILED,
TIMED_OUT, or FINISHED. |
static CloudTrailClient |
create()
Create a
CloudTrailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateChannelResponse |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
default CreateChannelResponse |
createChannel(CreateChannelRequest createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
default CreateEventDataStoreResponse |
createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest)
Creates a new event data store.
|
default CreateEventDataStoreResponse |
createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest)
Creates a new event data store.
|
default CreateTrailResponse |
createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default CreateTrailResponse |
createTrail(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default DeleteChannelResponse |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Deletes a channel.
|
default DeleteChannelResponse |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes a channel.
|
default DeleteEventDataStoreResponse |
deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
default DeleteEventDataStoreResponse |
deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
default DeleteResourcePolicyResponse |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
|
default DeleteResourcePolicyResponse |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
|
default DeleteTrailResponse |
deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)
Deletes a trail.
|
default DeleteTrailResponse |
deleteTrail(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
default DeregisterOrganizationDelegatedAdminResponse |
deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
default DeregisterOrganizationDelegatedAdminResponse |
deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
default DescribeQueryResponse |
describeQuery(Consumer<DescribeQueryRequest.Builder> describeQueryRequest)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status.
|
default DescribeQueryResponse |
describeQuery(DescribeQueryRequest describeQueryRequest)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status.
|
default DescribeTrailsResponse |
describeTrails()
Retrieves settings for one or more trails associated with the current Region for your account.
|
default DescribeTrailsResponse |
describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
|
default DescribeTrailsResponse |
describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
|
default GetChannelResponse |
getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Returns information about a specific channel.
|
default GetChannelResponse |
getChannel(GetChannelRequest getChannelRequest)
Returns information about a specific channel.
|
default GetEventDataStoreResponse |
getEventDataStore(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
default GetEventDataStoreResponse |
getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
default GetEventSelectorsResponse |
getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default GetEventSelectorsResponse |
getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default GetImportResponse |
getImport(Consumer<GetImportRequest.Builder> getImportRequest)
Returns information about a specific import.
|
default GetImportResponse |
getImport(GetImportRequest getImportRequest)
Returns information about a specific import.
|
default GetInsightSelectorsResponse |
getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default GetInsightSelectorsResponse |
getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default GetQueryResultsResponse |
getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Gets event data results of a query.
|
default GetQueryResultsResponse |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query.
|
default GetQueryResultsIterable |
getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Gets event data results of a query.
|
default GetQueryResultsIterable |
getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query.
|
default GetResourcePolicyResponse |
getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
default GetResourcePolicyResponse |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
default GetTrailResponse |
getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)
Returns settings information for a specified trail.
|
default GetTrailResponse |
getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
|
default GetTrailStatusResponse |
getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default GetTrailStatusResponse |
getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default ListChannelsResponse |
listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListChannelsResponse |
listChannels(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListChannelsIterable |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListChannelsIterable |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListEventDataStoresResponse |
listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListEventDataStoresResponse |
listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListEventDataStoresIterable |
listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListEventDataStoresIterable |
listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListImportFailuresResponse |
listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportFailuresResponse |
listImportFailures(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportFailuresIterable |
listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportFailuresIterable |
listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportsResponse |
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListImportsResponse |
listImports(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListImportsIterable |
listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListImportsIterable |
listImportsPaginator(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListPublicKeysResponse |
listPublicKeys()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysResponse |
listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysResponse |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysIterable |
listPublicKeysPaginator()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysIterable |
listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysIterable |
listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListQueriesResponse |
listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListQueriesResponse |
listQueries(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListQueriesIterable |
listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListQueriesIterable |
listQueriesPaginator(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTagsIterable |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTrailsResponse |
listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsResponse |
listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsIterable |
listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsIterable |
listTrailsPaginator(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default LookupEventsResponse |
lookupEvents()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsResponse |
lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsResponse |
lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsIterable |
lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default PutEventSelectorsResponse |
putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default PutEventSelectorsResponse |
putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default PutInsightSelectorsResponse |
putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
default PutInsightSelectorsResponse |
putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
default PutResourcePolicyResponse |
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
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.
|
default PutResourcePolicyResponse |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
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.
|
default RegisterOrganizationDelegatedAdminResponse |
registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
default RegisterOrganizationDelegatedAdminResponse |
registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
|
default RestoreEventDataStoreResponse |
restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
default RestoreEventDataStoreResponse |
restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
default CloudTrailServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartEventDataStoreIngestionResponse |
startEventDataStoreIngestion(Consumer<StartEventDataStoreIngestionRequest.Builder> startEventDataStoreIngestionRequest)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
default StartEventDataStoreIngestionResponse |
startEventDataStoreIngestion(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
default StartImportResponse |
startImport(Consumer<StartImportRequest.Builder> startImportRequest)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
default StartImportResponse |
startImport(StartImportRequest startImportRequest)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
default StartLoggingResponse |
startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
default StartLoggingResponse |
startLogging(StartLoggingRequest startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
default StartQueryResponse |
startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
Starts a CloudTrail Lake query.
|
default StartQueryResponse |
startQuery(StartQueryRequest startQueryRequest)
Starts a CloudTrail Lake query.
|
default StopEventDataStoreIngestionResponse |
stopEventDataStoreIngestion(Consumer<StopEventDataStoreIngestionRequest.Builder> stopEventDataStoreIngestionRequest)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
default StopEventDataStoreIngestionResponse |
stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
default StopImportResponse |
stopImport(Consumer<StopImportRequest.Builder> stopImportRequest)
Stops a specified import.
|
default StopImportResponse |
stopImport(StopImportRequest stopImportRequest)
Stops a specified import.
|
default StopLoggingResponse |
stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
default StopLoggingResponse |
stopLogging(StopLoggingRequest stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
default UpdateChannelResponse |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
|
default UpdateChannelResponse |
updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
|
default UpdateEventDataStoreResponse |
updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest)
Updates an event data store.
|
default UpdateEventDataStoreResponse |
updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest)
Updates an event data store.
|
default UpdateTrailResponse |
updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)
Updates trail settings that control what events you are logging, and how to handle log files.
|
default UpdateTrailResponse |
updateTrail(UpdateTrailRequest updateTrailRequest)
Updates trail settings that control what events you are logging, and how to handle log files.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, TagsLimitExceededException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException
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).
addTagsRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, TagsLimitExceededException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException
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).
This is a convenience which creates an instance of the AddTagsRequest.Builder avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest - A Consumer that will call methods on
AddTagsRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelQueryResponse cancelQuery(CancelQueryRequest cancelQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InactiveQueryException, InvalidParameterException, QueryIdNotFoundException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException
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.
cancelQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelQueryResponse cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InactiveQueryException, InvalidParameterException, QueryIdNotFoundException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, ConflictException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the CancelQueryRequest.Builder avoiding the need to
create one manually via CancelQueryRequest.builder()
cancelQueryRequest - A Consumer that will call methods on
CancelQueryRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChannelResponse createChannel(CreateChannelRequest createChannelRequest) throws ChannelMaxLimitExceededException, InvalidSourceException, ChannelAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidParameterException, InvalidTagParameterException, TagsLimitExceededException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
createChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChannelResponse createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest) throws ChannelMaxLimitExceededException, InvalidSourceException, ChannelAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidParameterException, InvalidTagParameterException, TagsLimitExceededException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the CreateChannelRequest.Builder avoiding the need to
create one manually via CreateChannelRequest.builder()
createChannelRequest - A Consumer that will call methods on
CreateChannelRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventDataStoreResponse createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest) throws EventDataStoreAlreadyExistsException, EventDataStoreMaxLimitExceededException, InvalidEventSelectorsException, InvalidParameterException, InvalidTagParameterException, OperationNotPermittedException, UnsupportedOperationException, ConflictException, InsufficientEncryptionPolicyException, InvalidKmsKeyIdException, KmsKeyNotFoundException, KmsException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Creates a new event data store.
createEventDataStoreRequest - 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventDataStoreResponse createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest) throws EventDataStoreAlreadyExistsException, EventDataStoreMaxLimitExceededException, InvalidEventSelectorsException, InvalidParameterException, InvalidTagParameterException, OperationNotPermittedException, UnsupportedOperationException, ConflictException, InsufficientEncryptionPolicyException, InvalidKmsKeyIdException, KmsKeyNotFoundException, KmsException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Creates a new event data store.
This is a convenience which creates an instance of the CreateEventDataStoreRequest.Builder avoiding the
need to create one manually via CreateEventDataStoreRequest.builder()
createEventDataStoreRequest - A Consumer that will call methods on
CreateEventDataStoreRequest.Builder to create a
request.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTrailResponse createTrail(CreateTrailRequest createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, TagsLimitExceededException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, CloudTrailInvalidClientTokenIdException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailRequest - Specifies the settings for each trail.MaximumNumberOfTrailsExceededException - This exception is thrown when the maximum number of trails is reached.TrailAlreadyExistsException - This exception is thrown when the specified trail already exists.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException - This exception is thrown when the policy on the 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.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.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateTrailResponse createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest) throws MaximumNumberOfTrailsExceededException, TrailAlreadyExistsException, S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, TagsLimitExceededException, InvalidParameterCombinationException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, InvalidTagParameterException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, NotOrganizationMasterAccountException, OrganizationsNotInUseException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, CloudTrailInvalidClientTokenIdException, ConflictException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
This is a convenience which creates an instance of the CreateTrailRequest.Builder avoiding the need to
create one manually via CreateTrailRequest.builder()
createTrailRequest - A Consumer that will call methods on
CreateTrailRequest.Builder to create a request.
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.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.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(DeleteChannelRequest deleteChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Deletes a channel.
deleteChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChannelResponse deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Deletes a channel.
This is a convenience which creates an instance of the DeleteChannelRequest.Builder avoiding the need to
create one manually via DeleteChannelRequest.builder()
deleteChannelRequest - A Consumer that will call methods on
DeleteChannelRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventDataStoreResponse deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, EventDataStoreTerminationProtectedException, EventDataStoreHasOngoingImportException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ChannelExistsForEdsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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; this operation cannot work if
TerminationProtectionEnabled is True.
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.
deleteEventDataStoreRequest - 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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventDataStoreResponse deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, EventDataStoreTerminationProtectedException, EventDataStoreHasOngoingImportException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ChannelExistsForEdsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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; this operation cannot work if
TerminationProtectionEnabled is True.
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.
This is a convenience which creates an instance of the DeleteEventDataStoreRequest.Builder avoiding the
need to create one manually via DeleteEventDataStoreRequest.builder()
deleteEventDataStoreRequest - A Consumer that will call methods on
DeleteEventDataStoreRequest.Builder to create a
request.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Deletes the resource-based policy attached to the CloudTrail channel.
deleteResourcePolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Deletes the resource-based policy attached to the CloudTrail channel.
This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the
need to create one manually via DeleteResourcePolicyRequest.builder()
deleteResourcePolicyRequest - A Consumer that will call methods on
DeleteResourcePolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTrailResponse deleteTrail(DeleteTrailRequest deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
deleteTrailRequest - The request that specifies the name of a trail to delete.TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteTrailResponse deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
This is a convenience which creates an instance of the DeleteTrailRequest.Builder avoiding the need to
create one manually via DeleteTrailRequest.builder()
deleteTrailRequest - A Consumer that will call methods on
DeleteTrailRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterOrganizationDelegatedAdminResponse deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest) throws AccountNotFoundException, AccountNotRegisteredException, CloudTrailAccessNotEnabledException, ConflictException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Removes CloudTrail delegated administrator permissions from a member account in an organization.
deregisterOrganizationDelegatedAdminRequest - 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterOrganizationDelegatedAdminResponse deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest) throws AccountNotFoundException, AccountNotRegisteredException, CloudTrailAccessNotEnabledException, ConflictException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Removes CloudTrail delegated administrator permissions from a member account in an organization.
This is a convenience which creates an instance of the
DeregisterOrganizationDelegatedAdminRequest.Builder avoiding the need to create one manually via
DeregisterOrganizationDelegatedAdminRequest.builder()
deregisterOrganizationDelegatedAdminRequest - A Consumer that will call methods on
DeregisterOrganizationDelegatedAdminRequest.Builder
to create a request. 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQueryResponse describeQuery(DescribeQueryRequest describeQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, QueryIdNotFoundException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
describeQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeQueryResponse describeQuery(Consumer<DescribeQueryRequest.Builder> describeQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, QueryIdNotFoundException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the DescribeQueryRequest.Builder avoiding the need to
create one manually via DescribeQueryRequest.builder()
describeQueryRequest - A Consumer that will call methods on
DescribeQueryRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTrailsResponse describeTrails(DescribeTrailsRequest describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails associated with the current Region for your account.
describeTrailsRequest - Returns information about the trail.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are not valid.
Not be in IP address format (for example, 192.168.5.4)
NoManagementAccountSlrExistsException - This exception is thrown when the management account does not have a service-linked role.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTrailsResponse describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails associated with the current Region for your account.
This is a convenience which creates an instance of the DescribeTrailsRequest.Builder avoiding the need to
create one manually via DescribeTrailsRequest.builder()
describeTrailsRequest - A Consumer that will call methods on
DescribeTrailsRequest.Builder to create a
request. 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)
NoManagementAccountSlrExistsException - This exception is thrown when the management account does not have a service-linked role.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTrailsResponse describeTrails() throws UnsupportedOperationException, OperationNotPermittedException, InvalidTrailNameException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves settings for one or more trails associated with the current Region for your account.
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)
NoManagementAccountSlrExistsException - This exception is thrown when the management account does not have a service-linked role.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeTrails(DescribeTrailsRequest),
AWS API
Documentationdefault GetChannelResponse getChannel(GetChannelRequest getChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about a specific channel.
getChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetChannelResponse getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about a specific channel.
This is a convenience which creates an instance of the GetChannelRequest.Builder avoiding the need to
create one manually via GetChannelRequest.builder()
getChannelRequest - A Consumer that will call methods on
GetChannelRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventDataStoreResponse getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
getEventDataStoreRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventDataStoreResponse getEventDataStore(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
This is a convenience which creates an instance of the GetEventDataStoreRequest.Builder avoiding the need
to create one manually via GetEventDataStoreRequest.builder()
getEventDataStoreRequest - A Consumer that will call methods on
GetEventDataStoreRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventSelectorsResponse getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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:
getEventSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEventSelectorsResponse getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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:
This is a convenience which creates an instance of the GetEventSelectorsRequest.Builder avoiding the need
to create one manually via GetEventSelectorsRequest.builder()
getEventSelectorsRequest - A Consumer that will call methods on
GetEventSelectorsRequest.Builder to create a
request.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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetImportResponse getImport(GetImportRequest getImportRequest) throws ImportNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about a specific import.
getImportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetImportResponse getImport(Consumer<GetImportRequest.Builder> getImportRequest) throws ImportNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about a specific import.
This is a convenience which creates an instance of the GetImportRequest.Builder avoiding the need to
create one manually via GetImportRequest.builder()
getImportRequest - A Consumer that will call methods on
GetImportRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSelectorsResponse getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, InsightNotEnabledException, NoManagementAccountSlrExistsException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
getInsightSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInsightSelectorsResponse getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, UnsupportedOperationException, OperationNotPermittedException, InsightNotEnabledException, NoManagementAccountSlrExistsException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
This is a convenience which creates an instance of the GetInsightSelectorsRequest.Builder avoiding the
need to create one manually via GetInsightSelectorsRequest.builder()
getInsightSelectorsRequest - A Consumer that will call methods on
GetInsightSelectorsRequest.Builder to create a
request.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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, QueryIdNotFoundException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
getQueryResultsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, QueryIdNotFoundException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest - A Consumer that will call methods on
GetQueryResultsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsIterable getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, QueryIdNotFoundException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
This is a variant of
getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client
.getQueryResultsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.
getQueryResultsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryResultsIterable getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, QueryIdNotFoundException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
This is a variant of
getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client
.getQueryResultsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest) operation.
This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need
to create one manually via GetQueryResultsRequest.builder()
getQueryResultsRequest - A Consumer that will call methods on
GetQueryResultsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
getResourcePolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) throws ResourceArnNotValidException, ResourceNotFoundException, ResourcePolicyNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need
to create one manually via GetResourcePolicyRequest.builder()
getResourcePolicyRequest - A Consumer that will call methods on
GetResourcePolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTrailResponse getTrail(GetTrailRequest getTrailRequest) throws CloudTrailArnInvalidException, TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns settings information for a specified trail.
getTrailRequest - CloudTrailArnInvalidException - This exception is thrown when an operation is called with a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTrailResponse getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest) throws CloudTrailArnInvalidException, TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns settings information for a specified trail.
This is a convenience which creates an instance of the GetTrailRequest.Builder avoiding the need to
create one manually via GetTrailRequest.builder()
getTrailRequest - A Consumer that will call methods on
GetTrailRequest.Builder to create a request.CloudTrailArnInvalidException - This exception is thrown when an operation is called with a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTrailStatusResponse getTrailStatus(GetTrailStatusRequest getTrailStatusRequest) throws CloudTrailArnInvalidException, TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
getTrailStatusRequest - The name of a trail about which you want the current status.CloudTrailArnInvalidException - This exception is thrown when an operation is called with a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTrailStatusResponse getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest) throws CloudTrailArnInvalidException, TrailNotFoundException, InvalidTrailNameException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
This is a convenience which creates an instance of the GetTrailStatusRequest.Builder avoiding the need to
create one manually via GetTrailStatusRequest.builder()
getTrailStatusRequest - A Consumer that will call methods on
GetTrailStatusRequest.Builder to create a
request. The name of a trail about which you want the current status.CloudTrailArnInvalidException - This exception is thrown when an operation is called with a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Lists the channels in the current account, and their source names.
listChannelsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Lists the channels in the current account, and their source names.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Lists the channels in the current account, and their source names.
This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.
listChannelsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Lists the channels in the current account, and their source names.
This is a variant of listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest) operation.
This is a convenience which creates an instance of the ListChannelsRequest.Builder avoiding the need to
create one manually via ListChannelsRequest.builder()
listChannelsRequest - A Consumer that will call methods on
ListChannelsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventDataStoresResponse listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest) throws InvalidMaxResultsException, InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about all event data stores in the account, in the current Region.
listEventDataStoresRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventDataStoresResponse listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) throws InvalidMaxResultsException, InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about all event data stores in the account, in the current Region.
This is a convenience which creates an instance of the ListEventDataStoresRequest.Builder avoiding the
need to create one manually via ListEventDataStoresRequest.builder()
listEventDataStoresRequest - A Consumer that will call methods on
ListEventDataStoresRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventDataStoresIterable listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest) throws InvalidMaxResultsException, InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about all event data stores in the account, in the current Region.
This is a variant of
listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client
.listEventDataStoresPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation.
listEventDataStoresRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventDataStoresIterable listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) throws InvalidMaxResultsException, InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Returns information about all event data stores in the account, in the current Region.
This is a variant of
listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client
.listEventDataStoresPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresIterable responses = client.listEventDataStoresPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation.
This is a convenience which creates an instance of the ListEventDataStoresRequest.Builder avoiding the
need to create one manually via ListEventDataStoresRequest.builder()
listEventDataStoresRequest - A Consumer that will call methods on
ListEventDataStoresRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportFailuresResponse listImportFailures(ListImportFailuresRequest listImportFailuresRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns a list of failures for the specified import.
listImportFailuresRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportFailuresResponse listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns a list of failures for the specified import.
This is a convenience which creates an instance of the ListImportFailuresRequest.Builder avoiding the
need to create one manually via ListImportFailuresRequest.builder()
listImportFailuresRequest - A Consumer that will call methods on
ListImportFailuresRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportFailuresIterable listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns a list of failures for the specified import.
This is a variant of
listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client
.listImportFailuresPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation.
listImportFailuresRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportFailuresIterable listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) throws InvalidNextTokenException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns a list of failures for the specified import.
This is a variant of
listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client
.listImportFailuresPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresIterable responses = client.listImportFailuresPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation.
This is a convenience which creates an instance of the ListImportFailuresRequest.Builder avoiding the
need to create one manually via ListImportFailuresRequest.builder()
listImportFailuresRequest - A Consumer that will call methods on
ListImportFailuresRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsResponse listImports(ListImportsRequest listImportsRequest) throws EventDataStoreArnInvalidException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
listImportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) throws EventDataStoreArnInvalidException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on
ListImportsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest) throws EventDataStoreArnInvalidException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.
listImportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsIterable listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) throws EventDataStoreArnInvalidException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
This is a variant of listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest) operation.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on
ListImportsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPublicKeysResponse listPublicKeys(ListPublicKeysRequest listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
listPublicKeysRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPublicKeysResponse listPublicKeys(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the ListPublicKeysRequest.Builder avoiding the need to
create one manually via ListPublicKeysRequest.builder()
listPublicKeysRequest - A Consumer that will call methods on
ListPublicKeysRequest.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPublicKeysResponse listPublicKeys() throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPublicKeys(ListPublicKeysRequest),
AWS API
Documentationdefault ListPublicKeysIterable listPublicKeysPaginator() throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistPublicKeysPaginator(ListPublicKeysRequest),
AWS API
Documentationdefault ListPublicKeysIterable listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
listPublicKeysRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPublicKeysIterable listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) throws InvalidTimeRangeException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a variant of
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client
.listPublicKeysPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysIterable responses = client.listPublicKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest) operation.
This is a convenience which creates an instance of the ListPublicKeysRequest.Builder avoiding the need to
create one manually via ListPublicKeysRequest.builder()
listPublicKeysRequest - A Consumer that will call methods on
ListPublicKeysRequest.Builder to create a
request. 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueriesResponse listQueries(ListQueriesRequest listQueriesRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidDateRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, InvalidQueryStatusException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
listQueriesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueriesResponse listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidDateRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, InvalidQueryStatusException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the ListQueriesRequest.Builder avoiding the need to
create one manually via ListQueriesRequest.builder()
listQueriesRequest - A Consumer that will call methods on
ListQueriesRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueriesIterable listQueriesPaginator(ListQueriesRequest listQueriesRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidDateRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, InvalidQueryStatusException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.
listQueriesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListQueriesIterable listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidDateRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidParameterException, InvalidQueryStatusException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a variant of listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesIterable responses = client.listQueriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest) operation.
This is a convenience which creates an instance of the ListQueriesRequest.Builder avoiding the need to
create one manually via ListQueriesRequest.builder()
listQueriesRequest - A Consumer that will call methods on
ListQueriesRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InactiveEventDataStoreException, EventDataStoreNotFoundException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the specified trails, event data stores, or channels in the current Region.
listTagsRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InactiveEventDataStoreException, EventDataStoreNotFoundException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the specified trails, event data stores, or channels in the current Region.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on
ListTagsRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InactiveEventDataStoreException, EventDataStoreNotFoundException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the specified trails, event data stores, or channels in the current Region.
This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
listTagsRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InactiveEventDataStoreException, EventDataStoreNotFoundException, UnsupportedOperationException, OperationNotPermittedException, InvalidTokenException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Lists the tags for the specified trails, event data stores, or channels in the current Region.
This is a variant of listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest) operation.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on
ListTagsRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTrailsResponse listTrails(ListTrailsRequest listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
listTrailsRequest - UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTrailsResponse listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to
create one manually via ListTrailsRequest.builder()
listTrailsRequest - A Consumer that will call methods on
ListTrailsRequest.Builder to create a request.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTrailsIterable listTrailsPaginator(ListTrailsRequest listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
listTrailsRequest - UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTrailsIterable listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest) throws UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Lists trails that are in the current account.
This is a variant of listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsIterable responses = client.listTrailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest) operation.
This is a convenience which creates an instance of the ListTrailsRequest.Builder avoiding the need to
create one manually via ListTrailsRequest.builder()
listTrailsRequest - A Consumer that will call methods on
ListTrailsRequest.Builder to create a request.UnsupportedOperationException - This exception is thrown when the requested operation is not supported.OperationNotPermittedException - This exception is thrown when the requested operation is not permitted.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LookupEventsResponse lookupEvents(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
lookupEventsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LookupEventsResponse lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
This is a convenience which creates an instance of the LookupEventsRequest.Builder avoiding the need to
create one manually via LookupEventsRequest.builder()
lookupEventsRequest - A Consumer that will call methods on
LookupEventsRequest.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LookupEventsResponse lookupEvents() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlookupEvents(LookupEventsRequest),
AWS API
Documentationdefault LookupEventsIterable lookupEventsPaginator() throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlookupEventsPaginator(LookupEventsRequest),
AWS API
Documentationdefault LookupEventsIterable lookupEventsPaginator(LookupEventsRequest lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
lookupEventsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault LookupEventsIterable lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) throws InvalidLookupAttributesException, InvalidTimeRangeException, InvalidMaxResultsException, InvalidNextTokenException, InvalidEventCategoryException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.
This is a variant of lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
for (software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsIterable responses = client.lookupEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
lookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest) operation.
This is a convenience which creates an instance of the LookupEventsRequest.Builder avoiding the need to
create one manually via LookupEventsRequest.builder()
lookupEventsRequest - A Consumer that will call methods on
LookupEventsRequest.Builder to create a request.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventSelectorsResponse putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, InvalidHomeRegionException, InvalidEventSelectorsException, ConflictException, ThrottlingException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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 for trails 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.
putEventSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventSelectorsResponse putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, InvalidHomeRegionException, InvalidEventSelectorsException, ConflictException, ThrottlingException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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 for trails 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.
This is a convenience which creates an instance of the PutEventSelectorsRequest.Builder avoiding the need
to create one manually via PutEventSelectorsRequest.builder()
putEventSelectorsRequest - A Consumer that will call methods on
PutEventSelectorsRequest.Builder to create a
request.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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutInsightSelectorsResponse putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, InvalidHomeRegionException, InvalidInsightSelectorsException, InsufficientS3BucketPolicyException, InsufficientEncryptionPolicyException, S3BucketDoesNotExistException, KmsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
and ApiCallRateInsight.
To log CloudTrail Insights events on API call volume, the trail must log write management events. To
log CloudTrail Insights events on API error rate, the trail must log read or write
management events. You can call GetEventSelectors on a trail to check whether the trail logs
management events.
putInsightSelectorsRequest - TrailNotFoundException - This exception is thrown when the trail with the given name is not found.InvalidTrailNameException - This exception is thrown when the provided trail name is not valid. Trail names must meet the following
requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
Start with a letter or number, and end with a letter or number
Be between 3 and 128 characters
Have no adjacent periods, underscores or dashes. Names like my-_namespace and
my--namespace are 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 - The formatting or syntax of the InsightSelectors JSON statement in your
PutInsightSelectors or GetInsightSelectors request is not valid, or the specified
insight type in the InsightSelectors statement is not a valid insight type.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key 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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutInsightSelectorsResponse putInsightSelectors(Consumer<PutInsightSelectorsRequest.Builder> putInsightSelectorsRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, InvalidHomeRegionException, InvalidInsightSelectorsException, InsufficientS3BucketPolicyException, InsufficientEncryptionPolicyException, S3BucketDoesNotExistException, KmsException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, ThrottlingException, AwsServiceException, SdkClientException, CloudTrailException
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
and ApiCallRateInsight.
To log CloudTrail Insights events on API call volume, the trail must log write management events. To
log CloudTrail Insights events on API error rate, the trail must log read or write
management events. You can call GetEventSelectors on a trail to check whether the trail logs
management events.
This is a convenience which creates an instance of the PutInsightSelectorsRequest.Builder avoiding the
need to create one manually via PutInsightSelectorsRequest.builder()
putInsightSelectorsRequest - A Consumer that will call methods on
PutInsightSelectorsRequest.Builder to create a
request.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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 - The formatting or syntax of the InsightSelectors JSON statement in your
PutInsightSelectors or GetInsightSelectors request is not valid, or the specified
insight type in the InsightSelectors statement is not a valid insight type.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientEncryptionPolicyException - This exception is thrown when the policy on the S3 bucket or KMS key 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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws ResourceArnNotValidException, ResourcePolicyNotValidException, ResourceNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
putResourcePolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws ResourceArnNotValidException, ResourcePolicyNotValidException, ResourceNotFoundException, ResourceTypeNotSupportedException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need
to create one manually via PutResourcePolicyRequest.builder()
putResourcePolicyRequest - A Consumer that will call methods on
PutResourcePolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest) throws AccountRegisteredException, AccountNotFoundException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, CannotDelegateManagementAccountException, CloudTrailAccessNotEnabledException, ConflictException, DelegatedAdminAccountLimitExceededException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Registers an organization’s member account as the CloudTrail delegated administrator.
registerOrganizationDelegatedAdminRequest - 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterOrganizationDelegatedAdminResponse registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest) throws AccountRegisteredException, AccountNotFoundException, InsufficientDependencyServiceAccessPermissionException, InvalidParameterException, CannotDelegateManagementAccountException, CloudTrailAccessNotEnabledException, ConflictException, DelegatedAdminAccountLimitExceededException, NotOrganizationManagementAccountException, OrganizationNotInAllFeaturesModeException, OrganizationsNotInUseException, UnsupportedOperationException, OperationNotPermittedException, AwsServiceException, SdkClientException, CloudTrailException
Registers an organization’s member account as the CloudTrail delegated administrator.
This is a convenience which creates an instance of the RegisterOrganizationDelegatedAdminRequest.Builder
avoiding the need to create one manually via RegisterOrganizationDelegatedAdminRequest.builder()
registerOrganizationDelegatedAdminRequest - A Consumer that will call methods on
RegisterOrganizationDelegatedAdminRequest.Builder
to create a request. 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Removes the specified tags from a trail, event data store, or channel.
removeTagsRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.NoManagementAccountSlrExistsException - This exception is thrown when the management account does not have a service-linked role.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws ResourceNotFoundException, CloudTrailArnInvalidException, EventDataStoreArnInvalidException, ChannelArnInvalidException, ResourceTypeNotSupportedException, InvalidTrailNameException, InvalidTagParameterException, InactiveEventDataStoreException, EventDataStoreNotFoundException, ChannelNotFoundException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
Removes the specified tags from a trail, event data store, or channel.
This is a convenience which creates an instance of the RemoveTagsRequest.Builder avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest - A Consumer that will call methods on
RemoveTagsRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.NoManagementAccountSlrExistsException - This exception is thrown when the management account does not have a service-linked role.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreEventDataStoreResponse restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, EventDataStoreMaxLimitExceededException, InvalidEventDataStoreStatusException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, OrganizationNotInAllFeaturesModeException, AwsServiceException, SdkClientException, CloudTrailException
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.
restoreEventDataStoreRequest - 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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreEventDataStoreResponse restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, EventDataStoreMaxLimitExceededException, InvalidEventDataStoreStatusException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, OrganizationNotInAllFeaturesModeException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the RestoreEventDataStoreRequest.Builder avoiding the
need to create one manually via RestoreEventDataStoreRequest.builder()
restoreEventDataStoreRequest - A Consumer that will call methods on
RestoreEventDataStoreRequest.Builder to create a
request.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEventDataStoreIngestionResponse startEventDataStoreIngestion(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
startEventDataStoreIngestionRequest - 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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartEventDataStoreIngestionResponse startEventDataStoreIngestion(Consumer<StartEventDataStoreIngestionRequest.Builder> startEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the StartEventDataStoreIngestionRequest.Builder
avoiding the need to create one manually via StartEventDataStoreIngestionRequest.builder()
startEventDataStoreIngestionRequest - A Consumer that will call methods on
StartEventDataStoreIngestionRequest.Builder to
create a request.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImportResponse startImport(StartImportRequest startImportRequest) throws AccountHasOngoingImportException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidImportSourceException, ImportNotFoundException, InvalidParameterException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
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.
startImportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImportResponse startImport(Consumer<StartImportRequest.Builder> startImportRequest) throws AccountHasOngoingImportException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidImportSourceException, ImportNotFoundException, InvalidParameterException, InsufficientEncryptionPolicyException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
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.
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.
This is a convenience which creates an instance of the StartImportRequest.Builder avoiding the need to
create one manually via StartImportRequest.builder()
startImportRequest - A Consumer that will call methods on
StartImportRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartLoggingResponse startLogging(StartLoggingRequest startLoggingRequest) throws CloudTrailArnInvalidException, ConflictException, ThrottlingException, TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
startLoggingRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartLoggingResponse startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest) throws CloudTrailArnInvalidException, ConflictException, ThrottlingException, TrailNotFoundException, InvalidTrailNameException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the StartLoggingRequest.Builder avoiding the need to
create one manually via StartLoggingRequest.builder()
startLoggingRequest - A Consumer that will call methods on
StartLoggingRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryResponse startQuery(StartQueryRequest startQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, InvalidQueryStatementException, MaxConcurrentQueriesException, InsufficientEncryptionPolicyException, InvalidS3PrefixException, InvalidS3BucketNameException, InsufficientS3BucketPolicyException, S3BucketDoesNotExistException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
startQueryRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryResponse startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InactiveEventDataStoreException, InvalidParameterException, InvalidQueryStatementException, MaxConcurrentQueriesException, InsufficientEncryptionPolicyException, InvalidS3PrefixException, InvalidS3BucketNameException, InsufficientS3BucketPolicyException, S3BucketDoesNotExistException, OperationNotPermittedException, UnsupportedOperationException, NoManagementAccountSlrExistsException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the StartQueryRequest.Builder avoiding the need to
create one manually via StartQueryRequest.builder()
startQueryRequest - A Consumer that will call methods on
StartQueryRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
stopEventDataStoreIngestionRequest - 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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopEventDataStoreIngestionResponse stopEventDataStoreIngestion(Consumer<StopEventDataStoreIngestionRequest.Builder> stopEventDataStoreIngestionRequest) throws EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreStatusException, InvalidParameterException, InvalidEventDataStoreCategoryException, OperationNotPermittedException, UnsupportedOperationException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the StopEventDataStoreIngestionRequest.Builder
avoiding the need to create one manually via StopEventDataStoreIngestionRequest.builder()
stopEventDataStoreIngestionRequest - A Consumer that will call methods on
StopEventDataStoreIngestionRequest.Builder to
create a request.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopImportResponse stopImport(StopImportRequest stopImportRequest) throws ImportNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Stops a specified import.
stopImportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopImportResponse stopImport(Consumer<StopImportRequest.Builder> stopImportRequest) throws ImportNotFoundException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Stops a specified import.
This is a convenience which creates an instance of the StopImportRequest.Builder avoiding the need to
create one manually via StopImportRequest.builder()
stopImportRequest - A Consumer that will call methods on
StopImportRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopLoggingResponse stopLogging(StopLoggingRequest stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
stopLoggingRequest - 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopLoggingResponse stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest) throws TrailNotFoundException, InvalidTrailNameException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidHomeRegionException, UnsupportedOperationException, OperationNotPermittedException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, InsufficientDependencyServiceAccessPermissionException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the StopLoggingRequest.Builder avoiding the need to
create one manually via StopLoggingRequest.builder()
stopLoggingRequest - A Consumer that will call methods on
StopLoggingRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateChannelResponse updateChannel(UpdateChannelRequest updateChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, ChannelAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Updates a channel specified by a required channel ARN or UUID.
updateChannelRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateChannelResponse updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest) throws ChannelArnInvalidException, ChannelNotFoundException, ChannelAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventDataStoreCategoryException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, AwsServiceException, SdkClientException, CloudTrailException
Updates a channel specified by a required channel ARN or UUID.
This is a convenience which creates an instance of the UpdateChannelRequest.Builder avoiding the need to
create one manually via UpdateChannelRequest.builder()
updateChannelRequest - A Consumer that will call methods on
UpdateChannelRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateEventDataStoreResponse updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest) throws EventDataStoreAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventSelectorsException, EventDataStoreHasOngoingImportException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, InsufficientEncryptionPolicyException, InvalidKmsKeyIdException, KmsKeyNotFoundException, KmsException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, OrganizationNotInAllFeaturesModeException, AwsServiceException, SdkClientException, CloudTrailException
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 90 and 2557. By default,
TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management
and data events in your event data store. For more information about AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectors includes events of that type in your event data store.
updateEventDataStoreRequest - 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.
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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateEventDataStoreResponse updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest) throws EventDataStoreAlreadyExistsException, EventDataStoreArnInvalidException, EventDataStoreNotFoundException, InvalidEventSelectorsException, EventDataStoreHasOngoingImportException, InactiveEventDataStoreException, InvalidParameterException, OperationNotPermittedException, UnsupportedOperationException, InsufficientEncryptionPolicyException, InvalidKmsKeyIdException, KmsKeyNotFoundException, KmsException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, NoManagementAccountSlrExistsException, OrganizationNotInAllFeaturesModeException, AwsServiceException, SdkClientException, CloudTrailException
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 90 and 2557. By default,
TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management
and data events in your event data store. For more information about AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectors includes events of that type in your event data store.
This is a convenience which creates an instance of the UpdateEventDataStoreRequest.Builder avoiding the
need to create one manually via UpdateEventDataStoreRequest.builder()
updateEventDataStoreRequest - A Consumer that will call methods on
UpdateEventDataStoreRequest.Builder to create a
request.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.
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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTrailResponse updateTrail(UpdateTrailRequest updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidEventSelectorsException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, CloudTrailInvalidClientTokenIdException, InvalidParameterException, AwsServiceException, SdkClientException, CloudTrailException
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.
updateTrailRequest - Specifies settings to update for the trail.S3BucketDoesNotExistException - This exception is thrown when the specified S3 bucket does not exist.InsufficientS3BucketPolicyException - This exception is thrown when the policy on the S3 bucket is not sufficient.InsufficientSnsTopicPolicyException - This exception is thrown when the policy on the 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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTrailResponse updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest) throws S3BucketDoesNotExistException, InsufficientS3BucketPolicyException, InsufficientSnsTopicPolicyException, InsufficientEncryptionPolicyException, TrailNotFoundException, InvalidS3BucketNameException, InvalidS3PrefixException, InvalidSnsTopicNameException, InvalidKmsKeyIdException, InvalidTrailNameException, TrailNotProvidedException, InvalidEventSelectorsException, CloudTrailArnInvalidException, ConflictException, ThrottlingException, InvalidParameterCombinationException, InvalidHomeRegionException, KmsKeyNotFoundException, KmsException, InvalidCloudWatchLogsLogGroupArnException, InvalidCloudWatchLogsRoleArnException, CloudWatchLogsDeliveryUnavailableException, UnsupportedOperationException, OperationNotPermittedException, CloudTrailAccessNotEnabledException, InsufficientDependencyServiceAccessPermissionException, OrganizationsNotInUseException, NotOrganizationMasterAccountException, OrganizationNotInAllFeaturesModeException, NoManagementAccountSlrExistsException, CloudTrailInvalidClientTokenIdException, InvalidParameterException, AwsServiceException, SdkClientException, CloudTrailException
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.
This is a convenience which creates an instance of the UpdateTrailRequest.Builder avoiding the need to
create one manually via UpdateTrailRequest.builder()
updateTrailRequest - A Consumer that will call methods on
UpdateTrailRequest.Builder to create a request.
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 a trail ARN that is not valid. The following is
the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
This exception is also thrown when you call AddTags or RemoveTags on a trail,
event data store, or channel with a resource ARN that is not valid.
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.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 Enabling
Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your 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.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 Create an
event data store.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudTrailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic CloudTrailClient create()
CloudTrailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudTrailClientBuilder builder()
CloudTrailClient.static ServiceMetadata serviceMetadata()
default CloudTrailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.