Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- Types
- AbortTransactionRequest
- AbortTransactionResult
- CommitTransactionRequest
- CommitTransactionResult
- EndSessionRequest
- EndSessionResult
- ExecuteStatementRequest
- ExecuteStatementResult
- FetchPageRequest
- FetchPageResult
- IOUsage
- Page
- StartSessionRequest
- StartSessionResult
- StartTransactionRequest
- StartTransactionResult
- TimingInformation
- ValueHolder
Synopsis
- sendCommand_abortTransaction :: Lens' SendCommand (Maybe AbortTransactionRequest)
- sendCommand_commitTransaction :: Lens' SendCommand (Maybe CommitTransactionRequest)
- sendCommand_endSession :: Lens' SendCommand (Maybe EndSessionRequest)
- sendCommand_executeStatement :: Lens' SendCommand (Maybe ExecuteStatementRequest)
- sendCommand_fetchPage :: Lens' SendCommand (Maybe FetchPageRequest)
- sendCommand_sessionToken :: Lens' SendCommand (Maybe Text)
- sendCommand_startSession :: Lens' SendCommand (Maybe StartSessionRequest)
- sendCommand_startTransaction :: Lens' SendCommand (Maybe StartTransactionRequest)
- sendCommandResponse_abortTransaction :: Lens' SendCommandResponse (Maybe AbortTransactionResult)
- sendCommandResponse_commitTransaction :: Lens' SendCommandResponse (Maybe CommitTransactionResult)
- sendCommandResponse_endSession :: Lens' SendCommandResponse (Maybe EndSessionResult)
- sendCommandResponse_executeStatement :: Lens' SendCommandResponse (Maybe ExecuteStatementResult)
- sendCommandResponse_fetchPage :: Lens' SendCommandResponse (Maybe FetchPageResult)
- sendCommandResponse_startSession :: Lens' SendCommandResponse (Maybe StartSessionResult)
- sendCommandResponse_startTransaction :: Lens' SendCommandResponse (Maybe StartTransactionResult)
- sendCommandResponse_httpStatus :: Lens' SendCommandResponse Int
- abortTransactionResult_timingInformation :: Lens' AbortTransactionResult (Maybe TimingInformation)
- commitTransactionRequest_transactionId :: Lens' CommitTransactionRequest Text
- commitTransactionRequest_commitDigest :: Lens' CommitTransactionRequest ByteString
- commitTransactionResult_commitDigest :: Lens' CommitTransactionResult (Maybe ByteString)
- commitTransactionResult_consumedIOs :: Lens' CommitTransactionResult (Maybe IOUsage)
- commitTransactionResult_timingInformation :: Lens' CommitTransactionResult (Maybe TimingInformation)
- commitTransactionResult_transactionId :: Lens' CommitTransactionResult (Maybe Text)
- endSessionResult_timingInformation :: Lens' EndSessionResult (Maybe TimingInformation)
- executeStatementRequest_parameters :: Lens' ExecuteStatementRequest (Maybe [ValueHolder])
- executeStatementRequest_transactionId :: Lens' ExecuteStatementRequest Text
- executeStatementRequest_statement :: Lens' ExecuteStatementRequest Text
- executeStatementResult_consumedIOs :: Lens' ExecuteStatementResult (Maybe IOUsage)
- executeStatementResult_firstPage :: Lens' ExecuteStatementResult (Maybe Page)
- executeStatementResult_timingInformation :: Lens' ExecuteStatementResult (Maybe TimingInformation)
- fetchPageRequest_transactionId :: Lens' FetchPageRequest Text
- fetchPageRequest_nextPageToken :: Lens' FetchPageRequest Text
- fetchPageResult_consumedIOs :: Lens' FetchPageResult (Maybe IOUsage)
- fetchPageResult_page :: Lens' FetchPageResult (Maybe Page)
- fetchPageResult_timingInformation :: Lens' FetchPageResult (Maybe TimingInformation)
- iOUsage_readIOs :: Lens' IOUsage (Maybe Integer)
- iOUsage_writeIOs :: Lens' IOUsage (Maybe Integer)
- page_nextPageToken :: Lens' Page (Maybe Text)
- page_values :: Lens' Page (Maybe [ValueHolder])
- startSessionRequest_ledgerName :: Lens' StartSessionRequest Text
- startSessionResult_sessionToken :: Lens' StartSessionResult (Maybe Text)
- startSessionResult_timingInformation :: Lens' StartSessionResult (Maybe TimingInformation)
- startTransactionResult_timingInformation :: Lens' StartTransactionResult (Maybe TimingInformation)
- startTransactionResult_transactionId :: Lens' StartTransactionResult (Maybe Text)
- timingInformation_processingTimeMilliseconds :: Lens' TimingInformation (Maybe Integer)
- valueHolder_ionBinary :: Lens' ValueHolder (Maybe ByteString)
- valueHolder_ionText :: Lens' ValueHolder (Maybe Text)
Operations
SendCommand
sendCommand_abortTransaction :: Lens' SendCommand (Maybe AbortTransactionRequest) Source #
Command to abort the current transaction.
sendCommand_commitTransaction :: Lens' SendCommand (Maybe CommitTransactionRequest) Source #
Command to commit the specified transaction.
sendCommand_endSession :: Lens' SendCommand (Maybe EndSessionRequest) Source #
Command to end the current session.
sendCommand_executeStatement :: Lens' SendCommand (Maybe ExecuteStatementRequest) Source #
Command to execute a statement in the specified transaction.
sendCommand_fetchPage :: Lens' SendCommand (Maybe FetchPageRequest) Source #
Command to fetch a page.
sendCommand_sessionToken :: Lens' SendCommand (Maybe Text) Source #
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.
sendCommand_startSession :: Lens' SendCommand (Maybe StartSessionRequest) Source #
Command to start a new session. A session token is obtained as part of the response.
sendCommand_startTransaction :: Lens' SendCommand (Maybe StartTransactionRequest) Source #
Command to start a new transaction.
sendCommandResponse_abortTransaction :: Lens' SendCommandResponse (Maybe AbortTransactionResult) Source #
Contains the details of the aborted transaction.
sendCommandResponse_commitTransaction :: Lens' SendCommandResponse (Maybe CommitTransactionResult) Source #
Contains the details of the committed transaction.
sendCommandResponse_endSession :: Lens' SendCommandResponse (Maybe EndSessionResult) Source #
Contains the details of the ended session.
sendCommandResponse_executeStatement :: Lens' SendCommandResponse (Maybe ExecuteStatementResult) Source #
Contains the details of the executed statement.
sendCommandResponse_fetchPage :: Lens' SendCommandResponse (Maybe FetchPageResult) Source #
Contains the details of the fetched page.
sendCommandResponse_startSession :: Lens' SendCommandResponse (Maybe StartSessionResult) Source #
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.
sendCommandResponse_startTransaction :: Lens' SendCommandResponse (Maybe StartTransactionResult) Source #
Contains the details of the started transaction.
sendCommandResponse_httpStatus :: Lens' SendCommandResponse Int Source #
The response's http status code.
Types
AbortTransactionRequest
AbortTransactionResult
abortTransactionResult_timingInformation :: Lens' AbortTransactionResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
CommitTransactionRequest
commitTransactionRequest_transactionId :: Lens' CommitTransactionRequest Text Source #
Specifies the transaction ID of the transaction to commit.
commitTransactionRequest_commitDigest :: Lens' CommitTransactionRequest ByteString Source #
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.
The purpose of the CommitDigest
parameter is to ensure that QLDB
commits a transaction if and only if the server has processed the exact
set of statements sent by the client, in the same order that client sent
them, and with no duplicates.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
CommitTransactionResult
commitTransactionResult_commitDigest :: Lens' CommitTransactionResult (Maybe ByteString) Source #
The commit digest of the committed transaction.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
commitTransactionResult_consumedIOs :: Lens' CommitTransactionResult (Maybe IOUsage) Source #
Contains metrics about the number of I/O requests that were consumed.
commitTransactionResult_timingInformation :: Lens' CommitTransactionResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
commitTransactionResult_transactionId :: Lens' CommitTransactionResult (Maybe Text) Source #
The transaction ID of the committed transaction.
EndSessionRequest
EndSessionResult
endSessionResult_timingInformation :: Lens' EndSessionResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
ExecuteStatementRequest
executeStatementRequest_parameters :: Lens' ExecuteStatementRequest (Maybe [ValueHolder]) Source #
Specifies the parameters for the parameterized statement in the request.
executeStatementRequest_transactionId :: Lens' ExecuteStatementRequest Text Source #
Specifies the transaction ID of the request.
executeStatementRequest_statement :: Lens' ExecuteStatementRequest Text Source #
Specifies the statement of the request.
ExecuteStatementResult
executeStatementResult_consumedIOs :: Lens' ExecuteStatementResult (Maybe IOUsage) Source #
Contains metrics about the number of I/O requests that were consumed.
executeStatementResult_firstPage :: Lens' ExecuteStatementResult (Maybe Page) Source #
Contains the details of the first fetched page.
executeStatementResult_timingInformation :: Lens' ExecuteStatementResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
FetchPageRequest
fetchPageRequest_transactionId :: Lens' FetchPageRequest Text Source #
Specifies the transaction ID of the page to be fetched.
fetchPageRequest_nextPageToken :: Lens' FetchPageRequest Text Source #
Specifies the next page token of the page to be fetched.
FetchPageResult
fetchPageResult_consumedIOs :: Lens' FetchPageResult (Maybe IOUsage) Source #
Contains metrics about the number of I/O requests that were consumed.
fetchPageResult_page :: Lens' FetchPageResult (Maybe Page) Source #
Contains details of the fetched page.
fetchPageResult_timingInformation :: Lens' FetchPageResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
IOUsage
iOUsage_readIOs :: Lens' IOUsage (Maybe Integer) Source #
The number of read I/O requests that the command made.
iOUsage_writeIOs :: Lens' IOUsage (Maybe Integer) Source #
The number of write I/O requests that the command made.
Page
page_values :: Lens' Page (Maybe [ValueHolder]) Source #
A structure that contains values in multiple encoding formats.
StartSessionRequest
startSessionRequest_ledgerName :: Lens' StartSessionRequest Text Source #
The name of the ledger to start a new session against.
StartSessionResult
startSessionResult_sessionToken :: Lens' StartSessionResult (Maybe Text) Source #
Session token of the started session. This SessionToken
is required
for every subsequent command that is issued during the current session.
startSessionResult_timingInformation :: Lens' StartSessionResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
StartTransactionRequest
StartTransactionResult
startTransactionResult_timingInformation :: Lens' StartTransactionResult (Maybe TimingInformation) Source #
Contains server-side performance information for the command.
startTransactionResult_transactionId :: Lens' StartTransactionResult (Maybe Text) Source #
The transaction ID of the started transaction.
TimingInformation
timingInformation_processingTimeMilliseconds :: Lens' TimingInformation (Maybe Integer) Source #
The amount of time that QLDB spent on processing the command, measured in milliseconds.
ValueHolder
valueHolder_ionBinary :: Lens' ValueHolder (Maybe ByteString) Source #
An Amazon Ion binary value contained in a ValueHolder
structure.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
valueHolder_ionText :: Lens' ValueHolder (Maybe Text) Source #
An Amazon Ion plaintext value contained in a ValueHolder
structure.