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
SendCommandAPI 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§
- Abort
Transaction Request Contains the details of the transaction to abort.
- Abort
Transaction Result Contains the details of the aborted transaction.
- Commit
Transaction Request Contains the details of the transaction to commit.
- Commit
Transaction Result Contains the details of the committed transaction.
- EndSession
Request Specifies a request to end the session.
- EndSession
Result Contains the details of the ended session.
- Execute
Statement Request Specifies a request to execute a statement.
- Execute
Statement Result Contains the details of the executed statement.
- Fetch
Page Request Specifies the details of the page to be fetched.
- Fetch
Page Result Contains the page that was fetched.
- IOUsage
Contains I/O usage metrics for a command that was invoked.
- Page
Contains details of the fetched page.
- Qldb
Session Client - A client for the QLDB Session API.
- Send
Command Request - Send
Command Result - Start
Session Request Specifies a request to start a new session.
- Start
Session Result Contains the details of the started session.
- Start
Transaction Request Specifies a request to start a transaction.
- Start
Transaction Result Contains the details of the started transaction.
- Timing
Information 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.
- Value
Holder A structure that can contain a value in multiple encoding formats.
Enums§
- Send
Command Error - Errors returned by SendCommand
Traits§
- Qldb
Session - Trait representing the capabilities of the QLDB Session API. QLDB Session clients implement this trait.