com.amazonaws.services.qldbsession

Interface AmazonQLDBSession

All Known Subinterfaces:

AmazonQLDBSessionAsync

All Known Implementing Classes:

AbstractAmazonQLDBSession, AbstractAmazonQLDBSessionAsync, AmazonQLDBSessionAsyncClient, AmazonQLDBSessionClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQLDBSession

Interface for accessing QLDB Session.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonQLDBSession instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
SendCommandResult	sendCommand(SendCommandRequest sendCommandRequest) Sends a command to an Amazon QLDB ledger.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

sendCommand

SendCommandResult sendCommand(SendCommandRequest sendCommandRequest)

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.

Parameters:

sendCommandRequest -

Returns:

Result of the SendCommand operation returned by the service.

Throws:

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

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

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

RateExceededException - Returned when the rate of requests exceeds the allowed throughput.

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

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.