Class: Aws::MediaLive::Waiters::InputDetached

Inherits:

Object

Object
Aws::MediaLive::Waiters::InputDetached

show all

Defined in:: lib/aws-sdk-medialive/waiters.rb

Overview

Wait until an input has been detached

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ InputDetached constructor

A new instance of InputDetached.
#wait(params = {}) ⇒ Types::DescribeInputResponse

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

Constructor Details

#initialize(options) ⇒ `InputDetached`

Returns a new instance of InputDetached.

Parameters:

options (Hash)

Options Hash (options):

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

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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 84,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_input,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DETACHED"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "CREATING"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "ATTACHED"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



711
712
713

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

def waiter
  @waiter
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

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



706
707
708

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

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