com.amazonaws.services.cloudtrail

Interface AWSCloudTrailAsync

All Superinterfaces:

AWSCloudTrail

All Known Implementing Classes:

AWSCloudTrailAsyncClient

public interface AWSCloudTrailAsync
extends AWSCloudTrail

Interface for accessing AWSCloudTrail asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. AWS Cloud Trail

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.

Method Summary

Methods

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.
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<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.

Methods inherited from interface com.amazonaws.services.cloudtrail.AWSCloudTrail

createTrail, deleteTrail, describeTrails, describeTrails, getCachedResponseMetadata, getTrailStatus, setEndpoint, setRegion, shutdown, startLogging, stopLogging, updateTrail

Method Detail

getTrailStatusAsync

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.

Parameters:

getTrailStatusRequest - Container for the necessary parameters to execute the GetTrailStatus operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the GetTrailStatus service method, as returned by AWSCloudTrail.

Throws:

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.

getTrailStatusAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the GetTrailStatus service method, as returned by AWSCloudTrail.

Throws:

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.

deleteTrailAsync

Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Deletes a trail.

Parameters:

deleteTrailRequest - Container for the necessary parameters to execute the DeleteTrail operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the DeleteTrail service method, as returned by AWSCloudTrail.

Throws:

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.

deleteTrailAsync

Future<DeleteTrailResult> deleteTrailAsync(DeleteTrailRequest deleteTrailRequest,
                                         AsyncHandler<DeleteTrailRequest,DeleteTrailResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Deletes a trail.

Parameters:

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.

Returns:

A Java Future object containing the response from the DeleteTrail service method, as returned by AWSCloudTrail.

Throws:

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.

createTrailAsync

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:

• Trail name.
• The name of an existing Amazon S3 bucket to which CloudTrail delivers your log files.
• The name of the Amazon S3 key prefix that precedes each log file.
• The name of an existing Amazon SNS topic that notifies you that a new file is available in your bucket.
• Whether the log file should include AWS API calls from global services. Currently, the only global AWS API calls included in CloudTrail log files are from IAM and AWS STS.

Parameters:

createTrailRequest - Container for the necessary parameters to execute the CreateTrail operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the CreateTrail service method, as returned by AWSCloudTrail.

Throws:

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.

createTrailAsync

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:

• Trail name.
• The name of an existing Amazon S3 bucket to which CloudTrail delivers your log files.
• The name of the Amazon S3 key prefix that precedes each log file.
• The name of an existing Amazon SNS topic that notifies you that a new file is available in your bucket.
• Whether the log file should include AWS API calls from global services. Currently, the only global AWS API calls included in CloudTrail log files are from IAM and AWS STS.

Parameters:

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.

Returns:

A Java Future object containing the response from the CreateTrail service method, as returned by AWSCloudTrail.

Throws:

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.

updateTrailAsync

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.

Parameters:

updateTrailRequest - Container for the necessary parameters to execute the UpdateTrail operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the UpdateTrail service method, as returned by AWSCloudTrail.

Throws:

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.

updateTrailAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the UpdateTrail service method, as returned by AWSCloudTrail.

Throws:

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.

describeTrailsAsync

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.

Parameters:

describeTrailsRequest - Container for the necessary parameters to execute the DescribeTrails operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the DescribeTrails service method, as returned by AWSCloudTrail.

Throws:

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.

describeTrailsAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the DescribeTrails service method, as returned by AWSCloudTrail.

Throws:

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.

stopLoggingAsync

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.

Parameters:

stopLoggingRequest - Container for the necessary parameters to execute the StopLogging operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the StopLogging service method, as returned by AWSCloudTrail.

Throws:

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.

stopLoggingAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the StopLogging service method, as returned by AWSCloudTrail.

Throws:

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.

startLoggingAsync

Future<StartLoggingResult> startLoggingAsync(StartLoggingRequest startLoggingRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

Starts the recording of AWS API calls and log file delivery for a trail.

Parameters:

startLoggingRequest - Container for the necessary parameters to execute the StartLogging operation on AWSCloudTrail.

Returns:

A Java Future object containing the response from the StartLogging service method, as returned by AWSCloudTrail.

Throws:

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.

startLoggingAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the StartLogging service method, as returned by AWSCloudTrail.

Throws:

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.