aws-sdk-autoscaling 1.33.0 → 1.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1b91119d5438f8a9221c54356341819b776df8f50ac29cccbac7af0f38fa83c3
4
- data.tar.gz: e2f581c53ec372865c1bd6ffc29dd8ed21695ca35d73b9b1af7141520235a508
3
+ metadata.gz: d4075d13ad4121be0e6e87f0762647e0acd14692f92d15bb2290ca82281bc2b6
4
+ data.tar.gz: 3c7994c29c076ab530213169b28a9d265b922847ad06161cd7ca8af9740522fd
5
5
  SHA512:
6
- metadata.gz: 1e3fb49c1e46cc9b4e0a2def902ca57e1232b61668c206626f272c5b1ea5aa9a76bff1026508595b9830849bc39742368061d98d2a6a2e159c1d760195290bfc
7
- data.tar.gz: 7b54eaead6ad303be8aad389fd6b4d086b7d7835ab201bfedd3089212050d70651a7b713d1dfd5338ba55546b891e3d70dc3f4f9da16fddec46b306e811a6c38
6
+ metadata.gz: 9752cc1c302ea399b8a876a1c5f17c7b28b53d9b9b2b3e9bd85b13134f1042fdb478ef46a4e5ca1e779c514691510102fd611adbf92fa1c4925014fb878d423e
7
+ data.tar.gz: a75ded324ac743e093e62a26179cf0911632b0a486beb1d449a80143e832d4ac14c5c12afb7e49a084e15d406fecdd9afcc63bf5440e69149fd3dc280665f725
@@ -56,6 +56,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
56
56
  # @service
57
57
  module Aws::AutoScaling
58
58
 
59
- GEM_VERSION = '1.33.0'
59
+ GEM_VERSION = '1.34.0'
60
60
 
61
61
  end
@@ -127,7 +127,8 @@ module Aws::AutoScaling
127
127
  # Waiter polls an API operation until a resource enters a desired
128
128
  # state.
129
129
  #
130
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
130
+ # @note The waiting operation is performed on a copy. The original resource
131
+ # remains unchanged.
131
132
  #
132
133
  # ## Basic Usage
133
134
  #
@@ -140,13 +141,15 @@ module Aws::AutoScaling
140
141
  #
141
142
  # ## Example
142
143
  #
143
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
144
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
145
+ # instance.state.name == 'running'
146
+ # end
144
147
  #
145
148
  # ## Configuration
146
149
  #
147
150
  # You can configure the maximum number of polling attempts, and the
148
- # delay (in seconds) between each polling attempt. The waiting condition is set
149
- # by passing a block to {#wait_until}:
151
+ # delay (in seconds) between each polling attempt. The waiting condition is
152
+ # set by passing a block to {#wait_until}:
150
153
  #
151
154
  # # poll for ~25 seconds
152
155
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -177,17 +180,16 @@ module Aws::AutoScaling
177
180
  # # resource did not enter the desired state in time
178
181
  # end
179
182
  #
183
+ # @yieldparam [Resource] resource to be used in the waiting condition.
180
184
  #
181
- # @yield param [Resource] resource to be used in the waiting condition
182
- #
183
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
184
- # because the waiter has entered a state that it will not transition
185
- # out of, preventing success.
185
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
186
+ # terminates because the waiter has entered a state that it will not
187
+ # transition out of, preventing success.
186
188
  #
187
189
  # yet successful.
188
190
  #
189
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
190
- # while polling for a resource that is not expected.
191
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
192
+ # encountered while polling for a resource that is not expected.
191
193
  #
192
194
  # @raise [NotImplementedError] Raised when the resource does not
193
195
  #
@@ -290,7 +290,8 @@ module Aws::AutoScaling
290
290
  # Waiter polls an API operation until a resource enters a desired
291
291
  # state.
292
292
  #
293
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
293
+ # @note The waiting operation is performed on a copy. The original resource
294
+ # remains unchanged.
294
295
  #
295
296
  # ## Basic Usage
296
297
  #
@@ -303,13 +304,15 @@ module Aws::AutoScaling
303
304
  #
304
305
  # ## Example
305
306
  #
306
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
307
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
308
+ # instance.state.name == 'running'
309
+ # end
307
310
  #
308
311
  # ## Configuration
309
312
  #
310
313
  # You can configure the maximum number of polling attempts, and the
311
- # delay (in seconds) between each polling attempt. The waiting condition is set
312
- # by passing a block to {#wait_until}:
314
+ # delay (in seconds) between each polling attempt. The waiting condition is
315
+ # set by passing a block to {#wait_until}:
313
316
  #
314
317
  # # poll for ~25 seconds
315
318
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -340,17 +343,16 @@ module Aws::AutoScaling
340
343
  # # resource did not enter the desired state in time
341
344
  # end
342
345
  #
346
+ # @yieldparam [Resource] resource to be used in the waiting condition.
343
347
  #
344
- # @yield param [Resource] resource to be used in the waiting condition
345
- #
346
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
347
- # because the waiter has entered a state that it will not transition
348
- # out of, preventing success.
348
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
349
+ # terminates because the waiter has entered a state that it will not
350
+ # transition out of, preventing success.
349
351
  #
350
352
  # yet successful.
351
353
  #
352
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
353
- # while polling for a resource that is not expected.
354
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
355
+ # encountered while polling for a resource that is not expected.
354
356
  #
355
357
  # @raise [NotImplementedError] Raised when the resource does not
356
358
  #
@@ -1291,8 +1293,8 @@ module Aws::AutoScaling
1291
1293
 
1292
1294
  def yield_waiter_and_warn(waiter, &block)
1293
1295
  if !@waiter_block_warned
1294
- msg = "pass options to configure the waiter; "
1295
- msg << "yielding the waiter is deprecated"
1296
+ msg = "pass options to configure the waiter; "\
1297
+ "yielding the waiter is deprecated"
1296
1298
  warn(msg)
1297
1299
  @waiter_block_warned = true
1298
1300
  end
@@ -1300,7 +1302,9 @@ module Aws::AutoScaling
1300
1302
  end
1301
1303
 
1302
1304
  def separate_params_and_options(options)
1303
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
1305
+ opts = Set.new(
1306
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
1307
+ )
1304
1308
  waiter_opts = {}
1305
1309
  waiter_params = {}
1306
1310
  options.each_pair do |key, value|
@@ -269,8 +269,7 @@ module Aws::AutoScaling
269
269
  #
270
270
  # @option options [Integer] :http_read_timeout (60) The default
271
271
  # number of seconds to wait for response data. This value can
272
- # safely be set
273
- # per-request on the session yielded by {#session_for}.
272
+ # safely be set per-request on the session.
274
273
  #
275
274
  # @option options [Float] :http_idle_timeout (5) The number of
276
275
  # seconds a connection is allowed to sit idle before it is
@@ -282,7 +281,7 @@ module Aws::AutoScaling
282
281
  # request body. This option has no effect unless the request has
283
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
284
283
  # disables this behaviour. This value can safely be set per
285
- # request on the session yielded by {#session_for}.
284
+ # request on the session.
286
285
  #
287
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
288
287
  # HTTP debug output will be sent to the `:logger`.
@@ -1825,6 +1824,8 @@ module Aws::AutoScaling
1825
1824
  # * {Types::AutoScalingGroupsType#auto_scaling_groups #auto_scaling_groups} => Array&lt;Types::AutoScalingGroup&gt;
1826
1825
  # * {Types::AutoScalingGroupsType#next_token #next_token} => String
1827
1826
  #
1827
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1828
+ #
1828
1829
  #
1829
1830
  # @example Example: To describe an Auto Scaling group
1830
1831
  #
@@ -1956,6 +1957,13 @@ module Aws::AutoScaling
1956
1957
  # resp.auto_scaling_groups[0].max_instance_lifetime #=> Integer
1957
1958
  # resp.next_token #=> String
1958
1959
  #
1960
+ #
1961
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1962
+ #
1963
+ # * group_exists
1964
+ # * group_in_service
1965
+ # * group_not_exists
1966
+ #
1959
1967
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups AWS API Documentation
1960
1968
  #
1961
1969
  # @overload describe_auto_scaling_groups(params = {})
@@ -1985,6 +1993,8 @@ module Aws::AutoScaling
1985
1993
  # * {Types::AutoScalingInstancesType#auto_scaling_instances #auto_scaling_instances} => Array&lt;Types::AutoScalingInstanceDetails&gt;
1986
1994
  # * {Types::AutoScalingInstancesType#next_token #next_token} => String
1987
1995
  #
1996
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1997
+ #
1988
1998
  #
1989
1999
  # @example Example: To describe one or more Auto Scaling instances
1990
2000
  #
@@ -2104,6 +2114,8 @@ module Aws::AutoScaling
2104
2114
  # * {Types::LaunchConfigurationsType#launch_configurations #launch_configurations} => Array&lt;Types::LaunchConfiguration&gt;
2105
2115
  # * {Types::LaunchConfigurationsType#next_token #next_token} => String
2106
2116
  #
2117
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2118
+ #
2107
2119
  #
2108
2120
  # @example Example: To describe Auto Scaling launch configurations
2109
2121
  #
@@ -2515,6 +2527,8 @@ module Aws::AutoScaling
2515
2527
  # * {Types::DescribeNotificationConfigurationsAnswer#notification_configurations #notification_configurations} => Array&lt;Types::NotificationConfiguration&gt;
2516
2528
  # * {Types::DescribeNotificationConfigurationsAnswer#next_token #next_token} => String
2517
2529
  #
2530
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2531
+ #
2518
2532
  #
2519
2533
  # @example Example: To describe Auto Scaling notification configurations
2520
2534
  #
@@ -2595,6 +2609,8 @@ module Aws::AutoScaling
2595
2609
  # * {Types::PoliciesType#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
2596
2610
  # * {Types::PoliciesType#next_token #next_token} => String
2597
2611
  #
2612
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2613
+ #
2598
2614
  #
2599
2615
  # @example Example: To describe Auto Scaling policies
2600
2616
  #
@@ -2710,6 +2726,8 @@ module Aws::AutoScaling
2710
2726
  # * {Types::ActivitiesType#activities #activities} => Array&lt;Types::Activity&gt;
2711
2727
  # * {Types::ActivitiesType#next_token #next_token} => String
2712
2728
  #
2729
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2730
+ #
2713
2731
  #
2714
2732
  # @example Example: To describe the scaling activities for an Auto Scaling group
2715
2733
  #
@@ -2862,6 +2880,8 @@ module Aws::AutoScaling
2862
2880
  # * {Types::ScheduledActionsType#scheduled_update_group_actions #scheduled_update_group_actions} => Array&lt;Types::ScheduledUpdateGroupAction&gt;
2863
2881
  # * {Types::ScheduledActionsType#next_token #next_token} => String
2864
2882
  #
2883
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2884
+ #
2865
2885
  #
2866
2886
  # @example Example: To describe scheduled actions
2867
2887
  #
@@ -2951,6 +2971,8 @@ module Aws::AutoScaling
2951
2971
  # * {Types::TagsType#tags #tags} => Array&lt;Types::TagDescription&gt;
2952
2972
  # * {Types::TagsType#next_token #next_token} => String
2953
2973
  #
2974
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2975
+ #
2954
2976
  #
2955
2977
  # @example Example: To describe tags
2956
2978
  #
@@ -4876,7 +4898,7 @@ module Aws::AutoScaling
4876
4898
  params: params,
4877
4899
  config: config)
4878
4900
  context[:gem_name] = 'aws-sdk-autoscaling'
4879
- context[:gem_version] = '1.33.0'
4901
+ context[:gem_version] = '1.34.0'
4880
4902
  Seahorse::Client::Request.new(handlers, context)
4881
4903
  end
4882
4904
 
@@ -4942,11 +4964,11 @@ module Aws::AutoScaling
4942
4964
  # The following table lists the valid waiter names, the operations they call,
4943
4965
  # and the default `:delay` and `:max_attempts` values.
4944
4966
  #
4945
- # | waiter_name | params | :delay | :max_attempts |
4946
- # | ---------------- | ------------------------------- | -------- | ------------- |
4947
- # | group_exists | {#describe_auto_scaling_groups} | 5 | 10 |
4948
- # | group_in_service | {#describe_auto_scaling_groups} | 15 | 40 |
4949
- # | group_not_exists | {#describe_auto_scaling_groups} | 15 | 40 |
4967
+ # | waiter_name | params | :delay | :max_attempts |
4968
+ # | ---------------- | ------------------------------------- | -------- | ------------- |
4969
+ # | group_exists | {Client#describe_auto_scaling_groups} | 5 | 10 |
4970
+ # | group_in_service | {Client#describe_auto_scaling_groups} | 15 | 40 |
4971
+ # | group_not_exists | {Client#describe_auto_scaling_groups} | 15 | 40 |
4950
4972
  #
4951
4973
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
4952
4974
  # because the waiter has entered a state that it will not transition
@@ -138,7 +138,8 @@ module Aws::AutoScaling
138
138
  # Waiter polls an API operation until a resource enters a desired
139
139
  # state.
140
140
  #
141
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
141
+ # @note The waiting operation is performed on a copy. The original resource
142
+ # remains unchanged.
142
143
  #
143
144
  # ## Basic Usage
144
145
  #
@@ -151,13 +152,15 @@ module Aws::AutoScaling
151
152
  #
152
153
  # ## Example
153
154
  #
154
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
155
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
156
+ # instance.state.name == 'running'
157
+ # end
155
158
  #
156
159
  # ## Configuration
157
160
  #
158
161
  # You can configure the maximum number of polling attempts, and the
159
- # delay (in seconds) between each polling attempt. The waiting condition is set
160
- # by passing a block to {#wait_until}:
162
+ # delay (in seconds) between each polling attempt. The waiting condition is
163
+ # set by passing a block to {#wait_until}:
161
164
  #
162
165
  # # poll for ~25 seconds
163
166
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -188,17 +191,16 @@ module Aws::AutoScaling
188
191
  # # resource did not enter the desired state in time
189
192
  # end
190
193
  #
194
+ # @yieldparam [Resource] resource to be used in the waiting condition.
191
195
  #
192
- # @yield param [Resource] resource to be used in the waiting condition
193
- #
194
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
195
- # because the waiter has entered a state that it will not transition
196
- # out of, preventing success.
196
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
197
+ # terminates because the waiter has entered a state that it will not
198
+ # transition out of, preventing success.
197
199
  #
198
200
  # yet successful.
199
201
  #
200
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
201
- # while polling for a resource that is not expected.
202
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
203
+ # encountered while polling for a resource that is not expected.
202
204
  #
203
205
  # @raise [NotImplementedError] Raised when the resource does not
204
206
  #
@@ -298,7 +298,8 @@ module Aws::AutoScaling
298
298
  # Waiter polls an API operation until a resource enters a desired
299
299
  # state.
300
300
  #
301
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
301
+ # @note The waiting operation is performed on a copy. The original resource
302
+ # remains unchanged.
302
303
  #
303
304
  # ## Basic Usage
304
305
  #
@@ -311,13 +312,15 @@ module Aws::AutoScaling
311
312
  #
312
313
  # ## Example
313
314
  #
314
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
315
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
316
+ # instance.state.name == 'running'
317
+ # end
315
318
  #
316
319
  # ## Configuration
317
320
  #
318
321
  # You can configure the maximum number of polling attempts, and the
319
- # delay (in seconds) between each polling attempt. The waiting condition is set
320
- # by passing a block to {#wait_until}:
322
+ # delay (in seconds) between each polling attempt. The waiting condition is
323
+ # set by passing a block to {#wait_until}:
321
324
  #
322
325
  # # poll for ~25 seconds
323
326
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -348,17 +351,16 @@ module Aws::AutoScaling
348
351
  # # resource did not enter the desired state in time
349
352
  # end
350
353
  #
354
+ # @yieldparam [Resource] resource to be used in the waiting condition.
351
355
  #
352
- # @yield param [Resource] resource to be used in the waiting condition
353
- #
354
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
355
- # because the waiter has entered a state that it will not transition
356
- # out of, preventing success.
356
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
357
+ # terminates because the waiter has entered a state that it will not
358
+ # transition out of, preventing success.
357
359
  #
358
360
  # yet successful.
359
361
  #
360
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
361
- # while polling for a resource that is not expected.
362
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
363
+ # encountered while polling for a resource that is not expected.
362
364
  #
363
365
  # @raise [NotImplementedError] Raised when the resource does not
364
366
  #
@@ -144,7 +144,8 @@ module Aws::AutoScaling
144
144
  # Waiter polls an API operation until a resource enters a desired
145
145
  # state.
146
146
  #
147
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
147
+ # @note The waiting operation is performed on a copy. The original resource
148
+ # remains unchanged.
148
149
  #
149
150
  # ## Basic Usage
150
151
  #
@@ -157,13 +158,15 @@ module Aws::AutoScaling
157
158
  #
158
159
  # ## Example
159
160
  #
160
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
161
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
162
+ # instance.state.name == 'running'
163
+ # end
161
164
  #
162
165
  # ## Configuration
163
166
  #
164
167
  # You can configure the maximum number of polling attempts, and the
165
- # delay (in seconds) between each polling attempt. The waiting condition is set
166
- # by passing a block to {#wait_until}:
168
+ # delay (in seconds) between each polling attempt. The waiting condition is
169
+ # set by passing a block to {#wait_until}:
167
170
  #
168
171
  # # poll for ~25 seconds
169
172
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -194,17 +197,16 @@ module Aws::AutoScaling
194
197
  # # resource did not enter the desired state in time
195
198
  # end
196
199
  #
200
+ # @yieldparam [Resource] resource to be used in the waiting condition.
197
201
  #
198
- # @yield param [Resource] resource to be used in the waiting condition
199
- #
200
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
201
- # because the waiter has entered a state that it will not transition
202
- # out of, preventing success.
202
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
203
+ # terminates because the waiter has entered a state that it will not
204
+ # transition out of, preventing success.
203
205
  #
204
206
  # yet successful.
205
207
  #
206
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
207
- # while polling for a resource that is not expected.
208
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
209
+ # encountered while polling for a resource that is not expected.
208
210
  #
209
211
  # @raise [NotImplementedError] Raised when the resource does not
210
212
  #
@@ -99,7 +99,8 @@ module Aws::AutoScaling
99
99
  # Waiter polls an API operation until a resource enters a desired
100
100
  # state.
101
101
  #
102
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
102
+ # @note The waiting operation is performed on a copy. The original resource
103
+ # remains unchanged.
103
104
  #
104
105
  # ## Basic Usage
105
106
  #
@@ -112,13 +113,15 @@ module Aws::AutoScaling
112
113
  #
113
114
  # ## Example
114
115
  #
115
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
116
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
117
+ # instance.state.name == 'running'
118
+ # end
116
119
  #
117
120
  # ## Configuration
118
121
  #
119
122
  # You can configure the maximum number of polling attempts, and the
120
- # delay (in seconds) between each polling attempt. The waiting condition is set
121
- # by passing a block to {#wait_until}:
123
+ # delay (in seconds) between each polling attempt. The waiting condition is
124
+ # set by passing a block to {#wait_until}:
122
125
  #
123
126
  # # poll for ~25 seconds
124
127
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -149,17 +152,16 @@ module Aws::AutoScaling
149
152
  # # resource did not enter the desired state in time
150
153
  # end
151
154
  #
155
+ # @yieldparam [Resource] resource to be used in the waiting condition.
152
156
  #
153
- # @yield param [Resource] resource to be used in the waiting condition
154
- #
155
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
156
- # because the waiter has entered a state that it will not transition
157
- # out of, preventing success.
157
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
158
+ # terminates because the waiter has entered a state that it will not
159
+ # transition out of, preventing success.
158
160
  #
159
161
  # yet successful.
160
162
  #
161
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
162
- # while polling for a resource that is not expected.
163
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
164
+ # encountered while polling for a resource that is not expected.
163
165
  #
164
166
  # @raise [NotImplementedError] Raised when the resource does not
165
167
  #
@@ -85,7 +85,8 @@ module Aws::AutoScaling
85
85
  # Waiter polls an API operation until a resource enters a desired
86
86
  # state.
87
87
  #
88
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
88
+ # @note The waiting operation is performed on a copy. The original resource
89
+ # remains unchanged.
89
90
  #
90
91
  # ## Basic Usage
91
92
  #
@@ -98,13 +99,15 @@ module Aws::AutoScaling
98
99
  #
99
100
  # ## Example
100
101
  #
101
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
102
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
103
+ # instance.state.name == 'running'
104
+ # end
102
105
  #
103
106
  # ## Configuration
104
107
  #
105
108
  # You can configure the maximum number of polling attempts, and the
106
- # delay (in seconds) between each polling attempt. The waiting condition is set
107
- # by passing a block to {#wait_until}:
109
+ # delay (in seconds) between each polling attempt. The waiting condition is
110
+ # set by passing a block to {#wait_until}:
108
111
  #
109
112
  # # poll for ~25 seconds
110
113
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -135,17 +138,16 @@ module Aws::AutoScaling
135
138
  # # resource did not enter the desired state in time
136
139
  # end
137
140
  #
141
+ # @yieldparam [Resource] resource to be used in the waiting condition.
138
142
  #
139
- # @yield param [Resource] resource to be used in the waiting condition
140
- #
141
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
142
- # because the waiter has entered a state that it will not transition
143
- # out of, preventing success.
143
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
144
+ # terminates because the waiter has entered a state that it will not
145
+ # transition out of, preventing success.
144
146
  #
145
147
  # yet successful.
146
148
  #
147
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
148
- # while polling for a resource that is not expected.
149
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
150
+ # encountered while polling for a resource that is not expected.
149
151
  #
150
152
  # @raise [NotImplementedError] Raised when the resource does not
151
153
  #
@@ -6,13 +6,18 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AutoScaling
9
+
9
10
  # This class provides a resource oriented interface for AutoScaling.
10
11
  # To create a resource object:
12
+ #
11
13
  # resource = Aws::AutoScaling::Resource.new(region: 'us-west-2')
14
+ #
12
15
  # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
16
+ # If you do not pass `:client`, a default client will be constructed.
17
+ #
14
18
  # client = Aws::AutoScaling::Client.new(region: 'us-west-2')
15
19
  # resource = Aws::AutoScaling::Resource.new(client: client)
20
+ #
16
21
  class Resource
17
22
 
18
23
  # @param options ({})
@@ -171,7 +171,8 @@ module Aws::AutoScaling
171
171
  # Waiter polls an API operation until a resource enters a desired
172
172
  # state.
173
173
  #
174
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
174
+ # @note The waiting operation is performed on a copy. The original resource
175
+ # remains unchanged.
175
176
  #
176
177
  # ## Basic Usage
177
178
  #
@@ -184,13 +185,15 @@ module Aws::AutoScaling
184
185
  #
185
186
  # ## Example
186
187
  #
187
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
188
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
189
+ # instance.state.name == 'running'
190
+ # end
188
191
  #
189
192
  # ## Configuration
190
193
  #
191
194
  # You can configure the maximum number of polling attempts, and the
192
- # delay (in seconds) between each polling attempt. The waiting condition is set
193
- # by passing a block to {#wait_until}:
195
+ # delay (in seconds) between each polling attempt. The waiting condition is
196
+ # set by passing a block to {#wait_until}:
194
197
  #
195
198
  # # poll for ~25 seconds
196
199
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -221,17 +224,16 @@ module Aws::AutoScaling
221
224
  # # resource did not enter the desired state in time
222
225
  # end
223
226
  #
227
+ # @yieldparam [Resource] resource to be used in the waiting condition.
224
228
  #
225
- # @yield param [Resource] resource to be used in the waiting condition
226
- #
227
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
228
- # because the waiter has entered a state that it will not transition
229
- # out of, preventing success.
229
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
230
+ # terminates because the waiter has entered a state that it will not
231
+ # transition out of, preventing success.
230
232
  #
231
233
  # yet successful.
232
234
  #
233
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
234
- # while polling for a resource that is not expected.
235
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
236
+ # encountered while polling for a resource that is not expected.
235
237
  #
236
238
  # @raise [NotImplementedError] Raised when the resource does not
237
239
  #
@@ -132,7 +132,8 @@ module Aws::AutoScaling
132
132
  # Waiter polls an API operation until a resource enters a desired
133
133
  # state.
134
134
  #
135
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
135
+ # @note The waiting operation is performed on a copy. The original resource
136
+ # remains unchanged.
136
137
  #
137
138
  # ## Basic Usage
138
139
  #
@@ -145,13 +146,15 @@ module Aws::AutoScaling
145
146
  #
146
147
  # ## Example
147
148
  #
148
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
149
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
150
+ # instance.state.name == 'running'
151
+ # end
149
152
  #
150
153
  # ## Configuration
151
154
  #
152
155
  # You can configure the maximum number of polling attempts, and the
153
- # delay (in seconds) between each polling attempt. The waiting condition is set
154
- # by passing a block to {#wait_until}:
156
+ # delay (in seconds) between each polling attempt. The waiting condition is
157
+ # set by passing a block to {#wait_until}:
155
158
  #
156
159
  # # poll for ~25 seconds
157
160
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -182,17 +185,16 @@ module Aws::AutoScaling
182
185
  # # resource did not enter the desired state in time
183
186
  # end
184
187
  #
188
+ # @yieldparam [Resource] resource to be used in the waiting condition.
185
189
  #
186
- # @yield param [Resource] resource to be used in the waiting condition
187
- #
188
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
189
- # because the waiter has entered a state that it will not transition
190
- # out of, preventing success.
190
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
191
+ # terminates because the waiter has entered a state that it will not
192
+ # transition out of, preventing success.
191
193
  #
192
194
  # yet successful.
193
195
  #
194
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
195
- # while polling for a resource that is not expected.
196
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
197
+ # encountered while polling for a resource that is not expected.
196
198
  #
197
199
  # @raise [NotImplementedError] Raised when the resource does not
198
200
  #
@@ -110,7 +110,8 @@ module Aws::AutoScaling
110
110
  # Waiter polls an API operation until a resource enters a desired
111
111
  # state.
112
112
  #
113
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
113
+ # @note The waiting operation is performed on a copy. The original resource
114
+ # remains unchanged.
114
115
  #
115
116
  # ## Basic Usage
116
117
  #
@@ -123,13 +124,15 @@ module Aws::AutoScaling
123
124
  #
124
125
  # ## Example
125
126
  #
126
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
127
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
128
+ # instance.state.name == 'running'
129
+ # end
127
130
  #
128
131
  # ## Configuration
129
132
  #
130
133
  # You can configure the maximum number of polling attempts, and the
131
- # delay (in seconds) between each polling attempt. The waiting condition is set
132
- # by passing a block to {#wait_until}:
134
+ # delay (in seconds) between each polling attempt. The waiting condition is
135
+ # set by passing a block to {#wait_until}:
133
136
  #
134
137
  # # poll for ~25 seconds
135
138
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -160,17 +163,16 @@ module Aws::AutoScaling
160
163
  # # resource did not enter the desired state in time
161
164
  # end
162
165
  #
166
+ # @yieldparam [Resource] resource to be used in the waiting condition.
163
167
  #
164
- # @yield param [Resource] resource to be used in the waiting condition
165
- #
166
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
167
- # because the waiter has entered a state that it will not transition
168
- # out of, preventing success.
168
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
169
+ # terminates because the waiter has entered a state that it will not
170
+ # transition out of, preventing success.
169
171
  #
170
172
  # yet successful.
171
173
  #
172
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
173
- # while polling for a resource that is not expected.
174
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
175
+ # encountered while polling for a resource that is not expected.
174
176
  #
175
177
  # @raise [NotImplementedError] Raised when the resource does not
176
178
  #
@@ -8,6 +8,69 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::AutoScaling
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
+ # | group_exists | {Client#describe_auto_scaling_groups} | 5 | 10 |
71
+ # | group_in_service | {Client#describe_auto_scaling_groups} | 15 | 40 |
72
+ # | group_not_exists | {Client#describe_auto_scaling_groups} | 15 | 40 |
73
+ #
11
74
  module Waiters
12
75
 
13
76
  class GroupExists
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-autoscaling
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.33.0
4
+ version: 1.34.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: 2020-03-16 00:00:00.000000000 Z
11
+ date: 2020-04-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -91,7 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
91
91
  - !ruby/object:Gem::Version
92
92
  version: '0'
93
93
  requirements: []
94
- rubygems_version: 3.0.3
94
+ rubyforge_project:
95
+ rubygems_version: 2.7.6.2
95
96
  signing_key:
96
97
  specification_version: 4
97
98
  summary: AWS SDK for Ruby - Auto Scaling