aws-sdk-dynamodb 1.45.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e7ab1b7eb6c5743bf574f6f54f95c9efdf042da4
-  data.tar.gz: 0e101caf9a248990e4ddfa52c3ca8b073847ff9d
+SHA256:
+  metadata.gz: 17c21a56b3ec35228f0dc9e382315a37ae22ccbb464b42ef28af6631c8f98778
+  data.tar.gz: f1a4dcd833c1132737c26a12dc963481d1dd4fcdaae308bae634cd46820c6ae7
 SHA512:
-  metadata.gz: bbcfaf39a1e03666bde252e223f55f831c99c713f9b2ea3d201e3097a1e9c84f77e1e6f20df3e86c463d6731fff669881aa278f2f54988a8d2e6d5393c43682a
-  data.tar.gz: a384bbc0749ed6381e6893c3392b4ab6eb79726a992c8b85e46ce7ea232385d960cddd59641df1c2178b8b7c270cb76da4def58d5464f333f97ce42ffb2b0301
+  metadata.gz: b0fa58c02f5ed2d24159428eb54c6f675f38d1567c7910a982037a71ca4bab8b102ddf8b1a0fc50a073c30f6837f488de02e0794451f22d6ffc9fc2173ce703b
+  data.tar.gz: 4509fb85376f52e5c6c5e8c56ef37e8da13745bb0305ef155fbd5fd3c7d571891793c9701c248899014cc6514d313696eb143fa91084f1d83751639ac09c3c67

data/lib/aws-sdk-dynamodb.rb

@@ -47,6 +47,6 @@ require_relative 'aws-sdk-dynamodb/customizations'
 # @service
 module Aws::DynamoDB
 
-  GEM_VERSION = '1.45.0'
+  GEM_VERSION = '1.46.0'
 
 end

data/lib/aws-sdk-dynamodb/attribute_value.rb

@@ -48,8 +48,8 @@ module Aws
           when true, false then { bool: obj }
           when nil then { null: true }
           else
-            msg = "unsupported type, expected Hash, Array, Set, String, Numeric, "
-            msg << "IO, true, false, or nil, got #{obj.class.name}"
+            msg = 'unsupported type, expected Hash, Array, Set, String, Numeric, '\
+                  "IO, true, false, or nil, got #{obj.class.name}"
             raise ArgumentError, msg
           end
         end
@@ -64,7 +64,7 @@ module Aws
           when Numeric then { ns: set.map(&:to_s) }
           when StringIO, IO then { bs: set.to_a }
           else
-            msg = "set types only support String, Numeric, or IO objects"
+            msg = 'set types only support String, Numeric, or IO objects'
             raise ArgumentError, msg
           end
         end

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

@@ -35,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:dynamodb)
 module Aws::DynamoDB
   # An API client for DynamoDB.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::DynamoDB::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::DynamoDB::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).
@@ -111,7 +111,7 @@ module Aws::DynamoDB
     #   @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']`
@@ -173,7 +173,7 @@ module Aws::DynamoDB
     #   @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 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
@@ -240,15 +240,19 @@ module Aws::DynamoDB
     #
     #   @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.
+    #
+    #     * `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
     #
@@ -294,8 +298,7 @@ module Aws::DynamoDB
     #
     #   @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 yielded 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 idle before it is
@@ -307,7 +310,7 @@ module Aws::DynamoDB
     #     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 yielded 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`.
@@ -507,6 +510,8 @@ module Aws::DynamoDB
     #   * {Types::BatchGetItemOutput#unprocessed_keys #unprocessed_keys} => Hash<String,Types::KeysAndAttributes>
     #   * {Types::BatchGetItemOutput#consumed_capacity #consumed_capacity} => Array<Types::ConsumedCapacity>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To retrieve multiple items from a table
     #
@@ -2552,6 +2557,12 @@ module Aws::DynamoDB
     #   resp.table.archival_summary.archival_reason #=> String
     #   resp.table.archival_summary.archival_backup_arn #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * table_exists
+    #   * table_not_exists
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTable AWS API Documentation
     #
     # @overload describe_table(params = {})
@@ -2971,6 +2982,8 @@ module Aws::DynamoDB
     #   * {Types::ListContributorInsightsOutput#contributor_insights_summaries #contributor_insights_summaries} => Array<Types::ContributorInsightsSummary>
     #   * {Types::ListContributorInsightsOutput#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_contributor_insights({
@@ -3070,6 +3083,8 @@ module Aws::DynamoDB
     #   * {Types::ListTablesOutput#table_names #table_names} => Array<String>
     #   * {Types::ListTablesOutput#last_evaluated_table_name #last_evaluated_table_name} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To list tables
     #
@@ -3926,6 +3941,8 @@ module Aws::DynamoDB
     #   * {Types::QueryOutput#last_evaluated_key #last_evaluated_key} => Hash<String,Types::AttributeValue>
     #   * {Types::QueryOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To query an item
     #
@@ -4773,6 +4790,8 @@ module Aws::DynamoDB
     #   * {Types::ScanOutput#last_evaluated_key #last_evaluated_key} => Hash<String,Types::AttributeValue>
     #   * {Types::ScanOutput#consumed_capacity #consumed_capacity} => Types::ConsumedCapacity
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To scan a table
     #
@@ -6611,7 +6630,7 @@ module Aws::DynamoDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-dynamodb'
-      context[:gem_version] = '1.45.0'
+      context[:gem_version] = '1.46.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -6677,10 +6696,10 @@ module Aws::DynamoDB
     # The following table lists the valid waiter names, the operations they call,
     # and the default `:delay` and `:max_attempts` values.
     #
-    # | waiter_name      | params            | :delay   | :max_attempts |
-    # | ---------------- | ----------------- | -------- | ------------- |
-    # | table_exists     | {#describe_table} | 20       | 25            |
-    # | table_not_exists | {#describe_table} | 20       | 25            |
+    # | waiter_name      | params                  | :delay   | :max_attempts |
+    # | ---------------- | ----------------------- | -------- | ------------- |
+    # | table_exists     | {Client#describe_table} | 20       | 25            |
+    # | table_not_exists | {Client#describe_table} | 20       | 25            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

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

@@ -6,13 +6,18 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::DynamoDB
+
   # This class provides a resource oriented interface for DynamoDB.
   # To create a resource object:
+  #
   #     resource = Aws::DynamoDB::Resource.new(region: 'us-west-2')
+  #
   # You can supply a client object with custom configuration that will be used for all resource operations.
-  # If you do not pass +:client+, a default client will be constructed.
+  # If you do not pass `:client`, a default client will be constructed.
+  #
   #     client = Aws::DynamoDB::Client.new(region: 'us-west-2')
   #     resource = Aws::DynamoDB::Resource.new(client: client)
+  #
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-dynamodb/table.rb

@@ -394,7 +394,8 @@ module Aws::DynamoDB
     # Waiter polls an API operation until a resource enters a desired
     # state.
     #
-    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    # @note The waiting operation is performed on a copy. The original resource
+    #   remains unchanged.
     #
     # ## Basic Usage
     #
@@ -407,13 +408,15 @@ module Aws::DynamoDB
     #
     # ## Example
     #
-    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #     instance.wait_until(max_attempts:10, delay:5) do |instance|
+    #       instance.state.name == 'running'
+    #     end
     #
     # ## Configuration
     #
     # You can configure the maximum number of polling attempts, and the
-    # delay (in seconds) between each polling attempt. The waiting condition is set
-    # by passing a block to {#wait_until}:
+    # delay (in seconds) between each polling attempt. The waiting condition is
+    # set by passing a block to {#wait_until}:
     #
     #     # poll for ~25 seconds
     #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -444,17 +447,16 @@ module Aws::DynamoDB
     #       # resource did not enter the desired state in time
     #     end
     #
+    # @yieldparam [Resource] resource to be used in the waiting condition.
     #
-    # @yield param [Resource] resource to be used in the waiting condition
-    #
-    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
-    #   because the waiter has entered a state that it will not transition
-    #   out of, preventing success.
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
+    #   terminates because the waiter has entered a state that it will not
+    #   transition out of, preventing success.
     #
     #   yet successful.
     #
-    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
-    #   while polling for a resource that is not expected.
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
+    #   encountered while polling for a resource that is not expected.
     #
     # @raise [NotImplementedError] Raised when the resource does not
     #

data/lib/aws-sdk-dynamodb/waiters.rb

@@ -8,6 +8,68 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::DynamoDB
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name      | params                  | :delay   | :max_attempts |
+  # | ---------------- | ----------------------- | -------- | ------------- |
+  # | table_exists     | {Client#describe_table} | 20       | 25            |
+  # | table_not_exists | {Client#describe_table} | 20       | 25            |
+  #
   module Waiters
 
     class TableExists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-dynamodb
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -88,7 +88,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 - DynamoDB