logo
Expand description

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.

If you’re using the service, you’re probably looking for QldbSessionClient and QldbSession.

Structs

Contains the details of the transaction to abort.

Contains the details of the aborted transaction.

Contains the details of the transaction to commit.

Contains the details of the committed transaction.

Specifies a request to end the session.

Contains the details of the ended session.

Specifies a request to execute a statement.

Contains the details of the executed statement.

Specifies the details of the page to be fetched.

Contains the page that was fetched.

Contains I/O usage metrics for a command that was invoked.

Contains details of the fetched page.

A client for the QLDB Session API.

Specifies a request to start a new session.

Contains the details of the started session.

Specifies a request to start a transaction.

Contains the details of the started transaction.

Contains server-side performance information for a command. Amazon QLDB captures timing information between the times when it receives the request and when it sends the corresponding response.

A structure that can contain a value in multiple encoding formats.

Enums

Errors returned by SendCommand

Traits

Trait representing the capabilities of the QLDB Session API. QLDB Session clients implement this trait.