Interface CloudTrailAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.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.static CloudTrailAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aCloudTrailAsyncClient
.default CompletableFuture
<CancelQueryResponse> cancelQuery
(Consumer<CancelQueryRequest.Builder> cancelQueryRequest) Cancels a query if the query is not in a terminated state, such asCANCELLED
,FAILED
,TIMED_OUT
, orFINISHED
.default CompletableFuture
<CancelQueryResponse> cancelQuery
(CancelQueryRequest cancelQueryRequest) Cancels a query if the query is not in a terminated state, such asCANCELLED
,FAILED
,TIMED_OUT
, orFINISHED
.static CloudTrailAsyncClient
create()
Create aCloudTrailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createEventDataStore
(Consumer<CreateEventDataStoreRequest.Builder> createEventDataStoreRequest) Creates a new event data store.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.deleteEventDataStore
(Consumer<DeleteEventDataStoreRequest.Builder> deleteEventDataStoreRequest) Disables the event data store specified byEventDataStore
, which accepts an event data store ARN.deleteEventDataStore
(DeleteEventDataStoreRequest deleteEventDataStoreRequest) Disables the event data store specified byEventDataStore
, which accepts an event data store ARN.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes the resource-based policy attached to the CloudTrail channel.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.deregisterOrganizationDelegatedAdmin
(Consumer<DeregisterOrganizationDelegatedAdminRequest.Builder> deregisterOrganizationDelegatedAdminRequest) Removes CloudTrail delegated administrator permissions from a member account in an organization.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> 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.disableFederation
(Consumer<DisableFederationRequest.Builder> disableFederationRequest) Disables Lake query federation on the specified event data store.disableFederation
(DisableFederationRequest disableFederationRequest) Disables Lake query federation on the specified event data store.enableFederation
(Consumer<EnableFederationRequest.Builder> enableFederationRequest) Enables Lake query federation on the specified event data store.enableFederation
(EnableFederationRequest enableFederationRequest) Enables Lake query federation on the specified event data store.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.getEventDataStore
(Consumer<GetEventDataStoreRequest.Builder> getEventDataStoreRequest) Returns information about an event data store specified as either an ARN or the ID portion of the ARN.getEventDataStore
(GetEventDataStoreRequest getEventDataStoreRequest) Returns information about an event data store specified as either an ARN or the ID portion of the ARN.getEventSelectors
(Consumer<GetEventSelectorsRequest.Builder> getEventSelectorsRequest) Describes the settings for the event selectors that you configured for your trail.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.getInsightSelectors
(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.getInsightSelectors
(GetInsightSelectorsRequest getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.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) This is a variant ofgetQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest)
operation.default GetQueryResultsPublisher
getQueryResultsPaginator
(GetQueryResultsRequest getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.cloudtrail.model.GetQueryResultsRequest)
operation.getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.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) This is a variant oflistChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)
operation.default ListChannelsPublisher
listChannelsPaginator
(ListChannelsRequest listChannelsRequest) This is a variant oflistChannels(software.amazon.awssdk.services.cloudtrail.model.ListChannelsRequest)
operation.listEventDataStores
(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) Returns information about all event data stores in the account, in the current Region.listEventDataStores
(ListEventDataStoresRequest listEventDataStoresRequest) Returns information about all event data stores in the account, in the current Region.default ListEventDataStoresPublisher
listEventDataStoresPaginator
(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) This is a variant oflistEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation.default ListEventDataStoresPublisher
listEventDataStoresPaginator
(ListEventDataStoresRequest listEventDataStoresRequest) This is a variant oflistEventDataStores(software.amazon.awssdk.services.cloudtrail.model.ListEventDataStoresRequest)
operation.listImportFailures
(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) Returns a list of failures for the specified import.listImportFailures
(ListImportFailuresRequest listImportFailuresRequest) Returns a list of failures for the specified import.default ListImportFailuresPublisher
listImportFailuresPaginator
(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) This is a variant oflistImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation.default ListImportFailuresPublisher
listImportFailuresPaginator
(ListImportFailuresRequest listImportFailuresRequest) This is a variant oflistImportFailures(software.amazon.awssdk.services.cloudtrail.model.ListImportFailuresRequest)
operation.default CompletableFuture
<ListImportsResponse> listImports
(Consumer<ListImportsRequest.Builder> listImportsRequest) Returns information on all imports, or a select set of imports byImportStatus
orDestination
.default CompletableFuture
<ListImportsResponse> listImports
(ListImportsRequest listImportsRequest) Returns information on all imports, or a select set of imports byImportStatus
orDestination
.default ListImportsPublisher
listImportsPaginator
(Consumer<ListImportsRequest.Builder> listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)
operation.default ListImportsPublisher
listImportsPaginator
(ListImportsRequest listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudtrail.model.ListImportsRequest)
operation.listInsightsMetricData
(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights.listInsightsMetricData
(ListInsightsMetricDataRequest listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights.default ListInsightsMetricDataPublisher
listInsightsMetricDataPaginator
(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) This is a variant oflistInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
operation.default ListInsightsMetricDataPublisher
listInsightsMetricDataPaginator
(ListInsightsMetricDataRequest listInsightsMetricDataRequest) This is a variant oflistInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
operation.default CompletableFuture
<ListPublicKeysResponse> 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
This is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)
operation.default ListPublicKeysPublisher
listPublicKeysPaginator
(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) This is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)
operation.default ListPublicKeysPublisher
listPublicKeysPaginator
(ListPublicKeysRequest listPublicKeysRequest) This is a variant oflistPublicKeys(software.amazon.awssdk.services.cloudtrail.model.ListPublicKeysRequest)
operation.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) This is a variant oflistQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)
operation.default ListQueriesPublisher
listQueriesPaginator
(ListQueriesRequest listQueriesRequest) This is a variant oflistQueries(software.amazon.awssdk.services.cloudtrail.model.ListQueriesRequest)
operation.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) This is a variant oflistTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
operation.default ListTagsPublisher
listTagsPaginator
(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudtrail.model.ListTagsRequest)
operation.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) This is a variant oflistTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
operation.default ListTrailsPublisher
listTrailsPaginator
(ListTrailsRequest listTrailsRequest) This is a variant oflistTrails(software.amazon.awssdk.services.cloudtrail.model.ListTrailsRequest)
operation.default CompletableFuture
<LookupEventsResponse> 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
This is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.default LookupEventsPublisher
lookupEventsPaginator
(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) This is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.default LookupEventsPublisher
lookupEventsPaginator
(LookupEventsRequest lookupEventsRequest) This is a variant oflookupEvents(software.amazon.awssdk.services.cloudtrail.model.LookupEventsRequest)
operation.putEventSelectors
(Consumer<PutEventSelectorsRequest.Builder> putEventSelectorsRequest) Configures an event selector or advanced event selectors for your trail.putEventSelectors
(PutEventSelectorsRequest putEventSelectorsRequest) Configures an event selector or advanced event selectors for your trail.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 or event data store.putInsightSelectors
(PutInsightSelectorsRequest putInsightSelectorsRequest) Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store.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.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.registerOrganizationDelegatedAdmin
(Consumer<RegisterOrganizationDelegatedAdminRequest.Builder> registerOrganizationDelegatedAdminRequest) Registers an organization’s member account as the CloudTrail delegated administrator.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.restoreEventDataStore
(Consumer<RestoreEventDataStoreRequest.Builder> restoreEventDataStoreRequest) Restores a deleted event data store specified byEventDataStore
, which accepts an event data store ARN.restoreEventDataStore
(RestoreEventDataStoreRequest restoreEventDataStoreRequest) Restores a deleted event data store specified byEventDataStore
, which accepts an event data store ARN.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartEventDataStoreIngestion
(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.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.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.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.updateEventDataStore
(Consumer<UpdateEventDataStoreRequest.Builder> updateEventDataStoreRequest) Updates an event data store.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addTags
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).
- Parameters:
addTagsRequest
- Specifies the tags to add to a trail, event data store, or channel.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addTags
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 viaAddTagsRequest.builder()
- Parameters:
addTagsRequest
- AConsumer
that will call methods onAddTagsRequest.Builder
to create a request. Specifies the tags to add to a trail, event data store, or channel.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelQuery
Cancels a query if the query is not in a terminated state, such as
CANCELLED
,FAILED
,TIMED_OUT
, orFINISHED
. You must specify an ARN value forEventDataStore
. The ID of the query that you want to cancel is also required. When you runCancelQuery
, the query status might show asCANCELLED
even if the operation is not yet finished.- Parameters:
cancelQueryRequest
-- Returns:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InactiveQueryException The specified query cannot be canceled because it is in the
FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
state. - InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelQuery
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
, orFINISHED
. You must specify an ARN value forEventDataStore
. The ID of the query that you want to cancel is also required. When you runCancelQuery
, the query status might show asCANCELLED
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 viaCancelQueryRequest.builder()
- Parameters:
cancelQueryRequest
- AConsumer
that will call methods onCancelQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InactiveQueryException The specified query cannot be canceled because it is in the
FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
state. - InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
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.
- Parameters:
createChannelRequest
-- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelMaxLimitExceededException This exception is thrown when the maximum number of channels limit is exceeded.
- InvalidSourceException This exception is thrown when the specified value of
Source
is not valid. - ChannelAlreadyExistsException This exception is thrown when the provided channel already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannel
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 viaCreateChannelRequest.builder()
- Parameters:
createChannelRequest
- AConsumer
that will call methods onCreateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelMaxLimitExceededException This exception is thrown when the maximum number of channels limit is exceeded.
- InvalidSourceException This exception is thrown when the specified value of
Source
is not valid. - ChannelAlreadyExistsException This exception is thrown when the provided channel already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventDataStore
default CompletableFuture<CreateEventDataStoreResponse> createEventDataStore(CreateEventDataStoreRequest createEventDataStoreRequest) Creates a new event data store.
- Parameters:
createEventDataStoreRequest
-- Returns:
- A Java Future containing the result of the CreateEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreAlreadyExistsException An event data store with that name already exists.
- EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEventDataStore
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 viaCreateEventDataStoreRequest.builder()
- Parameters:
createEventDataStoreRequest
- AConsumer
that will call methods onCreateEventDataStoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreAlreadyExistsException An event data store with that name already exists.
- EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrail
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
- Parameters:
createTrailRequest
- Specifies the settings for each trail.- Returns:
- A Java Future containing the result of the CreateTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MaximumNumberOfTrailsExceededException This exception is thrown when the maximum number of trails is reached.
- TrailAlreadyExistsException This exception is thrown when the specified trail already exists.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientSnsTopicPolicyException This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidSnsTopicNameException This exception is thrown when the provided SNS topic name is not valid.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- TrailNotProvidedException This exception is no longer in use.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- InvalidCloudWatchLogsLogGroupArnException This exception is thrown when the provided CloudWatch Logs log group is not valid.
- InvalidCloudWatchLogsRoleArnException This exception is thrown when the provided role is not valid.
- CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this Region.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- CloudTrailInvalidClientTokenIdException This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account. - ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrail
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 viaCreateTrailRequest.builder()
- Parameters:
createTrailRequest
- AConsumer
that will call methods onCreateTrailRequest.Builder
to create a request. Specifies the settings for each trail.- Returns:
- A Java Future containing the result of the CreateTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- MaximumNumberOfTrailsExceededException This exception is thrown when the maximum number of trails is reached.
- TrailAlreadyExistsException This exception is thrown when the specified trail already exists.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientSnsTopicPolicyException This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidSnsTopicNameException This exception is thrown when the provided SNS topic name is not valid.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- TrailNotProvidedException This exception is no longer in use.
- TagsLimitExceededException The number of tags per trail, event data store, or channel has exceeded the permitted amount. Currently, the limit is 50.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- InvalidCloudWatchLogsLogGroupArnException This exception is thrown when the provided CloudWatch Logs log group is not valid.
- InvalidCloudWatchLogsRoleArnException This exception is thrown when the provided role is not valid.
- CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this Region.
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- CloudTrailInvalidClientTokenIdException This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account. - ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteChannel
default CompletableFuture<DeleteChannelResponse> deleteChannel(DeleteChannelRequest deleteChannelRequest) Deletes a channel.
- Parameters:
deleteChannelRequest
-- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
deleteChannel
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 viaDeleteChannelRequest.builder()
- Parameters:
deleteChannelRequest
- AConsumer
that will call methods onDeleteChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
deleteEventDataStore
default CompletableFuture<DeleteEventDataStoreResponse> deleteEventDataStore(DeleteEventDataStoreRequest deleteEventDataStoreRequest) Disables the event data store specified by
EventDataStore
, which accepts an event data store ARN. After you runDeleteEventDataStore
, the event data store enters aPENDING_DELETION
state, and is automatically deleted after a wait period of seven days.TerminationProtectionEnabled
must be set toFalse
on the event data store and theFederationStatus
must beDISABLED
. You cannot delete an event data store ifTerminationProtectionEnabled
isTrue
or theFederationStatus
isENABLED
.After you run
DeleteEventDataStore
on an event data store, you cannot runListQueries
,DescribeQuery
, orGetQueryResults
on queries that are using an event data store in aPENDING_DELETION
state. An event data store in thePENDING_DELETION
state does not incur costs.- Parameters:
deleteEventDataStoreRequest
-- Returns:
- A Java Future containing the result of the DeleteEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- EventDataStoreTerminationProtectedException The event data store cannot be deleted because termination protection is enabled for it.
- EventDataStoreHasOngoingImportException This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ChannelExistsForEdsException This exception is thrown when the specified event data store cannot yet be deleted because it is in use by a channel.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- EventDataStoreFederationEnabledException You cannot delete the event data store because Lake query
federation is enabled. To delete the event data store, run the
DisableFederation
operation to disable Lake query federation on the event data store. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEventDataStore
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 runDeleteEventDataStore
, the event data store enters aPENDING_DELETION
state, and is automatically deleted after a wait period of seven days.TerminationProtectionEnabled
must be set toFalse
on the event data store and theFederationStatus
must beDISABLED
. You cannot delete an event data store ifTerminationProtectionEnabled
isTrue
or theFederationStatus
isENABLED
.After you run
DeleteEventDataStore
on an event data store, you cannot runListQueries
,DescribeQuery
, orGetQueryResults
on queries that are using an event data store in aPENDING_DELETION
state. An event data store in thePENDING_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 viaDeleteEventDataStoreRequest.builder()
- Parameters:
deleteEventDataStoreRequest
- AConsumer
that will call methods onDeleteEventDataStoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- EventDataStoreTerminationProtectedException The event data store cannot be deleted because termination protection is enabled for it.
- EventDataStoreHasOngoingImportException This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ChannelExistsForEdsException This exception is thrown when the specified event data store cannot yet be deleted because it is in use by a channel.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- EventDataStoreFederationEnabledException You cannot delete the event data store because Lake query
federation is enabled. To delete the event data store, run the
DisableFederation
operation to disable Lake query federation on the event data store. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes the resource-based policy attached to the CloudTrail channel.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourcePolicyNotFoundException This exception is thrown when the specified resource policy is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
deleteResourcePolicy
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 viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourcePolicyNotFoundException This exception is thrown when the specified resource policy is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
deleteTrail
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.- Parameters:
deleteTrailRequest
- The request that specifies the name of a trail to delete.- Returns:
- A Java Future containing the result of the DeleteTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrail
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 viaDeleteTrailRequest.builder()
- Parameters:
deleteTrailRequest
- AConsumer
that will call methods onDeleteTrailRequest.Builder
to create a request. The request that specifies the name of a trail to delete.- Returns:
- A Java Future containing the result of the DeleteTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterOrganizationDelegatedAdmin
default CompletableFuture<DeregisterOrganizationDelegatedAdminResponse> deregisterOrganizationDelegatedAdmin(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest) Removes CloudTrail delegated administrator permissions from a member account in an organization.
- Parameters:
deregisterOrganizationDelegatedAdminRequest
- Removes CloudTrail delegated administrator permissions from a specified member account in an organization that is currently designated as a delegated administrator.- Returns:
- A Java Future containing the result of the DeregisterOrganizationDelegatedAdmin operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountNotFoundException This exception is thrown when the specified account is not found or not part of an organization.
- AccountNotRegisteredException This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- InvalidParameterException The request includes a parameter that is not valid.
- NotOrganizationManagementAccountException This exception is thrown when the account making the request is not the organization's management account.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterOrganizationDelegatedAdmin
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 viaDeregisterOrganizationDelegatedAdminRequest.builder()
- Parameters:
deregisterOrganizationDelegatedAdminRequest
- AConsumer
that will call methods onDeregisterOrganizationDelegatedAdminRequest.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.- Returns:
- A Java Future containing the result of the DeregisterOrganizationDelegatedAdmin operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountNotFoundException This exception is thrown when the specified account is not found or not part of an organization.
- AccountNotRegisteredException This exception is thrown when the specified account is not registered as the CloudTrail delegated administrator.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- InvalidParameterException The request includes a parameter that is not valid.
- NotOrganizationManagementAccountException This exception is thrown when the account making the request is not the organization's management account.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQuery
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 aQueryAlias
. Specifying theQueryAlias
parameter returns information about the last query run for the alias.- Parameters:
describeQueryRequest
-- Returns:
- A Java Future containing the result of the DescribeQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQuery
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 aQueryAlias
. Specifying theQueryAlias
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 viaDescribeQueryRequest.builder()
- Parameters:
describeQueryRequest
- AConsumer
that will call methods onDescribeQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTrails
default CompletableFuture<DescribeTrailsResponse> describeTrails(DescribeTrailsRequest describeTrailsRequest) Retrieves settings for one or more trails associated with the current Region for your account.
- Parameters:
describeTrailsRequest
- Returns information about the trail.- Returns:
- A Java Future containing the result of the DescribeTrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTrails
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 viaDescribeTrailsRequest.builder()
- Parameters:
describeTrailsRequest
- AConsumer
that will call methods onDescribeTrailsRequest.Builder
to create a request. Returns information about the trail.- Returns:
- A Java Future containing the result of the DescribeTrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTrails
Retrieves settings for one or more trails associated with the current Region for your account.
- Returns:
- A Java Future containing the result of the DescribeTrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableFederation
default CompletableFuture<DisableFederationResponse> disableFederation(DisableFederationRequest disableFederationRequest) Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
- Parameters:
disableFederationRequest
-- Returns:
- A Java Future containing the result of the DisableFederation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InactiveEventDataStoreException The event data store is inactive.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- ConcurrentModificationException You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableFederation
default CompletableFuture<DisableFederationResponse> disableFederation(Consumer<DisableFederationRequest.Builder> disableFederationRequest) Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena.
No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.
This is a convenience which creates an instance of the
DisableFederationRequest.Builder
avoiding the need to create one manually viaDisableFederationRequest.builder()
- Parameters:
disableFederationRequest
- AConsumer
that will call methods onDisableFederationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisableFederation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InactiveEventDataStoreException The event data store is inactive.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- ConcurrentModificationException You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableFederation
default CompletableFuture<EnableFederationResponse> enableFederation(EnableFederationRequest enableFederationRequest) Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.
When you enable Lake query federation, CloudTrail creates a managed database named
aws:cloudtrail
(if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog.For more information about Lake query federation, see Federate an event data store.
- Parameters:
enableFederationRequest
-- Returns:
- A Java Future containing the result of the EnableFederation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InactiveEventDataStoreException The event data store is inactive.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- ConcurrentModificationException You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.
- AccessDeniedException You do not have sufficient access to perform this action.
- EventDataStoreFederationEnabledException You cannot delete the event data store because Lake query
federation is enabled. To delete the event data store, run the
DisableFederation
operation to disable Lake query federation on the event data store. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableFederation
default CompletableFuture<EnableFederationResponse> enableFederation(Consumer<EnableFederationRequest.Builder> enableFederationRequest) Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.
When you enable Lake query federation, CloudTrail creates a managed database named
aws:cloudtrail
(if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog.For more information about Lake query federation, see Federate an event data store.
This is a convenience which creates an instance of the
EnableFederationRequest.Builder
avoiding the need to create one manually viaEnableFederationRequest.builder()
- Parameters:
enableFederationRequest
- AConsumer
that will call methods onEnableFederationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableFederation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InactiveEventDataStoreException The event data store is inactive.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- ConcurrentModificationException You are trying to update a resource when another request is in progress. Allow sufficient wait time for the previous request to complete, then retry your request.
- AccessDeniedException You do not have sufficient access to perform this action.
- EventDataStoreFederationEnabledException You cannot delete the event data store because Lake query
federation is enabled. To delete the event data store, run the
DisableFederation
operation to disable Lake query federation on the event data store. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChannel
Returns information about a specific channel.
- Parameters:
getChannelRequest
-- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
getChannel
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 viaGetChannelRequest.builder()
- Parameters:
getChannelRequest
- AConsumer
that will call methods onGetChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
getEventDataStore
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.
- Parameters:
getEventDataStoreRequest
-- Returns:
- A Java Future containing the result of the GetEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEventDataStore
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 viaGetEventDataStoreRequest.builder()
- Parameters:
getEventDataStoreRequest
- AConsumer
that will call methods onGetEventDataStoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEventSelectors
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:
- Parameters:
getEventSelectorsRequest
-- Returns:
- A Java Future containing the result of the GetEventSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getEventSelectors
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 viaGetEventSelectorsRequest.builder()
- Parameters:
getEventSelectorsRequest
- AConsumer
that will call methods onGetEventSelectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEventSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getImport
Returns information about a specific import.
- Parameters:
getImportRequest
-- Returns:
- A Java Future containing the result of the GetImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImport
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 viaGetImportRequest.builder()
- Parameters:
getImportRequest
- AConsumer
that will call methods onGetImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSelectors
default CompletableFuture<GetInsightSelectorsResponse> getInsightSelectors(GetInsightSelectorsRequest getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.
GetInsightSelectors
shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you runGetInsightSelectors
on a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledException
Specify either the
EventDataStore
parameter to get Insights event selectors for an event data store, or theTrailName
parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
- Parameters:
getInsightSelectorsRequest
-- Returns:
- A Java Future containing the result of the GetInsightSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InsightNotEnabledException If you run
GetInsightSelectors
on a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledException
. - NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSelectors
default CompletableFuture<GetInsightSelectorsResponse> getInsightSelectors(Consumer<GetInsightSelectorsRequest.Builder> getInsightSelectorsRequest) Describes the settings for the Insights event selectors that you configured for your trail or event data store.
GetInsightSelectors
shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you runGetInsightSelectors
on a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledException
Specify either the
EventDataStore
parameter to get Insights event selectors for an event data store, or theTrailName
parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
This is a convenience which creates an instance of the
GetInsightSelectorsRequest.Builder
avoiding the need to create one manually viaGetInsightSelectorsRequest.builder()
- Parameters:
getInsightSelectorsRequest
- AConsumer
that will call methods onGetInsightSelectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInsightSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InsightNotEnabledException If you run
GetInsightSelectors
on a trail or event data store that does not have Insights events enabled, the operation throws the exceptionInsightNotEnabledException
. - NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResults
default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest) Gets event data results of a query. You must specify the
QueryID
value returned by theStartQuery
operation.- Parameters:
getQueryResultsRequest
-- Returns:
- A Java Future containing the result of the GetQueryResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResults
default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) Gets event data results of a query. You must specify the
QueryID
value returned by theStartQuery
operation.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetQueryResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsPublisher getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getQueryResultsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsPublisher getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- QueryIdNotFoundException The query ID does not exist or does not map to a query.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
- Parameters:
getResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourcePolicyNotFoundException This exception is thrown when the specified resource policy is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
getResourcePolicy
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 viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourcePolicyNotFoundException This exception is thrown when the specified resource policy is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
getTrail
Returns settings information for a specified trail.
- Parameters:
getTrailRequest
-- Returns:
- A Java Future containing the result of the GetTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
getTrail
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 viaGetTrailRequest.builder()
- Parameters:
getTrailRequest
- AConsumer
that will call methods onGetTrailRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
getTrailStatus
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.
- Parameters:
getTrailStatusRequest
- The name of a trail about which you want the current status.- Returns:
- A Java Future containing the result of the GetTrailStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
getTrailStatus
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 viaGetTrailStatusRequest.builder()
- Parameters:
getTrailStatusRequest
- AConsumer
that will call methods onGetTrailStatusRequest.Builder
to create a request. The name of a trail about which you want the current status.- Returns:
- A Java Future containing the result of the GetTrailStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest) Lists the channels in the current account, and their source names.
- Parameters:
listChannelsRequest
-- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannels
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listChannelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListChannelsRequest.builder()
- Parameters:
listChannelsRequest
- AConsumer
that will call methods onListChannelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventDataStores
default CompletableFuture<ListEventDataStoresResponse> listEventDataStores(ListEventDataStoresRequest listEventDataStoresRequest) Returns information about all event data stores in the account, in the current Region.
- Parameters:
listEventDataStoresRequest
-- Returns:
- A Java Future containing the result of the ListEventDataStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventDataStores
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 viaListEventDataStoresRequest.builder()
- Parameters:
listEventDataStoresRequest
- AConsumer
that will call methods onListEventDataStoresRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEventDataStores operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventDataStoresPaginator
default ListEventDataStoresPublisher listEventDataStoresPaginator(ListEventDataStoresRequest listEventDataStoresRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listEventDataStoresRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventDataStoresPaginator
default ListEventDataStoresPublisher listEventDataStoresPaginator(Consumer<ListEventDataStoresRequest.Builder> listEventDataStoresRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListEventDataStoresPublisher publisher = client.listEventDataStoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListEventDataStoresRequest.builder()
- Parameters:
listEventDataStoresRequest
- AConsumer
that will call methods onListEventDataStoresRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportFailures
default CompletableFuture<ListImportFailuresResponse> listImportFailures(ListImportFailuresRequest listImportFailuresRequest) Returns a list of failures for the specified import.
- Parameters:
listImportFailuresRequest
-- Returns:
- A Java Future containing the result of the ListImportFailures operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportFailures
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 viaListImportFailuresRequest.builder()
- Parameters:
listImportFailuresRequest
- AConsumer
that will call methods onListImportFailuresRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImportFailures operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportFailuresPaginator
default ListImportFailuresPublisher listImportFailuresPaginator(ListImportFailuresRequest listImportFailuresRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listImportFailuresRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportFailuresPaginator
default ListImportFailuresPublisher listImportFailuresPaginator(Consumer<ListImportFailuresRequest.Builder> listImportFailuresRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportFailuresPublisher publisher = client.listImportFailuresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListImportFailuresRequest.builder()
- Parameters:
listImportFailuresRequest
- AConsumer
that will call methods onListImportFailuresRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImports
Returns information on all imports, or a select set of imports by
ImportStatus
orDestination
.- Parameters:
listImportsRequest
-- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImports
default CompletableFuture<ListImportsResponse> listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) Returns information on all imports, or a select set of imports by
ImportStatus
orDestination
.
This is a convenience which creates an instance of the
ListImportsRequest.Builder
avoiding the need to create one manually viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listImportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportsPaginator
default ListImportsPublisher listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInsightsMetricData
default CompletableFuture<ListInsightsMetricDataResponse> listInsightsMetricData(ListInsightsMetricDataRequest listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights. The request must include the
EventSource
,EventName
, andInsightType
parameters.If the
InsightType
is set toApiErrorRateInsight
, the request must also include theErrorCode
parameter.The following are the available time periods for
ListInsightsMetricData
. Each cutoff is inclusive.-
Data points with a period of 60 seconds (1-minute) are available for 15 days.
-
Data points with a period of 300 seconds (5-minute) are available for 63 days.
-
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the
ListInsightsMetricData
API operation is linked to thecloudtrail:LookupEvents
action. To use this operation, you must have permissions to perform thecloudtrail:LookupEvents
action.- Parameters:
listInsightsMetricDataRequest
-- Returns:
- A Java Future containing the result of the ListInsightsMetricData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listInsightsMetricData
default CompletableFuture<ListInsightsMetricDataResponse> listInsightsMetricData(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) Returns Insights metrics data for trails that have enabled Insights. The request must include the
EventSource
,EventName
, andInsightType
parameters.If the
InsightType
is set toApiErrorRateInsight
, the request must also include theErrorCode
parameter.The following are the available time periods for
ListInsightsMetricData
. Each cutoff is inclusive.-
Data points with a period of 60 seconds (1-minute) are available for 15 days.
-
Data points with a period of 300 seconds (5-minute) are available for 63 days.
-
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the
ListInsightsMetricData
API operation is linked to thecloudtrail:LookupEvents
action. To use this operation, you must have permissions to perform thecloudtrail:LookupEvents
action.
This is a convenience which creates an instance of the
ListInsightsMetricDataRequest.Builder
avoiding the need to create one manually viaListInsightsMetricDataRequest.builder()
- Parameters:
listInsightsMetricDataRequest
- AConsumer
that will call methods onListInsightsMetricDataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInsightsMetricData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listInsightsMetricDataPaginator
default ListInsightsMetricDataPublisher listInsightsMetricDataPaginator(ListInsightsMetricDataRequest listInsightsMetricDataRequest) This is a variant of
listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataPublisher publisher = client.listInsightsMetricDataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataPublisher publisher = client.listInsightsMetricDataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse response) { //... }; });
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
listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
operation.- Parameters:
listInsightsMetricDataRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInsightsMetricDataPaginator
default ListInsightsMetricDataPublisher listInsightsMetricDataPaginator(Consumer<ListInsightsMetricDataRequest.Builder> listInsightsMetricDataRequest) This is a variant of
listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataPublisher publisher = client.listInsightsMetricDataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudtrail.paginators.ListInsightsMetricDataPublisher publisher = client.listInsightsMetricDataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataResponse response) { //... }; });
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
listInsightsMetricData(software.amazon.awssdk.services.cloudtrail.model.ListInsightsMetricDataRequest)
operation.
This is a convenience which creates an instance of the
ListInsightsMetricDataRequest.Builder
avoiding the need to create one manually viaListInsightsMetricDataRequest.builder()
- Parameters:
listInsightsMetricDataRequest
- AConsumer
that will call methods onListInsightsMetricDataRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPublicKeys
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.
- Parameters:
listPublicKeysRequest
- Requests the public keys for a specified time range.- Returns:
- A Java Future containing the result of the ListPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPublicKeys
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 viaListPublicKeysRequest.builder()
- Parameters:
listPublicKeysRequest
- AConsumer
that will call methods onListPublicKeysRequest.Builder
to create a request. Requests the public keys for a specified time range.- Returns:
- A Java Future containing the result of the ListPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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.
- Returns:
- A Java Future containing the result of the ListPublicKeys operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPublicKeysPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPublicKeysPaginator
default ListPublicKeysPublisher listPublicKeysPaginator(ListPublicKeysRequest listPublicKeysRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listPublicKeysRequest
- Requests the public keys for a specified time range.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPublicKeysPaginator
default ListPublicKeysPublisher listPublicKeysPaginator(Consumer<ListPublicKeysRequest.Builder> listPublicKeysRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListPublicKeysPublisher publisher = client.listPublicKeysPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListPublicKeysRequest.builder()
- Parameters:
listPublicKeysRequest
- AConsumer
that will call methods onListPublicKeysRequest.Builder
to create a request. Requests the public keys for a specified time range.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueries
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 addingStartTime
andEndTime
parameters, and aQueryStatus
value. Valid values forQueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
.- Parameters:
listQueriesRequest
-- Returns:
- A Java Future containing the result of the ListQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidDateRangeException A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatusException The query status is not valid for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueries
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 addingStartTime
andEndTime
parameters, and aQueryStatus
value. Valid values forQueryStatus
includeQUEUED
,RUNNING
,FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
.
This is a convenience which creates an instance of the
ListQueriesRequest.Builder
avoiding the need to create one manually viaListQueriesRequest.builder()
- Parameters:
listQueriesRequest
- AConsumer
that will call methods onListQueriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidDateRangeException A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatusException The query status is not valid for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueriesPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listQueriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidDateRangeException A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatusException The query status is not valid for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueriesPaginator
default ListQueriesPublisher listQueriesPaginator(Consumer<ListQueriesRequest.Builder> listQueriesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListQueriesPublisher publisher = client.listQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListQueriesRequest.builder()
- Parameters:
listQueriesRequest
- AConsumer
that will call methods onListQueriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidDateRangeException A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatusException The query status is not valid for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
Lists the tags for the specified trails, event data stores, or channels in the current Region.
- Parameters:
listTagsRequest
- Specifies a list of tags to return.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request. Specifies a list of tags to return.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listTagsRequest
- Specifies a list of tags to return.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request. Specifies a list of tags to return.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- InvalidTokenException Reserved for future use.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrails
Lists trails that are in the current account.
- Parameters:
listTrailsRequest
-- Returns:
- A Java Future containing the result of the ListTrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrails
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 viaListTrailsRequest.builder()
- Parameters:
listTrailsRequest
- AConsumer
that will call methods onListTrailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrailsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listTrailsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrailsPaginator
default ListTrailsPublisher listTrailsPaginator(Consumer<ListTrailsRequest.Builder> listTrailsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.ListTrailsPublisher publisher = client.listTrailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListTrailsRequest.builder()
- Parameters:
listTrailsRequest
- AConsumer
that will call methods onListTrailsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
lookupEvents
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.
LookupEvents
returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights.Lookup supports the following attributes for management events:
-
Amazon Web Services access key
-
Event ID
-
Event name
-
Event source
-
Read only
-
Resource name
-
Resource type
-
User name
Lookup supports the following attributes for Insights events:
-
Event ID
-
Event name
-
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.
- Parameters:
lookupEventsRequest
- Contains a request for LookupEvents.- Returns:
- A Java Future containing the result of the LookupEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
lookupEvents
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.
LookupEvents
returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights.Lookup supports the following attributes for management events:
-
Amazon Web Services access key
-
Event ID
-
Event name
-
Event source
-
Read only
-
Resource name
-
Resource type
-
User name
Lookup supports the following attributes for Insights events:
-
Event ID
-
Event name
-
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.
This is a convenience which creates an instance of the
LookupEventsRequest.Builder
avoiding the need to create one manually viaLookupEventsRequest.builder()
- Parameters:
lookupEventsRequest
- AConsumer
that will call methods onLookupEventsRequest.Builder
to create a request. Contains a request for LookupEvents.- Returns:
- A Java Future containing the result of the LookupEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
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.
LookupEvents
returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights.Lookup supports the following attributes for management events:
-
Amazon Web Services access key
-
Event ID
-
Event name
-
Event source
-
Read only
-
Resource name
-
Resource type
-
User name
Lookup supports the following attributes for Insights events:
-
Event ID
-
Event name
-
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.
- Returns:
- A Java Future containing the result of the LookupEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
lookupEventsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
lookupEventsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
lookupEventsRequest
- Contains a request for LookupEvents.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
lookupEventsPaginator
default LookupEventsPublisher lookupEventsPaginator(Consumer<LookupEventsRequest.Builder> lookupEventsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.cloudtrail.paginators.LookupEventsPublisher publisher = client.lookupEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaLookupEventsRequest.builder()
- Parameters:
lookupEventsRequest
- AConsumer
that will call methods onLookupEventsRequest.Builder
to create a request. Contains a request for LookupEvents.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidLookupAttributesException Occurs when a lookup attribute is specified that is not valid.
- InvalidTimeRangeException Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
- InvalidMaxResultsException This exception is thrown if the limit specified is not valid.
- InvalidNextTokenException A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
- InvalidEventCategoryException Occurs if an event category that is not valid is specified as a value
of
EventCategory
. - UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEventSelectors
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
andRunInstances
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, anInvalidHomeRegionException
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
orEventSelectors
, but not both. If you applyAdvancedEventSelectors
to a trail, any existingEventSelectors
are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.- Parameters:
putEventSelectorsRequest
-- Returns:
- A Java Future containing the result of the PutEventSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putEventSelectors
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
andRunInstances
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, anInvalidHomeRegionException
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
orEventSelectors
, but not both. If you applyAdvancedEventSelectors
to a trail, any existingEventSelectors
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 viaPutEventSelectorsRequest.builder()
- Parameters:
putEventSelectorsRequest
- AConsumer
that will call methods onPutEventSelectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutEventSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putInsightSelectors
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 or event data store. You also use
PutInsightSelectors
to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types areApiErrorRateInsight
andApiCallRateInsight
.To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (
EventDataStore
) and the destination event data store (InsightsDestination
). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.To log Insights events for a trail, you must specify the name (
TrailName
) of the CloudTrail trail for which you want to change or add Insights selectors.To log CloudTrail Insights events on API call volume, the trail or event data store must log
write
management events. To log CloudTrail Insights events on API error rate, the trail or event data store must logread
orwrite
management events. You can callGetEventSelectors
on a trail to check whether the trail logs management events. You can callGetEventDataStore
on an event data store to check whether the event data store logs management events.For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
- Parameters:
putInsightSelectorsRequest
-- Returns:
- A Java Future containing the result of the PutInsightSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- InvalidInsightSelectorsException For
PutInsightSelectors
, this exception is thrown when the formatting or syntax of theInsightSelectors
JSON statement is not valid, or the specifiedInsightType
in theInsightSelectors
statement is not valid. Valid values forInsightType
areApiCallRateInsight
andApiErrorRateInsight
. To enable Insights on an event data store, the destination event data store specified by theInsightsDestination
parameter must log Insights events and the source event data store specified by theEventDataStore
parameter must log management events.For
UpdateEventDataStore
, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configuredInsightSelectors
. If theInsightSelectors
includes anInsightType
ofApiCallRateInsight
, the source event data store must logwrite
management events. If theInsightSelectors
includes anInsightType
ofApiErrorRateInsight
, the source event data store must log management events. - InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putInsightSelectors
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 or event data store. You also use
PutInsightSelectors
to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types areApiErrorRateInsight
andApiCallRateInsight
.To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (
EventDataStore
) and the destination event data store (InsightsDestination
). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.To log Insights events for a trail, you must specify the name (
TrailName
) of the CloudTrail trail for which you want to change or add Insights selectors.To log CloudTrail Insights events on API call volume, the trail or event data store must log
write
management events. To log CloudTrail Insights events on API error rate, the trail or event data store must logread
orwrite
management events. You can callGetEventSelectors
on a trail to check whether the trail logs management events. You can callGetEventDataStore
on an event data store to check whether the event data store logs management events.For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
This is a convenience which creates an instance of the
PutInsightSelectorsRequest.Builder
avoiding the need to create one manually viaPutInsightSelectorsRequest.builder()
- Parameters:
putInsightSelectorsRequest
- AConsumer
that will call methods onPutInsightSelectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutInsightSelectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException The request includes a parameter that is not valid.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- InvalidInsightSelectorsException For
PutInsightSelectors
, this exception is thrown when the formatting or syntax of theInsightSelectors
JSON statement is not valid, or the specifiedInsightType
in theInsightSelectors
statement is not valid. Valid values forInsightType
areApiCallRateInsight
andApiErrorRateInsight
. To enable Insights on an event data store, the destination event data store specified by theInsightsDestination
parameter must log Insights events and the source event data store specified by theEventDataStore
parameter must log management events.For
UpdateEventDataStore
, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configuredInsightSelectors
. If theInsightSelectors
includes anInsightType
ofApiCallRateInsight
, the source event data store must logwrite
management events. If theInsightSelectors
includes anInsightType
ofApiErrorRateInsight
, the source event data store must log management events. - InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
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.
- Parameters:
putResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourcePolicyNotValidException This exception is thrown when the resouce-based policy has syntax
errors, or contains a principal that is not valid.
The following are requirements for the resource policy:
-
Contains only one action: cloudtrail-data:PutAuditEvents
-
Contains at least one statement. The policy can have a maximum of 20 statements.
-
Each statement contains at least one principal. A statement can have a maximum of 50 principals.
-
- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
putResourcePolicy
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 viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel
. - ResourcePolicyNotValidException This exception is thrown when the resouce-based policy has syntax
errors, or contains a principal that is not valid.
The following are requirements for the resource policy:
-
Contains only one action: cloudtrail-data:PutAuditEvents
-
Contains at least one statement. The policy can have a maximum of 20 statements.
-
Each statement contains at least one principal. A statement can have a maximum of 50 principals.
-
- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceArnNotValidException This exception is thrown when the provided resource does not exist, or
the ARN format of the resource is not valid. The following is the valid format for a resource ARN:
- See Also:
-
registerOrganizationDelegatedAdmin
default CompletableFuture<RegisterOrganizationDelegatedAdminResponse> registerOrganizationDelegatedAdmin(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest) Registers an organization’s member account as the CloudTrail delegated administrator.
- Parameters:
registerOrganizationDelegatedAdminRequest
- Specifies an organization member account ID as a CloudTrail delegated administrator.- Returns:
- A Java Future containing the result of the RegisterOrganizationDelegatedAdmin operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountRegisteredException This exception is thrown when the account is already registered as the CloudTrail delegated administrator.
- AccountNotFoundException This exception is thrown when the specified account is not found or not part of an organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- InvalidParameterException The request includes a parameter that is not valid.
- CannotDelegateManagementAccountException This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- DelegatedAdminAccountLimitExceededException This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.
- NotOrganizationManagementAccountException This exception is thrown when the account making the request is not the organization's management account.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerOrganizationDelegatedAdmin
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 viaRegisterOrganizationDelegatedAdminRequest.builder()
- Parameters:
registerOrganizationDelegatedAdminRequest
- AConsumer
that will call methods onRegisterOrganizationDelegatedAdminRequest.Builder
to create a request. Specifies an organization member account ID as a CloudTrail delegated administrator.- Returns:
- A Java Future containing the result of the RegisterOrganizationDelegatedAdmin operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountRegisteredException This exception is thrown when the account is already registered as the CloudTrail delegated administrator.
- AccountNotFoundException This exception is thrown when the specified account is not found or not part of an organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- InvalidParameterException The request includes a parameter that is not valid.
- CannotDelegateManagementAccountException This exception is thrown when the management account of an organization is registered as the CloudTrail delegated administrator.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- DelegatedAdminAccountLimitExceededException This exception is thrown when the maximum number of CloudTrail delegated administrators is reached.
- NotOrganizationManagementAccountException This exception is thrown when the account making the request is not the organization's management account.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTags
Removes the specified tags from a trail, event data store, or channel.
- Parameters:
removeTagsRequest
- Specifies the tags to remove from a trail, event data store, or channel.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeTags
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 viaRemoveTagsRequest.builder()
- Parameters:
removeTagsRequest
- AConsumer
that will call methods onRemoveTagsRequest.Builder
to create a request. Specifies the tags to remove from a trail, event data store, or channel.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException This exception is thrown when the specified resource is not found.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidTagParameterException This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
- InactiveEventDataStoreException The event data store is inactive.
- EventDataStoreNotFoundException The specified event data store was not found.
- ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreEventDataStore
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.- Parameters:
restoreEventDataStoreRequest
-- Returns:
- A Java Future containing the result of the RestoreEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreEventDataStore
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 viaRestoreEventDataStoreRequest.builder()
- Parameters:
restoreEventDataStoreRequest
- AConsumer
that will call methods onRestoreEventDataStoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEventDataStoreIngestion
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 beSTOPPED_INGESTION
and theeventCategory
must beManagement
,Data
, orConfigurationItem
.- Parameters:
startEventDataStoreIngestionRequest
-- Returns:
- A Java Future containing the result of the StartEventDataStoreIngestion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startEventDataStoreIngestion
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 beSTOPPED_INGESTION
and theeventCategory
must beManagement
,Data
, orConfigurationItem
.
This is a convenience which creates an instance of the
StartEventDataStoreIngestionRequest.Builder
avoiding the need to create one manually viaStartEventDataStoreIngestionRequest.builder()
- Parameters:
startEventDataStoreIngestionRequest
- AConsumer
that will call methods onStartEventDataStoreIngestionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartEventDataStoreIngestion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImport
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 theCloudTrail
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 theS3LocationUri
. For more considerations about importing trail events, see Considerations.When you start a new import, the
Destinations
andImportSource
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.
- Parameters:
startImportRequest
-- Returns:
- A Java Future containing the result of the StartImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountHasOngoingImportException This exception is thrown when you start a new import and a previous import is still in progress.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidImportSourceException This exception is thrown when the provided source S3 bucket is not valid for import.
- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImport
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 theCloudTrail
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 theS3LocationUri
. For more considerations about importing trail events, see Considerations.When you start a new import, the
Destinations
andImportSource
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 viaStartImportRequest.builder()
- Parameters:
startImportRequest
- AConsumer
that will call methods onStartImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AccountHasOngoingImportException This exception is thrown when you start a new import and a previous import is still in progress.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidImportSourceException This exception is thrown when the provided source S3 bucket is not valid for import.
- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startLogging
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.
- Parameters:
startLoggingRequest
- The request to CloudTrail to start logging Amazon Web Services API calls for an account.- Returns:
- A Java Future containing the result of the StartLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
startLogging
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 viaStartLoggingRequest.builder()
- Parameters:
startLoggingRequest
- AConsumer
that will call methods onStartLoggingRequest.Builder
to create a request. The request to CloudTrail to start logging Amazon Web Services API calls for an account.- Returns:
- A Java Future containing the result of the StartLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
- See Also:
-
startQuery
Starts a CloudTrail Lake query. Use the
QueryStatement
parameter to provide your SQL query, enclosed in single quotation marks. Use the optionalDeliveryS3Uri
parameter to deliver the query results to an S3 bucket.StartQuery
requires you specify either theQueryStatement
parameter, or aQueryAlias
and anyQueryParameters
. In the current release, theQueryAlias
andQueryParameters
parameters are used only for the queries that populate the CloudTrail Lake dashboards.- Parameters:
startQueryRequest
-- Returns:
- A Java Future containing the result of the StartQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatementException The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- MaxConcurrentQueriesException You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some queries to finish, and then run the query again.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startQuery
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 optionalDeliveryS3Uri
parameter to deliver the query results to an S3 bucket.StartQuery
requires you specify either theQueryStatement
parameter, or aQueryAlias
and anyQueryParameters
. In the current release, theQueryAlias
andQueryParameters
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 viaStartQueryRequest.builder()
- Parameters:
startQueryRequest
- AConsumer
that will call methods onStartQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidQueryStatementException The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.
- MaxConcurrentQueriesException You are already running the maximum number of concurrent queries. The maximum number of concurrent queries is 10. Wait a minute for some queries to finish, and then run the query again.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEventDataStoreIngestion
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 beENABLED
and theeventCategory
must beManagement
,Data
, orConfigurationItem
.- Parameters:
stopEventDataStoreIngestionRequest
-- Returns:
- A Java Future containing the result of the StopEventDataStoreIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopEventDataStoreIngestion
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 beENABLED
and theeventCategory
must beManagement
,Data
, orConfigurationItem
.
This is a convenience which creates an instance of the
StopEventDataStoreIngestionRequest.Builder
avoiding the need to create one manually viaStopEventDataStoreIngestionRequest.builder()
- Parameters:
stopEventDataStoreIngestionRequest
- AConsumer
that will call methods onStopEventDataStoreIngestionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopEventDataStoreIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.
- InvalidParameterException The request includes a parameter that is not valid.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopImport
Stops a specified import.
- Parameters:
stopImportRequest
-- Returns:
- A Java Future containing the result of the StopImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopImport
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 viaStopImportRequest.builder()
- Parameters:
stopImportRequest
- AConsumer
that will call methods onStopImportRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopImport operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ImportNotFoundException The specified import was not found.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopLogging
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.- Parameters:
stopLoggingRequest
- Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.- Returns:
- A Java Future containing the result of the StopLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopLogging
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 viaStopLoggingRequest.builder()
- Parameters:
stopLoggingRequest
- AConsumer
that will call methods onStopLoggingRequest.Builder
to create a request. Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.- Returns:
- A Java Future containing the result of the StopLogging operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChannel
default CompletableFuture<UpdateChannelResponse> updateChannel(UpdateChannelRequest updateChannelRequest) Updates a channel specified by a required channel ARN or UUID.
- Parameters:
updateChannelRequest
-- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- ChannelAlreadyExistsException This exception is thrown when the provided channel already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
updateChannel
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 viaUpdateChannelRequest.builder()
- Parameters:
updateChannelRequest
- AConsumer
that will call methods onUpdateChannelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChannelArnInvalidException This exception is thrown when the specified value of
ChannelARN
is not valid. - ChannelNotFoundException This exception is thrown when CloudTrail cannot find the specified channel.
- ChannelAlreadyExistsException This exception is thrown when the provided channel already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventDataStoreCategoryException This exception is thrown when event categories of specified event data stores are not valid.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ChannelArnInvalidException This exception is thrown when the specified value of
- See Also:
-
updateEventDataStore
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 7 and 3653 if theBillingMode
is set toEXTENDABLE_RETENTION_PRICING
, or between 7 and 2557 ifBillingMode
is set toFIXED_RETENTION_PRICING
. By default,TerminationProtection
is enabled.For event data stores for CloudTrail events,
AdvancedEventSelectors
includes or excludes management or data events in your event data store. For more information aboutAdvancedEventSelectors
, see AdvancedEventSelectors.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectors
includes events of that type in your event data store.- Parameters:
updateEventDataStoreRequest
-- Returns:
- A Java Future containing the result of the UpdateEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreAlreadyExistsException An event data store with that name already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- InvalidInsightSelectorsException For
PutInsightSelectors
, this exception is thrown when the formatting or syntax of theInsightSelectors
JSON statement is not valid, or the specifiedInsightType
in theInsightSelectors
statement is not valid. Valid values forInsightType
areApiCallRateInsight
andApiErrorRateInsight
. To enable Insights on an event data store, the destination event data store specified by theInsightsDestination
parameter must log Insights events and the source event data store specified by theEventDataStore
parameter must log management events.For
UpdateEventDataStore
, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configuredInsightSelectors
. If theInsightSelectors
includes anInsightType
ofApiCallRateInsight
, the source event data store must logwrite
management events. If theInsightSelectors
includes anInsightType
ofApiErrorRateInsight
, the source event data store must log management events. - EventDataStoreHasOngoingImportException This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEventDataStore
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 7 and 3653 if theBillingMode
is set toEXTENDABLE_RETENTION_PRICING
, or between 7 and 2557 ifBillingMode
is set toFIXED_RETENTION_PRICING
. By default,TerminationProtection
is enabled.For event data stores for CloudTrail events,
AdvancedEventSelectors
includes or excludes management or data events in your event data store. For more information aboutAdvancedEventSelectors
, see AdvancedEventSelectors.For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,
AdvancedEventSelectors
includes events of that type in your event data store.
This is a convenience which creates an instance of the
UpdateEventDataStoreRequest.Builder
avoiding the need to create one manually viaUpdateEventDataStoreRequest.builder()
- Parameters:
updateEventDataStoreRequest
- AConsumer
that will call methods onUpdateEventDataStoreRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEventDataStore operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- EventDataStoreAlreadyExistsException An event data store with that name already exists.
- EventDataStoreArnInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
- EventDataStoreNotFoundException The specified event data store was not found.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- InvalidInsightSelectorsException For
PutInsightSelectors
, this exception is thrown when the formatting or syntax of theInsightSelectors
JSON statement is not valid, or the specifiedInsightType
in theInsightSelectors
statement is not valid. Valid values forInsightType
areApiCallRateInsight
andApiErrorRateInsight
. To enable Insights on an event data store, the destination event data store specified by theInsightsDestination
parameter must log Insights events and the source event data store specified by theEventDataStore
parameter must log management events.For
UpdateEventDataStore
, this exception is thrown if Insights are enabled on the event data store and the updated advanced event selectors are not compatible with the configuredInsightSelectors
. If theInsightSelectors
includes anInsightType
ofApiCallRateInsight
, the source event data store must logwrite
management events. If theInsightSelectors
includes anInsightType
ofApiErrorRateInsight
, the source event data store must log management events. - EventDataStoreHasOngoingImportException This exception is thrown when you try to update or delete an event data store that currently has an import in progress.
- InactiveEventDataStoreException The event data store is inactive.
- InvalidParameterException The request includes a parameter that is not valid.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrail
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, anInvalidHomeRegionException
is thrown.- Parameters:
updateTrailRequest
- Specifies settings to update for the trail.- Returns:
- A Java Future containing the result of the UpdateTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientSnsTopicPolicyException This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidSnsTopicNameException This exception is thrown when the provided SNS topic name is not valid.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- TrailNotProvidedException This exception is no longer in use.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- InvalidCloudWatchLogsLogGroupArnException This exception is thrown when the provided CloudWatch Logs log group is not valid.
- InvalidCloudWatchLogsRoleArnException This exception is thrown when the provided role is not valid.
- CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this Region.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- CloudTrailInvalidClientTokenIdException This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account. - InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrail
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, anInvalidHomeRegionException
is thrown.
This is a convenience which creates an instance of the
UpdateTrailRequest.Builder
avoiding the need to create one manually viaUpdateTrailRequest.builder()
- Parameters:
updateTrailRequest
- AConsumer
that will call methods onUpdateTrailRequest.Builder
to create a request. Specifies settings to update for the trail.- Returns:
- A Java Future containing the result of the UpdateTrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
- InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
- InsufficientSnsTopicPolicyException This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
- InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
- TrailNotFoundException This exception is thrown when the trail with the given name is not found.
- InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
- InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
- InvalidSnsTopicNameException This exception is thrown when the provided SNS topic name is not valid.
- InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
- InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail
names must meet the following requirements:
-
Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
-
Start with a letter or number, and end with a letter or number
-
Be between 3 and 128 characters
-
Have no adjacent periods, underscores or dashes. Names like
my-_namespace
andmy--namespace
are not valid. -
Not be in IP address format (for example, 192.168.5.4)
-
- TrailNotProvidedException This exception is no longer in use.
- InvalidEventSelectorsException This exception is thrown when the
PutEventSelectors
operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.You can:
-
Specify a valid number of event selectors (1 to 5) for a trail.
-
Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
-
Specify up to 500 values for all conditions in all advanced event selectors for a trail.
-
Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
-
- CloudTrailArnInvalidException This exception is thrown when an operation is called with an ARN that
is not valid.
The following is the format of a trail ARN:
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
The following is the format of an event data store ARN:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
The following is the format of a channel ARN:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
- ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
- ThrottlingException This exception is thrown when the request rate exceeds the limit.
- InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
- InvalidHomeRegionException This exception is thrown when an operation is called on a trail from a Region other than the Region in which the trail was created.
- KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
- KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
- InvalidCloudWatchLogsLogGroupArnException This exception is thrown when the provided CloudWatch Logs log group is not valid.
- InvalidCloudWatchLogsRoleArnException This exception is thrown when the provided role is not valid.
- CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this Region.
- UnsupportedOperationException This exception is thrown when the requested operation is not supported.
- OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
- CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
- InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
- OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
- NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
- OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
- NoManagementAccountSlrExistsException This exception is thrown when the management account does not have a service-linked role.
- CloudTrailInvalidClientTokenIdException This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account. - InvalidParameterException The request includes a parameter that is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudTrailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudTrailAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudTrailAsyncClient
.
-