public class AWSCloudTrailAsyncClient extends AWSCloudTrailClient implements AWSCloudTrailAsync
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 AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
NOTE: As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
jsonErrorUnmarshallers
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AWSCloudTrailAsyncClient()
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail.
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials.
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials,
executor service, and client configuration options.
|
AWSCloudTrailAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials
and executor service.
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials provider.
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials
provider and client configuration options.
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials
provider, executor service, and client configuration options.
|
AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail using the specified AWS account credentials provider
and executor service.
|
AWSCloudTrailAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
AWSCloudTrail.
|
Modifier and Type | Method and Description |
---|---|
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest createTrailRequest)
From the command line, use create-subscription.
|
Future<CreateTrailResult> |
createTrailAsync(CreateTrailRequest createTrailRequest,
AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler)
From the command line, use create-subscription.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest)
Deletes a trail.
|
Future<DeleteTrailResult> |
deleteTrailAsync(DeleteTrailRequest deleteTrailRequest,
AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
Deletes a trail.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest)
Retrieves the settings for some or all trails associated with an
account.
|
Future<DescribeTrailsResult> |
describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest,
AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler)
Retrieves the settings for some or all trails associated with an
account.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
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.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest startLoggingRequest)
Starts the recording of AWS API calls and log file delivery for a
trail.
|
Future<StartLoggingResult> |
startLoggingAsync(StartLoggingRequest startLoggingRequest,
AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler)
Starts the recording of AWS API calls and log file delivery for a
trail.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest stopLoggingRequest)
Suspends the recording of AWS API calls and log file delivery for the
specified trail.
|
Future<StopLoggingResult> |
stopLoggingAsync(StopLoggingRequest stopLoggingRequest,
AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler)
Suspends the recording of AWS API calls and log file delivery for the
specified trail.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest updateTrailRequest)
From the command line, use update-subscription.
|
Future<UpdateTrailResult> |
updateTrailAsync(UpdateTrailRequest updateTrailRequest,
AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler)
From the command line, use update-subscription.
|
createTrail, deleteTrail, describeTrails, describeTrails, getCachedResponseMetadata, getTrailStatus, setEndpoint, setEndpoint, startLogging, stopLogging, updateTrail
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTrail, deleteTrail, describeTrails, describeTrails, getCachedResponseMetadata, getTrailStatus, setEndpoint, setRegion, startLogging, stopLogging, updateTrail
public AWSCloudTrailAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AWSCloudTrailAsyncClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AWSCloudTrail
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
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.public AWSCloudTrailAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
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.public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
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.public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
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).public AWSCloudTrailAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
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 ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface AWSCloudTrail
shutdown
in class AmazonWebServiceClient
public Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest) throws AmazonServiceException, AmazonClientException
Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail.
getTrailStatusAsync
in interface AWSCloudTrailAsync
getTrailStatusRequest
- Container for the necessary parameters to
execute the GetTrailStatus operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<GetTrailStatusResult> getTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest, AsyncHandler<GetTrailStatusRequest,GetTrailStatusResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail.
getTrailStatusAsync
in interface AWSCloudTrailAsync
getTrailStatusRequest
- Container for the necessary parameters to
execute the GetTrailStatus operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest) throws AmazonServiceException, AmazonClientException
Deletes a trail.
deleteTrailAsync
in interface AWSCloudTrailAsync
deleteTrailRequest
- Container for the necessary parameters to
execute the DeleteTrail operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest, AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a trail.
deleteTrailAsync
in interface AWSCloudTrailAsync
deleteTrailRequest
- Container for the necessary parameters to
execute the DeleteTrail operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<CreateTrailResult> createTrailAsync(CreateTrailRequest createTrailRequest) throws AmazonServiceException, AmazonClientException
From the command line, use create-subscription.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:
createTrailAsync
in interface AWSCloudTrailAsync
createTrailRequest
- Container for the necessary parameters to
execute the CreateTrail operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<CreateTrailResult> createTrailAsync(CreateTrailRequest createTrailRequest, AsyncHandler<CreateTrailRequest,CreateTrailResult> asyncHandler) throws AmazonServiceException, AmazonClientException
From the command line, use create-subscription.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:
createTrailAsync
in interface AWSCloudTrailAsync
createTrailRequest
- Container for the necessary parameters to
execute the CreateTrail operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest updateTrailRequest) throws AmazonServiceException, AmazonClientException
From the command line, use update-subscription.
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names.
updateTrailAsync
in interface AWSCloudTrailAsync
updateTrailRequest
- Container for the necessary parameters to
execute the UpdateTrail operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateTrailResult> updateTrailAsync(UpdateTrailRequest updateTrailRequest, AsyncHandler<UpdateTrailRequest,UpdateTrailResult> asyncHandler) throws AmazonServiceException, AmazonClientException
From the command line, use update-subscription.
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names.
updateTrailAsync
in interface AWSCloudTrailAsync
updateTrailRequest
- Container for the necessary parameters to
execute the UpdateTrail operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest) throws AmazonServiceException, AmazonClientException
Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.
describeTrailsAsync
in interface AWSCloudTrailAsync
describeTrailsRequest
- Container for the necessary parameters to
execute the DescribeTrails operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeTrailsResult> describeTrailsAsync(DescribeTrailsRequest describeTrailsRequest, AsyncHandler<DescribeTrailsRequest,DescribeTrailsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.
describeTrailsAsync
in interface AWSCloudTrailAsync
describeTrailsRequest
- Container for the necessary parameters to
execute the DescribeTrails operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest stopLoggingRequest) throws AmazonServiceException, AmazonClientException
Suspends the recording of AWS 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.
stopLoggingAsync
in interface AWSCloudTrailAsync
stopLoggingRequest
- Container for the necessary parameters to
execute the StopLogging operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<StopLoggingResult> stopLoggingAsync(StopLoggingRequest stopLoggingRequest, AsyncHandler<StopLoggingRequest,StopLoggingResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Suspends the recording of AWS 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.
stopLoggingAsync
in interface AWSCloudTrailAsync
stopLoggingRequest
- Container for the necessary parameters to
execute the StopLogging operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest startLoggingRequest) throws AmazonServiceException, AmazonClientException
Starts the recording of AWS API calls and log file delivery for a trail.
startLoggingAsync
in interface AWSCloudTrailAsync
startLoggingRequest
- Container for the necessary parameters to
execute the StartLogging operation on AWSCloudTrail.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.public Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest startLoggingRequest, AsyncHandler<StartLoggingRequest,StartLoggingResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Starts the recording of AWS API calls and log file delivery for a trail.
startLoggingAsync
in interface AWSCloudTrailAsync
startLoggingRequest
- Container for the necessary parameters to
execute the StartLogging operation on AWSCloudTrail.asyncHandler
- Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AWSCloudTrail indicating
either a problem with the data in the request, or a server side issue.Copyright © 2014. All rights reserved.