'2.0', 'service' => '

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

', 'operations' => [ 'SendCommand' => '

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.

', ], 'shapes' => [ 'AbortTransactionRequest' => [ 'base' => '

Contains the details of the transaction to abort.

', 'refs' => [ 'SendCommandRequest$AbortTransaction' => '

Command to abort the current transaction.

', ], ], 'AbortTransactionResult' => [ 'base' => '

Contains the details of the aborted transaction.

', 'refs' => [ 'SendCommandResult$AbortTransaction' => '

Contains the details of the aborted transaction.

', ], ], 'BadRequestException' => [ 'base' => '

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

', 'refs' => [], ], 'CapacityExceededException' => [ 'base' => '

Returned when the request exceeds the processing capacity of the ledger.

', 'refs' => [], ], 'CommitDigest' => [ 'base' => NULL, 'refs' => [ 'CommitTransactionRequest$CommitDigest' => '

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.

', 'CommitTransactionResult$CommitDigest' => '

The commit digest of the committed transaction.

', ], ], 'CommitTransactionRequest' => [ 'base' => '

Contains the details of the transaction to commit.

', 'refs' => [ 'SendCommandRequest$CommitTransaction' => '

Command to commit the specified transaction.

', ], ], 'CommitTransactionResult' => [ 'base' => '

Contains the details of the committed transaction.

', 'refs' => [ 'SendCommandResult$CommitTransaction' => '

Contains the details of the committed transaction.

', ], ], 'EndSessionRequest' => [ 'base' => '

Specifies a request to end the session.

', 'refs' => [ 'SendCommandRequest$EndSession' => '

Command to end the current session.

', ], ], 'EndSessionResult' => [ 'base' => '

Contains the details of the ended session.

', 'refs' => [ 'SendCommandResult$EndSession' => '

Contains the details of the ended session.

', ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Code' => NULL, 'InvalidSessionException$Code' => NULL, ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BadRequestException$Message' => NULL, 'CapacityExceededException$Message' => NULL, 'InvalidSessionException$Message' => NULL, 'LimitExceededException$Message' => NULL, 'OccConflictException$Message' => NULL, 'RateExceededException$Message' => NULL, ], ], 'ExecuteStatementRequest' => [ 'base' => '

Specifies a request to execute a statement.

', 'refs' => [ 'SendCommandRequest$ExecuteStatement' => '

Command to execute a statement in the specified transaction.

', ], ], 'ExecuteStatementResult' => [ 'base' => '

Contains the details of the executed statement.

', 'refs' => [ 'SendCommandResult$ExecuteStatement' => '

Contains the details of the executed statement.

', ], ], 'FetchPageRequest' => [ 'base' => '

Specifies the details of the page to be fetched.

', 'refs' => [ 'SendCommandRequest$FetchPage' => '

Command to fetch a page.

', ], ], 'FetchPageResult' => [ 'base' => '

Contains the page that was fetched.

', 'refs' => [ 'SendCommandResult$FetchPage' => '

Contains the details of the fetched page.

', ], ], 'IOUsage' => [ 'base' => '

Contains I/O usage metrics for a command that was invoked.

', 'refs' => [ 'CommitTransactionResult$ConsumedIOs' => '

Contains metrics about the number of I/O requests that were consumed.

', 'ExecuteStatementResult$ConsumedIOs' => '

Contains metrics about the number of I/O requests that were consumed.

', 'FetchPageResult$ConsumedIOs' => '

Contains metrics about the number of I/O requests that were consumed.

', ], ], 'InvalidSessionException' => [ 'base' => '

Returned if the session doesn\'t exist anymore because it timed out or expired.

', 'refs' => [], ], 'IonBinary' => [ 'base' => NULL, 'refs' => [ 'ValueHolder$IonBinary' => '

An Amazon Ion binary value contained in a ValueHolder structure.

', ], ], 'IonText' => [ 'base' => NULL, 'refs' => [ 'ValueHolder$IonText' => '

An Amazon Ion plaintext value contained in a ValueHolder structure.

', ], ], 'LedgerName' => [ 'base' => NULL, 'refs' => [ 'StartSessionRequest$LedgerName' => '

The name of the ledger to start a new session against.

', ], ], 'LimitExceededException' => [ 'base' => '

Returned if a resource limit such as number of active sessions is exceeded.

', 'refs' => [], ], 'OccConflictException' => [ 'base' => '

Returned when a transaction cannot be written to the journal due to a failure in the verification phase of optimistic concurrency control (OCC).

', 'refs' => [], ], 'Page' => [ 'base' => '

Contains details of the fetched page.

', 'refs' => [ 'ExecuteStatementResult$FirstPage' => '

Contains the details of the first fetched page.

', 'FetchPageResult$Page' => '

Contains details of the fetched page.

', ], ], 'PageToken' => [ 'base' => NULL, 'refs' => [ 'FetchPageRequest$NextPageToken' => '

Specifies the next page token of the page to be fetched.

', 'Page$NextPageToken' => '

The token of the next page.

', ], ], 'ProcessingTimeMilliseconds' => [ 'base' => NULL, 'refs' => [ 'TimingInformation$ProcessingTimeMilliseconds' => '

The amount of time that QLDB spent on processing the command, measured in milliseconds.

', ], ], 'RateExceededException' => [ 'base' => '

Returned when the rate of requests exceeds the allowed throughput.

', 'refs' => [], ], 'ReadIOs' => [ 'base' => NULL, 'refs' => [ 'IOUsage$ReadIOs' => '

The number of read I/O requests that the command made.

', ], ], 'SendCommandRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendCommandResult' => [ 'base' => NULL, 'refs' => [], ], 'SessionToken' => [ 'base' => NULL, 'refs' => [ 'SendCommandRequest$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.

', 'StartSessionResult$SessionToken' => '

Session token of the started session. This SessionToken is required for every subsequent command that is issued during the current session.

', ], ], 'StartSessionRequest' => [ 'base' => '

Specifies a request to start a new session.

', 'refs' => [ 'SendCommandRequest$StartSession' => '

Command to start a new session. A session token is obtained as part of the response.

', ], ], 'StartSessionResult' => [ 'base' => '

Contains the details of the started session.

', 'refs' => [ 'SendCommandResult$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.

', ], ], 'StartTransactionRequest' => [ 'base' => '

Specifies a request to start a transaction.

', 'refs' => [ 'SendCommandRequest$StartTransaction' => '

Command to start a new transaction.

', ], ], 'StartTransactionResult' => [ 'base' => '

Contains the details of the started transaction.

', 'refs' => [ 'SendCommandResult$StartTransaction' => '

Contains the details of the started transaction.

', ], ], 'Statement' => [ 'base' => NULL, 'refs' => [ 'ExecuteStatementRequest$Statement' => '

Specifies the statement of the request.

', ], ], 'StatementParameters' => [ 'base' => NULL, 'refs' => [ 'ExecuteStatementRequest$Parameters' => '

Specifies the parameters for the parameterized statement in the request.

', ], ], 'TimingInformation' => [ 'base' => '

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.

', 'refs' => [ 'AbortTransactionResult$TimingInformation' => '