Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.cloudtrail;
 
 
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 CloudTrail

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.

 
 public interface AWSCloudTrailAsync extends AWSCloudTrail {
    

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.

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:
com.amazonaws.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.
com.amazonaws.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<GetTrailStatusResultgetTrailStatusAsync(GetTrailStatusRequest getTrailStatusRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<GetTrailStatusRequestGetTrailStatusResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<DeleteTrailResultdeleteTrailAsync(DeleteTrailRequest deleteTrailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<DeleteTrailResultdeleteTrailAsync(DeleteTrailRequest deleteTrailRequest,
            AsyncHandler<DeleteTrailRequestDeleteTrailResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

IMPORTANT:The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

IMPORTANT:Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

Parameters:
lookupEventsRequest Container for the necessary parameters to execute the LookupEvents operation on AWSCloudTrail.
Returns:
A Java Future object containing the response from the LookupEvents service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.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.
com.amazonaws.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<LookupEventsResultlookupEventsAsync(LookupEventsRequest lookupEventsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

IMPORTANT:The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

IMPORTANT:Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

Parameters:
lookupEventsRequest Container for the necessary parameters to execute the LookupEvents 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 LookupEvents service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.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.
com.amazonaws.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<LookupEventsResultlookupEventsAsync(LookupEventsRequest lookupEventsRequest,
            AsyncHandler<LookupEventsRequestLookupEventsResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

From the command line, use create-subscription .

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

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:
com.amazonaws.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.
com.amazonaws.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<CreateTrailResultcreateTrailAsync(CreateTrailRequest createTrailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

From the command line, use create-subscription .

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

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:
com.amazonaws.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.
com.amazonaws.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<CreateTrailResultcreateTrailAsync(CreateTrailRequest createTrailRequest,
            AsyncHandler<CreateTrailRequestCreateTrailResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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

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:
com.amazonaws.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.
com.amazonaws.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<UpdateTrailResultupdateTrailAsync(UpdateTrailRequest updateTrailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

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:
com.amazonaws.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.
com.amazonaws.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<UpdateTrailResultupdateTrailAsync(UpdateTrailRequest updateTrailRequest,
            AsyncHandler<UpdateTrailRequestUpdateTrailResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Retrieves settings for the trail associated with the current region for your account.

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:
com.amazonaws.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.
com.amazonaws.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<DescribeTrailsResultdescribeTrailsAsync(DescribeTrailsRequest describeTrailsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Retrieves settings for the trail associated with the current region for your account.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudTrail indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<DescribeTrailsRequestDescribeTrailsResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<StopLoggingResultstopLoggingAsync(StopLoggingRequest stopLoggingRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<StopLoggingResultstopLoggingAsync(StopLoggingRequest stopLoggingRequest,
            AsyncHandler<StopLoggingRequestStopLoggingResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<StartLoggingResultstartLoggingAsync(StartLoggingRequest startLoggingRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.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<StartLoggingResultstartLoggingAsync(StartLoggingRequest startLoggingRequest,
            AsyncHandler<StartLoggingRequestStartLoggingResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;
}
        
New to GrepCode? Check out our FAQ X