AWS.QLDBSession — 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 transactional data APIs for Amazon QLDB

Note: Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.

Sending a Request Using QLDBSession

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

var qldbsession = new AWS.QLDBSession({apiVersion: '2019-07-11'});

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

AWS.config.apiVersions = {
  qldbsession: '2019-07-11',
  // other service API versions
};

var qldbsession = new AWS.QLDBSession();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.QLDBSession(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

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

Sends a command to an Amazon QLDB ledger.

Note: Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.