aws-sdk-mediaconnect 1.31.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66869f7f5cfe2a8d84644b261aff1cd6806c75111dedd4bc4ceb0d019921da92
-  data.tar.gz: 2c47786961f4c0006b89870326d7e1833c27ecea35d4b1e87801102612248958
+  metadata.gz: 39c490d1bcd7ec754aaf25179fb8546eb531c5929782506541dd45a528fcef01
+  data.tar.gz: 1416cc4a3c334889bc2872369113f5796e3035019b84f3c5768229bc933c35d0
 SHA512:
-  metadata.gz: 8f2d0b4c1120c52f839600a63d1f5b1bf212bf5dba1db2f337cd93b441ee2b1b200a8dd5aa1fc5dafa111b1c5742d1ee6971e3828719afaee3e37f975581dc40
-  data.tar.gz: 513f3c9b7deb9e36cf7d5795652b8328057f3bbdf5f5c0534a36d0305a91240f658e7dfbd6cf15435301b59676cd79180d277307da301e33d292959e074239d2
+  metadata.gz: 15d6243c41e5adfd772ca9dc98f616cd620ede4c46433a86b651c40ab550d429480ec115f12c29820b47e6e76f07c96102fe963e0d71b180b14d086b8eee5634
+  data.tar.gz: 7da2bd25fd4d69a3547a450b6023810801b4a747e2ef60e5f14096227b5ef95e09d7bc7852321d4b5ca0e6df1d7e512028cb7bf805fa86a0a22205d1256a3e2b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.32.0 (2021-04-14)
+------------------
+
+* Feature - For flows that use Listener protocols, you can now easily locate an output's outbound IP address for a private internet. Additionally, MediaConnect now supports the Waiters feature that makes it easier to poll for the status of a flow until it reaches its desired state.
+
 1.31.0 (2021-03-16)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.31.0
+1.32.0

data/lib/aws-sdk-mediaconnect.rb

@@ -15,6 +15,7 @@ require_relative 'aws-sdk-mediaconnect/types'
 require_relative 'aws-sdk-mediaconnect/client_api'
 require_relative 'aws-sdk-mediaconnect/client'
 require_relative 'aws-sdk-mediaconnect/errors'
+require_relative 'aws-sdk-mediaconnect/waiters'
 require_relative 'aws-sdk-mediaconnect/resource'
 require_relative 'aws-sdk-mediaconnect/customizations'
 
@@ -48,6 +49,6 @@ require_relative 'aws-sdk-mediaconnect/customizations'
 # @!group service
 module Aws::MediaConnect
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.32.0'
 
 end

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

@@ -392,6 +392,7 @@ module Aws::MediaConnect
     #   resp.outputs[0].encryption.secret_arn #=> String
     #   resp.outputs[0].encryption.url #=> String
     #   resp.outputs[0].entitlement_arn #=> String
+    #   resp.outputs[0].listener_address #=> String
     #   resp.outputs[0].media_live_input_arn #=> String
     #   resp.outputs[0].name #=> String
     #   resp.outputs[0].output_arn #=> String
@@ -736,6 +737,7 @@ module Aws::MediaConnect
     #   resp.flow.outputs[0].encryption.secret_arn #=> String
     #   resp.flow.outputs[0].encryption.url #=> String
     #   resp.flow.outputs[0].entitlement_arn #=> String
+    #   resp.flow.outputs[0].listener_address #=> String
     #   resp.flow.outputs[0].media_live_input_arn #=> String
     #   resp.flow.outputs[0].name #=> String
     #   resp.flow.outputs[0].output_arn #=> String
@@ -910,6 +912,7 @@ module Aws::MediaConnect
     #   resp.flow.outputs[0].encryption.secret_arn #=> String
     #   resp.flow.outputs[0].encryption.url #=> String
     #   resp.flow.outputs[0].entitlement_arn #=> String
+    #   resp.flow.outputs[0].listener_address #=> String
     #   resp.flow.outputs[0].media_live_input_arn #=> String
     #   resp.flow.outputs[0].name #=> String
     #   resp.flow.outputs[0].output_arn #=> String
@@ -993,6 +996,13 @@ module Aws::MediaConnect
     #   resp.messages.errors #=> Array
     #   resp.messages.errors[0] #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * flow_active
+    #   * flow_deleted
+    #   * flow_standby
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DescribeFlow AWS API Documentation
     #
     # @overload describe_flow(params = {})
@@ -1723,6 +1733,7 @@ module Aws::MediaConnect
     #   resp.flow.outputs[0].encryption.secret_arn #=> String
     #   resp.flow.outputs[0].encryption.url #=> String
     #   resp.flow.outputs[0].entitlement_arn #=> String
+    #   resp.flow.outputs[0].listener_address #=> String
     #   resp.flow.outputs[0].media_live_input_arn #=> String
     #   resp.flow.outputs[0].name #=> String
     #   resp.flow.outputs[0].output_arn #=> String
@@ -2001,6 +2012,7 @@ module Aws::MediaConnect
     #   resp.output.encryption.secret_arn #=> String
     #   resp.output.encryption.url #=> String
     #   resp.output.entitlement_arn #=> String
+    #   resp.output.listener_address #=> String
     #   resp.output.media_live_input_arn #=> String
     #   resp.output.name #=> String
     #   resp.output.output_arn #=> String
@@ -2162,14 +2174,131 @@ module Aws::MediaConnect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-mediaconnect'
-      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 |
+    # | ------------ | ---------------------- | -------- | ------------- |
+    # | flow_active  | {Client#describe_flow} | 3        | 40            |
+    # | flow_deleted | {Client#describe_flow} | 3        | 40            |
+    # | flow_standby | {Client#describe_flow} | 3        | 40            |
+    #
+    # @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
+      {
+        flow_active: Waiters::FlowActive,
+        flow_deleted: Waiters::FlowDeleted,
+        flow_standby: Waiters::FlowStandby
+      }
     end
 
     class << self

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

@@ -353,6 +353,7 @@ module Aws::MediaConnect
     Output.add_member(:destination, Shapes::ShapeRef.new(shape: __string, location_name: "destination"))
     Output.add_member(:encryption, Shapes::ShapeRef.new(shape: Encryption, location_name: "encryption"))
     Output.add_member(:entitlement_arn, Shapes::ShapeRef.new(shape: __string, location_name: "entitlementArn"))
+    Output.add_member(:listener_address, Shapes::ShapeRef.new(shape: __string, location_name: "listenerAddress"))
     Output.add_member(:media_live_input_arn, Shapes::ShapeRef.new(shape: __string, location_name: "mediaLiveInputArn"))
     Output.add_member(:name, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "name"))
     Output.add_member(:output_arn, Shapes::ShapeRef.new(shape: __string, required: true, location_name: "outputArn"))

data/lib/aws-sdk-mediaconnect/types.rb

@@ -1533,6 +1533,15 @@ module Aws::MediaConnect
     #   is relevant only on entitled flows.
     #   @return [String]
     #
+    # @!attribute [rw] listener_address
+    #   The IP address that the receiver requires in order to establish a
+    #   connection with the flow. For public networking, the ListenerAddress
+    #   is represented by the elastic IP address of the flow. For private
+    #   networking, the ListenerAddress is represented by the elastic
+    #   network interface IP address of the VPC. This field applies only to
+    #   outputs that use the Zixi pull or SRT listener protocol.
+    #   @return [String]
+    #
     # @!attribute [rw] media_live_input_arn
     #   The input ARN of the AWS Elemental MediaLive channel. This parameter
     #   is relevant only for outputs that were added by creating a MediaLive
@@ -1569,6 +1578,7 @@ module Aws::MediaConnect
       :destination,
       :encryption,
       :entitlement_arn,
+      :listener_address,
       :media_live_input_arn,
       :name,
       :output_arn,

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

@@ -0,0 +1,266 @@
+# 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/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::MediaConnect
+  # 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 |
+  # | ------------ | ---------------------- | -------- | ------------- |
+  # | flow_active  | {Client#describe_flow} | 3        | 40            |
+  # | flow_deleted | {Client#describe_flow} | 3        | 40            |
+  # | flow_standby | {Client#describe_flow} | 3        | 40            |
+  #
+  module Waiters
+
+    # Wait until a flow is active
+    class FlowActive
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (40)
+      # @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: 40,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_flow,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "ACTIVE"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "STARTING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "UPDATING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 503
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "ERROR"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_flow)
+      # @return (see Client#describe_flow)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a flow is deleted
+    class FlowDeleted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (40)
+      # @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: 40,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_flow,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "status",
+                "expected" => 404
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "DELETING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 503
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "ERROR"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_flow)
+      # @return (see Client#describe_flow)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a flow is in standby mode
+    class FlowStandby
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (40)
+      # @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: 40,
+          delay: 3,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_flow,
+            acceptors: [
+              {
+                "state" => "success",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "STANDBY"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "STOPPING"
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 500
+              },
+              {
+                "state" => "retry",
+                "matcher" => "status",
+                "expected" => 503
+              },
+              {
+                "state" => "failure",
+                "matcher" => "path",
+                "argument" => "flow.status",
+                "expected" => "ERROR"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_flow)
+      # @return (see Client#describe_flow)
+      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-mediaconnect
 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: 2021-03-16 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -62,12 +62,13 @@ files:
 - lib/aws-sdk-mediaconnect/errors.rb
 - lib/aws-sdk-mediaconnect/resource.rb
 - lib/aws-sdk-mediaconnect/types.rb
+- lib/aws-sdk-mediaconnect/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-mediaconnect
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-mediaconnect/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-mediaconnect
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-mediaconnect/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS MediaConnect