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: 60
  • :delay (Integer) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 249

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:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :channel_id (required, String)

Returns:



281
282
283
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 281

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