@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudTrailAsync extends AWSCloudTrail
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCloudTrailAsync instead.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records 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.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest addTagsRequest,
AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50.
|
Future<CancelQueryResult> |
cancelQueryAsync(CancelQueryRequest cancelQueryRequest)
Cancels a query if the query is not in a terminated state, such as
CANCELLED, FAILED,
TIMED_OUT, or FINISHED. |
Future<CancelQueryResult> |
cancelQueryAsync(CancelQueryRequest cancelQueryRequest,
AsyncHandler<CancelQueryRequest,CancelQueryResult> asyncHandler)
Cancels a query if the query is not in a terminated state, such as
CANCELLED, FAILED,
TIMED_OUT, or FINISHED. |
Future<CreateChannelResult> |
createChannelAsync(CreateChannelRequest createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
Future<CreateChannelResult> |
createChannelAsync(CreateChannelRequest createChannelRequest,
AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
Creates a channel for CloudTrail to ingest events from a partner or external source.
|
Future<CreateEventDataStoreResult> |
createEventDataStoreAsync(CreateEventDataStoreRequest createEventDataStoreRequest)
Creates a new event data store.
|
Future<CreateEventDataStoreResult> |
createEventDataStoreAsync(CreateEventDataStoreRequest createEventDataStoreRequest,
AsyncHandler<CreateEventDataStoreRequest,CreateEventDataStoreResult> asyncHandler)
Creates a new event data store.
|
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest createTrailRequest,
AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
Future<DeleteChannelResult> |
deleteChannelAsync(DeleteChannelRequest deleteChannelRequest)
Deletes a channel.
|
Future<DeleteChannelResult> |
deleteChannelAsync(DeleteChannelRequest deleteChannelRequest,
AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
Deletes a channel.
|
Future<DeleteEventDataStoreResult> |
deleteEventDataStoreAsync(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
Future<DeleteEventDataStoreResult> |
deleteEventDataStoreAsync(DeleteEventDataStoreRequest deleteEventDataStoreRequest,
AsyncHandler<DeleteEventDataStoreRequest,DeleteEventDataStoreResult> asyncHandler)
Disables the event data store specified by
EventDataStore, which accepts an event data store ARN. |
Future<DeleteResourcePolicyResult> |
deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
|
Future<DeleteResourcePolicyResult> |
deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest,
AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
Deletes the resource-based policy attached to the CloudTrail channel.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest,
AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
Deletes a trail.
|
Future<DeregisterOrganizationDelegatedAdminResult> |
deregisterOrganizationDelegatedAdminAsync(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
Future<DeregisterOrganizationDelegatedAdminResult> |
deregisterOrganizationDelegatedAdminAsync(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest,
AsyncHandler<DeregisterOrganizationDelegatedAdminRequest,DeregisterOrganizationDelegatedAdminResult> asyncHandler)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
|
Future<DescribeQueryResult> |
describeQueryAsync(DescribeQueryRequest describeQueryRequest)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status.
|
Future<DescribeQueryResult> |
describeQueryAsync(DescribeQueryRequest describeQueryRequest,
AsyncHandler<DescribeQueryRequest,DescribeQueryResult> asyncHandler)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status.
|
Future<DescribeTrailsResult> |
describeTrailsAsync()
Simplified method form for invoking the DescribeTrails operation.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Simplified method form for invoking the DescribeTrails operation with an AsyncHandler.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest,
AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Retrieves settings for one or more trails associated with the current Region for your account.
|
Future<DisableFederationResult> |
disableFederationAsync(DisableFederationRequest disableFederationRequest)
Disables Lake query federation on the specified event data store.
|
Future<DisableFederationResult> |
disableFederationAsync(DisableFederationRequest disableFederationRequest,
AsyncHandler<DisableFederationRequest,DisableFederationResult> asyncHandler)
Disables Lake query federation on the specified event data store.
|
Future<EnableFederationResult> |
enableFederationAsync(EnableFederationRequest enableFederationRequest)
Enables Lake query federation on the specified event data store.
|
Future<EnableFederationResult> |
enableFederationAsync(EnableFederationRequest enableFederationRequest,
AsyncHandler<EnableFederationRequest,EnableFederationResult> asyncHandler)
Enables Lake query federation on the specified event data store.
|
Future<GetChannelResult> |
getChannelAsync(GetChannelRequest getChannelRequest)
Returns information about a specific channel.
|
Future<GetChannelResult> |
getChannelAsync(GetChannelRequest getChannelRequest,
AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)
Returns information about a specific channel.
|
Future<GetEventDataStoreResult> |
getEventDataStoreAsync(GetEventDataStoreRequest getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
Future<GetEventDataStoreResult> |
getEventDataStoreAsync(GetEventDataStoreRequest getEventDataStoreRequest,
AsyncHandler<GetEventDataStoreRequest,GetEventDataStoreResult> asyncHandler)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
|
Future<GetEventSelectorsResult> |
getEventSelectorsAsync(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail.
|
Future<GetEventSelectorsResult> |
getEventSelectorsAsync(GetEventSelectorsRequest getEventSelectorsRequest,
AsyncHandler<GetEventSelectorsRequest,GetEventSelectorsResult> asyncHandler)
Describes the settings for the event selectors that you configured for your trail.
|
Future<GetImportResult> |
getImportAsync(GetImportRequest getImportRequest)
Returns information about a specific import.
|
Future<GetImportResult> |
getImportAsync(GetImportRequest getImportRequest,
AsyncHandler<GetImportRequest,GetImportResult> asyncHandler)
Returns information about a specific import.
|
Future<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail or event data store.
|
Future<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest,
AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
Describes the settings for the Insights event selectors that you configured for your trail or event data store.
|
Future<GetQueryResultsResult> |
getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query.
|
Future<GetQueryResultsResult> |
getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest,
AsyncHandler<GetQueryResultsRequest,GetQueryResultsResult> asyncHandler)
Gets event data results of a query.
|
Future<GetResourcePolicyResult> |
getResourcePolicyAsync(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
Future<GetResourcePolicyResult> |
getResourcePolicyAsync(GetResourcePolicyRequest getResourcePolicyRequest,
AsyncHandler<GetResourcePolicyRequest,GetResourcePolicyResult> asyncHandler)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
|
Future<GetTrailResult> |
getTrailAsync(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
|
Future<GetTrailResult> |
getTrailAsync(GetTrailRequest getTrailRequest,
AsyncHandler<GetTrailRequest,GetTrailResult> asyncHandler)
Returns settings information for a specified trail.
|
Future<GetTrailStatusResult> |
getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail.
|
Future<GetTrailStatusResult> |
getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest,
AsyncHandler<GetTrailStatusRequest,GetTrailStatusResult> asyncHandler)
Returns a JSON-formatted list of information about the specified trail.
|
Future<ListChannelsResult> |
listChannelsAsync(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
|
Future<ListChannelsResult> |
listChannelsAsync(ListChannelsRequest listChannelsRequest,
AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
Lists the channels in the current account, and their source names.
|
Future<ListEventDataStoresResult> |
listEventDataStoresAsync(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
|
Future<ListEventDataStoresResult> |
listEventDataStoresAsync(ListEventDataStoresRequest listEventDataStoresRequest,
AsyncHandler<ListEventDataStoresRequest,ListEventDataStoresResult> asyncHandler)
Returns information about all event data stores in the account, in the current Region.
|
Future<ListImportFailuresResult> |
listImportFailuresAsync(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
|
Future<ListImportFailuresResult> |
listImportFailuresAsync(ListImportFailuresRequest listImportFailuresRequest,
AsyncHandler<ListImportFailuresRequest,ListImportFailuresResult> asyncHandler)
Returns a list of failures for the specified import.
|
Future<ListImportsResult> |
listImportsAsync(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
Future<ListImportsResult> |
listImportsAsync(ListImportsRequest listImportsRequest,
AsyncHandler<ListImportsRequest,ListImportsResult> asyncHandler)
Returns information on all imports, or a select set of imports by
ImportStatus or
Destination. |
Future<ListInsightsMetricDataResult> |
listInsightsMetricDataAsync(ListInsightsMetricDataRequest listInsightsMetricDataRequest)
Returns Insights metrics data for trails that have enabled Insights.
|
Future<ListInsightsMetricDataResult> |
listInsightsMetricDataAsync(ListInsightsMetricDataRequest listInsightsMetricDataRequest,
AsyncHandler<ListInsightsMetricDataRequest,ListInsightsMetricDataResult> asyncHandler)
Returns Insights metrics data for trails that have enabled Insights.
|
Future<ListPublicKeysResult> |
listPublicKeysAsync()
Simplified method form for invoking the ListPublicKeys operation.
|
Future<ListPublicKeysResult> |
listPublicKeysAsync(AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
Simplified method form for invoking the ListPublicKeys operation with an AsyncHandler.
|
Future<ListPublicKeysResult> |
listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
Future<ListPublicKeysResult> |
listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest,
AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
Future<ListQueriesResult> |
listQueriesAsync(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days.
|
Future<ListQueriesResult> |
listQueriesAsync(ListQueriesRequest listQueriesRequest,
AsyncHandler<ListQueriesRequest,ListQueriesResult> asyncHandler)
Returns a list of queries and query statuses for the past seven days.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest listTagsRequest,
AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
|
Future<ListTrailsResult> |
listTrailsAsync(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
|
Future<ListTrailsResult> |
listTrailsAsync(ListTrailsRequest listTrailsRequest,
AsyncHandler<ListTrailsRequest,ListTrailsResult> asyncHandler)
Lists trails that are in the current account.
|
Future<LookupEventsResult> |
lookupEventsAsync()
Simplified method form for invoking the LookupEvents operation.
|
Future<LookupEventsResult> |
lookupEventsAsync(AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
Simplified method form for invoking the LookupEvents operation with an AsyncHandler.
|
Future<LookupEventsResult> |
lookupEventsAsync(LookupEventsRequest lookupEventsRequest)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
Future<LookupEventsResult> |
lookupEventsAsync(LookupEventsRequest lookupEventsRequest,
AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
Future<PutEventSelectorsResult> |
putEventSelectorsAsync(PutEventSelectorsRequest putEventSelectorsRequest)
Configures an event selector or advanced event selectors for your trail.
|
Future<PutEventSelectorsResult> |
putEventSelectorsAsync(PutEventSelectorsRequest putEventSelectorsRequest,
AsyncHandler<PutEventSelectorsRequest,PutEventSelectorsResult> asyncHandler)
Configures an event selector or advanced event selectors for your trail.
|
Future<PutInsightSelectorsResult> |
putInsightSelectorsAsync(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.
|
Future<PutInsightSelectorsResult> |
putInsightSelectorsAsync(PutInsightSelectorsRequest putInsightSelectorsRequest,
AsyncHandler<PutInsightSelectorsRequest,PutInsightSelectorsResult> asyncHandler)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail or event data store.
|
Future<PutResourcePolicyResult> |
putResourcePolicyAsync(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.
|
Future<PutResourcePolicyResult> |
putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest,
AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
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.
|
Future<RegisterOrganizationDelegatedAdminResult> |
registerOrganizationDelegatedAdminAsync(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
Future<RegisterOrganizationDelegatedAdminResult> |
registerOrganizationDelegatedAdminAsync(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest,
AsyncHandler<RegisterOrganizationDelegatedAdminRequest,RegisterOrganizationDelegatedAdminResult> asyncHandler)
Registers an organization’s member account as the CloudTrail delegated administrator.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest,
AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes the specified tags from a trail, event data store, or channel.
|
Future<RestoreEventDataStoreResult> |
restoreEventDataStoreAsync(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
Future<RestoreEventDataStoreResult> |
restoreEventDataStoreAsync(RestoreEventDataStoreRequest restoreEventDataStoreRequest,
AsyncHandler<RestoreEventDataStoreRequest,RestoreEventDataStoreResult> asyncHandler)
Restores a deleted event data store specified by
EventDataStore, which accepts an event data store
ARN. |
Future<StartEventDataStoreIngestionResult> |
startEventDataStoreIngestionAsync(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.
|
Future<StartEventDataStoreIngestionResult> |
startEventDataStoreIngestionAsync(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest,
AsyncHandler<StartEventDataStoreIngestionRequest,StartEventDataStoreIngestionResult> asyncHandler)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
Future<StartImportResult> |
startImportAsync(StartImportRequest startImportRequest)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
Future<StartImportResult> |
startImportAsync(StartImportRequest startImportRequest,
AsyncHandler<StartImportRequest,StartImportResult> asyncHandler)
Starts an import of logged trail events from a source S3 bucket to a destination event data store.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest startLoggingRequest,
AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
Future<StartQueryResult> |
startQueryAsync(StartQueryRequest startQueryRequest)
Starts a CloudTrail Lake query.
|
Future<StartQueryResult> |
startQueryAsync(StartQueryRequest startQueryRequest,
AsyncHandler<StartQueryRequest,StartQueryResult> asyncHandler)
Starts a CloudTrail Lake query.
|
Future<StopEventDataStoreIngestionResult> |
stopEventDataStoreIngestionAsync(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.
|
Future<StopEventDataStoreIngestionResult> |
stopEventDataStoreIngestionAsync(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest,
AsyncHandler<StopEventDataStoreIngestionRequest,StopEventDataStoreIngestionResult> asyncHandler)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN.
|
Future<StopImportResult> |
stopImportAsync(StopImportRequest stopImportRequest)
Stops a specified import.
|
Future<StopImportResult> |
stopImportAsync(StopImportRequest stopImportRequest,
AsyncHandler<StopImportRequest,StopImportResult> asyncHandler)
Stops a specified import.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest stopLoggingRequest,
AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
Future<UpdateChannelResult> |
updateChannelAsync(UpdateChannelRequest updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
|
Future<UpdateChannelResult> |
updateChannelAsync(UpdateChannelRequest updateChannelRequest,
AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
Updates a channel specified by a required channel ARN or UUID.
|
Future<UpdateEventDataStoreResult> |
updateEventDataStoreAsync(UpdateEventDataStoreRequest updateEventDataStoreRequest)
Updates an event data store.
|
Future<UpdateEventDataStoreResult> |
updateEventDataStoreAsync(UpdateEventDataStoreRequest updateEventDataStoreRequest,
AsyncHandler<UpdateEventDataStoreRequest,UpdateEventDataStoreResult> asyncHandler)
Updates an event data store.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest updateTrailRequest)
Updates trail settings that control what events you are logging, and how to handle log files.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest updateTrailRequest,
AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler)
Updates trail settings that control what events you are logging, and how to handle log files.
|
addTags, cancelQuery, createChannel, createEventDataStore, createTrail, deleteChannel, deleteEventDataStore, deleteResourcePolicy, deleteTrail, deregisterOrganizationDelegatedAdmin, describeQuery, describeTrails, describeTrails, disableFederation, enableFederation, getCachedResponseMetadata, getChannel, getEventDataStore, getEventSelectors, getImport, getInsightSelectors, getQueryResults, getResourcePolicy, getTrail, getTrailStatus, listChannels, listEventDataStores, listImportFailures, listImports, listInsightsMetricData, listPublicKeys, listPublicKeys, listQueries, listTags, listTrails, lookupEvents, lookupEvents, putEventSelectors, putInsightSelectors, putResourcePolicy, registerOrganizationDelegatedAdmin, removeTags, restoreEventDataStore, setEndpoint, setRegion, shutdown, startEventDataStoreIngestion, startImport, startLogging, startQuery, stopEventDataStoreIngestion, stopImport, stopLogging, updateChannel, updateEventDataStore, updateTrailFuture<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).
addTagsRequest - Specifies the tags to add to a trail, event data store, or channel.Future<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds one or more tags to a trail, event data store, or channel, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home Region).
addTagsRequest - Specifies the tags to add to a trail, event data store, or channel.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelQueryResult> cancelQueryAsync(CancelQueryRequest cancelQueryRequest)
Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED,
TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore.
The ID of the query that you want to cancel is also required. When you run CancelQuery, the query
status might show as CANCELLED even if the operation is not yet finished.
cancelQueryRequest - Future<CancelQueryResult> cancelQueryAsync(CancelQueryRequest cancelQueryRequest, AsyncHandler<CancelQueryRequest,CancelQueryResult> asyncHandler)
Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED,
TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore.
The ID of the query that you want to cancel is also required. When you run CancelQuery, the query
status might show as CANCELLED even if the operation is not yet finished.
cancelQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest)
Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
createChannelRequest - Future<CreateChannelResult> createChannelAsync(CreateChannelRequest createChannelRequest, AsyncHandler<CreateChannelRequest,CreateChannelResult> asyncHandler)
Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
createChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateEventDataStoreResult> createEventDataStoreAsync(CreateEventDataStoreRequest createEventDataStoreRequest)
Creates a new event data store.
createEventDataStoreRequest - Future<CreateEventDataStoreResult> createEventDataStoreAsync(CreateEventDataStoreRequest createEventDataStoreRequest, AsyncHandler<CreateEventDataStoreRequest,CreateEventDataStoreResult> asyncHandler)
Creates a new event data store.
createEventDataStoreRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTrailResult> createTrailAsync(CreateTrailRequest createTrailRequest)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailRequest - Specifies the settings for each trail.Future<CreateTrailResult> createTrailAsync(CreateTrailRequest createTrailRequest, AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailRequest - Specifies the settings for each trail.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest)
Deletes a channel.
deleteChannelRequest - Future<DeleteChannelResult> deleteChannelAsync(DeleteChannelRequest deleteChannelRequest, AsyncHandler<DeleteChannelRequest,DeleteChannelResult> asyncHandler)
Deletes a channel.
deleteChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteEventDataStoreResult> deleteEventDataStoreAsync(DeleteEventDataStoreRequest deleteEventDataStoreRequest)
Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION
state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled
must be set to False on the event data store and the FederationStatus must be
DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is
True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
DescribeQuery, or GetQueryResults on queries that are using an event data store in a
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not
incur costs.
deleteEventDataStoreRequest - Future<DeleteEventDataStoreResult> deleteEventDataStoreAsync(DeleteEventDataStoreRequest deleteEventDataStoreRequest, AsyncHandler<DeleteEventDataStoreRequest,DeleteEventDataStoreResult> asyncHandler)
Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION
state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled
must be set to False on the event data store and the FederationStatus must be
DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is
True or the FederationStatus is ENABLED.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
DescribeQuery, or GetQueryResults on queries that are using an event data store in a
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not
incur costs.
deleteEventDataStoreRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource-based policy attached to the CloudTrail channel.
deleteResourcePolicyRequest - Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest deleteResourcePolicyRequest, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
Deletes the resource-based policy attached to the CloudTrail channel.
deleteResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest)
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
deleteTrailRequest - The request that specifies the name of a trail to delete.Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest, AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail
that is enabled in all Regions.
deleteTrailRequest - The request that specifies the name of a trail to delete.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterOrganizationDelegatedAdminResult> deregisterOrganizationDelegatedAdminAsync(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
deregisterOrganizationDelegatedAdminRequest - Removes CloudTrail delegated administrator permissions from a specified member account in an organization
that is currently designated as a delegated administrator.Future<DeregisterOrganizationDelegatedAdminResult> deregisterOrganizationDelegatedAdminAsync(DeregisterOrganizationDelegatedAdminRequest deregisterOrganizationDelegatedAdminRequest, AsyncHandler<DeregisterOrganizationDelegatedAdminRequest,DeregisterOrganizationDelegatedAdminResult> asyncHandler)
Removes CloudTrail delegated administrator permissions from a member account in an organization.
deregisterOrganizationDelegatedAdminRequest - Removes CloudTrail delegated administrator permissions from a specified member account in an organization
that is currently designated as a delegated administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeQueryResult> describeQueryAsync(DescribeQueryRequest describeQueryRequest)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
You must specify either a QueryID or a QueryAlias. Specifying the
QueryAlias parameter returns information about the last query run for the alias.
describeQueryRequest - Future<DescribeQueryResult> describeQueryAsync(DescribeQueryRequest describeQueryRequest, AsyncHandler<DescribeQueryRequest,DescribeQueryResult> asyncHandler)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.
You must specify either a QueryID or a QueryAlias. Specifying the
QueryAlias parameter returns information about the last query run for the alias.
describeQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest)
Retrieves settings for one or more trails associated with the current Region for your account.
describeTrailsRequest - Returns information about the trail.Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest, AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Retrieves settings for one or more trails associated with the current Region for your account.
describeTrailsRequest - Returns information about the trail.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrailsResult> describeTrailsAsync()
Future<DescribeTrailsResult> describeTrailsAsync(AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Future<DisableFederationResult> disableFederationAsync(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.
disableFederationRequest - Future<DisableFederationResult> disableFederationAsync(DisableFederationRequest disableFederationRequest, AsyncHandler<DisableFederationRequest,DisableFederationResult> asyncHandler)
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.
disableFederationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableFederationResult> enableFederationAsync(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.
enableFederationRequest - Future<EnableFederationResult> enableFederationAsync(EnableFederationRequest enableFederationRequest, AsyncHandler<EnableFederationRequest,EnableFederationResult> asyncHandler)
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.
enableFederationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChannelResult> getChannelAsync(GetChannelRequest getChannelRequest)
Returns information about a specific channel.
getChannelRequest - Future<GetChannelResult> getChannelAsync(GetChannelRequest getChannelRequest, AsyncHandler<GetChannelRequest,GetChannelResult> asyncHandler)
Returns information about a specific channel.
getChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEventDataStoreResult> getEventDataStoreAsync(GetEventDataStoreRequest getEventDataStoreRequest)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
getEventDataStoreRequest - Future<GetEventDataStoreResult> getEventDataStoreAsync(GetEventDataStoreRequest getEventDataStoreRequest, AsyncHandler<GetEventDataStoreRequest,GetEventDataStoreResult> asyncHandler)
Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
getEventDataStoreRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEventSelectorsResult> getEventSelectorsAsync(GetEventSelectorsRequest getEventSelectorsRequest)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management and data events, see the following topics in the CloudTrail User Guide:
getEventSelectorsRequest - Future<GetEventSelectorsResult> getEventSelectorsAsync(GetEventSelectorsRequest getEventSelectorsRequest, AsyncHandler<GetEventSelectorsRequest,GetEventSelectorsResult> asyncHandler)
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management and data events, see the following topics in the CloudTrail User Guide:
getEventSelectorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetImportResult> getImportAsync(GetImportRequest getImportRequest)
Returns information about a specific import.
getImportRequest - Future<GetImportResult> getImportAsync(GetImportRequest getImportRequest, AsyncHandler<GetImportRequest,GetImportResult> asyncHandler)
Returns information about a specific import.
getImportRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetInsightSelectorsResult> getInsightSelectorsAsync(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 run GetInsightSelectors on a trail or
event data store that does not have Insights events enabled, the operation throws the exception
InsightNotEnabledException
Specify either the EventDataStore parameter to get Insights event selectors for an event data store,
or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these
parameters together.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
getInsightSelectorsRequest - Future<GetInsightSelectorsResult> getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest, AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
Describes the settings for the Insights event selectors that you configured for your trail or event data store.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail or event data
store, and if it is, which Insights types are enabled. If you run GetInsightSelectors on a trail or
event data store that does not have Insights events enabled, the operation throws the exception
InsightNotEnabledException
Specify either the EventDataStore parameter to get Insights event selectors for an event data store,
or the TrailName parameter to the get Insights event selectors for a trail. You cannot specify these
parameters together.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
getInsightSelectorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest)
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
getQueryResultsRequest - Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest, AsyncHandler<GetQueryResultsRequest,GetQueryResultsResult> asyncHandler)
Gets event data results of a query. You must specify the QueryID value returned by the
StartQuery operation.
getQueryResultsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourcePolicyResult> getResourcePolicyAsync(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
getResourcePolicyRequest - Future<GetResourcePolicyResult> getResourcePolicyAsync(GetResourcePolicyRequest getResourcePolicyRequest, AsyncHandler<GetResourcePolicyRequest,GetResourcePolicyResult> asyncHandler)
Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel.
getResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTrailResult> getTrailAsync(GetTrailRequest getTrailRequest)
Returns settings information for a specified trail.
getTrailRequest - Future<GetTrailResult> getTrailAsync(GetTrailRequest getTrailRequest, AsyncHandler<GetTrailRequest,GetTrailResult> asyncHandler)
Returns settings information for a specified trail.
getTrailRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest)
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
getTrailStatusRequest - The name of a trail about which you want the current status.Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest, AsyncHandler<GetTrailStatusRequest,GetTrailStatusResult> asyncHandler)
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.
getTrailStatusRequest - The name of a trail about which you want the current status.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest)
Lists the channels in the current account, and their source names.
listChannelsRequest - Future<ListChannelsResult> listChannelsAsync(ListChannelsRequest listChannelsRequest, AsyncHandler<ListChannelsRequest,ListChannelsResult> asyncHandler)
Lists the channels in the current account, and their source names.
listChannelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEventDataStoresResult> listEventDataStoresAsync(ListEventDataStoresRequest listEventDataStoresRequest)
Returns information about all event data stores in the account, in the current Region.
listEventDataStoresRequest - Future<ListEventDataStoresResult> listEventDataStoresAsync(ListEventDataStoresRequest listEventDataStoresRequest, AsyncHandler<ListEventDataStoresRequest,ListEventDataStoresResult> asyncHandler)
Returns information about all event data stores in the account, in the current Region.
listEventDataStoresRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImportFailuresResult> listImportFailuresAsync(ListImportFailuresRequest listImportFailuresRequest)
Returns a list of failures for the specified import.
listImportFailuresRequest - Future<ListImportFailuresResult> listImportFailuresAsync(ListImportFailuresRequest listImportFailuresRequest, AsyncHandler<ListImportFailuresRequest,ListImportFailuresResult> asyncHandler)
Returns a list of failures for the specified import.
listImportFailuresRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImportsResult> listImportsAsync(ListImportsRequest listImportsRequest)
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
listImportsRequest - Future<ListImportsResult> listImportsAsync(ListImportsRequest listImportsRequest, AsyncHandler<ListImportsRequest,ListImportsResult> asyncHandler)
Returns information on all imports, or a select set of imports by ImportStatus or
Destination.
listImportsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListInsightsMetricDataResult> listInsightsMetricDataAsync(ListInsightsMetricDataRequest listInsightsMetricDataRequest)
Returns Insights metrics data for trails that have enabled Insights. The request must include the
EventSource, EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the
ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the ListInsightsMetricData API operation is linked to the
cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the
cloudtrail:LookupEvents action.
listInsightsMetricDataRequest - Future<ListInsightsMetricDataResult> listInsightsMetricDataAsync(ListInsightsMetricDataRequest listInsightsMetricDataRequest, AsyncHandler<ListInsightsMetricDataRequest,ListInsightsMetricDataResult> asyncHandler)
Returns Insights metrics data for trails that have enabled Insights. The request must include the
EventSource, EventName, and InsightType parameters.
If the InsightType is set to ApiErrorRateInsight, the request must also include the
ErrorCode parameter.
The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 90 days.
Access to the ListInsightsMetricData API operation is linked to the
cloudtrail:LookupEvents action. To use this operation, you must have permissions to perform the
cloudtrail:LookupEvents action.
listInsightsMetricDataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific Region, you must look in the same Region for its corresponding public key.
listPublicKeysRequest - Requests the public keys for a specified time range.Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest listPublicKeysRequest, AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific Region, you must look in the same Region for its corresponding public key.
listPublicKeysRequest - Requests the public keys for a specified time range.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPublicKeysResult> listPublicKeysAsync()
Future<ListPublicKeysResult> listPublicKeysAsync(AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
Future<ListQueriesResult> listQueriesAsync(ListQueriesRequest listQueriesRequest)
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for
EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted
as timestamps, by adding StartTime and EndTime parameters, and a
QueryStatus value. Valid values for QueryStatus include QUEUED,
RUNNING, FINISHED, FAILED, TIMED_OUT, or
CANCELLED.
listQueriesRequest - Future<ListQueriesResult> listQueriesAsync(ListQueriesRequest listQueriesRequest, AsyncHandler<ListQueriesRequest,ListQueriesResult> asyncHandler)
Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for
EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted
as timestamps, by adding StartTime and EndTime parameters, and a
QueryStatus value. Valid values for QueryStatus include QUEUED,
RUNNING, FINISHED, FAILED, TIMED_OUT, or
CANCELLED.
listQueriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
listTagsRequest - Specifies a list of tags to return.Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists the tags for the specified trails, event data stores, or channels in the current Region.
listTagsRequest - Specifies a list of tags to return.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTrailsResult> listTrailsAsync(ListTrailsRequest listTrailsRequest)
Lists trails that are in the current account.
listTrailsRequest - Future<ListTrailsResult> listTrailsAsync(ListTrailsRequest listTrailsRequest, AsyncHandler<ListTrailsRequest,ListTrailsResult> asyncHandler)
Lists trails that are in the current account.
listTrailsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<LookupEventsResult> lookupEventsAsync(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.
lookupEventsRequest - Contains a request for LookupEvents.Future<LookupEventsResult> lookupEventsAsync(LookupEventsRequest lookupEventsRequest, AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
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.
lookupEventsRequest - Contains a request for LookupEvents.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<LookupEventsResult> lookupEventsAsync()
lookupEventsAsync(LookupEventsRequest)Future<LookupEventsResult> lookupEventsAsync(AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
Future<PutEventSelectorsResult> putEventSelectorsAsync(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 in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't
log the event.
The PutEventSelectors operation must be called from the Region in which the trail was created;
otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data events in the CloudTrail User Guide.
putEventSelectorsRequest - Future<PutEventSelectorsResult> putEventSelectorsAsync(PutEventSelectorsRequest putEventSelectorsRequest, AsyncHandler<PutEventSelectorsRequest,PutEventSelectorsResult> asyncHandler)
Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't
log the event.
The PutEventSelectors operation must be called from the Region in which the trail was created;
otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500
values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or
EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any
existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging
data events in the CloudTrail User Guide.
putEventSelectorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutInsightSelectorsResult> putInsightSelectorsAsync(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 are
ApiErrorRateInsight and ApiCallRateInsight.
To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source
event data store (EventDataStore) and the destination event data store (
InsightsDestination). The source event data store logs management events and enables Insights. The
destination event data store logs Insights events based upon the management event activity of the source event
data store. The source and destination event data stores must belong to the same Amazon Web Services account.
To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail
for which you want to change or add Insights selectors.
To log CloudTrail Insights events on API call volume, the trail or event data store must log write
management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log
read or write management events. You can call GetEventSelectors on a trail
to check whether the trail logs management events. You can call GetEventDataStore on an event data
store to check whether the event data store logs management events.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
putInsightSelectorsRequest - Future<PutInsightSelectorsResult> putInsightSelectorsAsync(PutInsightSelectorsRequest putInsightSelectorsRequest, AsyncHandler<PutInsightSelectorsRequest,PutInsightSelectorsResult> asyncHandler)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail or event data store. You also use PutInsightSelectors to turn off Insights event
logging, by passing an empty list of Insights types. The valid Insights event types are
ApiErrorRateInsight and ApiCallRateInsight.
To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source
event data store (EventDataStore) and the destination event data store (
InsightsDestination). The source event data store logs management events and enables Insights. The
destination event data store logs Insights events based upon the management event activity of the source event
data store. The source and destination event data stores must belong to the same Amazon Web Services account.
To log Insights events for a trail, you must specify the name (TrailName) of the CloudTrail trail
for which you want to change or add Insights selectors.
To log CloudTrail Insights events on API call volume, the trail or event data store must log write
management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log
read or write management events. You can call GetEventSelectors on a trail
to check whether the trail logs management events. You can call GetEventDataStore on an event data
store to check whether the event data store logs management events.
For more information, see Logging CloudTrail Insights events in the CloudTrail User Guide.
putInsightSelectorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest)
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
putResourcePolicyRequest - Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest putResourcePolicyRequest, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
putResourcePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterOrganizationDelegatedAdminResult> registerOrganizationDelegatedAdminAsync(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest)
Registers an organization’s member account as the CloudTrail delegated administrator.
registerOrganizationDelegatedAdminRequest - Specifies an organization member account ID as a CloudTrail delegated administrator.Future<RegisterOrganizationDelegatedAdminResult> registerOrganizationDelegatedAdminAsync(RegisterOrganizationDelegatedAdminRequest registerOrganizationDelegatedAdminRequest, AsyncHandler<RegisterOrganizationDelegatedAdminRequest,RegisterOrganizationDelegatedAdminResult> asyncHandler)
Registers an organization’s member account as the CloudTrail delegated administrator.
registerOrganizationDelegatedAdminRequest - Specifies an organization member account ID as a CloudTrail delegated administrator.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail, event data store, or channel.
removeTagsRequest - Specifies the tags to remove from a trail, event data store, or channel.Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes the specified tags from a trail, event data store, or channel.
removeTagsRequest - Specifies the tags to remove from a trail, event data store, or channel.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RestoreEventDataStoreResult> restoreEventDataStoreAsync(RestoreEventDataStoreRequest restoreEventDataStoreRequest)
Restores a deleted event data store specified by EventDataStore, which accepts an event data store
ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring
an event data store can take several minutes, depending on the size of the event data store.
restoreEventDataStoreRequest - Future<RestoreEventDataStoreResult> restoreEventDataStoreAsync(RestoreEventDataStoreRequest restoreEventDataStoreRequest, AsyncHandler<RestoreEventDataStoreRequest,RestoreEventDataStoreResult> asyncHandler)
Restores a deleted event data store specified by EventDataStore, which accepts an event data store
ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring
an event data store can take several minutes, depending on the size of the event data store.
restoreEventDataStoreRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartEventDataStoreIngestionResult> startEventDataStoreIngestionAsync(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the
eventCategory must be Management, Data, or ConfigurationItem.
startEventDataStoreIngestionRequest - Future<StartEventDataStoreIngestionResult> startEventDataStoreIngestionAsync(StartEventDataStoreIngestionRequest startEventDataStoreIngestionRequest, AsyncHandler<StartEventDataStoreIngestionRequest,StartEventDataStoreIngestionResult> asyncHandler)
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the
eventCategory must be Management, Data, or ConfigurationItem.
startEventDataStoreIngestionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartImportResult> startImportAsync(StartImportRequest startImportRequest)
Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default,
CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes
inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If
you want to import CloudTrail events contained in another prefix, you must include the prefix in the
S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and ImportSource parameters are required.
Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more
information about disabling ACLs, see Controlling ownership of
objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization.
startImportRequest - Future<StartImportResult> startImportAsync(StartImportRequest startImportRequest, AsyncHandler<StartImportRequest,StartImportResult> asyncHandler)
Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default,
CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes
inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If
you want to import CloudTrail events contained in another prefix, you must include the prefix in the
S3LocationUri. For more considerations about importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.
When you start a new import, the Destinations and ImportSource parameters are required.
Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more
information about disabling ACLs, see Controlling ownership of
objects and disabling ACLs for your bucket.
When you retry an import, the ImportID parameter is required.
If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization.
startImportRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest startLoggingRequest)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
startLoggingRequest - The request to CloudTrail to start logging Amazon Web Services API calls for an account.Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest startLoggingRequest, AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.
startLoggingRequest - The request to CloudTrail to start logging Amazon Web Services API calls for an account.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartQueryResult> startQueryAsync(StartQueryRequest startQueryRequest)
Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed
in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to
an S3 bucket.
StartQuery requires you specify either the QueryStatement parameter, or a
QueryAlias and any QueryParameters. In the current release, the QueryAlias
and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake
dashboards.
startQueryRequest - Future<StartQueryResult> startQueryAsync(StartQueryRequest startQueryRequest, AsyncHandler<StartQueryRequest,StartQueryResult> asyncHandler)
Starts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed
in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to
an S3 bucket.
StartQuery requires you specify either the QueryStatement parameter, or a
QueryAlias and any QueryParameters. In the current release, the QueryAlias
and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake
dashboards.
startQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopEventDataStoreIngestionResult> stopEventDataStoreIngestionAsync(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To stop ingestion, the event data store Status must be ENABLED and the
eventCategory must be Management, Data, or ConfigurationItem.
stopEventDataStoreIngestionRequest - Future<StopEventDataStoreIngestionResult> stopEventDataStoreIngestionAsync(StopEventDataStoreIngestionRequest stopEventDataStoreIngestionRequest, AsyncHandler<StopEventDataStoreIngestionRequest,StopEventDataStoreIngestionResult> asyncHandler)
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the
ARN. To stop ingestion, the event data store Status must be ENABLED and the
eventCategory must be Management, Data, or ConfigurationItem.
stopEventDataStoreIngestionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopImportResult> stopImportAsync(StopImportRequest stopImportRequest)
Stops a specified import.
stopImportRequest - Future<StopImportResult> stopImportAsync(StopImportRequest stopImportRequest, AsyncHandler<StopImportRequest,StopImportResult> asyncHandler)
Stops a specified import.
stopImportRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest stopLoggingRequest)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most
circumstances, there is no need to use this action. You can update a trail without stopping it first. This action
is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the
Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation
cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.
stopLoggingRequest - Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest stopLoggingRequest, AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most
circumstances, there is no need to use this action. You can update a trail without stopping it first. This action
is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the
Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation
cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.
stopLoggingRequest - Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest)
Updates a channel specified by a required channel ARN or UUID.
updateChannelRequest - Future<UpdateChannelResult> updateChannelAsync(UpdateChannelRequest updateChannelRequest, AsyncHandler<UpdateChannelRequest,UpdateChannelResult> asyncHandler)
Updates a channel specified by a required channel ARN or UUID.
updateChannelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateEventDataStoreResult> updateEventDataStoreAsync(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 the
BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if
BillingMode is set to FIXED_RETENTION_PRICING. By default,
TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management
or data events in your event data store. For more information about AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or
non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event
data store.
updateEventDataStoreRequest - Future<UpdateEventDataStoreResult> updateEventDataStoreAsync(UpdateEventDataStoreRequest updateEventDataStoreRequest, AsyncHandler<UpdateEventDataStoreRequest,UpdateEventDataStoreResult> asyncHandler)
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the
ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws
an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the
BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if
BillingMode is set to FIXED_RETENTION_PRICING. By default,
TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management
or data events in your event data store. For more information about AdvancedEventSelectors, see
AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or
non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event
data store.
updateEventDataStoreRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest updateTrailRequest)
Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail
do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery.
If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the
bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an
InvalidHomeRegionException is thrown.
updateTrailRequest - Specifies settings to update for the trail.Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest updateTrailRequest, AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler)
Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail
do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery.
If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the
bucket. UpdateTrail must be called from the Region in which the trail was created; otherwise, an
InvalidHomeRegionException is thrown.
updateTrailRequest - Specifies settings to update for the trail.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2025. All rights reserved.