Interface QldbSessionClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic QldbSessionClientBuilder
builder()
Create a builder that can be used to configure and create aQldbSessionClient
.static QldbSessionClient
create()
Create aQldbSessionClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default SendCommandResponse
sendCommand
(Consumer<SendCommandRequest.Builder> sendCommandRequest) Sends a command to an Amazon QLDB ledger.default SendCommandResponse
sendCommand
(SendCommandRequest sendCommandRequest) Sends a command to an Amazon QLDB ledger.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
sendCommand
default SendCommandResponse sendCommand(SendCommandRequest sendCommandRequest) throws BadRequestException, InvalidSessionException, OccConflictException, RateExceededException, LimitExceededException, CapacityExceededException, AwsServiceException, SdkClientException, QldbSessionException 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.
- See Also:
-
-
sendCommand
default SendCommandResponse sendCommand(Consumer<SendCommandRequest.Builder> sendCommandRequest) throws BadRequestException, InvalidSessionException, OccConflictException, RateExceededException, LimitExceededException, CapacityExceededException, AwsServiceException, SdkClientException, QldbSessionException 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.
This is a convenience which creates an instance of the
SendCommandRequest.Builder
avoiding the need to create one manually viaSendCommandRequest.builder()
- Parameters:
sendCommandRequest
- AConsumer
that will call methods onSendCommandRequest.Builder
to create a request.- Returns:
- Result of the SendCommand operation returned by the service.
- See Also:
-
-
create
Create aQldbSessionClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQldbSessionClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-