aws-sdk-signer 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a3cc081da17bc2508da2e335d41883c500b47199
-  data.tar.gz: 9156271ebd96b4fd6248b6563b41c624a9380f10
+SHA256:
+  metadata.gz: cc2cd88c92a6c2d7bca0b973d3e32a643f6c1b7481620245aef5dfb4ee82c741
+  data.tar.gz: b5e0ff49189352ebdbc5a30bb795314b080cb92d9db498d4b6a8e88151f1e069
 SHA512:
-  metadata.gz: 76aafdc7b1f7fc367d8b10ec529feb3dba7f72d9890cde33ffa757aee6be95ab574fdacb8e7bd0fe72df5ee5320eb7f00da499c01daabb4d2f1839fc06db480d
-  data.tar.gz: dbfc41ef1e1e0b68c004df333ebf2a069e0b6cd21073a1f0ae3387d47f443b5b9ca479d69500a87a7ad0f3baa133d900d0f1eedb427c2d8d1683d60d003b3abc
+  metadata.gz: 788ade8e1afc85bfbea4f46dd941d05190c17f359aca314451e85bf16b6a53ce9c7e632efa55034e777906f083ce95cca771e787428805824314b18e9fd25bc4
+  data.tar.gz: b8568eaa0d403efbe63ce6459100ede13f37f3b39ec88cf380c27048150d2bc5011a7fb83c60796b0e2e9c146caa800aa8cd84ebc3ad219b939973104c26ac7e

data/lib/aws-sdk-signer.rb

@@ -46,6 +46,6 @@ require_relative 'aws-sdk-signer/customizations'
 # @service
 module Aws::Signer
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.20.0'
 
 end

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

@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:signer)
 module Aws::Signer
   # An API client for Signer.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::Signer::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::Signer::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).
@@ -105,7 +105,7 @@ module Aws::Signer
     #   @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']`
@@ -161,7 +161,7 @@ module Aws::Signer
     #   @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
@@ -229,15 +229,19 @@ module Aws::Signer
     #
     #   @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
     #
@@ -265,8 +269,7 @@ module Aws::Signer
     #
     #   @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
@@ -278,7 +281,7 @@ module Aws::Signer
     #     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`.
@@ -381,6 +384,11 @@ module Aws::Signer
     #   resp.signed_object.s3.bucket_name #=> String
     #   resp.signed_object.s3.key #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * successful_signing_job
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJob AWS API Documentation
     #
     # @overload describe_signing_job(params = {})
@@ -522,6 +530,8 @@ module Aws::Signer
     #   * {Types::ListSigningJobsResponse#jobs #jobs} => Array<Types::SigningJob>
     #   * {Types::ListSigningJobsResponse#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_signing_jobs({
@@ -586,6 +596,8 @@ module Aws::Signer
     #   * {Types::ListSigningPlatformsResponse#platforms #platforms} => Array<Types::SigningPlatform>
     #   * {Types::ListSigningPlatformsResponse#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_signing_platforms({
@@ -651,6 +663,8 @@ module Aws::Signer
     #   * {Types::ListSigningProfilesResponse#profiles #profiles} => Array<Types::SigningProfile>
     #   * {Types::ListSigningProfilesResponse#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_signing_profiles({
@@ -938,7 +952,7 @@ module Aws::Signer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-signer'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -1004,9 +1018,9 @@ module Aws::Signer
     # 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 |
-    # | ---------------------- | ----------------------- | -------- | ------------- |
-    # | successful_signing_job | {#describe_signing_job} | 20       | 25            |
+    # | waiter_name            | params                        | :delay   | :max_attempts |
+    # | ---------------------- | ----------------------------- | -------- | ------------- |
+    # | successful_signing_job | {Client#describe_signing_job} | 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-signer/resource.rb

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

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

@@ -8,6 +8,67 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::Signer
+  # 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 |
+  # | ---------------------- | ----------------------------- | -------- | ------------- |
+  # | successful_signing_job | {Client#describe_signing_job} | 20       | 25            |
+  #
   module Waiters
 
     class SuccessfulSigningJob

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-signer
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.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
@@ -82,7 +82,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 - signer