@datafire/amazonaws_qldb_session

Client library for Amazon QLDB Session

Installation and Usage

npm install --save @datafire/amazonaws_qldb_session

let amazonaws_qldb_session = require('@datafire/amazonaws_qldb_session').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

The transactional data APIs for Amazon QLDB

Instead of interacting directly with this API, we recommend that you use the Amazon 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 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 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.

Actions

SendCommand

amazonaws_qldb_session.SendCommand({}, context)

Input

• input object
  • AbortTransaction
  • CommitTransaction
    • CommitDigest required
    • TransactionId required
  • EndSession
  • ExecuteStatement
    • Parameters
      • items ValueHolder
    • Statement required
    • TransactionId required
  • FetchPage
    • NextPageToken required
    • TransactionId required
  • SessionToken
  • StartSession
    • LedgerName required
  • StartTransaction

Output

• output SendCommandResult

Definitions

AbortTransactionRequest

• AbortTransactionRequest object: Contains the details of the transaction to abort.

AbortTransactionResult

• AbortTransactionResult object: Contains the details of the aborted transaction.

BadRequestException

CommitDigest

• CommitDigest string

CommitTransactionRequest

• CommitTransactionRequest object: Contains the details of the transaction to commit.
  • CommitDigest required
  • TransactionId required

CommitTransactionResult

• CommitTransactionResult object: Contains the details of the committed transaction.
  • CommitDigest
  • TransactionId

EndSessionRequest

• EndSessionRequest object: Specifies a request to end the session.

EndSessionResult

• EndSessionResult object: Contains the details of the ended session.

ExecuteStatementRequest

• ExecuteStatementRequest object: Specifies a request to execute a statement.
  • Parameters
    • items ValueHolder
  • Statement required
  • TransactionId required

ExecuteStatementResult

• ExecuteStatementResult object: Contains the details of the executed statement.
  • FirstPage
    • NextPageToken
    • Values
      • items ValueHolder

FetchPageRequest

• FetchPageRequest object: Specifies the details of the page to be fetched.
  • NextPageToken required
  • TransactionId required

FetchPageResult

• FetchPageResult object: Contains the page that was fetched.
  • Page
    • NextPageToken
    • Values
      • items ValueHolder

InvalidSessionException

IonBinary

• IonBinary string

IonText

• IonText string

LedgerName

• LedgerName string

LimitExceededException

OccConflictException

Page

• Page object: Contains details of the fetched page.
  • NextPageToken
  • Values
    • items ValueHolder

PageToken

• PageToken string

RateExceededException

SendCommandRequest

• SendCommandRequest object
  • AbortTransaction
  • CommitTransaction
    • CommitDigest required
    • TransactionId required
  • EndSession
  • ExecuteStatement
    • Parameters
      • items ValueHolder
    • Statement required
    • TransactionId required
  • FetchPage
    • NextPageToken required
    • TransactionId required
  • SessionToken
  • StartSession
    • LedgerName required
  • StartTransaction

SendCommandResult

• SendCommandResult object
  • AbortTransaction
  • CommitTransaction
    • CommitDigest
    • TransactionId
  • EndSession
  • ExecuteStatement
    • FirstPage
      • NextPageToken
      • Values
        • items ValueHolder
  • FetchPage
    • Page
      • NextPageToken
      • Values
        • items ValueHolder
  • StartSession
    • SessionToken
  • StartTransaction
    • TransactionId

SessionToken

• SessionToken string

StartSessionRequest

• StartSessionRequest object: Specifies a request to start a new session.
  • LedgerName required

StartSessionResult

• StartSessionResult object: Contains the details of the started session.
  • SessionToken

StartTransactionRequest

• StartTransactionRequest object: Specifies a request to start a transaction.

StartTransactionResult

• StartTransactionResult object: Contains the details of the started transaction.
  • TransactionId

Statement

• Statement string

StatementParameters

• StatementParameters array
  • items ValueHolder

TransactionId

• TransactionId string

ValueHolder

• ValueHolder object: A structure that can contain an Amazon Ion value in multiple encoding formats.
  • IonBinary
  • IonText

ValueHolders

• ValueHolders array
  • items ValueHolder