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

    
Overrides the default endpoint for this client ("https://cloudtrail.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudtrail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's com.amazonaws.ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:
endpoint The endpoint (ex: "cloudtrail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://cloudtrail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the com.amazonaws.ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

    public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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 service method on AWSCloudTrail.
Returns:
The response from the GetTrailStatus service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidTrailNameException
com.amazonaws.services.cloudtrail.model.TrailNotFoundException
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 GetTrailStatusResult getTrailStatus(GetTrailStatusRequest getTrailStatusRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes a trail.

Parameters:
deleteTrailRequest Container for the necessary parameters to execute the DeleteTrail service method on AWSCloudTrail.
Returns:
The response from the DeleteTrail service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidTrailNameException
com.amazonaws.services.cloudtrail.model.TrailNotFoundException
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 DeleteTrailResult deleteTrail(DeleteTrailRequest deleteTrailRequest
            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 service method on AWSCloudTrail.
Returns:
The response from the LookupEvents service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidMaxResultsException
com.amazonaws.services.cloudtrail.model.InvalidNextTokenException
com.amazonaws.services.cloudtrail.model.InvalidLookupAttributesException
com.amazonaws.services.cloudtrail.model.InvalidTimeRangeException
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 LookupEventsResult lookupEvents(LookupEventsRequest lookupEventsRequest
            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.

    public CreateTrailResult createTrail(CreateTrailRequest createTrailRequest
            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.

    public UpdateTrailResult updateTrail(UpdateTrailRequest updateTrailRequest
            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 service method on AWSCloudTrail.
Returns:
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 DescribeTrailsResult describeTrails(DescribeTrailsRequest describeTrailsRequest
            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 service method on AWSCloudTrail.
Returns:
The response from the StopLogging service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidTrailNameException
com.amazonaws.services.cloudtrail.model.TrailNotFoundException
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 StopLoggingResult stopLogging(StopLoggingRequest stopLoggingRequest
            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 service method on AWSCloudTrail.
Returns:
The response from the StartLogging service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidTrailNameException
com.amazonaws.services.cloudtrail.model.TrailNotFoundException
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 StartLoggingResult startLogging(StartLoggingRequest startLoggingRequest
            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.

Returns:
The response from the LookupEvents service method, as returned by AWSCloudTrail.
Throws:
com.amazonaws.services.cloudtrail.model.InvalidMaxResultsException
com.amazonaws.services.cloudtrail.model.InvalidNextTokenException
com.amazonaws.services.cloudtrail.model.InvalidLookupAttributesException
com.amazonaws.services.cloudtrail.model.InvalidTimeRangeException
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.

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

Returns:
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.
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    public void shutdown();
    
    
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:
request The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.
}
        
New to GrepCode? Check out our FAQ X