Class: Aws::QLDB::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb

Overview

An API client for QLDB. To construct a client, you need to configure a :region and :credentials.

client = Aws::QLDB::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



324
325
326
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 324

def initialize(*args)
  super
end

Instance Method Details

#cancel_journal_kinesis_stream(params = {}) ⇒ Types::CancelJournalKinesisStreamResponse

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE.

You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.

Examples:

Request syntax with placeholder values


resp = client.cancel_journal_kinesis_stream({
  ledger_name: "LedgerName", # required
  stream_id: "UniqueId", # required
})

Response structure


resp.stream_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :ledger_name (required, String)

    The name of the ledger.

  • :stream_id (required, String)

    The unique ID that QLDB assigns to each QLDB journal stream.

Returns:

See Also:



362
363
364
365
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 362

def cancel_journal_kinesis_stream(params = {}, options = {})
  req = build_request(:cancel_journal_kinesis_stream, params)
  req.send_request(options)
end

#create_ledger(params = {}) ⇒ Types::CreateLedgerResponse

Creates a new ledger in your AWS account.

Examples:

Request syntax with placeholder values


resp = client.create_ledger({
  name: "LedgerName", # required
  tags: {
    "TagKey" => "TagValue",
  },
  permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
  deletion_protection: false,
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
resp.creation_date_time #=> Time
resp.deletion_protection #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

    Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

  • :tags (Hash<String,String>)

    The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

  • :permissions_mode (required, String)

    The permissions mode to assign to the ledger that you want to create.

  • :deletion_protection (Boolean)

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Returns:

See Also:



430
431
432
433
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 430

def create_ledger(params = {}, options = {})
  req = build_request(:create_ledger, params)
  req.send_request(options)
end

#delete_ledger(params = {}) ⇒ Struct

Deletes a ledger and all of its contents. This action is irreversible.

If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Examples:

Request syntax with placeholder values


resp = client.delete_ledger({
  name: "LedgerName", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



458
459
460
461
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 458

def delete_ledger(params = {}, options = {})
  req = build_request(:delete_ledger, params)
  req.send_request(options)
end

#describe_journal_kinesis_stream(params = {}) ⇒ Types::DescribeJournalKinesisStreamResponse

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.

Examples:

Request syntax with placeholder values


resp = client.describe_journal_kinesis_stream({
  ledger_name: "LedgerName", # required
  stream_id: "UniqueId", # required
})

Response structure


resp.stream.ledger_name #=> String
resp.stream.creation_time #=> Time
resp.stream.inclusive_start_time #=> Time
resp.stream.exclusive_end_time #=> Time
resp.stream.role_arn #=> String
resp.stream.stream_id #=> String
resp.stream.arn #=> String
resp.stream.status #=> String, one of "ACTIVE", "COMPLETED", "CANCELED", "FAILED", "IMPAIRED"
resp.stream.kinesis_configuration.stream_arn #=> String
resp.stream.kinesis_configuration.aggregation_enabled #=> Boolean
resp.stream.error_cause #=> String, one of "KINESIS_STREAM_NOT_FOUND", "IAM_PERMISSION_REVOKED"
resp.stream.stream_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :ledger_name (required, String)

    The name of the ledger.

  • :stream_id (required, String)

    The unique ID that QLDB assigns to each QLDB journal stream.

Returns:

See Also:



504
505
506
507
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 504

def describe_journal_kinesis_stream(params = {}, options = {})
  req = build_request(:describe_journal_kinesis_stream, params)
  req.send_request(options)
end

#describe_journal_s3_export(params = {}) ⇒ Types::DescribeJournalS3ExportResponse

Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

Examples:

Request syntax with placeholder values


resp = client.describe_journal_s3_export({
  name: "LedgerName", # required
  export_id: "UniqueId", # required
})

Response structure


resp.export_description.ledger_name #=> String
resp.export_description.export_id #=> String
resp.export_description.export_creation_time #=> Time
resp.export_description.status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
resp.export_description.inclusive_start_time #=> Time
resp.export_description.exclusive_end_time #=> Time
resp.export_description.s3_export_configuration.bucket #=> String
resp.export_description.s3_export_configuration.prefix #=> String
resp.export_description.s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
resp.export_description.s3_export_configuration.encryption_configuration.kms_key_arn #=> String
resp.export_description.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :export_id (required, String)

    The unique ID of the journal export job that you want to describe.

Returns:

See Also:



562
563
564
565
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 562

def describe_journal_s3_export(params = {}, options = {})
  req = build_request(:describe_journal_s3_export, params)
  req.send_request(options)
end

#describe_ledger(params = {}) ⇒ Types::DescribeLedgerResponse

Returns information about a ledger, including its state and when it was created.

Examples:

Request syntax with placeholder values


resp = client.describe_ledger({
  name: "LedgerName", # required
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
resp.creation_date_time #=> Time
resp.deletion_protection #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger that you want to describe.

Returns:

See Also:



599
600
601
602
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 599

def describe_ledger(params = {}, options = {})
  req = build_request(:describe_ledger, params)
  req.send_request(options)
end

#export_journal_to_s3(params = {}) ⇒ Types::ExportJournalToS3Response

Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

Examples:

Request syntax with placeholder values


resp = client.export_journal_to_s3({
  name: "LedgerName", # required
  inclusive_start_time: Time.now, # required
  exclusive_end_time: Time.now, # required
  s3_export_configuration: { # required
    bucket: "S3Bucket", # required
    prefix: "S3Prefix", # required
    encryption_configuration: { # required
      object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
      kms_key_arn: "Arn",
    },
  },
  role_arn: "Arn", # required
})

Response structure


resp.export_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :inclusive_start_time (required, Time, DateTime, Date, Integer, String)

    The inclusive start date and time for the range of journal contents that you want to export.

    The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

    The InclusiveStartTime must be before ExclusiveEndTime.

    If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

  • :exclusive_end_time (required, Time, DateTime, Date, Integer, String)

    The exclusive end date and time for the range of journal contents that you want to export.

    The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

    The ExclusiveEndTime must be less than or equal to the current UTC date and time.

  • :s3_export_configuration (required, Types::S3ExportConfiguration)

    The configuration settings of the Amazon S3 bucket destination for your export request.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

    • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    • (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.

Returns:

See Also:



689
690
691
692
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 689

def export_journal_to_s3(params = {}, options = {})
  req = build_request(:export_journal_to_s3, params)
  req.send_request(options)
end

#get_block(params = {}) ⇒ Types::GetBlockResponse

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.

If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

If no block exists with the specified address, then throws InvalidParameterException.

Examples:

Request syntax with placeholder values


resp = client.get_block({
  name: "LedgerName", # required
  block_address: { # required
    ion_text: "IonText",
  },
  digest_tip_address: {
    ion_text: "IonText",
  },
})

Response structure


resp.block.ion_text #=> String
resp.proof.ion_text #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :block_address (required, Types::ValueHolder)

    The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: \{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}

  • :digest_tip_address (Types::ValueHolder)

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: \{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}

Returns:

See Also:



756
757
758
759
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 756

def get_block(params = {}, options = {})
  req = build_request(:get_block, params)
  req.send_request(options)
end

#get_digest(params = {}) ⇒ Types::GetDigestResponse

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

Examples:

Request syntax with placeholder values


resp = client.get_digest({
  name: "LedgerName", # required
})

Response structure


resp.digest #=> String
resp.digest_tip_address.ion_text #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

Returns:

See Also:



788
789
790
791
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 788

def get_digest(params = {}, options = {})
  req = build_request(:get_digest, params)
  req.send_request(options)
end

#get_revision(params = {}) ⇒ Types::GetRevisionResponse

Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

Examples:

Request syntax with placeholder values


resp = client.get_revision({
  name: "LedgerName", # required
  block_address: { # required
    ion_text: "IonText",
  },
  document_id: "UniqueId", # required
  digest_tip_address: {
    ion_text: "IonText",
  },
})

Response structure


resp.proof.ion_text #=> String
resp.revision.ion_text #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :block_address (required, Types::ValueHolder)

    The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: \{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}

  • :document_id (required, String)

    The unique ID of the document to be verified.

  • :digest_tip_address (Types::ValueHolder)

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: \{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}

Returns:

See Also:



844
845
846
847
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 844

def get_revision(params = {}, options = {})
  req = build_request(:get_revision, params)
  req.send_request(options)
end

#list_journal_kinesis_streams_for_ledger(params = {}) ⇒ Types::ListJournalKinesisStreamsForLedgerResponse

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_journal_kinesis_streams_for_ledger({
  ledger_name: "LedgerName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.streams #=> Array
resp.streams[0].ledger_name #=> String
resp.streams[0].creation_time #=> Time
resp.streams[0].inclusive_start_time #=> Time
resp.streams[0].exclusive_end_time #=> Time
resp.streams[0].role_arn #=> String
resp.streams[0].stream_id #=> String
resp.streams[0].arn #=> String
resp.streams[0].status #=> String, one of "ACTIVE", "COMPLETED", "CANCELED", "FAILED", "IMPAIRED"
resp.streams[0].kinesis_configuration.stream_arn #=> String
resp.streams[0].kinesis_configuration.aggregation_enabled #=> Boolean
resp.streams[0].error_cause #=> String, one of "KINESIS_STREAM_NOT_FOUND", "IAM_PERMISSION_REVOKED"
resp.streams[0].stream_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :ledger_name (required, String)

    The name of the ledger.

  • :max_results (Integer)

    The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

  • :next_token (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here.

Returns:

See Also:



907
908
909
910
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 907

def list_journal_kinesis_streams_for_ledger(params = {}, options = {})
  req = build_request(:list_journal_kinesis_streams_for_ledger, params)
  req.send_request(options)
end

#list_journal_s3_exports(params = {}) ⇒ Types::ListJournalS3ExportsResponse

Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_journal_s3_exports({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.journal_s3_exports #=> Array
resp.journal_s3_exports[0].ledger_name #=> String
resp.journal_s3_exports[0].export_id #=> String
resp.journal_s3_exports[0].export_creation_time #=> Time
resp.journal_s3_exports[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
resp.journal_s3_exports[0].inclusive_start_time #=> Time
resp.journal_s3_exports[0].exclusive_end_time #=> Time
resp.journal_s3_exports[0].s3_export_configuration.bucket #=> String
resp.journal_s3_exports[0].s3_export_configuration.prefix #=> String
resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.kms_key_arn #=> String
resp.journal_s3_exports[0].role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.)

  • :next_token (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3Exports call, then you should use that value as input here.

Returns:

See Also:



972
973
974
975
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 972

def list_journal_s3_exports(params = {}, options = {})
  req = build_request(:list_journal_s3_exports, params)
  req.send_request(options)
end

#list_journal_s3_exports_for_ledger(params = {}) ⇒ Types::ListJournalS3ExportsForLedgerResponse

Returns an array of journal export job descriptions for a specified ledger.

This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_journal_s3_exports_for_ledger({
  name: "LedgerName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.journal_s3_exports #=> Array
resp.journal_s3_exports[0].ledger_name #=> String
resp.journal_s3_exports[0].export_id #=> String
resp.journal_s3_exports[0].export_creation_time #=> Time
resp.journal_s3_exports[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
resp.journal_s3_exports[0].inclusive_start_time #=> Time
resp.journal_s3_exports[0].exclusive_end_time #=> Time
resp.journal_s3_exports[0].s3_export_configuration.bucket #=> String
resp.journal_s3_exports[0].s3_export_configuration.prefix #=> String
resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.kms_key_arn #=> String
resp.journal_s3_exports[0].role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :max_results (Integer)

    The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)

  • :next_token (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you should use that value as input here.

Returns:

See Also:



1041
1042
1043
1044
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1041

def list_journal_s3_exports_for_ledger(params = {}, options = {})
  req = build_request(:list_journal_s3_exports_for_ledger, params)
  req.send_request(options)
end

#list_ledgers(params = {}) ⇒ Types::ListLedgersResponse

Returns an array of ledger summaries that are associated with the current AWS account and Region.

This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ledgers({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.ledgers #=> Array
resp.ledgers[0].name #=> String
resp.ledgers[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
resp.ledgers[0].creation_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)

  • :next_token (String)

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListLedgers call, then you should use that value as input here.

Returns:

See Also:



1089
1090
1091
1092
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1089

def list_ledgers(params = {}, options = {})
  req = build_request(:list_ledgers, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns all tags for a specified Amazon QLDB resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) for which you want to list the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

Returns:

See Also:



1121
1122
1123
1124
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1121

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#stream_journal_to_kinesis(params = {}) ⇒ Types::StreamJournalToKinesisResponse

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

Examples:

Request syntax with placeholder values


resp = client.stream_journal_to_kinesis({
  ledger_name: "LedgerName", # required
  role_arn: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  inclusive_start_time: Time.now, # required
  exclusive_end_time: Time.now,
  kinesis_configuration: { # required
    stream_arn: "Arn", # required
    aggregation_enabled: false,
  },
  stream_name: "StreamName", # required
})

Response structure


resp.stream_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :ledger_name (required, String)

    The name of the ledger.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

  • :tags (Hash<String,String>)

    The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

  • :inclusive_start_time (required, Time, DateTime, Date, Integer, String)

    The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

    The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

    If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

  • :exclusive_end_time (Time, DateTime, Date, Integer, String)

    The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

    The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

  • :kinesis_configuration (required, Types::KinesisConfiguration)

    The configuration settings of the Kinesis Data Streams destination for your stream request.

  • :stream_name (required, String)

    The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

    Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Returns:

See Also:



1213
1214
1215
1216
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1213

def stream_journal_to_kinesis(params = {}, options = {})
  req = build_request(:stream_journal_to_kinesis, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to a specified Amazon QLDB resource.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) to which you want to add the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • :tags (required, Hash<String,String>)

    The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1250
1251
1252
1253
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1250

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) from which you want to remove the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

  • :tag_keys (required, Array<String>)

    The list of tag keys that you want to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1280
1281
1282
1283
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1280

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_ledger(params = {}) ⇒ Types::UpdateLedgerResponse

Updates properties on a ledger.

Examples:

Request syntax with placeholder values


resp = client.update_ledger({
  name: "LedgerName", # required
  deletion_protection: false,
})

Response structure


resp.name #=> String
resp.arn #=> String
resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
resp.creation_date_time #=> Time
resp.deletion_protection #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the ledger.

  • :deletion_protection (Boolean)

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Returns:

See Also:



1328
1329
1330
1331
# File 'gems/aws-sdk-qldb/lib/aws-sdk-qldb/client.rb', line 1328

def update_ledger(params = {}, options = {})
  req = build_request(:update_ledger, params)
  req.send_request(options)
end