aws-sdk-acm 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c7a38ae4cba49a94fbce4e32acaa068e774508d
-  data.tar.gz: 44ce5505c1e8a38f31278ee222b54401131457e4
+  metadata.gz: e95fc0cc3d458b6e6efd9822d21038e286419c10
+  data.tar.gz: 0d284584e697726b5490ada11570a4bdef7b4b87
 SHA512:
-  metadata.gz: d2391dfc6e7b0ba6abaa806d2979acb05a0433989d9672c11afb384aa544f50664d6ba7f6c76dce407b3417607f222c0cd4ecfe83161ed2e11b5822594a77b1c
-  data.tar.gz: 45de13bb3523dd8218e963b459a85de985d846c716ac64ebe4b9739881eed49615c3ff10a46572790818d59c13a7e1f92eba75a364019e37c36bf53b1115d997
+  metadata.gz: 5a269e5590fbd35ddc7e514f11bb1698f1156ab0017c7b3b4f28d5a6932414acbedf7b9a79ab3d327f41621e619180a6a108ca91cca3883b5a73111ea2f5835b
+  data.tar.gz: adecb71c780e4de25fac677240bb4a897fafe6daf0cbd08412b5d50df00691d63722fa0ba24463abaa7730a122286c7844bcfee7563da70a6440a30ac6c072f7

data/lib/aws-sdk-acm.rb

@@ -12,6 +12,7 @@ require_relative 'aws-sdk-acm/types'
 require_relative 'aws-sdk-acm/client_api'
 require_relative 'aws-sdk-acm/client'
 require_relative 'aws-sdk-acm/errors'
+require_relative 'aws-sdk-acm/waiters'
 require_relative 'aws-sdk-acm/resource'
 require_relative 'aws-sdk-acm/customizations'
 
@@ -42,6 +43,6 @@ require_relative 'aws-sdk-acm/customizations'
 # @service
 module Aws::ACM
 
-  GEM_VERSION = '1.8.0'
+  GEM_VERSION = '1.9.0'
 
 end

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

@@ -980,14 +980,127 @@ module Aws::ACM
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-acm'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.9.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
+    # Polls an API operation until a resource enters a desired state.
+    #
+    # ## Basic Usage
+    #
+    # A waiter will call an API operation until:
+    #
+    # * It is successful
+    # * It enters a terminal state
+    # * It makes the maximum number of attempts
+    #
+    # In between attempts, the waiter will sleep.
+    #
+    #     # polls in a loop, sleeping between attempts
+    #     client.waiter_until(waiter_name, params)
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. You can pass
+    # configuration as the final arguments hash.
+    #
+    #     # poll for ~25 seconds
+    #     client.wait_until(waiter_name, params, {
+    #       max_attempts: 5,
+    #       delay: 5,
+    #     })
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     client.wait_until(waiter_name, params, {
+    #
+    #       # disable max attempts
+    #       max_attempts: nil,
+    #
+    #       # poll for 1 hour, instead of a number of attempts
+    #       before_wait: -> (attempts, response) do
+    #         throw :failure if Time.now - started_at > 3600
+    #       end
+    #     })
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is unsuccessful, it will raise an error.
+    # All of the failure errors extend from
+    # {Aws::Waiters::Errors::WaiterFailed}.
+    #
+    #     begin
+    #       client.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # ## Valid 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 |
+    # | --------------------- | ----------------------- | -------- | ------------- |
+    # | certificate_validated | {#describe_certificate} | 60       | 40            |
+    #
+    # @raise [Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    # @raise [Errors::TooManyAttemptsError] Raised when the configured
+    #   maximum number of attempts have been made, and the waiter is not
+    #   yet successful.
+    #
+    # @raise [Errors::UnexpectedError] Raised when an error is encounted
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
+    #   for an unknown state.
+    #
+    # @return [Boolean] Returns `true` if the waiter was successful.
+    # @param [Symbol] waiter_name
+    # @param [Hash] params ({})
+    # @param [Hash] options ({})
+    # @option options [Integer] :max_attempts
+    # @option options [Integer] :delay
+    # @option options [Proc] :before_attempt
+    # @option options [Proc] :before_wait
+    def wait_until(waiter_name, params = {}, options = {})
+      w = waiter(waiter_name, options)
+      yield(w.waiter) if block_given? # deprecated
+      w.wait(params)
+    end
+
     # @api private
     # @deprecated
     def waiter_names
-      []
+      waiters.keys
+    end
+
+    private
+
+    # @param [Symbol] waiter_name
+    # @param [Hash] options ({})
+    def waiter(waiter_name, options = {})
+      waiter_class = waiters[waiter_name]
+      if waiter_class
+        waiter_class.new(options.merge(client: self))
+      else
+        raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
+      end
+    end
+
+    def waiters
+      {
+        certificate_validated: Waiters::CertificateValidated
+      }
     end
 
     class << self

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

@@ -0,0 +1,68 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::ACM
+  module Waiters
+
+    class CertificateValidated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (40)
+      # @option options [Integer] :delay (60)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 40,
+          delay: 60,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_certificate,
+            acceptors: [
+              {
+                "matcher" => "pathAll",
+                "expected" => "SUCCESS",
+                "argument" => "certificate.domain_validation_options[].validation_status",
+                "state" => "success"
+              },
+              {
+                "matcher" => "pathAny",
+                "expected" => "PENDING_VALIDATION",
+                "argument" => "certificate.domain_validation_options[].validation_status",
+                "state" => "retry"
+              },
+              {
+                "matcher" => "path",
+                "expected" => "FAILED",
+                "argument" => "certificate.status",
+                "state" => "failure"
+              },
+              {
+                "matcher" => "error",
+                "expected" => "ResourceNotFoundException",
+                "state" => "failure"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_certificate)
+      # @return (see Client#describe_certificate)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-acm
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -53,6 +53,7 @@ files:
 - lib/aws-sdk-acm/errors.rb
 - lib/aws-sdk-acm/resource.rb
 - lib/aws-sdk-acm/types.rb
+- lib/aws-sdk-acm/waiters.rb
 homepage: http://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0