Class: AWS.CloudTrail
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.CloudTrail
- Identifier:
- cloudtrail
- API Version:
- 2013-11-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
Sending a Request Using CloudTrail
var cloudtrail = new AWS.CloudTrail();
cloudtrail.addTags(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the CloudTrail object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var cloudtrail = new AWS.CloudTrail({apiVersion: '2013-11-01'});
You can also set the API version globally in AWS.config.apiVersions
using
the cloudtrail service identifier:
AWS.config.apiVersions = {
cloudtrail: '2013-11-01',
// other service API versions
};
var cloudtrail = new AWS.CloudTrail();
Constructor Summary collapse
-
new AWS.CloudTrail(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
addTags(params = {}, callback) ⇒ AWS.Request
Adds one or more tags to a trail, up to a limit of 50.
-
createTrail(params = {}, callback) ⇒ AWS.Request
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
-
deleteTrail(params = {}, callback) ⇒ AWS.Request
Deletes a trail.
-
describeTrails(params = {}, callback) ⇒ AWS.Request
Retrieves settings for one or more trails associated with the current region for your account.
-
getEventSelectors(params = {}, callback) ⇒ AWS.Request
Describes the settings for the event selectors that you configured for your trail.
-
getInsightSelectors(params = {}, callback) ⇒ AWS.Request
Describes the settings for the Insights event selectors that you configured for your trail.
-
getTrail(params = {}, callback) ⇒ AWS.Request
Returns settings information for a specified trail.
-
getTrailStatus(params = {}, callback) ⇒ AWS.Request
Returns a JSON-formatted list of information about the specified trail.
-
listPublicKeys(params = {}, callback) ⇒ AWS.Request
Returns all public keys whose private keys were used to sign the digest files within the specified time range.
-
listTags(params = {}, callback) ⇒ AWS.Request
Lists the tags for the trail in the current region.
-
listTrails(params = {}, callback) ⇒ AWS.Request
Lists trails that are in the current account.
-
lookupEvents(params = {}, callback) ⇒ AWS.Request
Looks up management events or CloudTrail Insights events that are captured by CloudTrail.
-
putEventSelectors(params = {}, callback) ⇒ AWS.Request
Configures an event selector or advanced event selectors for your trail.
-
putInsightSelectors(params = {}, callback) ⇒ AWS.Request
Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.
-
removeTags(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from a trail.
-
startLogging(params = {}, callback) ⇒ AWS.Request
Starts the recording of AWS API calls and log file delivery for a trail.
-
stopLogging(params = {}, callback) ⇒ AWS.Request
Suspends the recording of AWS API calls and log file delivery for the specified trail.
-
updateTrail(params = {}, callback) ⇒ AWS.Request
Updates the settings that specify delivery of log files.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.CloudTrail(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
addTags(params = {}, callback) ⇒ AWS.Request
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 AWS Regions only from the Region in which the trail was created (also known as its home region).
createTrail(params = {}, callback) ⇒ AWS.Request
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
deleteTrail(params = {}, callback) ⇒ AWS.Request
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.
describeTrails(params = {}, callback) ⇒ AWS.Request
Retrieves settings for one or more trails associated with the current region for your account.
getEventSelectors(params = {}, callback) ⇒ AWS.Request
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 Amazon S3 objects or AWS Lambda functions that you are logging for data events.
For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.
getInsightSelectors(params = {}, callback) ⇒ AWS.Request
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 AWS CloudTrail User Guide.
getTrailStatus(params = {}, callback) ⇒ AWS.Request
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.
listPublicKeys(params = {}, callback) ⇒ AWS.Request
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.
lookupEvents(params = {}, callback) ⇒ AWS.Request
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:
-
AWS 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.
putEventSelectors(params = {}, callback) ⇒ AWS.Request
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
andRunInstances
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 AWS CloudTrail in the AWS 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 AWS CloudTrail User Guide.
putInsightSelectors(params = {}, callback) ⇒ AWS.Request
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. In this release, only ApiCallRateInsight
is supported as an Insights selector.
startLogging(params = {}, callback) ⇒ AWS.Request
Starts the recording of AWS 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.
stopLogging(params = {}, callback) ⇒ AWS.Request
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. 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.
updateTrail(params = {}, callback) ⇒ AWS.Request
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. UpdateTrail
must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException
is thrown.