aws-sdk-acmpca 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebde98092def92421a05fd619996e16f0e35348b
-  data.tar.gz: f02078c1f81b261249544ee545b3434b64f3891e
+  metadata.gz: 1ae30f0dafdfb9f2a8724f283b18d81c076adbbb
+  data.tar.gz: 5ad4daf3bed151785bb9c22e8d829d0ec5e5aba4
 SHA512:
-  metadata.gz: d2e3f07dec52f030132e08eefd4fb6dcc927c54236051fe50b4c6a9bbaafff2bfe8c1c6817912a90802bcec07c2c4640d7ee404fd6430672305fe5afbf092d80
-  data.tar.gz: ee2e0fb8d64b88c9ad5161f7ad3d223db8eb6bd818d7df8120bfab16156c94b4fb0ab79b5b80c9cb8690500e626c27c8567df376c536ebe3756684f77a8ac8dd
+  metadata.gz: 44c3820c5e791d46d7ffb24b46ca72c7cf5e2ba7cc9232e5cf7f231586e505d28a782f4fdd204dea64042b520f1779f1fab2b99d70153de3d5301bf2bf9936cf
+  data.tar.gz: 95ac56c7dba585b0b32c7122a93bd2928216bccfbcb6b122243559089ebd7ea38bd86a7fc22da293f9c677e0b12c01627cd5cfc40e2122a73a748e98554816a3

data/lib/aws-sdk-acmpca.rb

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

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

@@ -428,9 +428,9 @@ module Aws::ACMPCA
     #   create a new CA.
     #
     # * `DELETED` - Your private CA is within the restoration period, after
-    #   which it will be permanently deleted. The length of time remaining
-    #   in the CA's restoration period will also be included in this
-    #   operation's output.
+    #   which it is permanently deleted. The length of time remaining in the
+    #   CA's restoration period is also included in this operation's
+    #   output.
     #
     # @option params [required, String] :certificate_authority_arn
     #   The Amazon Resource Name (ARN) that was returned when you called
@@ -1171,14 +1171,131 @@ module Aws::ACMPCA
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-acmpca'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.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 |
+    # | --------------------------------- | ---------------------------------------------- | -------- | ------------- |
+    # | audit_report_created              | {#describe_certificate_authority_audit_report} | 3        | 60            |
+    # | certificate_authority_csr_created | {#get_certificate_authority_csr}               | 3        | 60            |
+    # | certificate_issued                | {#get_certificate}                             | 3        | 60            |
+    #
+    # @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
+      {
+        audit_report_created: Waiters::AuditReportCreated,
+        certificate_authority_csr_created: Waiters::CertificateAuthorityCSRCreated,
+        certificate_issued: Waiters::CertificateIssued
+      }
     end
 
     class << self

data/lib/aws-sdk-acmpca/client_api.rb

@@ -421,6 +421,12 @@ module Aws::ACMPCA
         o.input = Shapes::ShapeRef.new(shape: ListCertificateAuthoritiesRequest)
         o.output = Shapes::ShapeRef.new(shape: ListCertificateAuthoritiesResponse)
         o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:list_tags, Seahorse::Model::Operation.new.tap do |o|

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

@@ -0,0 +1,136 @@
+# 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::ACMPCA
+  module Waiters
+
+    # Wait until a Audit Report is created
+    class AuditReportCreated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (3)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_certificate_authority_audit_report,
+            acceptors: [{
+              "state" => "success",
+              "matcher" => "path",
+              "argument" => "audit_report_status",
+              "expected" => "SUCCESS"
+            }]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_certificate_authority_audit_report)
+      # @return (see Client#describe_certificate_authority_audit_report)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a Certificate Authority CSR is created
+    class CertificateAuthorityCSRCreated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (3)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_certificate_authority_csr,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "status",
+                "expected" => 200
+              },
+              {
+                "state" => "retry",
+                "matcher" => "error",
+                "expected" => "RequestInProgressException"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_certificate_authority_csr)
+      # @return (see Client#get_certificate_authority_csr)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a certificate is issued
+    class CertificateIssued
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (3)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_certificate,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "status",
+                "expected" => 200
+              },
+              {
+                "state" => "retry",
+                "matcher" => "error",
+                "expected" => "RequestInProgressException"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_certificate)
+      # @return (see Client#get_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-acmpca
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-acmpca/errors.rb
 - lib/aws-sdk-acmpca/resource.rb
 - lib/aws-sdk-acmpca/types.rb
+- lib/aws-sdk-acmpca/waiters.rb
 homepage: http://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0