@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudTrailAsyncClient 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 CompletableFuture<AddTagsResponse> |
addTags(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
|
default CompletableFuture<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 CloudTrailAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudTrailAsyncClient. |
default CompletableFuture<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 CompletableFuture<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 CloudTrailAsyncClient |
create()
Create a
CloudTrailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateChannelResponse> |
createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
default CompletableFuture<CreateChannelResponse> |
createChannel(CreateChannelRequest createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
default CompletableFuture<CreateEventDataStoreResponse> |
createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest)
Creates a new event data store.
|
default CompletableFuture<CreateEventDataStoreResponse> |
createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest)
Creates a new event data store.
|
default CompletableFuture<CreateTrailResponse> |
createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default CompletableFuture<CreateTrailResponse> |
createTrail(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
Deletes a channel.
|
default CompletableFuture<DeleteChannelResponse> |
deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes a channel.
|
default CompletableFuture<DeleteEventDataStoreResponse> |
deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
default CompletableFuture<DeleteEventDataStoreResponse> |
deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
default CompletableFuture<DeleteResourcePolicyResponse> |
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
|
default CompletableFuture<DeleteResourcePolicyResponse> |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
|
default CompletableFuture<DeleteTrailResponse> |
deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)
Deletes a trail.
|
default CompletableFuture<DeleteTrailResponse> |
deleteTrail(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
default CompletableFuture<DeregisterOrganizationDelegatedAdminResponse> |
deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
default CompletableFuture<DeregisterOrganizationDelegatedAdminResponse> |
deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<DescribeTrailsResponse> |
describeTrails()
Retrieves settings for one or more trails associated with the current Region for your account.
|
default CompletableFuture<DescribeTrailsResponse> |
describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
|
default CompletableFuture<DescribeTrailsResponse> |
describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
|
default CompletableFuture<GetChannelResponse> |
getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
Returns information about a specific channel.
|
default CompletableFuture<GetChannelResponse> |
getChannel(GetChannelRequest getChannelRequest)
Returns information about a specific channel.
|
default CompletableFuture<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 CompletableFuture<GetEventDataStoreResponse> |
getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
default CompletableFuture<GetEventSelectorsResponse> |
getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default CompletableFuture<GetEventSelectorsResponse> |
getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
default CompletableFuture<GetImportResponse> |
getImport(Consumer<GetImportRequest.Builder> getImportRequest)
Returns information about a specific import.
|
default CompletableFuture<GetImportResponse> |
getImport(GetImportRequest getImportRequest)
Returns information about a specific import.
|
default CompletableFuture<GetInsightSelectorsResponse> |
getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default CompletableFuture<GetInsightSelectorsResponse> |
getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
default CompletableFuture<GetQueryResultsResponse> |
getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Gets event data results of a query.
|
default CompletableFuture<GetQueryResultsResponse> |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query.
|
default GetQueryResultsPublisher |
getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
Gets event data results of a query.
|
default GetQueryResultsPublisher |
getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query.
|
default CompletableFuture<GetResourcePolicyResponse> |
getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
default CompletableFuture<GetResourcePolicyResponse> |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
default CompletableFuture<GetTrailResponse> |
getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)
Returns settings information for a specified trail.
|
default CompletableFuture<GetTrailResponse> |
getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
|
default CompletableFuture<GetTrailStatusResponse> |
getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default CompletableFuture<GetTrailStatusResponse> |
getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
default CompletableFuture<ListChannelsResponse> |
listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default CompletableFuture<ListChannelsResponse> |
listChannels(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListChannelsPublisher |
listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default ListChannelsPublisher |
listChannelsPaginator(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
|
default CompletableFuture<ListEventDataStoresResponse> |
listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default CompletableFuture<ListEventDataStoresResponse> |
listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListEventDataStoresPublisher |
listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default ListEventDataStoresPublisher |
listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
default CompletableFuture<ListImportFailuresResponse> |
listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default CompletableFuture<ListImportFailuresResponse> |
listImportFailures(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportFailuresPublisher |
listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default ListImportFailuresPublisher |
listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
|
default CompletableFuture<ListImportsResponse> |
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default CompletableFuture<ListImportsResponse> |
listImports(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListImportsPublisher |
listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default ListImportsPublisher |
listImportsPaginator(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
default CompletableFuture<ListPublicKeysResponse> |
listPublicKeys()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default CompletableFuture<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 CompletableFuture<ListPublicKeysResponse> |
listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysPublisher |
listPublicKeysPaginator()
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default ListPublicKeysPublisher |
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 ListPublicKeysPublisher |
listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
default CompletableFuture<ListQueriesResponse> |
listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default CompletableFuture<ListQueriesResponse> |
listQueries(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListQueriesPublisher |
listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default ListQueriesPublisher |
listQueriesPaginator(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
default CompletableFuture<ListTagsResponse> |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default CompletableFuture<ListTagsResponse> |
listTags(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTagsPublisher |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default ListTagsPublisher |
listTagsPaginator(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
default CompletableFuture<ListTrailsResponse> |
listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default CompletableFuture<ListTrailsResponse> |
listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsPublisher |
listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
Lists trails that are in the current account.
|
default ListTrailsPublisher |
listTrailsPaginator(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
default CompletableFuture<LookupEventsResponse> |
lookupEvents()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default CompletableFuture<LookupEventsResponse> |
lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default CompletableFuture<LookupEventsResponse> |
lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsPublisher |
lookupEventsPaginator()
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsPublisher |
lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default LookupEventsPublisher |
lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
default CompletableFuture<PutEventSelectorsResponse> |
putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default CompletableFuture<PutEventSelectorsResponse> |
putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<RegisterOrganizationDelegatedAdminResponse> |
registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
default CompletableFuture<RegisterOrganizationDelegatedAdminResponse> |
registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
|
default CompletableFuture<RestoreEventDataStoreResponse> |
restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
default CompletableFuture<RestoreEventDataStoreResponse> |
restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
default CloudTrailServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<StartImportResponse> |
startImport(StartImportRequest startImportRequest)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
default CompletableFuture<StartLoggingResponse> |
startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
default CompletableFuture<StartLoggingResponse> |
startLogging(StartLoggingRequest startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
default CompletableFuture<StartQueryResponse> |
startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
Starts a CloudTrail Lake query.
|
default CompletableFuture<StartQueryResponse> |
startQuery(StartQueryRequest startQueryRequest)
Starts a CloudTrail Lake query.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<StopImportResponse> |
stopImport(Consumer<StopImportRequest.Builder> stopImportRequest)
Stops a specified import.
|
default CompletableFuture<StopImportResponse> |
stopImport(StopImportRequest stopImportRequest)
Stops a specified import.
|
default CompletableFuture<StopLoggingResponse> |
stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
default CompletableFuture<StopLoggingResponse> |
stopLogging(StopLoggingRequest stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
|
default CompletableFuture<UpdateChannelResponse> |
updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
|
default CompletableFuture<UpdateEventDataStoreResponse> |
updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest)
Updates an event data store.
|
default CompletableFuture<UpdateEventDataStoreResponse> |
updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest)
Updates an event data store.
|
default CompletableFuture<UpdateTrailResponse> |
updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)
Updates trail settings that control what events you are logging, and how to handle log files.
|
default CompletableFuture<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 CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)
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.
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
ChannelARN is not valid.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)
default CompletableFuture<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. 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.
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
ChannelARN is not valid.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)
default CompletableFuture<CancelQueryResponse> cancelQuery(CancelQueryRequest cancelQueryRequest)
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 - FINISHED, FAILED, TIMED_OUT, or CANCELLED state.default CompletableFuture<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. 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.FINISHED, FAILED, TIMED_OUT, or CANCELLED state.default CompletableFuture<CreateChannelResponse> createChannel(CreateChannelRequest createChannelRequest)
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 - Source is
not valid.default CompletableFuture<CreateChannelResponse> createChannel(Consumer<CreateChannelRequest.Builder> createChannelRequest)
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.Source is
not valid.default CompletableFuture<CreateEventDataStoreResponse> createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest)
Creates a new event data store.
createEventDataStoreRequest - 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.
default CompletableFuture<CreateEventDataStoreResponse> createEventDataStore(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest)
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.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.
default CompletableFuture<CreateTrailResponse> createTrail(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailRequest - Specifies the settings for each trail.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)
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.default CompletableFuture<CreateTrailResponse> createTrail(Consumer<CreateTrailRequest.Builder> createTrailRequest)
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.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)
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.default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest)
Deletes a channel.
deleteChannelRequest - ChannelARN is not valid.default CompletableFuture<DeleteChannelResponse> deleteChannel(Consumer<DeleteChannelRequest.Builder> deleteChannelRequest)
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.ChannelARN is not valid.default CompletableFuture<DeleteEventDataStoreResponse> deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
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 - default CompletableFuture<DeleteEventDataStoreResponse> deleteEventDataStore(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest)
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.default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
deleteResourcePolicyRequest - arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
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.arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.default CompletableFuture<DeleteTrailResponse> deleteTrail(DeleteTrailRequest deleteTrailRequest)
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
deleteTrailRequest - The request that specifies the name of a trail to delete.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)
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
default CompletableFuture<DeleteTrailResponse> deleteTrail(Consumer<DeleteTrailRequest.Builder> deleteTrailRequest)
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
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.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)
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
default CompletableFuture<DeregisterOrganizationDelegatedAdminResponse> deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
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.default CompletableFuture<DeregisterOrganizationDelegatedAdminResponse> deregisterOrganizationDelegatedAdmin(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest)
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.default CompletableFuture<DescribeQueryResponse> describeQuery(DescribeQueryRequest describeQueryRequest)
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 - default CompletableFuture<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. 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.default CompletableFuture<DescribeTrailsResponse> describeTrails(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
describeTrailsRequest - Returns information about the trail.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)
default CompletableFuture<DescribeTrailsResponse> describeTrails(Consumer<DescribeTrailsRequest.Builder> describeTrailsRequest)
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.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)
default CompletableFuture<DescribeTrailsResponse> describeTrails()
Retrieves settings for one or more trails associated with the current Region for your account.
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)
default CompletableFuture<GetChannelResponse> getChannel(GetChannelRequest getChannelRequest)
Returns information about a specific channel.
getChannelRequest - ChannelARN is not valid.default CompletableFuture<GetChannelResponse> getChannel(Consumer<GetChannelRequest.Builder> getChannelRequest)
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.ChannelARN is not valid.default CompletableFuture<GetEventDataStoreResponse> getEventDataStore(GetEventDataStoreRequest getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
getEventDataStoreRequest - default CompletableFuture<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.
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.default CompletableFuture<GetEventSelectorsResponse> getEventSelectors(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the 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 - 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)
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
default CompletableFuture<GetEventSelectorsResponse> getEventSelectors(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the 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.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)
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
default CompletableFuture<GetImportResponse> getImport(GetImportRequest getImportRequest)
Returns information about a specific import.
getImportRequest - default CompletableFuture<GetImportResponse> getImport(Consumer<GetImportRequest.Builder> getImportRequest)
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.default CompletableFuture<GetInsightSelectorsResponse> getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
getInsightSelectorsRequest - 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)
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
GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException.default CompletableFuture<GetInsightSelectorsResponse> getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the 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.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)
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
GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException.default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
getQueryResultsRequest - default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
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.default GetQueryResultsPublisher getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default GetQueryResultsPublisher getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
getResourcePolicyRequest - arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
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.arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.default CompletableFuture<GetTrailResponse> getTrail(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
getTrailRequest -
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
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)
default CompletableFuture<GetTrailResponse> getTrail(Consumer<GetTrailRequest.Builder> getTrailRequest)
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.
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
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)
default CompletableFuture<GetTrailStatusResponse> getTrailStatus(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
getTrailStatusRequest - The name of a trail about which you want the current status.
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
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)
default CompletableFuture<GetTrailStatusResponse> getTrailStatus(Consumer<GetTrailStatusRequest.Builder> getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
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.
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
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)
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
listChannelsRequest - default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
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.default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListEventDataStoresResponse> listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
listEventDataStoresRequest - default CompletableFuture<ListEventDataStoresResponse> listEventDataStores(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
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.default ListEventDataStoresPublisher listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListEventDataStoresPublisher listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListImportFailuresResponse> listImportFailures(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
listImportFailuresRequest - default CompletableFuture<ListImportFailuresResponse> listImportFailures(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
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.default ListImportFailuresPublisher listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListImportFailuresPublisher listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListImportsResponse> listImports(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
listImportsRequest - default CompletableFuture<ListImportsResponse> listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
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.default ListImportsPublisher listImportsPaginator(ListImportsRequest listImportsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListImportsPublisher listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListImportsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListPublicKeysResponse> listPublicKeys(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private 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.default CompletableFuture<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. 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.default CompletableFuture<ListPublicKeysResponse> listPublicKeys()
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.
default ListPublicKeysPublisher listPublicKeysPaginator()
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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default ListPublicKeysPublisher listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private 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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default ListPublicKeysPublisher listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private 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 publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListQueriesResponse> listQueries(ListQueriesRequest listQueriesRequest)
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 - default CompletableFuture<ListQueriesResponse> listQueries(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
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.default ListQueriesPublisher listQueriesPaginator(ListQueriesRequest listQueriesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListQueriesPublisher listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListQueriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
listTagsRequest - Specifies a list of tags to return.
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
ChannelARN is not valid.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)
default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
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.
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
ChannelARN is not valid.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)
default ListTagsPublisher listTagsPaginator(ListTagsRequest listTagsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
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
ChannelARN is not valid.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)
default ListTagsPublisher listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
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
ChannelARN is not valid.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)
default CompletableFuture<ListTrailsResponse> listTrails(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
listTrailsRequest - default CompletableFuture<ListTrailsResponse> listTrails(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
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.default ListTrailsPublisher listTrailsPaginator(ListTrailsRequest listTrailsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 - default ListTrailsPublisher listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest)
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListTrailsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default CompletableFuture<LookupEventsResponse> lookupEvents(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.EventCategory.default CompletableFuture<LookupEventsResponse> lookupEvents(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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.EventCategory.default CompletableFuture<LookupEventsResponse> lookupEvents()
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.
EventCategory.default LookupEventsPublisher lookupEventsPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
EventCategory.default LookupEventsPublisher lookupEventsPaginator(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.EventCategory.default LookupEventsPublisher lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days. Lookup supports the following attributes for management events:
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.cloudtrail.model.LookupEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.EventCategory.default CompletableFuture<PutEventSelectorsResponse> putEventSelectors(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. 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 - 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)
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
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.
default CompletableFuture<PutEventSelectorsResponse> putEventSelectors(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. 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.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)
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
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.
default CompletableFuture<PutInsightSelectorsResponse> putInsightSelectors(PutInsightSelectorsRequest putInsightSelectorsRequest)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. 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 - 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)
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
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.default CompletableFuture<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. 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.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)
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
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.default CompletableFuture<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. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
putResourcePolicyRequest - arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.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.
default CompletableFuture<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. 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.arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel.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.
default CompletableFuture<RegisterOrganizationDelegatedAdminResponse> registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
registerOrganizationDelegatedAdminRequest - Specifies an organization member account ID as a CloudTrail delegated administrator.default CompletableFuture<RegisterOrganizationDelegatedAdminResponse> registerOrganizationDelegatedAdmin(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest)
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.default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)
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.
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
ChannelARN is not valid.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)
default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
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.
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
ChannelARN is not valid.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)
default CompletableFuture<RestoreEventDataStoreResponse> restoreEventDataStore(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
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 - default CompletableFuture<RestoreEventDataStoreResponse> restoreEventDataStore(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest)
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.default CompletableFuture<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. To start ingestion, the event data store Status must be STOPPED_INGESTION and the
eventCategory must be Management, Data, or ConfigurationItem.
startEventDataStoreIngestionRequest - default CompletableFuture<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. 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.default CompletableFuture<StartImportResponse> startImport(StartImportRequest startImportRequest)
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 - default CompletableFuture<StartImportResponse> startImport(Consumer<StartImportRequest.Builder> startImportRequest)
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.default CompletableFuture<StartLoggingResponse> startLogging(StartLoggingRequest startLoggingRequest)
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.
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
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)
default CompletableFuture<StartLoggingResponse> startLogging(Consumer<StartLoggingRequest.Builder> startLoggingRequest)
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.
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
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)
default CompletableFuture<StartQueryResponse> startQuery(StartQueryRequest startQueryRequest)
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 - default CompletableFuture<StartQueryResponse> startQuery(Consumer<StartQueryRequest.Builder> startQueryRequest)
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.default CompletableFuture<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. To stop ingestion, the event data store Status must be ENABLED and the
eventCategory must be Management, Data, or ConfigurationItem.
stopEventDataStoreIngestionRequest - default CompletableFuture<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. 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.default CompletableFuture<StopImportResponse> stopImport(StopImportRequest stopImportRequest)
Stops a specified import.
stopImportRequest - default CompletableFuture<StopImportResponse> stopImport(Consumer<StopImportRequest.Builder> stopImportRequest)
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.default CompletableFuture<StopLoggingResponse> stopLogging(StopLoggingRequest stopLoggingRequest)
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.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)
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
default CompletableFuture<StopLoggingResponse> stopLogging(Consumer<StopLoggingRequest.Builder> stopLoggingRequest)
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.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)
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
default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
updateChannelRequest - ChannelARN is not valid.default CompletableFuture<UpdateChannelResponse> updateChannel(Consumer<UpdateChannelRequest.Builder> updateChannelRequest)
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.ChannelARN is not valid.default CompletableFuture<UpdateEventDataStoreResponse> updateEventDataStore(UpdateEventDataStoreRequest updateEventDataStoreRequest)
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 - 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.
default CompletableFuture<UpdateEventDataStoreResponse> updateEventDataStore(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest)
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.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.
default CompletableFuture<UpdateTrailResponse> updateTrail(UpdateTrailRequest updateTrailRequest)
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.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)
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.
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
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.default CompletableFuture<UpdateTrailResponse> updateTrail(Consumer<UpdateTrailRequest.Builder> updateTrailRequest)
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.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)
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.
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
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.default CloudTrailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic CloudTrailAsyncClient create()
CloudTrailAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudTrailAsyncClientBuilder builder()
CloudTrailAsyncClient.Copyright © 2023. All rights reserved.