Class: Aws::MediaConnect::Waiters::FlowActive

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

Overview

Wait until a flow is active

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FlowActive

Returns a new instance of FlowActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/waiters.rb', line 87

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_flow,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "flow.status",
          "expected" => "ACTIVE"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "flow.status",
          "expected" => "STARTING"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "flow.status",
          "expected" => "UPDATING"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 503
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "flow.status",
          "expected" => "ERROR"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeFlowResponse

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :flow_arn (required, String)

Returns:



136
137
138
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/waiters.rb', line 136

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