qldbsession/aws.sdk.kotlin.services.qldbsession/QldbSessionClient

QldbSessionClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<QldbSessionClient.Config, QldbSessionClient.Config.Builder, QldbSessionClient>

Companion

object Companion : AbstractAwsSdkClientFactory<QldbSessionClient.Config, QldbSessionClient.Config.Builder, QldbSessionClient, QldbSessionClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: QldbSessionClient.Config

QldbSessionClient's configuration

Functions

sendCommand

abstract suspend fun sendCommand(input: SendCommandRequest = SendCommandRequest { }): SendCommandResponse

Sends a command to an Amazon QLDB ledger.

Inherited functions

expect abstract fun close()

sendCommand

inline suspend fun QldbSessionClient.sendCommand(crossinline block: SendCommandRequest.Builder.() -> Unit): SendCommandResponse

Sends a command to an Amazon QLDB ledger.

withConfig

fun QldbSessionClient.withConfig(block: QldbSessionClient.Config.Builder.() -> Unit): QldbSessionClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.