aws-sdk-ssm 1.81.1 → 1.86.0

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

@@ -0,0 +1,156 @@
+# 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::SSM
+  # 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 |
+  # | ---------------- | ------------------------------- | -------- | ------------- |
+  # | command_executed | {Client#get_command_invocation} | 5        | 20            |
+  #
+  module Waiters
+
+    class CommandExecuted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (20)
+      # @option options [Integer] :delay (5)
+      # @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: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_command_invocation,
+            acceptors: [
+              {
+                "expected" => "Pending",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "InProgress",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Delayed",
+                "matcher" => "path",
+                "state" => "retry",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Success",
+                "matcher" => "path",
+                "state" => "success",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Cancelled",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "TimedOut",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Failed",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              },
+              {
+                "expected" => "Cancelling",
+                "matcher" => "path",
+                "state" => "failure",
+                "argument" => "status"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_command_invocation)
+      # @return (see Client#get_command_invocation)
+      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-ssm
 version: !ruby/object:Gem::Version
-  version: 1.81.1
+  version: 1.86.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-ssm/errors.rb
 - lib/aws-sdk-ssm/resource.rb
 - lib/aws-sdk-ssm/types.rb
+- lib/aws-sdk-ssm/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0