aws-sdk-acmpca 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa2980e530b18e404e5a14352b8dfd635362fb2d
-  data.tar.gz: 1f4e685556868c14566a5ce3d5fcde59f169d552
+SHA256:
+  metadata.gz: 96bf9124c470f2e12df5e965c22a0f2f6b7c153da97223aa8a207c0c2675e9dc
+  data.tar.gz: 6c4adf43abe38b03f28f3f101ae4daee37c2a9bb6be5c65e8d65b7e72a6fc9e3
 SHA512:
-  metadata.gz: 7a60edee8f9065d0aa94be18ac3ed6d9849e6173cc60fd05615254356da2ddd78800842a6433f618fcf5d2290944f90d147dc0ee603bbbff92e529a9832c06ac
-  data.tar.gz: bc0994540500e634a26ea6e14b2234dfe5aa3f6c0d4f083f984db32511a3f58dea8b8f1f7a9eafbac995c13459c072693abf3b23dcfa2a6f983940f7dc82d2f6
+  metadata.gz: de40d07c0fb2b7f33732b7015b072a7718503be52746f12a063676dd81865db6327d1bdd321e8faf0b3f3c4fd2bc7b3ec77f7d1efe367666391b026474a84b18
+  data.tar.gz: d553fcdb8a4f85a5ba19fae916f1d8d7bead9634bfa7b3996cdfbb18ac02ab331c1809bf61148258614768603c303784ff248fc95641f0e2d9dec344dc64e42f

data/lib/aws-sdk-acmpca.rb

@@ -46,6 +46,6 @@ require_relative 'aws-sdk-acmpca/customizations'
 # @service
 module Aws::ACMPCA
 
-  GEM_VERSION = '1.22.0'
+  GEM_VERSION = '1.23.0'
 
 end

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

@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:acmpca)
 module Aws::ACMPCA
   # An API client for ACMPCA.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::ACMPCA::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::ACMPCA::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::ACMPCA
     #   @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::ACMPCA
     #   @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::ACMPCA
     #
     #   @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
     #
@@ -275,8 +279,7 @@ module Aws::ACMPCA
     #
     #   @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
@@ -288,7 +291,7 @@ module Aws::ACMPCA
     #     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`.
@@ -739,6 +742,11 @@ module Aws::ACMPCA
     #   resp.s3_key #=> String
     #   resp.created_at #=> Time
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * audit_report_created
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport AWS API Documentation
     #
     # @overload describe_certificate_authority_audit_report(params = {})
@@ -788,6 +796,11 @@ module Aws::ACMPCA
     #   resp.certificate #=> String
     #   resp.certificate_chain #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * certificate_issued
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate AWS API Documentation
     #
     # @overload get_certificate(params = {})
@@ -863,6 +876,11 @@ module Aws::ACMPCA
     #
     #   resp.csr #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * certificate_authority_csr_created
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr AWS API Documentation
     #
     # @overload get_certificate_authority_csr(params = {})
@@ -1077,6 +1095,8 @@ module Aws::ACMPCA
     #   * {Types::ListCertificateAuthoritiesResponse#certificate_authorities #certificate_authorities} => Array<Types::CertificateAuthority>
     #   * {Types::ListCertificateAuthoritiesResponse#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_certificate_authorities({
@@ -1157,6 +1177,8 @@ module Aws::ACMPCA
     #   * {Types::ListPermissionsResponse#permissions #permissions} => Array<Types::Permission>
     #   * {Types::ListPermissionsResponse#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_permissions({
@@ -1216,6 +1238,8 @@ module Aws::ACMPCA
     #   * {Types::ListTagsResponse#tags #tags} => Array<Types::Tag>
     #   * {Types::ListTagsResponse#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_tags({
@@ -1485,7 +1509,7 @@ module Aws::ACMPCA
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-acmpca'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -1551,11 +1575,11 @@ module Aws::ACMPCA
     # 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            |
+    # | waiter_name                       | params                                               | :delay   | :max_attempts |
+    # | --------------------------------- | ---------------------------------------------------- | -------- | ------------- |
+    # | audit_report_created              | {Client#describe_certificate_authority_audit_report} | 3        | 60            |
+    # | certificate_authority_csr_created | {Client#get_certificate_authority_csr}               | 3        | 60            |
+    # | certificate_issued                | {Client#get_certificate}                             | 3        | 60            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

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

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

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

@@ -8,6 +8,69 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::ACMPCA
+  # 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 |
+  # | --------------------------------- | ---------------------------------------------------- | -------- | ------------- |
+  # | audit_report_created              | {Client#describe_certificate_authority_audit_report} | 3        | 60            |
+  # | certificate_authority_csr_created | {Client#get_certificate_authority_csr}               | 3        | 60            |
+  # | certificate_issued                | {Client#get_certificate}                             | 3        | 60            |
+  #
   module Waiters
 
     # Wait until a Audit Report is created

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-acmpca
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.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 - ACM-PCA