You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb

Overview

Wait until a channel has is stopped

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChannelStopped

Returns a new instance of ChannelStopped

Parameters:

  • options (Hash)

Options Hash (options):

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


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 178

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

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :channel_id (required, String)

Returns:



210
211
212
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 210

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