AWS.CloudTrailData — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The CloudTrail Data Service lets you ingest events into CloudTrail from any source in your hybrid environments, such as in-house or SaaS applications hosted on-premises or in the cloud, virtual machines, or containers. You can store, access, analyze, troubleshoot and take action on this data without maintaining multiple log aggregators and reporting tools. After you run PutAuditEvents to ingest your application activity into CloudTrail, you can use CloudTrail Lake to search, query, and analyze the data that is logged from your applications.

Sending a Request Using CloudTrailData

var cloudtraildata = new AWS.CloudTrailData();
cloudtraildata.putAuditEvents(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 CloudTrailData object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudtraildata = new AWS.CloudTrailData({apiVersion: '2021-08-11'});

You can also set the API version globally in AWS.config.apiVersions using the cloudtraildata service identifier:

AWS.config.apiVersions = {
  cloudtraildata: '2021-08-11',
  // other service API versions
};

var cloudtraildata = new AWS.CloudTrailData();

Constructor Summarycollapse

• new AWS.CloudTrailData(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• putAuditEvents(params = {}, callback) ⇒ AWS.Request
  Ingests your application events into CloudTrail Lake.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CloudTrailData(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

putAuditEvents(params = {}, callback) ⇒ AWS.Request

Ingests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records (also called payload) of events that you want CloudTrail to ingest. You can add up to 100 of these events (or up to 1 MB) per PutAuditEvents request.