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

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

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

Overview

Wait until a channel has been created

Instance Method Summary collapse

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)


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 22

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 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:



60
61
62
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 60

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