Amazon QLDB API Reference - Amazon Quantum Ledger Database (Amazon QLDB)

Amazon QLDB API Reference

This section describes the low-level API operations for Amazon QLDB that are accessible via HTTP, the AWS Command Line Interface (AWS CLI), or an AWS SDK:

  • Amazon QLDB – The QLDB control plane. These API actions are used only for managing ledgers and for non-transactional data operations. You can use these actions to create, delete, describe, list, and update ledgers. You can also verify a document cryptographically, and export or stream journal blocks.

  • Amazon QLDB Session – The QLDB transactional data plane. You can use this API to execute data transactions on a ledger with PartiQL statements.


    Instead of interacting directly with the QLDB Session API, we recommend that you use 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 the qldbsession data plane and manages SendCommand API calls for you. For information and a list of supported programming languages, see Getting Started with the Driver.

    • If you are working with the AWS CLI, use the QLDB Shell. The shell is a command line interface that uses the QLDB Driver for Python to interact with a ledger. For information, see Using the Amazon QLDB Shell (Data Plane Only).