module Aws::ClientWaiters
def self.included(subclass)
- Api: - private
def self.included(subclass) class << subclass def set_waiters(waiters) @waiters = case waiters when Waiters::Provider then waiters when Hash then Waiters::Provider.new(waiters) when String then Waiters::Provider.new(Aws.load_json(waiters)) when nil then Waiters::NullProvider.new else raise ArgumentError, 'invalid waiters' end end def waiters @waiters end end end
def set_waiters(waiters)
def set_waiters(waiters) @waiters = case waiters when Waiters::Provider then waiters when Hash then Waiters::Provider.new(waiters) when String then Waiters::Provider.new(Aws.load_json(waiters)) when nil then Waiters::NullProvider.new else raise ArgumentError, 'invalid waiters' end end
def wait_until(waiter_name, params = {}, &block)
-
(Waiters::Errors::WaiterFailed)
- Raised when one of the -
(Waiters::Errors::NoSuchWaiter)
- Raised when the named waiter
Other tags:
- Yieldparam: waiter - Yields a {Waiters::Waiter Waiter}
Returns:
-
(Seahorse::Client::Response)
- Returns the client response from
Parameters:
-
params
(Hash
) -- Additional request parameters. See the {#waiter_names} -
waiter_name
(Symbol
) -- The name of the waiter. See {#waiter_names}
Other tags:
- Example: Throw :success or :failure to terminate early -
Example: Waiting with progress callbacks -
Example: Rescuing a failed wait -
Example: Configuring interval and maximum attempts -
Example: Basic usage -
def wait_until(waiter_name, params = {}, &block) waiter = self.class.waiters.waiter(waiter_name) yield(waiter) if block_given? waiter.wait(self, params) end
def waiter_names
-
(Array
-)
def waiter_names self.class.waiters.waiter_names end
def waiters
def waiters @waiters end