aws-sdk-elasticbeanstalk 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac6559fb1cf7ea7dce359370e30c8b1c8e2c6f4095b535d6095bae135d0ace2
-  data.tar.gz: b90c59a5c690527c41ca4cc5844402c8aa7234c883155e08cb871bcae6c01db0
+  metadata.gz: b84c4cde014f9096639a7008f1265a93484271a1ea0a2454a196ffeb9bf16178
+  data.tar.gz: bc8b419956a4fab618e015ed99833a845924a862b5d69168a0c8be6628a01d23
 SHA512:
-  metadata.gz: f69cfb1b8140201dd3025376e5447987c6bb1cf0399cd749693944bb6a23b581164010752b89ee08de477a745fa218fe41f675a133f68bdd7e8b6dd1685134f3
-  data.tar.gz: d79a58f8a5a432a3596d1433fc3d1c0dfe25f597e25b835b19a5ba26fc03a136c7eced6456a4dddda81240c0a566db82442204f056a00a6cdcee32d4db0a2709
+  metadata.gz: 45886e4cd8cd3aac96b84a6d3a2123c134b7a00f32e67ead85f10c1130b82178de8ad85b17ce1ee21b76028ad232779bf013eebbc7422aadc7b758367bf380f1
+  data.tar.gz: 3d43b824722656b86e7c35b44e914b90af70ccbfaee50ea66e52cd39f547dc13a219c6434dad544bdbb6d6819785afe67ba442a4ff442a182a73feef03d800ec

data/lib/aws-sdk-elasticbeanstalk.rb

@@ -14,6 +14,7 @@ require_relative 'aws-sdk-elasticbeanstalk/types'
 require_relative 'aws-sdk-elasticbeanstalk/client_api'
 require_relative 'aws-sdk-elasticbeanstalk/client'
 require_relative 'aws-sdk-elasticbeanstalk/errors'
+require_relative 'aws-sdk-elasticbeanstalk/waiters'
 require_relative 'aws-sdk-elasticbeanstalk/resource'
 require_relative 'aws-sdk-elasticbeanstalk/customizations'
 
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
 # @service
 module Aws::ElasticBeanstalk
 
-  GEM_VERSION = '1.34.0'
+  GEM_VERSION = '1.35.0'
 
 end

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

@@ -2232,6 +2232,8 @@ module Aws::ElasticBeanstalk
     #   * {Types::DescribeEnvironmentManagedActionHistoryResult#managed_action_history_items #managed_action_history_items} => Array<Types::ManagedActionHistoryItem>
     #   * {Types::DescribeEnvironmentManagedActionHistoryResult#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.describe_environment_managed_action_history({
@@ -2533,6 +2535,13 @@ module Aws::ElasticBeanstalk
     #   resp.environments[0].operations_role #=> String
     #   resp.next_token #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * environment_exists
+    #   * environment_terminated
+    #   * environment_updated
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments AWS API Documentation
     #
     # @overload describe_environments(params = {})
@@ -3151,6 +3160,8 @@ module Aws::ElasticBeanstalk
     #   * {Types::ListPlatformVersionsResult#platform_summary_list #platform_summary_list} => Array<Types::PlatformSummary>
     #   * {Types::ListPlatformVersionsResult#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_platform_versions({
@@ -4475,14 +4486,131 @@ module Aws::ElasticBeanstalk
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-elasticbeanstalk'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.35.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.wait_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 |
+    # | ---------------------- | ------------------------------ | -------- | ------------- |
+    # | environment_exists     | {Client#describe_environments} | 20       | 20            |
+    # | environment_terminated | {Client#describe_environments} | 20       | 20            |
+    # | environment_updated    | {Client#describe_environments} | 20       | 20            |
+    #
+    # @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
+      {
+        environment_exists: Waiters::EnvironmentExists,
+        environment_terminated: Waiters::EnvironmentTerminated,
+        environment_updated: Waiters::EnvironmentUpdated
+      }
     end
 
     class << self

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

@@ -1440,6 +1440,12 @@ module Aws::ElasticBeanstalk
         o.input = Shapes::ShapeRef.new(shape: DescribeEnvironmentManagedActionHistoryRequest)
         o.output = Shapes::ShapeRef.new(shape: DescribeEnvironmentManagedActionHistoryResult)
         o.errors << Shapes::ShapeRef.new(shape: ElasticBeanstalkServiceException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_items",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:describe_environment_managed_actions, Seahorse::Model::Operation.new.tap do |o|
@@ -1541,6 +1547,12 @@ module Aws::ElasticBeanstalk
         o.output = Shapes::ShapeRef.new(shape: ListPlatformVersionsResult)
         o.errors << Shapes::ShapeRef.new(shape: InsufficientPrivilegesException)
         o.errors << Shapes::ShapeRef.new(shape: ElasticBeanstalkServiceException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|

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

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+# 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::ElasticBeanstalk
+  # 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 |
+  # | ---------------------- | ------------------------------ | -------- | ------------- |
+  # | environment_exists     | {Client#describe_environments} | 20       | 20            |
+  # | environment_terminated | {Client#describe_environments} | 20       | 20            |
+  # | environment_updated    | {Client#describe_environments} | 20       | 20            |
+  #
+  module Waiters
+
+    class EnvironmentExists
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (20)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 20,
+          delay: 20,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_environments,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Ready"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Launching"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_environments)
+      # @return (see Client#describe_environments)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    class EnvironmentTerminated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (20)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 20,
+          delay: 20,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_environments,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Terminated"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Terminating"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_environments)
+      # @return (see Client#describe_environments)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    class EnvironmentUpdated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (20)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 20,
+          delay: 20,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_environments,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Ready"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "pathAll",
+                "argument" => "environments[].status",
+                "expected" => "Updating"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_environments)
+      # @return (see Client#describe_environments)
+      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-elasticbeanstalk
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-elasticbeanstalk/errors.rb
 - lib/aws-sdk-elasticbeanstalk/resource.rb
 - lib/aws-sdk-elasticbeanstalk/types.rb
+- lib/aws-sdk-elasticbeanstalk/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0