@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, up to a limit of 50.
|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest addTagsRequest,
AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds one or more tags to a trail, 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<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<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<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest,
AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
Deletes a trail.
|
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<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<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
|
Future<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest,
AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
Describes the settings for the Insights event selectors that you configured for your trail.
|
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<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<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<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 trail in the current region.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest listTagsRequest,
AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists the tags for the trail 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.
|
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.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest removeTagsRequest,
AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes the specified tags from a trail.
|
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<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<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<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, createEventDataStore, createTrail, deleteEventDataStore, deleteTrail, describeQuery, describeTrails, describeTrails, getCachedResponseMetadata, getEventDataStore, getEventSelectors, getInsightSelectors, getQueryResults, getTrail, getTrailStatus, listEventDataStores, listPublicKeys, listPublicKeys, listQueries, listTags, listTrails, lookupEvents, lookupEvents, putEventSelectors, putInsightSelectors, removeTags, restoreEventDataStore, setEndpoint, setRegion, shutdown, startLogging, startQuery, stopLogging, updateEventDataStore, updateTrailFuture<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest)
Adds one or more tags to a trail, 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 for a trail; 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 that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).
addTagsRequest - Specifies the tags to add to a trail.Future<AddTagsResult> addTagsAsync(AddTagsRequest addTagsRequest, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds one or more tags to a trail, 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 for a trail; 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 that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).
addTagsRequest - Specifies the tags to add to a 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<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<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<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; this operation cannot work if
TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
DescribeQuery, or GetQueryResults on queries that are using an event data store in a
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not
incur costs.
deleteEventDataStoreRequest - 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; this operation cannot work if
TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
DescribeQuery, or GetQueryResults on queries that are using an event data store in a
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not
incur costs.
deleteEventDataStoreRequest - 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<DescribeQueryResult> describeQueryAsync(DescribeQueryRequest describeQueryRequest)
Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched,
and query status. You must specify an ARN for EventDataStore, and a value for QueryID.
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. You must specify an ARN for EventDataStore, and a value for QueryID.
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<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, see Logging Data and Management Events for Trails 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, see Logging Data and Management Events for Trails 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<GetInsightSelectorsResult> getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest)
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
getInsightSelectorsRequest - Future<GetInsightSelectorsResult> getInsightSelectorsAsync(GetInsightSelectorsRequest getInsightSelectorsRequest, AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
Describes the settings for the Insights event selectors that you configured for your trail.
GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it
is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have
Insights events enabled, the operation throws the exception InsightNotEnabledException
For more information, see Logging CloudTrail Insights Events for Trails in the CloudTrail User Guide.
getInsightSelectorsRequest - 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, and an ARN for EventDataStore.
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, and an ARN for EventDataStore.
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<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<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<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 trail in the current region.
listTagsRequest - Specifies a list of trail tags to return.Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists the tags for the trail in the current region.
listTagsRequest - Specifies a list of trail 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. 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. 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. 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 data and management events for trails 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 for trails 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. 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 data and management events for trails 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 for trails 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. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
and ApiCallRateInsight.
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. You also use PutInsightSelectors to turn off Insights event logging, by passing an
empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight
and ApiCallRateInsight.
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<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest)
Removes the specified tags from a trail.
removeTagsRequest - Specifies the tags to remove from a trail.Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest removeTagsRequest, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes the specified tags from a trail.
removeTagsRequest - Specifies the tags to remove from a 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<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<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. The required QueryStatement parameter provides your SQL query,
enclosed in single quotation marks.
startQueryRequest - Future<StartQueryResult> startQueryAsync(StartQueryRequest startQueryRequest, AsyncHandler<StartQueryRequest,StartQueryResult> asyncHandler)
Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query,
enclosed in single quotation marks.
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<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<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 90 and 2555. By default,
TerminationProtection is enabled. AdvancedEventSelectors includes or excludes
management and data events in your event data store; for more information about
AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.
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 90 and 2555. By default,
TerminationProtection is enabled. AdvancedEventSelectors includes or excludes
management and data events in your event data store; for more information about
AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.
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.