qldbsession function

Amazon QLDB Session

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 send_command

  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.

qldbsession(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

• config: Optional configuration of credentials, endpoint, and/or region.

  • credentials :

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token

    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint : The complete URL to use for the constructed client.

  • region : The AWS Region used in instantiating the client.

  • close_connection : Immediately close all HTTP connections.

  • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

  • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

• credentials: Optional credentials shorthand for the config parameter

  • creds :

    • access_key_id : AWS access key ID
    • secret_access_key : AWS secret access key
    • session_token : AWS temporary session token

  • profile : The name of a profile to use. If not given, then the default profile is used.

  • anonymous : Set anonymous credentials.

• endpoint: Optional shorthand for complete URL to use for the constructed client.

• region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- qldbsession(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

Examples

## Not run:

svc <- qldbsession()
svc$send_command(
  Foo = 123
)
## End(Not run)