2019/09/09 - Amazon QLDB Session - 1 new api methods
Changes (New Service) Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. Amazon QLDB is a new class of serverless database that eliminates the need to engage in the complex development effort of building your own ledger-like applications and it automatically scales to support the demands of your application. Introduces Amazon QLDB API operations needed for managing Amazon QLDB ledgers. This includes the ability to manage Amazon QLDB ledgers, cryptographically verify documents, and export the journal in a ledger.
Sends a command to an Amazon QLDB ledger.
See also: AWS API Documentation
Request Syntax
client.send_command(
SessionToken='string',
StartSession={
'LedgerName': 'string'
},
StartTransaction={}
,
EndSession={}
,
CommitTransaction={
'TransactionId': 'string',
'CommitDigest': b'bytes'
},
AbortTransaction={}
,
ExecuteStatement={
'TransactionId': 'string',
'Statement': 'string',
'Parameters': [
{
'IonBinary': b'bytes',
'IonText': 'string'
},
]
},
FetchPage={
'TransactionId': 'string',
'NextPageToken': 'string'
}
)
string
Specifies the session token for the current command. A session token is constant throughout the life of the session.
To obtain a session token, run the StartSession command. This SessionToken is required for every subsequent command that is issued during the current session.
dict
Command to start a new session. A session token is obtained as part of the response.
LedgerName (string) -- [REQUIRED]
The name of the ledger to start a new session against.
dict
Command to start a new transaction.
dict
Command to end the current session.
dict
Command to commit the specified transaction.
TransactionId (string) -- [REQUIRED]
Specifies the transaction id of the transaction to commit.
CommitDigest (bytes) -- [REQUIRED]
Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates CommitDigest and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.
dict
Command to abort the current transaction.
dict
Command to execute a statement in the specified transaction.
TransactionId (string) -- [REQUIRED]
Specifies the transaction id of the request.
Statement (string) -- [REQUIRED]
Specifies the statement of the request.
Parameters (list) --
Specifies the parameters for the parameterized statement in the request.
(dict) --
A structure that can contains values in multiple encoding formats.
IonBinary (bytes) --
An Amazon Ion binary value contained in a ValueHolder structure.
IonText (string) --
An Amazon Ion plaintext value contained in a ValueHolder structure.
dict
Command to fetch a page.
TransactionId (string) -- [REQUIRED]
Specifies the transaction id of the page to be fetched.
NextPageToken (string) -- [REQUIRED]
Specifies the next page token of the page to be fetched.
dict
Response Syntax
{
'StartSession': {
'SessionToken': 'string'
},
'StartTransaction': {
'TransactionId': 'string'
},
'EndSession': {},
'CommitTransaction': {
'TransactionId': 'string',
'CommitDigest': b'bytes'
},
'AbortTransaction': {},
'ExecuteStatement': {
'FirstPage': {
'Values': [
{
'IonBinary': b'bytes',
'IonText': 'string'
},
],
'NextPageToken': 'string'
}
},
'FetchPage': {
'Page': {
'Values': [
{
'IonBinary': b'bytes',
'IonText': 'string'
},
],
'NextPageToken': 'string'
}
}
}
Response Structure
(dict) --
StartSession (dict) --
Contains the details of the started session that includes a session token. This SessionToken is required for every subsequent command that is issued during the current session.
SessionToken (string) --
Session token of the started session. This SessionToken is required for every subsequent command that is issued during the current session.
StartTransaction (dict) --
Contains the details of the started transaction.
TransactionId (string) --
The transaction id of the started transaction.
EndSession (dict) --
Contains the details of the ended session.
CommitTransaction (dict) --
Contains the details of the committed transaction.
TransactionId (string) --
The transaction id of the committed transaction.
CommitDigest (bytes) --
The commit digest of the committed transaction.
AbortTransaction (dict) --
Contains the details of the aborted transaction.
ExecuteStatement (dict) --
Contains the details of the executed statement.
FirstPage (dict) --
Contains the details of the first fetched page.
Values (list) --
A structure that contains values in multiple encoding formats.
(dict) --
A structure that can contains values in multiple encoding formats.
IonBinary (bytes) --
An Amazon Ion binary value contained in a ValueHolder structure.
IonText (string) --
An Amazon Ion plaintext value contained in a ValueHolder structure.
NextPageToken (string) --
The token of the next page.
FetchPage (dict) --
Contains the details of the fetched page.
Page (dict) --
Contains details of the fetched page.
Values (list) --
A structure that contains values in multiple encoding formats.
(dict) --
A structure that can contains values in multiple encoding formats.
IonBinary (bytes) --
An Amazon Ion binary value contained in a ValueHolder structure.
IonText (string) --
An Amazon Ion plaintext value contained in a ValueHolder structure.
NextPageToken (string) --
The token of the next page.