aws-sdk-cloudfront 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b377334a0c36a314560f12962831526e96258b7d
-  data.tar.gz: fcd47dd54ef0430f24492dcc724f05b31446c327
+SHA256:
+  metadata.gz: 7f93abab99808eadaa877a0195106ce2f3bb02e4899d83633930a58ea86a6bc2
+  data.tar.gz: cdfa566d8e2f9c69709ac9ad6686b5bdbc50af390a43e8039417613fa148569e
 SHA512:
-  metadata.gz: 6d4e1ee11180bc758447383709255bb9cf25d73bd65e4332957d15084c9036f6f99f99137cf38ea4e778b13d071c259a742a850397e81c7102fa18b6f2a9b6a5
-  data.tar.gz: ce5429ab6a0cd7b9b3d36e16a07191c794483a7fd2d0ae26d41a9ca93a70ae20d9a49edc42cf7288b56dfcb6d6067498f75ac6859225460d1137b80b0e0f588e
+  metadata.gz: 8730c76a34ac99860ebce41aa49662d8a47017cdc9388ce445335e3bc0a0bda1c5bc1c31d0f42293b687cd818d8aae249788f13ad17f40bc91390984ed3edbbe
+  data.tar.gz: 1dcf93ab7dcb45a26f75dff4380346af8b5ffd173e0dec9e2d9746e0bc0606371e25964fc06cc767d992a39b35aa74a3ecb1e23a7d774c557b9c64a8a9ebbd45

data/lib/aws-sdk-cloudfront.rb

@@ -46,6 +46,6 @@ require_relative 'aws-sdk-cloudfront/customizations'
 # @service
 module Aws::CloudFront
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.27.0'
 
 end

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

@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:cloudfront)
 module Aws::CloudFront
   # An API client for CloudFront.  To construct a client, you need to configure a `:region` and `:credentials`.
   #
-  #   client = Aws::CloudFront::Client.new(
-  #     region: region_name,
-  #     credentials: credentials,
-  #     # ...
-  #   )
+  #     client = Aws::CloudFront::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::CloudFront
     #   @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::CloudFront
     #   @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::CloudFront
     #
     #   @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::CloudFront
     #
     #   @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::CloudFront
     #     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`.
@@ -2019,6 +2022,11 @@ module Aws::CloudFront
     #   resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
     #   resp.etag #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * distribution_deployed
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetDistribution2019_03_26 AWS API Documentation
     #
     # @overload get_distribution(params = {})
@@ -2387,6 +2395,11 @@ module Aws::CloudFront
     #   resp.invalidation.invalidation_batch.paths.items[0] #=> String
     #   resp.invalidation.invalidation_batch.caller_reference #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * invalidation_completed
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetInvalidation2019_03_26 AWS API Documentation
     #
     # @overload get_invalidation(params = {})
@@ -2513,6 +2526,11 @@ module Aws::CloudFront
     #   resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
     #   resp.etag #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * streaming_distribution_deployed
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetStreamingDistribution2019_03_26 AWS API Documentation
     #
     # @overload get_streaming_distribution(params = {})
@@ -2585,6 +2603,8 @@ module Aws::CloudFront
     #
     #   * {Types::ListCloudFrontOriginAccessIdentitiesResult#cloud_front_origin_access_identity_list #cloud_front_origin_access_identity_list} => Types::CloudFrontOriginAccessIdentityList
     #
+    # 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_cloud_front_origin_access_identities({
@@ -2629,6 +2649,8 @@ module Aws::CloudFront
     #
     #   * {Types::ListDistributionsResult#distribution_list #distribution_list} => Types::DistributionList
     #
+    # 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_distributions({
@@ -3099,6 +3121,8 @@ module Aws::CloudFront
     #
     #   * {Types::ListInvalidationsResult#invalidation_list #invalidation_list} => Types::InvalidationList
     #
+    # 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_invalidations({
@@ -3185,6 +3209,8 @@ module Aws::CloudFront
     #
     #   * {Types::ListStreamingDistributionsResult#streaming_distribution_list #streaming_distribution_list} => Types::StreamingDistributionList
     #
+    # 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_streaming_distributions({
@@ -4132,7 +4158,7 @@ module Aws::CloudFront
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudfront'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -4198,11 +4224,11 @@ module Aws::CloudFront
     # 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 |
-    # | ------------------------------- | ----------------------------- | -------- | ------------- |
-    # | distribution_deployed           | {#get_distribution}           | 60       | 35            |
-    # | invalidation_completed          | {#get_invalidation}           | 20       | 30            |
-    # | streaming_distribution_deployed | {#get_streaming_distribution} | 60       | 25            |
+    # | waiter_name                     | params                              | :delay   | :max_attempts |
+    # | ------------------------------- | ----------------------------------- | -------- | ------------- |
+    # | distribution_deployed           | {Client#get_distribution}           | 60       | 35            |
+    # | invalidation_completed          | {Client#get_invalidation}           | 20       | 30            |
+    # | streaming_distribution_deployed | {Client#get_streaming_distribution} | 60       | 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-cloudfront/resource.rb

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

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

@@ -8,6 +8,69 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::CloudFront
+  # 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 |
+  # | ------------------------------- | ----------------------------------- | -------- | ------------- |
+  # | distribution_deployed           | {Client#get_distribution}           | 60       | 35            |
+  # | invalidation_completed          | {Client#get_invalidation}           | 20       | 30            |
+  # | streaming_distribution_deployed | {Client#get_streaming_distribution} | 60       | 25            |
+  #
   module Waiters
 
     # Wait until a distribution is deployed.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudfront
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.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
@@ -85,7 +85,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 - CloudFront