aws-sdk-medialive 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a9a0258d57e674a96e00bf6313de8ed34bea3de
-  data.tar.gz: d9e42c8a373835e176a44b2f15a90b65bff55e1a
+  metadata.gz: a38f84aaad1441fe3a7d1fff47fe7e2dda7faca2
+  data.tar.gz: 81c454a8168ff6a45078b085f409a0f30154aecb
 SHA512:
-  metadata.gz: 694e1f334f3c5687bad77dc48fe5fd378db88dca2043b046e9a5d55c3f31a6b80f2dc87fc0e610a11091fac430da0783f4131692b567395d36b05e3ccad6dd8e
-  data.tar.gz: 520cf545c5da1ff7306fd9ce0d144d928a5de64dc4e42e6b76e8efcd530f702b55157240fef48dc516b99980901ceef9fd71b737967f3dabb6d14704277c93be
+  metadata.gz: cd2d5bb0c76897886840bbbb276cc5c77496b86687c310a61be77ec9c22acf908adc91f8c36a4a0c4b05dd86d5b97c5c73859003124277785f7242c51ca80909
+  data.tar.gz: 6b83a954a9578e54e56352df0ce9e60a1014dd44c958881d8476d9c8edf7a2da87ae7c61c201e44e3410e9ebf4b61004bb04930a8d02bf23db772a7745f7e390

data/lib/aws-sdk-medialive.rb

@@ -12,6 +12,7 @@ require_relative 'aws-sdk-medialive/types'
 require_relative 'aws-sdk-medialive/client_api'
 require_relative 'aws-sdk-medialive/client'
 require_relative 'aws-sdk-medialive/errors'
+require_relative 'aws-sdk-medialive/waiters'
 require_relative 'aws-sdk-medialive/resource'
 require_relative 'aws-sdk-medialive/customizations'
 
@@ -42,6 +43,6 @@ require_relative 'aws-sdk-medialive/customizations'
 # @service
 module Aws::MediaLive
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end

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

@@ -6842,14 +6842,133 @@ module Aws::MediaLive
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-medialive'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.32.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 |
+    # | --------------- | ------------------- | -------- | ------------- |
+    # | channel_created | {#describe_channel} | 3        | 5             |
+    # | channel_deleted | {#describe_channel} | 5        | 20            |
+    # | channel_running | {#describe_channel} | 5        | 120           |
+    # | channel_stopped | {#describe_channel} | 5        | 28            |
+    #
+    # @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
+      {
+        channel_created: Waiters::ChannelCreated,
+        channel_deleted: Waiters::ChannelDeleted,
+        channel_running: Waiters::ChannelRunning,
+        channel_stopped: Waiters::ChannelStopped
+      }
     end
 
     class << self

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

@@ -0,0 +1,219 @@
+# 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::MediaLive
+  module Waiters
+
+    # Wait until a channel has been created
+    class ChannelCreated
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (5)
+      # @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: 5,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_channel,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "IDLE"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "CREATING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "CREATE_FAILED"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_channel)
+      # @return (see Client#describe_channel)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a channel has been deleted
+    class ChannelDeleted
+
+      # @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: :describe_channel,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "DELETED"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "DELETING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_channel)
+      # @return (see Client#describe_channel)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a channel is running
+    class ChannelRunning
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (120)
+      # @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: 120,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_channel,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "RUNNING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "STARTING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_channel)
+      # @return (see Client#describe_channel)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a channel has is stopped
+    class ChannelStopped
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (28)
+      # @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: 28,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_channel,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "IDLE"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "state",
+                "expected" => "STOPPING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_channel)
+      # @return (see Client#describe_channel)
+      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-medialive
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -59,6 +59,7 @@ files:
 - lib/aws-sdk-medialive/errors.rb
 - lib/aws-sdk-medialive/resource.rb
 - lib/aws-sdk-medialive/types.rb
+- lib/aws-sdk-medialive/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0