@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudTrailAsyncClient extends AWSCloudTrailClient implements AWSCloudTrailAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSCloudTrailAsyncClient()
Deprecated.
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSCloudTrailAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest request)
Adds one or more tags to a trail, up to a limit of 50.
|
Future<AddTagsResult> |
addTagsAsync(AddTagsRequest request,
AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds one or more tags to a trail, up to a limit of 50.
|
static AWSCloudTrailAsyncClientBuilder |
asyncBuilder() |
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest request)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest request,
AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler)
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest request)
Deletes a trail.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest request,
AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
Deletes a trail.
|
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 request)
Retrieves settings for one or more trails associated with the current region for your account.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(DescribeTrailsRequest request,
AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Retrieves settings for one or more trails associated with the current region for your account.
|
Future<GetEventSelectorsResult> |
getEventSelectorsAsync(GetEventSelectorsRequest request)
Describes the settings for the event selectors that you configured for your trail.
|
Future<GetEventSelectorsResult> |
getEventSelectorsAsync(GetEventSelectorsRequest request,
AsyncHandler<GetEventSelectorsRequest,GetEventSelectorsResult> asyncHandler)
Describes the settings for the event selectors that you configured for your trail.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest request)
Describes the settings for the Insights event selectors that you configured for your trail.
|
Future<GetInsightSelectorsResult> |
getInsightSelectorsAsync(GetInsightSelectorsRequest request,
AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
Describes the settings for the Insights event selectors that you configured for your trail.
|
Future<GetTrailResult> |
getTrailAsync(GetTrailRequest request)
Returns settings information for a specified trail.
|
Future<GetTrailResult> |
getTrailAsync(GetTrailRequest request,
AsyncHandler<GetTrailRequest,GetTrailResult> asyncHandler)
Returns settings information for a specified trail.
|
Future<GetTrailStatusResult> |
getTrailStatusAsync(GetTrailStatusRequest request)
Returns a JSON-formatted list of information about the specified trail.
|
Future<GetTrailStatusResult> |
getTrailStatusAsync(GetTrailStatusRequest request,
AsyncHandler<GetTrailStatusRequest,GetTrailStatusResult> asyncHandler)
Returns a JSON-formatted list of information about the specified trail.
|
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 request)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
Future<ListPublicKeysResult> |
listPublicKeysAsync(ListPublicKeysRequest request,
AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest request)
Lists the tags for the trail in the current region.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest request,
AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists the tags for the trail in the current region.
|
Future<ListTrailsResult> |
listTrailsAsync(ListTrailsRequest request)
Lists trails that are in the current account.
|
Future<ListTrailsResult> |
listTrailsAsync(ListTrailsRequest request,
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 request)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
Future<LookupEventsResult> |
lookupEventsAsync(LookupEventsRequest request,
AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
|
Future<PutEventSelectorsResult> |
putEventSelectorsAsync(PutEventSelectorsRequest request)
Configures an event selector or advanced event selectors for your trail.
|
Future<PutEventSelectorsResult> |
putEventSelectorsAsync(PutEventSelectorsRequest request,
AsyncHandler<PutEventSelectorsRequest,PutEventSelectorsResult> asyncHandler)
Configures an event selector or advanced event selectors for your trail.
|
Future<PutInsightSelectorsResult> |
putInsightSelectorsAsync(PutInsightSelectorsRequest request)
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an
existing trail.
|
Future<PutInsightSelectorsResult> |
putInsightSelectorsAsync(PutInsightSelectorsRequest request,
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 request)
Removes the specified tags from a trail.
|
Future<RemoveTagsResult> |
removeTagsAsync(RemoveTagsRequest request,
AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes the specified tags from a trail.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest request)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest request,
AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler)
Starts the recording of Amazon Web Services API calls and log file delivery for a trail.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest request)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest request,
AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler)
Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest request)
Updates trail settings that control what events you are logging, and how to handle log files.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest request,
AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler)
Updates trail settings that control what events you are logging, and how to handle log files.
|
addTags, builder, createTrail, deleteTrail, describeTrails, describeTrails, getCachedResponseMetadata, getEventSelectors, getInsightSelectors, getTrail, getTrailStatus, listPublicKeys, listPublicKeys, listTags, listTrails, lookupEvents, lookupEvents, putEventSelectors, putInsightSelectors, removeTags, startLogging, stopLogging, updateTrail
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addTags, createTrail, deleteTrail, describeTrails, describeTrails, getCachedResponseMetadata, getEventSelectors, getInsightSelectors, getTrail, getTrailStatus, listPublicKeys, listPublicKeys, listTags, listTrails, lookupEvents, lookupEvents, putEventSelectors, putInsightSelectors, removeTags, setEndpoint, setRegion, startLogging, stopLogging, updateTrail
@Deprecated public AWSCloudTrailAsyncClient()
AWSCloudTrailAsyncClientBuilder.defaultClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AWSCloudTrailAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client connects to CloudTrail (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.public static AWSCloudTrailAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddTagsResult> addTagsAsync(AddTagsRequest request)
AWSCloudTrailAsync
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).
addTagsAsync
in interface AWSCloudTrailAsync
request
- Specifies the tags to add to a trail.public Future<AddTagsResult> addTagsAsync(AddTagsRequest request, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
AWSCloudTrailAsync
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).
addTagsAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<CreateTrailResult> createTrailAsync(CreateTrailRequest request)
AWSCloudTrailAsync
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailAsync
in interface AWSCloudTrailAsync
request
- Specifies the settings for each trail.public Future<CreateTrailResult> createTrailAsync(CreateTrailRequest request, AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler)
AWSCloudTrailAsync
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
createTrailAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest request)
AWSCloudTrailAsync
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.
deleteTrailAsync
in interface AWSCloudTrailAsync
request
- The request that specifies the name of a trail to delete.public Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest request, AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
AWSCloudTrailAsync
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.
deleteTrailAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest request)
AWSCloudTrailAsync
Retrieves settings for one or more trails associated with the current region for your account.
describeTrailsAsync
in interface AWSCloudTrailAsync
request
- Returns information about the trail.public Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest request, AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
AWSCloudTrailAsync
Retrieves settings for one or more trails associated with the current region for your account.
describeTrailsAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<DescribeTrailsResult> describeTrailsAsync()
describeTrailsAsync
in interface AWSCloudTrailAsync
describeTrailsAsync(DescribeTrailsRequest)
public Future<DescribeTrailsResult> describeTrailsAsync(AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
describeTrailsAsync
in interface AWSCloudTrailAsync
describeTrailsAsync(DescribeTrailsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<GetEventSelectorsResult> getEventSelectorsAsync(GetEventSelectorsRequest request)
AWSCloudTrailAsync
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.
getEventSelectorsAsync
in interface AWSCloudTrailAsync
public Future<GetEventSelectorsResult> getEventSelectorsAsync(GetEventSelectorsRequest request, AsyncHandler<GetEventSelectorsRequest,GetEventSelectorsResult> asyncHandler)
AWSCloudTrailAsync
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.
getEventSelectorsAsync
in interface AWSCloudTrailAsync
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.public Future<GetInsightSelectorsResult> getInsightSelectorsAsync(GetInsightSelectorsRequest request)
AWSCloudTrailAsync
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.
getInsightSelectorsAsync
in interface AWSCloudTrailAsync
public Future<GetInsightSelectorsResult> getInsightSelectorsAsync(GetInsightSelectorsRequest request, AsyncHandler<GetInsightSelectorsRequest,GetInsightSelectorsResult> asyncHandler)
AWSCloudTrailAsync
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.
getInsightSelectorsAsync
in interface AWSCloudTrailAsync
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.public Future<GetTrailResult> getTrailAsync(GetTrailRequest request)
AWSCloudTrailAsync
Returns settings information for a specified trail.
getTrailAsync
in interface AWSCloudTrailAsync
public Future<GetTrailResult> getTrailAsync(GetTrailRequest request, AsyncHandler<GetTrailRequest,GetTrailResult> asyncHandler)
AWSCloudTrailAsync
Returns settings information for a specified trail.
getTrailAsync
in interface AWSCloudTrailAsync
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.public Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest request)
AWSCloudTrailAsync
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.
getTrailStatusAsync
in interface AWSCloudTrailAsync
request
- The name of a trail about which you want the current status.public Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest request, AsyncHandler<GetTrailStatusRequest,GetTrailStatusResult> asyncHandler)
AWSCloudTrailAsync
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.
getTrailStatusAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest request)
AWSCloudTrailAsync
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.
listPublicKeysAsync
in interface AWSCloudTrailAsync
request
- Requests the public keys for a specified time range.public Future<ListPublicKeysResult> listPublicKeysAsync(ListPublicKeysRequest request, AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
AWSCloudTrailAsync
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.
listPublicKeysAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<ListPublicKeysResult> listPublicKeysAsync()
listPublicKeysAsync
in interface AWSCloudTrailAsync
listPublicKeysAsync(ListPublicKeysRequest)
public Future<ListPublicKeysResult> listPublicKeysAsync(AsyncHandler<ListPublicKeysRequest,ListPublicKeysResult> asyncHandler)
listPublicKeysAsync
in interface AWSCloudTrailAsync
listPublicKeysAsync(ListPublicKeysRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListTagsResult> listTagsAsync(ListTagsRequest request)
AWSCloudTrailAsync
Lists the tags for the trail in the current region.
listTagsAsync
in interface AWSCloudTrailAsync
request
- Specifies a list of trail tags to return.public Future<ListTagsResult> listTagsAsync(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
AWSCloudTrailAsync
Lists the tags for the trail in the current region.
listTagsAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<ListTrailsResult> listTrailsAsync(ListTrailsRequest request)
AWSCloudTrailAsync
Lists trails that are in the current account.
listTrailsAsync
in interface AWSCloudTrailAsync
public Future<ListTrailsResult> listTrailsAsync(ListTrailsRequest request, AsyncHandler<ListTrailsRequest,ListTrailsResult> asyncHandler)
AWSCloudTrailAsync
Lists trails that are in the current account.
listTrailsAsync
in interface AWSCloudTrailAsync
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.public Future<LookupEventsResult> lookupEventsAsync(LookupEventsRequest request)
AWSCloudTrailAsync
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.
lookupEventsAsync
in interface AWSCloudTrailAsync
request
- Contains a request for LookupEvents.public Future<LookupEventsResult> lookupEventsAsync(LookupEventsRequest request, AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
AWSCloudTrailAsync
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.
lookupEventsAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<LookupEventsResult> lookupEventsAsync()
lookupEventsAsync
in interface AWSCloudTrailAsync
lookupEventsAsync(LookupEventsRequest)
public Future<LookupEventsResult> lookupEventsAsync(AsyncHandler<LookupEventsRequest,LookupEventsResult> asyncHandler)
lookupEventsAsync
in interface AWSCloudTrailAsync
lookupEventsAsync(LookupEventsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<PutEventSelectorsResult> putEventSelectorsAsync(PutEventSelectorsRequest request)
AWSCloudTrailAsync
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.
putEventSelectorsAsync
in interface AWSCloudTrailAsync
public Future<PutEventSelectorsResult> putEventSelectorsAsync(PutEventSelectorsRequest request, AsyncHandler<PutEventSelectorsRequest,PutEventSelectorsResult> asyncHandler)
AWSCloudTrailAsync
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.
putEventSelectorsAsync
in interface AWSCloudTrailAsync
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.public Future<PutInsightSelectorsResult> putInsightSelectorsAsync(PutInsightSelectorsRequest request)
AWSCloudTrailAsync
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 type in this release is ApiCallRateInsight
.
putInsightSelectorsAsync
in interface AWSCloudTrailAsync
public Future<PutInsightSelectorsResult> putInsightSelectorsAsync(PutInsightSelectorsRequest request, AsyncHandler<PutInsightSelectorsRequest,PutInsightSelectorsResult> asyncHandler)
AWSCloudTrailAsync
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 type in this release is ApiCallRateInsight
.
putInsightSelectorsAsync
in interface AWSCloudTrailAsync
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.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request)
AWSCloudTrailAsync
Removes the specified tags from a trail.
removeTagsAsync
in interface AWSCloudTrailAsync
request
- Specifies the tags to remove from a trail.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
AWSCloudTrailAsync
Removes the specified tags from a trail.
removeTagsAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest request)
AWSCloudTrailAsync
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.
startLoggingAsync
in interface AWSCloudTrailAsync
request
- The request to CloudTrail to start logging Amazon Web Services API calls for an account.public Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest request, AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler)
AWSCloudTrailAsync
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.
startLoggingAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest request)
AWSCloudTrailAsync
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.
stopLoggingAsync
in interface AWSCloudTrailAsync
request
- Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.public Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest request, AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler)
AWSCloudTrailAsync
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.
stopLoggingAsync
in interface AWSCloudTrailAsync
request
- 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.public Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest request)
AWSCloudTrailAsync
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.
updateTrailAsync
in interface AWSCloudTrailAsync
request
- Specifies settings to update for the trail.public Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest request, AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler)
AWSCloudTrailAsync
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.
updateTrailAsync
in interface AWSCloudTrailAsync
request
- 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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSCloudTrail
shutdown
in class AWSCloudTrailClient