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

Amazonka.QLDBSession.SendCommand

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends a command to an Amazon QLDB ledger.

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 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.

Synopsis

Creating a Request

data SendCommand Source #

See: newSendCommand smart constructor.

Constructors

SendCommand'

Fields

abortTransaction :: Maybe AbortTransactionRequest
Command to abort the current transaction.
commitTransaction :: Maybe CommitTransactionRequest
Command to commit the specified transaction.
endSession :: Maybe EndSessionRequest
Command to end the current session.
executeStatement :: Maybe ExecuteStatementRequest
Command to execute a statement in the specified transaction.
fetchPage :: Maybe FetchPageRequest
Command to fetch a page.
sessionToken :: Maybe Text
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.
startSession :: Maybe StartSessionRequest
Command to start a new session. A session token is obtained as part of the response.
startTransaction :: Maybe StartTransactionRequest
Command to start a new transaction.

Instances

Instances details

ToJSON SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods toJSON :: SendCommand -> Value # toEncoding :: SendCommand -> Encoding # toJSONList :: [SendCommand] -> Value # toEncodingList :: [SendCommand] -> Encoding #
ToHeaders SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods toHeaders :: SendCommand -> [Header] #
ToPath SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods toPath :: SendCommand -> ByteString #
ToQuery SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods toQuery :: SendCommand -> QueryString #
AWSRequest SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Associated Types type AWSResponse SendCommand # Methods request :: (Service -> Service) -> SendCommand -> Request SendCommand # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendCommand -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendCommand))) #
Generic SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Associated Types type Rep SendCommand :: Type -> Type # Methods from :: SendCommand -> Rep SendCommand x # to :: Rep SendCommand x -> SendCommand #
Read SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods readsPrec :: Int -> ReadS SendCommand # readList :: ReadS [SendCommand] # readPrec :: ReadPrec SendCommand # readListPrec :: ReadPrec [SendCommand] #
Show SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods showsPrec :: Int -> SendCommand -> ShowS # show :: SendCommand -> String # showList :: [SendCommand] -> ShowS #
NFData SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods rnf :: SendCommand -> () #
Eq SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods (==) :: SendCommand -> SendCommand -> Bool # (/=) :: SendCommand -> SendCommand -> Bool #
Hashable SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods hashWithSalt :: Int -> SendCommand -> Int # hash :: SendCommand -> Int #
type AWSResponse SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand type AWSResponse SendCommand = SendCommandResponse
type Rep SendCommand Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand type Rep SendCommand = D1 ('MetaData "SendCommand" "Amazonka.QLDBSession.SendCommand" "amazonka-qldb-session-2.0-gRYyYLKJNC7JJpkGq35oC" 'False) (C1 ('MetaCons "SendCommand'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abortTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbortTransactionRequest)) :: S1 ('MetaSel ('Just "commitTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommitTransactionRequest))) :: (S1 ('MetaSel ('Just "endSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndSessionRequest)) :: S1 ('MetaSel ('Just "executeStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecuteStatementRequest)))) :: ((S1 ('MetaSel ('Just "fetchPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FetchPageRequest)) :: S1 ('MetaSel ('Just "sessionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartSessionRequest)) :*: S1 ('MetaSel ('Just "startTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartTransactionRequest))))))

newSendCommand :: SendCommand Source #

Create a value of SendCommand with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SendCommand, sendCommand_abortTransaction - Command to abort the current transaction.

SendCommand, sendCommand_commitTransaction - Command to commit the specified transaction.

SendCommand, sendCommand_endSession - Command to end the current session.

SendCommand, sendCommand_executeStatement - Command to execute a statement in the specified transaction.

SendCommand, sendCommand_fetchPage - Command to fetch a page.

SendCommand, sendCommand_sessionToken - 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, sendCommand_startSession - Command to start a new session. A session token is obtained as part of the response.

SendCommand, sendCommand_startTransaction - Command to start a new transaction.

Request Lenses

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.

Destructuring the Response

data SendCommandResponse Source #

See: newSendCommandResponse smart constructor.

Constructors

SendCommandResponse'

Fields

abortTransaction :: Maybe AbortTransactionResult
Contains the details of the aborted transaction.
commitTransaction :: Maybe CommitTransactionResult
Contains the details of the committed transaction.
endSession :: Maybe EndSessionResult
Contains the details of the ended session.
executeStatement :: Maybe ExecuteStatementResult
Contains the details of the executed statement.
fetchPage :: Maybe FetchPageResult
Contains the details of the fetched page.
startSession :: Maybe StartSessionResult
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.
startTransaction :: Maybe StartTransactionResult
Contains the details of the started transaction.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Associated Types type Rep SendCommandResponse :: Type -> Type # Methods from :: SendCommandResponse -> Rep SendCommandResponse x # to :: Rep SendCommandResponse x -> SendCommandResponse #
Read SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods readsPrec :: Int -> ReadS SendCommandResponse # readList :: ReadS [SendCommandResponse] # readPrec :: ReadPrec SendCommandResponse # readListPrec :: ReadPrec [SendCommandResponse] #
Show SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods showsPrec :: Int -> SendCommandResponse -> ShowS # show :: SendCommandResponse -> String # showList :: [SendCommandResponse] -> ShowS #
NFData SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods rnf :: SendCommandResponse -> () #
Eq SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand Methods (==) :: SendCommandResponse -> SendCommandResponse -> Bool # (/=) :: SendCommandResponse -> SendCommandResponse -> Bool #
type Rep SendCommandResponse Source #
Instance details Defined in Amazonka.QLDBSession.SendCommand type Rep SendCommandResponse = D1 ('MetaData "SendCommandResponse" "Amazonka.QLDBSession.SendCommand" "amazonka-qldb-session-2.0-gRYyYLKJNC7JJpkGq35oC" 'False) (C1 ('MetaCons "SendCommandResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abortTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbortTransactionResult)) :: S1 ('MetaSel ('Just "commitTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommitTransactionResult))) :: (S1 ('MetaSel ('Just "endSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndSessionResult)) :: S1 ('MetaSel ('Just "executeStatement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecuteStatementResult)))) :: ((S1 ('MetaSel ('Just "fetchPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FetchPageResult)) :: S1 ('MetaSel ('Just "startSession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartSessionResult))) :: (S1 ('MetaSel ('Just "startTransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StartTransactionResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newSendCommandResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendCommandResponse'`
-> SendCommandResponse

Create a value of SendCommandResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SendCommand, sendCommandResponse_abortTransaction - Contains the details of the aborted transaction.

SendCommand, sendCommandResponse_commitTransaction - Contains the details of the committed transaction.

SendCommand, sendCommandResponse_endSession - Contains the details of the ended session.

SendCommand, sendCommandResponse_executeStatement - Contains the details of the executed statement.

SendCommand, sendCommandResponse_fetchPage - Contains the details of the fetched page.

SendCommand, sendCommandResponse_startSession - 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.

SendCommand, sendCommandResponse_startTransaction - Contains the details of the started transaction.

$sel:httpStatus:SendCommandResponse', sendCommandResponse_httpStatus - The response's http status code.

Response Lenses

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.