Class: AWS.QLDBSession
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.QLDBSession
- Identifier:
- qldbsession
- API Version:
- 2019-07-11
- Defined in:
- (unknown)
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.
- If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this QLDB Session data plane and manages
SendCommand
API calls for you. For information and a list of supported programming languages, see Getting started with the driver in the Amazon QLDB Developer Guide. - If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see Accessing Amazon QLDB using the QLDB shell.
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 Summary collapse
-
new AWS.QLDBSession(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
-
sendCommand(params = {}, callback) ⇒ AWS.Request
Sends a command to an Amazon QLDB ledger.
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
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.
- If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this QLDB Session data plane and manages
SendCommand
API calls for you. For information and a list of supported programming languages, see Getting started with the driver in the Amazon QLDB Developer Guide. - If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see Accessing Amazon QLDB using the QLDB shell.