Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class QLDBSession

The transactional data APIs for Amazon QLDB

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.

Hierarchy

Implements

Implemented by

Constructors

constructor

Properties

config

Methods

destroy sendCommand

Constructors

constructor

Properties

Readonly config

config: QLDBSessionClientResolvedConfig

The resolved configuration of QLDBSessionClient class. This is resolved and normalized from the constructor configuration interface.

Methods

destroy

  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

sendCommand

Settings

Member Visibility

Theme