Class: Aws::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-core/client.rb
Overview
Base class for all Aws service clients.
Class Attribute Summary collapse
- .identifier ⇒ Symbol private
- .paginators ⇒ Paging::Provider private
- .waiters ⇒ Waiters::Provider private
Attributes inherited from Seahorse::Client::Base
Class Method Summary collapse
Instance Method Summary collapse
-
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Seahorse::Client::Response
Waits until a particular condition is satisfied.
-
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
Methods included from ClientStubs
#initialize, #next_stub, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, #build_request, clear_plugins, #initialize, #inspect, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response, #handler_for, #new_handler
Class Attribute Details
.identifier ⇒ Symbol
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
89 90 91 |
# File 'lib/aws-sdk-core/client.rb', line 89 def identifier @identifier end |
.paginators ⇒ Paging::Provider
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
93 94 95 |
# File 'lib/aws-sdk-core/client.rb', line 93 def paginators @paginators end |
.waiters ⇒ Waiters::Provider
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
97 98 99 |
# File 'lib/aws-sdk-core/client.rb', line 97 def waiters @waiters end |
Class Method Details
.define(svc_name, options) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
100 101 102 103 104 105 106 |
# File 'lib/aws-sdk-core/client.rb', line 100 def define(svc_name, ) client_class = Class.new(self) client_class.identifier = svc_name.downcase.to_sym client_class.set_api(load_api([:api])) Api::ServiceCustomizations.apply(client_class) client_class end |
Instance Method Details
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Seahorse::Client::Response
Waits until a particular condition is satisfied. This works by polling a client request and checking for particular response data or errors. Waiters each have a default duration max attempts which are configurable. Additionally, you can register callbacks and stop waiters by throwing ‘:success` or `:failure`.
73 74 75 76 77 |
# File 'lib/aws-sdk-core/client.rb', line 73 def wait_until(waiter_name, params = {}, &block) waiter = self.class.waiters.waiter(waiter_name) yield(waiter) if block_given? waiter.wait(self, params) end |
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
81 82 83 |
# File 'lib/aws-sdk-core/client.rb', line 81 def waiter_names self.class.waiters.waiter_names end |