aws-sdk-opsworks 1.19.0 → 1.24.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: c68fe664548f8d94ac622ac408998c7abc6336ea
4
- data.tar.gz: 61996593304774f577fa2326593dacd02eb046bc
2
+ SHA256:
3
+ metadata.gz: 439874b78a476332ccb4f2e11b07fc7ba0ddd03daa53c24d07299771de8d21d5
4
+ data.tar.gz: 5ff6d5b024efa36fab5342f28c45471d6d494ef188d7355259e080f578bfc3b4
5
5
  SHA512:
6
- metadata.gz: 30050d30f5a2fd655e95387dd47faa664b5ccadf58c1077530cca7f5236f498c04a446450d58765f123e4cf63b7ce7dd92beafcb4982117b1f35b304368474c9
7
- data.tar.gz: 828a3ad0bcfd76d5b73e3102b915b1392aa798c7134eaa5989cbb20dc81af5a489417e012dd591d8e32f26c6a974b7c13b581fe0043441d38b206bb12d4b8068
6
+ metadata.gz: 627fe72974d42c14598bf776cdbcd587899b4ccaa1d245588d1632ce85600227328529ec0a2e472c7d37ed7aec9fc79453c8b23e412a897819e5422b5382e8d9
7
+ data.tar.gz: 7f1dc4056906bd9ed45379dabe83a75c92d711fa3cfc16aa22c50b0b0bac96fa12d76b9f1a1cd7729bba9c30481044256bde8d437f5fe3f1605239f276341d46
@@ -28,17 +28,20 @@ require_relative 'aws-sdk-opsworks/customizations'
28
28
  # methods each accept a hash of request parameters and return a response
29
29
  # structure.
30
30
  #
31
+ # ops_works = Aws::OpsWorks::Client.new
32
+ # resp = ops_works.assign_instance(params)
33
+ #
31
34
  # See {Client} for more information.
32
35
  #
33
36
  # # Errors
34
37
  #
35
- # Errors returned from AWS OpsWorks all
36
- # extend {Errors::ServiceError}.
38
+ # Errors returned from AWS OpsWorks are defined in the
39
+ # {Errors} module and all extend {Errors::ServiceError}.
37
40
  #
38
41
  # begin
39
42
  # # do stuff
40
43
  # rescue Aws::OpsWorks::Errors::ServiceError
41
- # # rescues all service API errors
44
+ # # rescues all AWS OpsWorks API errors
42
45
  # end
43
46
  #
44
47
  # See {Errors} for more information.
@@ -46,6 +49,6 @@ require_relative 'aws-sdk-opsworks/customizations'
46
49
  # @service
47
50
  module Aws::OpsWorks
48
51
 
49
- GEM_VERSION = '1.19.0'
52
+ GEM_VERSION = '1.24.0'
50
53
 
51
54
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:opsworks)
31
31
 
32
32
  module Aws::OpsWorks
33
+ # An API client for OpsWorks. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::OpsWorks::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::OpsWorks
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::OpsWorks
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::OpsWorks
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::OpsWorks
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::OpsWorks
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::OpsWorks
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::OpsWorks
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::OpsWorks
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::OpsWorks
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -2356,6 +2410,11 @@ module Aws::OpsWorks
2356
2410
  # resp.apps[0].environment[0].value #=> String
2357
2411
  # resp.apps[0].environment[0].secure #=> Boolean
2358
2412
  #
2413
+ #
2414
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2415
+ #
2416
+ # * app_exists
2417
+ #
2359
2418
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeApps AWS API Documentation
2360
2419
  #
2361
2420
  # @overload describe_apps(params = {})
@@ -2492,6 +2551,11 @@ module Aws::OpsWorks
2492
2551
  # resp.deployments[0].instance_ids #=> Array
2493
2552
  # resp.deployments[0].instance_ids[0] #=> String
2494
2553
  #
2554
+ #
2555
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2556
+ #
2557
+ # * deployment_successful
2558
+ #
2495
2559
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeDeployments AWS API Documentation
2496
2560
  #
2497
2561
  # @overload describe_deployments(params = {})
@@ -2545,6 +2609,8 @@ module Aws::OpsWorks
2545
2609
  # * {Types::DescribeEcsClustersResult#ecs_clusters #ecs_clusters} => Array&lt;Types::EcsCluster&gt;
2546
2610
  # * {Types::DescribeEcsClustersResult#next_token #next_token} => String
2547
2611
  #
2612
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2613
+ #
2548
2614
  # @example Request syntax with placeholder values
2549
2615
  #
2550
2616
  # resp = client.describe_ecs_clusters({
@@ -2793,6 +2859,14 @@ module Aws::OpsWorks
2793
2859
  # resp.instances[0].tenancy #=> String
2794
2860
  # resp.instances[0].virtualization_type #=> String, one of "paravirtual", "hvm"
2795
2861
  #
2862
+ #
2863
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2864
+ #
2865
+ # * instance_online
2866
+ # * instance_registered
2867
+ # * instance_stopped
2868
+ # * instance_terminated
2869
+ #
2796
2870
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeInstances AWS API Documentation
2797
2871
  #
2798
2872
  # @overload describe_instances(params = {})
@@ -5556,7 +5630,7 @@ module Aws::OpsWorks
5556
5630
  params: params,
5557
5631
  config: config)
5558
5632
  context[:gem_name] = 'aws-sdk-opsworks'
5559
- context[:gem_version] = '1.19.0'
5633
+ context[:gem_version] = '1.24.0'
5560
5634
  Seahorse::Client::Request.new(handlers, context)
5561
5635
  end
5562
5636
 
@@ -5622,14 +5696,14 @@ module Aws::OpsWorks
5622
5696
  # The following table lists the valid waiter names, the operations they call,
5623
5697
  # and the default `:delay` and `:max_attempts` values.
5624
5698
  #
5625
- # | waiter_name | params | :delay | :max_attempts |
5626
- # | --------------------- | ----------------------- | -------- | ------------- |
5627
- # | app_exists | {#describe_apps} | 1 | 40 |
5628
- # | deployment_successful | {#describe_deployments} | 15 | 40 |
5629
- # | instance_online | {#describe_instances} | 15 | 40 |
5630
- # | instance_registered | {#describe_instances} | 15 | 40 |
5631
- # | instance_stopped | {#describe_instances} | 15 | 40 |
5632
- # | instance_terminated | {#describe_instances} | 15 | 40 |
5699
+ # | waiter_name | params | :delay | :max_attempts |
5700
+ # | --------------------- | ----------------------------- | -------- | ------------- |
5701
+ # | app_exists | {Client#describe_apps} | 1 | 40 |
5702
+ # | deployment_successful | {Client#describe_deployments} | 15 | 40 |
5703
+ # | instance_online | {Client#describe_instances} | 15 | 40 |
5704
+ # | instance_registered | {Client#describe_instances} | 15 | 40 |
5705
+ # | instance_stopped | {Client#describe_instances} | 15 | 40 |
5706
+ # | instance_terminated | {Client#describe_instances} | 15 | 40 |
5633
5707
  #
5634
5708
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
5635
5709
  # because the waiter has entered a state that it will not transition
@@ -6,6 +6,30 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorks
9
+
10
+ # When OpsWorks returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::OpsWorks::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all OpsWorks errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::OpsWorks::Errors::ServiceError
18
+ # # rescues all OpsWorks API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {ResourceNotFoundException}
29
+ # * {ValidationException}
30
+ #
31
+ # Additionally, error classes are dynamically generated for service errors based on the error code
32
+ # if they are not defined above.
9
33
  module Errors
10
34
 
11
35
  extend Aws::Errors::DynamicErrors
@@ -23,7 +47,6 @@ module Aws::OpsWorks
23
47
  def message
24
48
  @message || @data[:message]
25
49
  end
26
-
27
50
  end
28
51
 
29
52
  class ValidationException < ServiceError
@@ -39,7 +62,6 @@ module Aws::OpsWorks
39
62
  def message
40
63
  @message || @data[:message]
41
64
  end
42
-
43
65
  end
44
66
 
45
67
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorks
9
+
9
10
  class Layer
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::OpsWorks
21
22
  @id = extract_id(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -261,7 +263,8 @@ module Aws::OpsWorks
261
263
  # Waiter polls an API operation until a resource enters a desired
262
264
  # state.
263
265
  #
264
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
266
+ # @note The waiting operation is performed on a copy. The original resource
267
+ # remains unchanged.
265
268
  #
266
269
  # ## Basic Usage
267
270
  #
@@ -274,13 +277,15 @@ module Aws::OpsWorks
274
277
  #
275
278
  # ## Example
276
279
  #
277
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
280
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
281
+ # instance.state.name == 'running'
282
+ # end
278
283
  #
279
284
  # ## Configuration
280
285
  #
281
286
  # You can configure the maximum number of polling attempts, and the
282
- # delay (in seconds) between each polling attempt. The waiting condition is set
283
- # by passing a block to {#wait_until}:
287
+ # delay (in seconds) between each polling attempt. The waiting condition is
288
+ # set by passing a block to {#wait_until}:
284
289
  #
285
290
  # # poll for ~25 seconds
286
291
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -311,17 +316,16 @@ module Aws::OpsWorks
311
316
  # # resource did not enter the desired state in time
312
317
  # end
313
318
  #
319
+ # @yieldparam [Resource] resource to be used in the waiting condition.
314
320
  #
315
- # @yield param [Resource] resource to be used in the waiting condition
316
- #
317
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
318
- # because the waiter has entered a state that it will not transition
319
- # out of, preventing success.
321
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
322
+ # terminates because the waiter has entered a state that it will not
323
+ # transition out of, preventing success.
320
324
  #
321
325
  # yet successful.
322
326
  #
323
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
324
- # while polling for a resource that is not expected.
327
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
328
+ # encountered while polling for a resource that is not expected.
325
329
  #
326
330
  # @raise [NotImplementedError] Raised when the resource does not
327
331
  #
@@ -6,6 +6,18 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorks
9
+
10
+ # This class provides a resource oriented interface for OpsWorks.
11
+ # To create a resource object:
12
+ #
13
+ # resource = Aws::OpsWorks::Resource.new(region: 'us-west-2')
14
+ #
15
+ # You can supply a client object with custom configuration that will be used for all resource operations.
16
+ # If you do not pass `:client`, a default client will be constructed.
17
+ #
18
+ # client = Aws::OpsWorks::Client.new(region: 'us-west-2')
19
+ # resource = Aws::OpsWorks::Resource.new(client: client)
20
+ #
9
21
  class Resource
10
22
 
11
23
  # @param options ({})
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorks
9
+
9
10
  class Stack
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::OpsWorks
21
22
  @id = extract_id(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -254,7 +256,8 @@ module Aws::OpsWorks
254
256
  # Waiter polls an API operation until a resource enters a desired
255
257
  # state.
256
258
  #
257
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
259
+ # @note The waiting operation is performed on a copy. The original resource
260
+ # remains unchanged.
258
261
  #
259
262
  # ## Basic Usage
260
263
  #
@@ -267,13 +270,15 @@ module Aws::OpsWorks
267
270
  #
268
271
  # ## Example
269
272
  #
270
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
273
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
274
+ # instance.state.name == 'running'
275
+ # end
271
276
  #
272
277
  # ## Configuration
273
278
  #
274
279
  # You can configure the maximum number of polling attempts, and the
275
- # delay (in seconds) between each polling attempt. The waiting condition is set
276
- # by passing a block to {#wait_until}:
280
+ # delay (in seconds) between each polling attempt. The waiting condition is
281
+ # set by passing a block to {#wait_until}:
277
282
  #
278
283
  # # poll for ~25 seconds
279
284
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -304,17 +309,16 @@ module Aws::OpsWorks
304
309
  # # resource did not enter the desired state in time
305
310
  # end
306
311
  #
312
+ # @yieldparam [Resource] resource to be used in the waiting condition.
307
313
  #
308
- # @yield param [Resource] resource to be used in the waiting condition
309
- #
310
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
311
- # because the waiter has entered a state that it will not transition
312
- # out of, preventing success.
314
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
315
+ # terminates because the waiter has entered a state that it will not
316
+ # transition out of, preventing success.
313
317
  #
314
318
  # yet successful.
315
319
  #
316
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
317
- # while polling for a resource that is not expected.
320
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
321
+ # encountered while polling for a resource that is not expected.
318
322
  #
319
323
  # @raise [NotImplementedError] Raised when the resource does not
320
324
  #
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::OpsWorks
9
+
9
10
  class StackSummary
10
11
 
11
12
  extend Aws::Deprecations
@@ -21,6 +22,7 @@ module Aws::OpsWorks
21
22
  @stack_id = extract_stack_id(args, options)
22
23
  @data = options.delete(:data)
23
24
  @client = options.delete(:client) || Client.new(options)
25
+ @waiter_block_warned = false
24
26
  end
25
27
 
26
28
  # @!group Read-Only Attributes
@@ -101,7 +103,8 @@ module Aws::OpsWorks
101
103
  # Waiter polls an API operation until a resource enters a desired
102
104
  # state.
103
105
  #
104
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
106
+ # @note The waiting operation is performed on a copy. The original resource
107
+ # remains unchanged.
105
108
  #
106
109
  # ## Basic Usage
107
110
  #
@@ -114,13 +117,15 @@ module Aws::OpsWorks
114
117
  #
115
118
  # ## Example
116
119
  #
117
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
120
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
121
+ # instance.state.name == 'running'
122
+ # end
118
123
  #
119
124
  # ## Configuration
120
125
  #
121
126
  # You can configure the maximum number of polling attempts, and the
122
- # delay (in seconds) between each polling attempt. The waiting condition is set
123
- # by passing a block to {#wait_until}:
127
+ # delay (in seconds) between each polling attempt. The waiting condition is
128
+ # set by passing a block to {#wait_until}:
124
129
  #
125
130
  # # poll for ~25 seconds
126
131
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -151,17 +156,16 @@ module Aws::OpsWorks
151
156
  # # resource did not enter the desired state in time
152
157
  # end
153
158
  #
159
+ # @yieldparam [Resource] resource to be used in the waiting condition.
154
160
  #
155
- # @yield param [Resource] resource to be used in the waiting condition
156
- #
157
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
158
- # because the waiter has entered a state that it will not transition
159
- # out of, preventing success.
161
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
162
+ # terminates because the waiter has entered a state that it will not
163
+ # transition out of, preventing success.
160
164
  #
161
165
  # yet successful.
162
166
  #
163
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
164
- # while polling for a resource that is not expected.
167
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
168
+ # encountered while polling for a resource that is not expected.
165
169
  #
166
170
  # @raise [NotImplementedError] Raised when the resource does not
167
171
  #
@@ -8,6 +8,72 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::OpsWorks
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | --------------------- | ----------------------------- | -------- | ------------- |
70
+ # | app_exists | {Client#describe_apps} | 1 | 40 |
71
+ # | deployment_successful | {Client#describe_deployments} | 15 | 40 |
72
+ # | instance_online | {Client#describe_instances} | 15 | 40 |
73
+ # | instance_registered | {Client#describe_instances} | 15 | 40 |
74
+ # | instance_stopped | {Client#describe_instances} | 15 | 40 |
75
+ # | instance_terminated | {Client#describe_instances} | 15 | 40 |
76
+ #
11
77
  module Waiters
12
78
 
13
79
  class AppExists
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-opsworks
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.19.0
4
+ version: 1.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-01 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.58.0
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.58.0
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
85
85
  version: '0'
86
86
  requirements: []
87
87
  rubyforge_project:
88
- rubygems_version: 2.5.2.3
88
+ rubygems_version: 2.7.6.2
89
89
  signing_key:
90
90
  specification_version: 4
91
91
  summary: AWS SDK for Ruby - AWS OpsWorks