aws-sdk-kinesis 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16fc2f718c441ad022ba4bce8849076c0bf400e0
-  data.tar.gz: 313a191dbdaab09d51fe89db039e92caa54be7c2
+SHA256:
+  metadata.gz: def11d9ea166ae0e3582f3e7eaf97a1efd74a4df29d2e36980a4cfea83a279b9
+  data.tar.gz: 0ac31606c17612fb8ec70885a056293884234a205fadbb99df5fe122fe604948
 SHA512:
-  metadata.gz: 26ac9871e938b5463a539ebfa0f12c0df7fa5346e08a0abbd56a471530e793dc81f702dc36f03afc834a15cad168b27d1a6a245ced54498a1abacb6e1fe2f09c
-  data.tar.gz: 555cefc3860e47c67ca52628f887511031a44b1b42b1c8657960888cab5e677caa7e7aabf744969ea2ec2e567861e78da62e843a259b154ac678f2ba3f52da4f
+  metadata.gz: 9978c6457020e7b7e5a4a5d3eecef9df071e4abaf28885725ea0ce0d39caf25583bfbb57de8d8728099da4ac53b82f2dc9e006020444c15b993eb5ffc514c9d2
+  data.tar.gz: ac4ba901bfa03e78ceaeffda9a1381ebd73b4b86b37e69abd8a14ab0862854c0c102412ecee904f4c240edf0901f16327fd2f08d228e43359aea261fedf96006

data/lib/aws-sdk-kinesis.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kinesis/event_streams'
 # @service
 module Aws::Kinesis
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.22.0'
 
 end

data/lib/aws-sdk-kinesis/async_client.rb

@@ -88,7 +88,7 @@ module Aws::Kinesis
     #   @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']`
@@ -116,7 +116,7 @@ module Aws::Kinesis
     #   @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 [Proc] :event_stream_handler
     #     When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
@@ -178,15 +178,19 @@ module Aws::Kinesis
     #
     #   @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
     #
@@ -512,7 +516,7 @@ module Aws::Kinesis
         http_response: Seahorse::Client::Http::AsyncResponse.new,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesis'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -525,8 +529,8 @@ module Aws::Kinesis
       when nil then event_stream_class.new
       else
         msg = "expected #{type}_event_stream_handler to be a block or "\
-          "instance of Aws::Kinesis::#{event_stream_class}"\
-          ", got `#{handler.inspect}` instead"
+              "instance of Aws::Kinesis::#{event_stream_class}"\
+              ", got `#{handler.inspect}` instead"
         raise ArgumentError, msg
       end
     end

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

@@ -33,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:kinesis)
 module Aws::Kinesis
   # An API client for Kinesis.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::Kinesis::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::Kinesis::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).
@@ -107,7 +107,7 @@ module Aws::Kinesis
     #   @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']`
@@ -163,7 +163,7 @@ module Aws::Kinesis
     #   @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::Kinesis
     #
     #   @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
     #
@@ -286,8 +290,7 @@ module Aws::Kinesis
     #
     #   @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
@@ -299,7 +302,7 @@ module Aws::Kinesis
     #     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`.
@@ -640,6 +643,8 @@ module Aws::Kinesis
     #
     #   * {Types::DescribeStreamOutput#stream_description #stream_description} => Types::StreamDescription
     #
+    # 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.describe_stream({
@@ -670,6 +675,12 @@ module Aws::Kinesis
     #   resp.stream_description.encryption_type #=> String, one of "NONE", "KMS"
     #   resp.stream_description.key_id #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * stream_exists
+    #   * stream_not_exists
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStream AWS API Documentation
     #
     # @overload describe_stream(params = {})
@@ -1349,6 +1360,8 @@ module Aws::Kinesis
     #   * {Types::ListStreamConsumersOutput#consumers #consumers} => Array<Types::Consumer>
     #   * {Types::ListStreamConsumersOutput#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_stream_consumers({
@@ -1406,6 +1419,8 @@ module Aws::Kinesis
     #   * {Types::ListStreamsOutput#stream_names #stream_names} => Array<String>
     #   * {Types::ListStreamsOutput#has_more_streams #has_more_streams} => Boolean
     #
+    # 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_streams({
@@ -2184,7 +2199,7 @@ module Aws::Kinesis
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesis'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -2250,10 +2265,10 @@ module Aws::Kinesis
     # 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 |
-    # | ----------------- | ------------------ | -------- | ------------- |
-    # | stream_exists     | {#describe_stream} | 10       | 18            |
-    # | stream_not_exists | {#describe_stream} | 10       | 18            |
+    # | waiter_name       | params                   | :delay   | :max_attempts |
+    # | ----------------- | ------------------------ | -------- | ------------- |
+    # | stream_exists     | {Client#describe_stream} | 10       | 18            |
+    # | stream_not_exists | {Client#describe_stream} | 10       | 18            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

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

@@ -6,13 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Kinesis
-  # This class provides a resource oriented interface for Kinesis.
-  # To create a resource object:
-  #     resource = Aws::Kinesis::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.
-  #     client = Aws::Kinesis::Client.new(region: 'us-west-2')
-  #     resource = Aws::Kinesis::Resource.new(client: client)
+
   class Resource
 
     # @param options ({})

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

@@ -8,6 +8,68 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::Kinesis
+  # 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 |
+  # | ----------------- | ------------------------ | -------- | ------------- |
+  # | stream_exists     | {Client#describe_stream} | 10       | 18            |
+  # | stream_not_exists | {Client#describe_stream} | 10       | 18            |
+  #
   module Waiters
 
     class StreamExists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kinesis
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.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
@@ -84,7 +84,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 - Kinesis