aws-sdk-qldbsession 1.0.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 522b84c7773a28e65d501c9c87252bc46948f81a
-  data.tar.gz: d474bac277b3912964cfec14edef658dc5eace01
+SHA256:
+  metadata.gz: 4de43ed0fa7cd7a33095fe7b3cbcae4306a8b5f59f2de1df0ea02924aad81f55
+  data.tar.gz: 160dec99182489e972de822c9421738e887fcc90d50416e421f8ac4fb6543513
 SHA512:
-  metadata.gz: 19cfc5d906b5aefe216e1b2d8e33ea2f63e046b5c73a332bd1cbb8d487fc5f0f23b6c7c05eaa59ddcb505642f9e201278933120e7bee5de4fc47c6e8e8a7db19
-  data.tar.gz: 4082d43f1848593ccd1b8689bcaec7ffd58d07c2206a5b90ca48572c1dd5a3f61a44097d64a53f5133cceefbc59018dbb4bc61e791cf7d9d1912941f320bc0e4
+  metadata.gz: b5909be9378d802d38bee8dd4ded509d376aedb31a970fdf67caacfbd3b472ad20dfff0a0466d031f5ce6e77bf84862bb544a20b118ac9f6c976910e4f437f49
+  data.tar.gz: fcc108ddb1291b35c37d931aa516a39913a14b9c4ac4939d10fe6bb69193a13b170d386aa84a0acf0448d6c64663312e52bbc7ac4583df1e3e6064417fb3b706

data/lib/aws-sdk-qldbsession.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-qldbsession/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     qldb_session = Aws::QLDBSession::Client.new
+#     resp = qldb_session.send_command(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon QLDB Session all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon QLDB Session are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::QLDBSession::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon QLDB Session API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-qldbsession/customizations'
 # @service
 module Aws::QLDBSession
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.5.1'
 
 end

data/lib/aws-sdk-qldbsession/client.rb

@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:qldbsession)
 
 module Aws::QLDBSession
+  # An API client for QLDBSession.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::QLDBSession::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::QLDBSession
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -93,7 +107,7 @@ module Aws::QLDBSession
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::QLDBSession
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (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.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +152,10 @@ module Aws::QLDBSession
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::QLDBSession
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::QLDBSession
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +190,29 @@ module Aws::QLDBSession
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (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.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (: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.
+    #     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
     #
@@ -182,11 +220,30 @@ module Aws::QLDBSession
     #     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 and auth
-    #     errors from expired credentials.
+    #     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.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     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.
+    #
+    #   @option options [String] :retry_mode ("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.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -219,16 +276,15 @@ module Aws::QLDBSession
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     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.
     #
@@ -237,7 +293,7 @@ module Aws::QLDBSession
     #     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 yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -266,6 +322,29 @@ module Aws::QLDBSession
 
     # Sends a command to an Amazon QLDB ledger.
     #
+    # <note markdown="1"> Instead of interacting directly with this API, we recommend that you
+    # use the Amazon 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 `qldbsession`
+    #   data plane and manages `SendCommand` API calls for you. For
+    #   information and a list of supported programming languages, see
+    #   [Getting started with the driver][1] 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][2].
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html
+    # [2]: https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html
+    #
     # @option params [String] :session_token
     #   Specifies the session token for the current command. A session token
     #   is constant throughout the life of the session.
@@ -376,7 +455,7 @@ module Aws::QLDBSession
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-qldbsession'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.5.1'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-qldbsession/errors.rb

@@ -6,6 +6,33 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::QLDBSession
+
+  # When QLDBSession returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::QLDBSession::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all QLDBSession errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::QLDBSession::Errors::ServiceError
+  #       # rescues all QLDBSession API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {BadRequestException}
+  # * {InvalidSessionException}
+  # * {LimitExceededException}
+  # * {OccConflictException}
+  # * {RateExceededException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -28,7 +55,6 @@ module Aws::QLDBSession
       def code
         @code || @data[:code]
       end
-
     end
 
     class InvalidSessionException < ServiceError
@@ -49,7 +75,6 @@ module Aws::QLDBSession
       def code
         @code || @data[:code]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -65,7 +90,6 @@ module Aws::QLDBSession
       def message
         @message || @data[:message]
       end
-
     end
 
     class OccConflictException < ServiceError
@@ -81,7 +105,6 @@ module Aws::QLDBSession
       def message
         @message || @data[:message]
       end
-
     end
 
     class RateExceededException < ServiceError
@@ -97,7 +120,6 @@ module Aws::QLDBSession
       def message
         @message || @data[:message]
       end
-
     end
 
   end

data/lib/aws-sdk-qldbsession/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::QLDBSession
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-qldbsession/types.rb

@@ -50,7 +50,7 @@ module Aws::QLDBSession
     #       }
     #
     # @!attribute [rw] transaction_id
-    #   Specifies the transaction id of the transaction to commit.
+    #   Specifies the transaction ID of the transaction to commit.
     #   @return [String]
     #
     # @!attribute [rw] commit_digest
@@ -71,7 +71,7 @@ module Aws::QLDBSession
     # Contains the details of the committed transaction.
     #
     # @!attribute [rw] transaction_id
-    #   The transaction id of the committed transaction.
+    #   The transaction ID of the committed transaction.
     #   @return [String]
     #
     # @!attribute [rw] commit_digest
@@ -117,7 +117,7 @@ module Aws::QLDBSession
     #       }
     #
     # @!attribute [rw] transaction_id
-    #   Specifies the transaction id of the request.
+    #   Specifies the transaction ID of the request.
     #   @return [String]
     #
     # @!attribute [rw] statement
@@ -162,7 +162,7 @@ module Aws::QLDBSession
     #       }
     #
     # @!attribute [rw] transaction_id
-    #   Specifies the transaction id of the page to be fetched.
+    #   Specifies the transaction ID of the page to be fetched.
     #   @return [String]
     #
     # @!attribute [rw] next_page_token
@@ -190,7 +190,7 @@ module Aws::QLDBSession
       include Aws::Structure
     end
 
-    # Returned if the session doesn't exist anymore because it timed-out or
+    # Returned if the session doesn't exist anymore because it timed out or
     # expired.
     #
     # @!attribute [rw] message
@@ -221,7 +221,8 @@ module Aws::QLDBSession
     end
 
     # Returned when a transaction cannot be written to the journal due to a
-    # failure in the verification phase of Optimistic Concurrency Control.
+    # failure in the verification phase of *optimistic concurrency control*
+    # (OCC).
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -392,7 +393,7 @@ module Aws::QLDBSession
       include Aws::Structure
     end
 
-    # Specifies a request to start a a new session.
+    # Specifies a request to start a new session.
     #
     # @note When making an API call, you may pass StartSessionRequest
     #   data as a hash:
@@ -438,7 +439,7 @@ module Aws::QLDBSession
     # Contains the details of the started transaction.
     #
     # @!attribute [rw] transaction_id
-    #   The transaction id of the started transaction.
+    #   The transaction ID of the started transaction.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-session-2019-07-11/StartTransactionResult AWS API Documentation
@@ -448,7 +449,8 @@ module Aws::QLDBSession
       include Aws::Structure
     end
 
-    # A structure that can contains values in multiple encoding formats.
+    # A structure that can contain an Amazon Ion value in multiple encoding
+    # formats.
     #
     # @note When making an API call, you may pass ValueHolder
     #   data as a hash:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-qldbsession
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - QLDB Session