Class: Aws::MediaLive::Waiters::InputAttached

Inherits:

Object

• Object
• Aws::MediaLive::Waiters::InputAttached

Defined in:

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

Overview

Wait until an input has been attached

Instance Method Summary

• #initialize(options) ⇒ InputAttached constructor

  A new instance of InputAttached.

• #wait(params = {}) ⇒ Types::DescribeInputResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ InputAttached

Returns a new instance of InputAttached.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 20
• :delay (Integer) — default: 5
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 568

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_input,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "ATTACHED"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DETACHED"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeInputResponse

Returns a response object which responds to the following methods:

• #arn => String
• #attached_channels => Array<String>
• #destinations => Array<Types::InputDestination>
• #id => String
• #input_class => String
• #input_devices => Array<Types::InputDeviceSettings>
• #input_partner_ids => Array<String>
• #input_source_type => String
• #media_connect_flows => Array<Types::MediaConnectFlow>
• #name => String
• #role_arn => String
• #security_groups => Array<String>
• #sources => Array<Types::InputSource>
• #state => String
• #tags => Hash<String,String>
• #type => String
• #srt_settings => Types::SrtSettings
• #input_network_location => String
• #multicast_settings => Types::MulticastSettings

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :input_id (required, String)

Returns:

• (Types::DescribeInputResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #attached_channels => Array<String>
  • #destinations => Array<Types::InputDestination>
  • #id => String
  • #input_class => String
  • #input_devices => Array<Types::InputDeviceSettings>
  • #input_partner_ids => Array<String>
  • #input_source_type => String
  • #media_connect_flows => Array<Types::MediaConnectFlow>
  • #name => String
  • #role_arn => String
  • #security_groups => Array<String>
  • #sources => Array<Types::InputSource>
  • #state => String
  • #tags => Hash<String,String>
  • #type => String
  • #srt_settings => Types::SrtSettings
  • #input_network_location => String
  • #multicast_settings => Types::MulticastSettings

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 600

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end