Skip to content

Client

qldb R Documentation

Amazon QLDB

Description

The resource management API for Amazon QLDB

Usage

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

Value

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 <- qldb(
  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

cancel_journal_kinesis_stream Ends a given Amazon QLDB journal stream
create_ledger Creates a new ledger in your Amazon Web Services account in the current Region
delete_ledger Deletes a ledger and all of its contents
describe_journal_kinesis_stream Returns detailed information about a given Amazon QLDB journal stream
describe_journal_s3_export Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request
describe_ledger Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created
export_journal_to_s3 Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket
get_block Returns a block object at a specified address in a journal
get_digest Returns the digest of a ledger at the latest committed block in the journal
get_revision Returns a revision data object for a specified document ID and block address
list_journal_kinesis_streams_for_ledger Returns all Amazon QLDB journal streams for a given ledger
list_journal_s3_exports Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region
list_journal_s3_exports_for_ledger Returns all journal export jobs for a specified ledger
list_ledgers Returns all ledgers that are associated with the current Amazon Web Services account and Region
list_tags_for_resource Returns all tags for a specified Amazon QLDB resource
stream_journal_to_kinesis Creates a journal stream for a given Amazon QLDB ledger
tag_resource Adds one or more tags to a specified Amazon QLDB resource
untag_resource Removes one or more tags from a specified Amazon QLDB resource
update_ledger Updates properties on a ledger
update_ledger_permissions_mode Updates the permissions mode of a ledger

Examples

## Not run: 
svc <- qldb()
svc$cancel_journal_kinesis_stream(
  Foo = 123
)

## End(Not run)