Class: Aws::MediaConnect::Waiters::FlowStandby

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

Overview

Wait until a flow is in standby mode

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FlowStandby

Returns a new instance of FlowStandby.

Parameters:

  • options (Hash)

Options Hash (options):

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


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/waiters.rb', line 228

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: [
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "success",
          "expected" => "STANDBY"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "retry",
          "expected" => "STOPPING"
        },
        {
          "matcher" => "error",
          "state" => "retry",
          "expected" => "InternalServerErrorException"
        },
        {
          "matcher" => "error",
          "state" => "retry",
          "expected" => "ServiceUnavailableException"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "failure",
          "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) —

    The ARN of the flow that you want to describe.

Returns:



271
272
273
 
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/waiters.rb', line 271

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