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

Class: Aws::MediaLive::Waiters::ChannelDeleted

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

Overview

Wait until a channel has been deleted

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChannelDeleted

Returns a new instance of ChannelDeleted

Parameters:

  • options (Hash)

Options Hash (options):

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


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 78

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_channel,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DELETED"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DELETING"
        },
        {
          "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:



110
111
112
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/waiters.rb', line 110

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