Class: Aws::MediaLive::Waiters::ChannelCreated

Inherits:

Object

Object
Aws::MediaLive::Waiters::ChannelCreated

show all

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

Overview

Wait until a channel has been created

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ ChannelCreated constructor

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

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

Constructor Details

#initialize(options) ⇒ `ChannelCreated`

Returns a new instance of ChannelCreated.

Parameters:

options (Hash)

Options Hash (options):

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

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

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

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.



149
150
151

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

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::DescribeChannelResponse`

Returns a response object which responds to the following methods:

#arn => String
#cdi_input_specification => Types::CdiInputSpecification
#channel_class => String
#destinations => Array<Types::OutputDestination>
#egress_endpoints => Array<Types::ChannelEgressEndpoint>
#encoder_settings => Types::EncoderSettings
#id => String
#input_attachments => Array<Types::InputAttachment>
#input_specification => Types::InputSpecification
#log_level => String
#maintenance => Types::MaintenanceStatus
#name => String
#pipeline_details => Array<Types::PipelineDetail>
#pipelines_running_count => Integer
#role_arn => String
#state => String
#tags => Hash<String,String>
#vpc => Types::VpcOutputSettingsDescription
#anywhere_settings => Types::DescribeAnywhereSettings

Options Hash (params):

:channel_id (required, String)

Returns:

(Types::DescribeChannelResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #cdi_input_specification => Types::CdiInputSpecification
- #channel_class => String
- #destinations => Array<Types::OutputDestination>
- #egress_endpoints => Array<Types::ChannelEgressEndpoint>
- #encoder_settings => Types::EncoderSettings
- #id => String
- #input_attachments => Array<Types::InputAttachment>
- #input_specification => Types::InputSpecification
- #log_level => String
- #maintenance => Types::MaintenanceStatus
- #name => String
- #pipeline_details => Array<Types::PipelineDetail>
- #pipelines_running_count => Integer
- #role_arn => String
- #state => String
- #tags => Hash<String,String>
- #vpc => Types::VpcOutputSettingsDescription
- #anywhere_settings => Types::DescribeAnywhereSettings



144
145
146

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

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