Class: Aws::MediaLive::Waiters::ChannelStopped

Inherits:

Object

• Object
• Aws::MediaLive::Waiters::ChannelStopped

Defined in:

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

Overview

Wait until a channel has is stopped

Instance Method Summary

• #initialize(options) ⇒ ChannelStopped constructor

  A new instance of ChannelStopped.

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

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

Constructor Details

#initialize(options) ⇒ ChannelStopped

Returns a new instance of ChannelStopped.

Parameters:

• options (Hash)

Options Hash (options):

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

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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    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

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

Parameters:

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

  a customizable set of options

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

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

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