aws-sdk-autoscaling 1.32.0 → 1.37.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: 162819f3b0c0d3f5c0a739f09693501c82636cab
4
- data.tar.gz: 28d261d22a106c32f9c933e144f56d0cb8f2a180
2
+ SHA256:
3
+ metadata.gz: c086cea371c937d88a7b1b9cd28b169a8fef23dadad9c9319aca18d3945ef777
4
+ data.tar.gz: c880b97dcaef3184de0336b7b92e357025eca761e2e50b8cf3c8159561b6eba1
5
5
  SHA512:
6
- metadata.gz: 21d9b905c299b9d7ba05fe0fe53e7b704b092a452a03ac4d2a9f4aaccc9509f3d139e76a17a7df526ec72756964fcc5b42680f742396dfefe45101a77da5ed38
7
- data.tar.gz: d2a631b38e79813c4dcb8923dea71828976136de929c05a4831082695a7d0a1ba6e6ac94c70c9fc94e089a991a1400e2e63b464d6c4437bc8d7ff6441b8099eb
6
+ metadata.gz: 24ce25063ee1ded19008d85928963fa2ae354e1b64a5c5198fdcfb6fd5e97db4b3bf5aadaaf2eaa50dfaea6c22e7d09735e75adbfff3b8e08c17f7825fde7a92
7
+ data.tar.gz: 49caf7c247a7d223510b3d0cf4ce7b4c2cb8b804875c886cfe463f2c929d3cac89c3a04cda2344cf51111478920026cf0778493404fcd8227fc257f02ed20fbd
@@ -35,17 +35,20 @@ require_relative 'aws-sdk-autoscaling/customizations'
35
35
  # methods each accept a hash of request parameters and return a response
36
36
  # structure.
37
37
  #
38
+ # auto_scaling = Aws::AutoScaling::Client.new
39
+ # resp = auto_scaling.attach_instances(params)
40
+ #
38
41
  # See {Client} for more information.
39
42
  #
40
43
  # # Errors
41
44
  #
42
- # Errors returned from Auto Scaling all
43
- # extend {Errors::ServiceError}.
45
+ # Errors returned from Auto Scaling are defined in the
46
+ # {Errors} module and all extend {Errors::ServiceError}.
44
47
  #
45
48
  # begin
46
49
  # # do stuff
47
50
  # rescue Aws::AutoScaling::Errors::ServiceError
48
- # # rescues all service API errors
51
+ # # rescues all Auto Scaling API errors
49
52
  # end
50
53
  #
51
54
  # See {Errors} for more information.
@@ -53,6 +56,6 @@ require_relative 'aws-sdk-autoscaling/customizations'
53
56
  # @service
54
57
  module Aws::AutoScaling
55
58
 
56
- GEM_VERSION = '1.32.0'
59
+ GEM_VERSION = '1.37.0'
57
60
 
58
61
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AutoScaling
9
+
9
10
  class Activity
10
11
 
11
12
  extend Aws::Deprecations
@@ -126,7 +127,8 @@ module Aws::AutoScaling
126
127
  # Waiter polls an API operation until a resource enters a desired
127
128
  # state.
128
129
  #
129
- # @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.
130
132
  #
131
133
  # ## Basic Usage
132
134
  #
@@ -139,13 +141,15 @@ module Aws::AutoScaling
139
141
  #
140
142
  # ## Example
141
143
  #
142
- # 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
143
147
  #
144
148
  # ## Configuration
145
149
  #
146
150
  # You can configure the maximum number of polling attempts, and the
147
- # delay (in seconds) between each polling attempt. The waiting condition is set
148
- # 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}:
149
153
  #
150
154
  # # poll for ~25 seconds
151
155
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -176,17 +180,16 @@ module Aws::AutoScaling
176
180
  # # resource did not enter the desired state in time
177
181
  # end
178
182
  #
183
+ # @yieldparam [Resource] resource to be used in the waiting condition.
179
184
  #
180
- # @yield param [Resource] resource to be used in the waiting condition
181
- #
182
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
183
- # because the waiter has entered a state that it will not transition
184
- # 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.
185
188
  #
186
189
  # yet successful.
187
190
  #
188
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
189
- # 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.
190
193
  #
191
194
  # @raise [NotImplementedError] Raised when the resource does not
192
195
  #
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AutoScaling
9
+
9
10
  class AutoScalingGroup
10
11
 
11
12
  extend Aws::Deprecations
@@ -148,8 +149,8 @@ module Aws::AutoScaling
148
149
  data[:enabled_metrics]
149
150
  end
150
151
 
151
- # The current state of the group when DeleteAutoScalingGroup is in
152
- # progress.
152
+ # The current state of the group when the DeleteAutoScalingGroup
153
+ # operation is in progress.
153
154
  # @return [String]
154
155
  def status
155
156
  data[:status]
@@ -178,7 +179,7 @@ module Aws::AutoScaling
178
179
  # The maximum amount of time, in seconds, that an instance can be in
179
180
  # service.
180
181
  #
181
- # Valid Range: Minimum value of 604800.
182
+ # Valid Range: Minimum value of 0.
182
183
  # @return [Integer]
183
184
  def max_instance_lifetime
184
185
  data[:max_instance_lifetime]
@@ -289,7 +290,8 @@ module Aws::AutoScaling
289
290
  # Waiter polls an API operation until a resource enters a desired
290
291
  # state.
291
292
  #
292
- # @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.
293
295
  #
294
296
  # ## Basic Usage
295
297
  #
@@ -302,13 +304,15 @@ module Aws::AutoScaling
302
304
  #
303
305
  # ## Example
304
306
  #
305
- # 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
306
310
  #
307
311
  # ## Configuration
308
312
  #
309
313
  # You can configure the maximum number of polling attempts, and the
310
- # delay (in seconds) between each polling attempt. The waiting condition is set
311
- # 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}:
312
316
  #
313
317
  # # poll for ~25 seconds
314
318
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -339,17 +343,16 @@ module Aws::AutoScaling
339
343
  # # resource did not enter the desired state in time
340
344
  # end
341
345
  #
346
+ # @yieldparam [Resource] resource to be used in the waiting condition.
342
347
  #
343
- # @yield param [Resource] resource to be used in the waiting condition
344
- #
345
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
346
- # because the waiter has entered a state that it will not transition
347
- # 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.
348
351
  #
349
352
  # yet successful.
350
353
  #
351
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
352
- # 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.
353
356
  #
354
357
  # @raise [NotImplementedError] Raised when the resource does not
355
358
  #
@@ -448,8 +451,7 @@ module Aws::AutoScaling
448
451
  # })
449
452
  # @param [Hash] options ({})
450
453
  # @option options [Array<String>] :metrics
451
- # One or more of the following metrics. If you omit this parameter, all
452
- # metrics are disabled.
454
+ # Specifies one or more of the following metrics:
453
455
  #
454
456
  # * `GroupMinSize`
455
457
  #
@@ -466,6 +468,18 @@ module Aws::AutoScaling
466
468
  # * `GroupTerminatingInstances`
467
469
  #
468
470
  # * `GroupTotalInstances`
471
+ #
472
+ # * `GroupInServiceCapacity`
473
+ #
474
+ # * `GroupPendingCapacity`
475
+ #
476
+ # * `GroupStandbyCapacity`
477
+ #
478
+ # * `GroupTerminatingCapacity`
479
+ #
480
+ # * `GroupTotalCapacity`
481
+ #
482
+ # If you omit this parameter, all metrics are disabled.
469
483
  # @return [EmptyStructure]
470
484
  def disable_metrics_collection(options = {})
471
485
  options = options.merge(auto_scaling_group_name: @name)
@@ -481,8 +495,8 @@ module Aws::AutoScaling
481
495
  # })
482
496
  # @param [Hash] options ({})
483
497
  # @option options [Array<String>] :metrics
484
- # One or more of the following metrics. If you omit this parameter, all
485
- # metrics are enabled.
498
+ # Specifies which group-level metrics to start collecting. You can
499
+ # specify one or more of the following metrics:
486
500
  #
487
501
  # * `GroupMinSize`
488
502
  #
@@ -499,6 +513,21 @@ module Aws::AutoScaling
499
513
  # * `GroupTerminatingInstances`
500
514
  #
501
515
  # * `GroupTotalInstances`
516
+ #
517
+ # The instance weighting feature supports the following additional
518
+ # metrics:
519
+ #
520
+ # * `GroupInServiceCapacity`
521
+ #
522
+ # * `GroupPendingCapacity`
523
+ #
524
+ # * `GroupStandbyCapacity`
525
+ #
526
+ # * `GroupTerminatingCapacity`
527
+ #
528
+ # * `GroupTotalCapacity`
529
+ #
530
+ # If you omit this parameter, all metrics are enabled.
502
531
  # @option options [required, String] :granularity
503
532
  # The granularity to associate with the metrics to collect. The only
504
533
  # valid value is `1Minute`.
@@ -573,20 +602,22 @@ module Aws::AutoScaling
573
602
  # Available for backward compatibility. Use `MinAdjustmentMagnitude`
574
603
  # instead.
575
604
  # @option options [Integer] :min_adjustment_magnitude
576
- # The minimum number of instances to scale. If the value of
577
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
578
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
579
- # this many instances. Otherwise, the error is `ValidationError`.
580
- #
581
- # This property replaces the `MinAdjustmentStep` property. For example,
582
- # suppose that you create a step scaling policy to scale out an Auto
583
- # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
584
- # of 2. If the group has 4 instances and the scaling policy is
585
- # performed, 25 percent of 4 is 1. However, because you specified a
586
- # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
587
- # group by 2 instances.
588
- #
589
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
605
+ # The minimum value to scale by when scaling by percentages. For
606
+ # example, suppose that you create a step scaling policy to scale out an
607
+ # Auto Scaling group by 25 percent and you specify a
608
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
609
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
610
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
611
+ # scales out the group by 2 instances.
612
+ #
613
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
614
+ # the adjustment type is `PercentChangeInCapacity`. For more
615
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
616
+ # Scaling User Guide*.
617
+ #
618
+ #
619
+ #
620
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
590
621
  # @option options [Integer] :scaling_adjustment
591
622
  # The amount by which a simple scaling policy scales the Auto Scaling
592
623
  # group in response to an alarm breach. The adjustment is based on the
@@ -655,7 +686,7 @@ module Aws::AutoScaling
655
686
  # @return [ScalingPolicy]
656
687
  def put_scaling_policy(options = {})
657
688
  options = options.merge(auto_scaling_group_name: @name)
658
- resp = @client.put_scaling_policy(options)
689
+ @client.put_scaling_policy(options)
659
690
  ScalingPolicy.new(
660
691
  name: options[:policy_name],
661
692
  client: @client
@@ -707,16 +738,18 @@ module Aws::AutoScaling
707
738
  #
708
739
  # [1]: http://crontab.org
709
740
  # @option options [Integer] :min_size
710
- # The minimum number of instances in the Auto Scaling group.
741
+ # The minimum size of the Auto Scaling group.
711
742
  # @option options [Integer] :max_size
712
- # The maximum number of instances in the Auto Scaling group.
743
+ # The maximum size of the Auto Scaling group.
713
744
  # @option options [Integer] :desired_capacity
714
- # The number of EC2 instances that should be running in the Auto Scaling
715
- # group.
745
+ # The desired capacity is the initial capacity of the Auto Scaling group
746
+ # after the scheduled action runs and the capacity it attempts to
747
+ # maintain. It can scale beyond this capacity if you add more scaling
748
+ # conditions.
716
749
  # @return [ScheduledAction]
717
750
  def put_scheduled_update_group_action(options = {})
718
751
  options = options.merge(auto_scaling_group_name: @name)
719
- resp = @client.put_scheduled_update_group_action(options)
752
+ @client.put_scheduled_update_group_action(options)
720
753
  ScheduledAction.new(
721
754
  name: options[:scheduled_action_name],
722
755
  client: @client
@@ -763,8 +796,9 @@ module Aws::AutoScaling
763
796
  # })
764
797
  # @param [Hash] options ({})
765
798
  # @option options [required, Integer] :desired_capacity
766
- # The number of EC2 instances that should be running in the Auto Scaling
767
- # group.
799
+ # The desired capacity is the initial capacity of the Auto Scaling group
800
+ # after this operation completes and the capacity it attempts to
801
+ # maintain.
768
802
  # @option options [Boolean] :honor_cooldown
769
803
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
770
804
  # period to complete before initiating a scaling activity to set your
@@ -892,10 +926,22 @@ module Aws::AutoScaling
892
926
  # The minimum size of the Auto Scaling group.
893
927
  # @option options [Integer] :max_size
894
928
  # The maximum size of the Auto Scaling group.
929
+ #
930
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
931
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
932
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
933
+ # above `MaxSize` by more than your maximum instance weight (weights
934
+ # that define how many capacity units each instance contributes to the
935
+ # capacity of the group).
936
+ #
937
+ # </note>
895
938
  # @option options [Integer] :desired_capacity
896
- # The number of EC2 instances that should be running in the Auto Scaling
897
- # group. This number must be greater than or equal to the minimum size
898
- # of the group and less than or equal to the maximum size of the group.
939
+ # The desired capacity is the initial capacity of the Auto Scaling group
940
+ # after this operation completes and the capacity it attempts to
941
+ # maintain.
942
+ #
943
+ # This number must be greater than or equal to the minimum size of the
944
+ # group and less than or equal to the maximum size of the group.
899
945
  # @option options [Integer] :default_cooldown
900
946
  # The amount of time, in seconds, after a scaling activity completes
901
947
  # before another scaling activity can start. The default value is `300`.
@@ -981,13 +1027,17 @@ module Aws::AutoScaling
981
1027
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html
982
1028
  # @option options [Integer] :max_instance_lifetime
983
1029
  # The maximum amount of time, in seconds, that an instance can be in
984
- # service.
1030
+ # service. The default is null.
1031
+ #
1032
+ # This parameter is optional, but if you specify a value for it, you
1033
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
1034
+ # previously set value, specify a new value of 0.
985
1035
  #
986
1036
  # For more information, see [Replacing Auto Scaling Instances Based on
987
1037
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
988
1038
  # Guide*.
989
1039
  #
990
- # Valid Range: Minimum value of 604800.
1040
+ # Valid Range: Minimum value of 0.
991
1041
  #
992
1042
  #
993
1043
  #
@@ -995,7 +1045,7 @@ module Aws::AutoScaling
995
1045
  # @return [AutoScalingGroup]
996
1046
  def update(options = {})
997
1047
  options = options.merge(auto_scaling_group_name: @name)
998
- resp = @client.update_auto_scaling_group(options)
1048
+ @client.update_auto_scaling_group(options)
999
1049
  AutoScalingGroup.new(
1000
1050
  name: options[:auto_scaling_group_name],
1001
1051
  client: @client
@@ -1290,8 +1340,8 @@ module Aws::AutoScaling
1290
1340
 
1291
1341
  def yield_waiter_and_warn(waiter, &block)
1292
1342
  if !@waiter_block_warned
1293
- msg = "pass options to configure the waiter; "
1294
- msg << "yielding the waiter is deprecated"
1343
+ msg = "pass options to configure the waiter; "\
1344
+ "yielding the waiter is deprecated"
1295
1345
  warn(msg)
1296
1346
  @waiter_block_warned = true
1297
1347
  end
@@ -1299,7 +1349,9 @@ module Aws::AutoScaling
1299
1349
  end
1300
1350
 
1301
1351
  def separate_params_and_options(options)
1302
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
1352
+ opts = Set.new(
1353
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
1354
+ )
1303
1355
  waiter_opts = {}
1304
1356
  waiter_params = {}
1305
1357
  options.each_pair do |key, value|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:autoscaling)
31
31
 
32
32
  module Aws::AutoScaling
33
+ # An API client for AutoScaling. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::AutoScaling::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::AutoScaling
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::AutoScaling
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::AutoScaling
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::AutoScaling
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::AutoScaling
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::AutoScaling
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::AutoScaling
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
  #
@@ -209,16 +264,15 @@ module Aws::AutoScaling
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::AutoScaling
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -314,9 +368,9 @@ module Aws::AutoScaling
314
368
  # Attaches one or more target groups to the specified Auto Scaling
315
369
  # group.
316
370
  #
317
- # To describe the target groups for an Auto Scaling group, use
318
- # DescribeLoadBalancerTargetGroups. To detach the target group from the
319
- # Auto Scaling group, use DetachLoadBalancerTargetGroups.
371
+ # To describe the target groups for an Auto Scaling group, call the
372
+ # DescribeLoadBalancerTargetGroups API. To detach the target group from
373
+ # the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
320
374
  #
321
375
  # With Application Load Balancers and Network Load Balancers, instances
322
376
  # are registered as targets with a target group. With Classic Load
@@ -365,15 +419,18 @@ module Aws::AutoScaling
365
419
  req.send_request(options)
366
420
  end
367
421
 
368
- # Attaches one or more Classic Load Balancers to the specified Auto
369
- # Scaling group.
422
+ # <note markdown="1"> To attach an Application Load Balancer or a Network Load Balancer, use
423
+ # the AttachLoadBalancerTargetGroups API operation instead.
370
424
  #
371
- # To attach an Application Load Balancer or a Network Load Balancer
372
- # instead, see AttachLoadBalancerTargetGroups.
425
+ # </note>
373
426
  #
374
- # To describe the load balancers for an Auto Scaling group, use
375
- # DescribeLoadBalancers. To detach the load balancer from the Auto
376
- # Scaling group, use DetachLoadBalancers.
427
+ # Attaches one or more Classic Load Balancers to the specified Auto
428
+ # Scaling group. Amazon EC2 Auto Scaling registers the running instances
429
+ # with these Classic Load Balancers.
430
+ #
431
+ # To describe the load balancers for an Auto Scaling group, call the
432
+ # DescribeLoadBalancers API. To detach the load balancer from the Auto
433
+ # Scaling group, call the DetachLoadBalancers API.
377
434
  #
378
435
  # For more information, see [Attaching a Load Balancer to Your Auto
379
436
  # Scaling Group][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -590,34 +647,49 @@ module Aws::AutoScaling
590
647
  # Creates an Auto Scaling group with the specified name and attributes.
591
648
  #
592
649
  # If you exceed your maximum limit of Auto Scaling groups, the call
593
- # fails. For information about viewing this limit, see
594
- # DescribeAccountLimits. For information about updating this limit, see
595
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
596
- # Scaling User Guide*.
650
+ # fails. To query this limit, call the DescribeAccountLimits API. For
651
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
652
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
653
+ #
654
+ # For introductory exercises for creating an Auto Scaling group, see
655
+ # [Getting Started with Amazon EC2 Auto Scaling][2] and [Tutorial: Set
656
+ # Up a Scaled and Load-Balanced Application][3] in the *Amazon EC2 Auto
657
+ # Scaling User Guide*. For more information, see [Auto Scaling
658
+ # Groups][4] in the *Amazon EC2 Auto Scaling User Guide*.
597
659
  #
598
660
  #
599
661
  #
600
662
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html
663
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html
664
+ # [3]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html
665
+ # [4]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html
601
666
  #
602
667
  # @option params [required, String] :auto_scaling_group_name
603
668
  # The name of the Auto Scaling group. This name must be unique per
604
669
  # Region per account.
605
670
  #
606
671
  # @option params [String] :launch_configuration_name
607
- # The name of the launch configuration.
672
+ # The name of the launch configuration to use when an instance is
673
+ # launched. To get the launch configuration name, use the
674
+ # DescribeLaunchConfigurations API operation. New launch configurations
675
+ # can be created with the CreateLaunchConfiguration API.
608
676
  #
609
- # If you do not specify `LaunchConfigurationName`, you must specify one
610
- # of the following parameters: `InstanceId`, `LaunchTemplate`, or
677
+ # You must specify one of the following parameters in your request:
678
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
611
679
  # `MixedInstancesPolicy`.
612
680
  #
613
681
  # @option params [Types::LaunchTemplateSpecification] :launch_template
614
- # The launch template to use to launch instances.
682
+ # Parameters used to specify the launch template and version to use when
683
+ # an instance is launched.
615
684
  #
616
685
  # For more information, see [LaunchTemplateSpecification][1] in the
617
686
  # *Amazon EC2 Auto Scaling API Reference*.
618
687
  #
619
- # If you do not specify `LaunchTemplate`, you must specify one of the
620
- # following parameters: `InstanceId`, `LaunchConfigurationName`, or
688
+ # You can alternatively associate a launch template to the Auto Scaling
689
+ # group by using the `MixedInstancesPolicy` parameter.
690
+ #
691
+ # You must specify one of the following parameters in your request:
692
+ # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
621
693
  # `MixedInstancesPolicy`.
622
694
  #
623
695
  #
@@ -652,23 +724,21 @@ module Aws::AutoScaling
652
724
  #
653
725
  # @option params [String] :instance_id
654
726
  # The ID of the instance used to create a launch configuration for the
655
- # group.
727
+ # group. To get the instance ID, use the Amazon EC2
728
+ # [DescribeInstances][1] API operation.
656
729
  #
657
730
  # When you specify an ID of an instance, Amazon EC2 Auto Scaling creates
658
731
  # a new launch configuration and associates it with the group. This
659
732
  # launch configuration derives its attributes from the specified
660
733
  # instance, except for the block device mapping.
661
734
  #
662
- # For more information, see [Create an Auto Scaling Group Using an EC2
663
- # Instance][1] in the *Amazon EC2 Auto Scaling User Guide*.
664
- #
665
735
  # You must specify one of the following parameters in your request:
666
736
  # `LaunchConfigurationName`, `LaunchTemplate`, `InstanceId`, or
667
737
  # `MixedInstancesPolicy`.
668
738
  #
669
739
  #
670
740
  #
671
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html
741
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html
672
742
  #
673
743
  # @option params [required, Integer] :min_size
674
744
  # The minimum size of the group.
@@ -676,12 +746,24 @@ module Aws::AutoScaling
676
746
  # @option params [required, Integer] :max_size
677
747
  # The maximum size of the group.
678
748
  #
749
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
750
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
751
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
752
+ # above `MaxSize` by more than your maximum instance weight (weights
753
+ # that define how many capacity units each instance contributes to the
754
+ # capacity of the group).
755
+ #
756
+ # </note>
757
+ #
679
758
  # @option params [Integer] :desired_capacity
680
- # The number of Amazon EC2 instances that the Auto Scaling group
681
- # attempts to maintain. This number must be greater than or equal to the
682
- # minimum size of the group and less than or equal to the maximum size
683
- # of the group. If you do not specify a desired capacity, the default is
684
- # the minimum size of the group.
759
+ # The desired capacity is the initial capacity of the Auto Scaling group
760
+ # at the time of its creation and the capacity it attempts to maintain.
761
+ # It can scale beyond this capacity if you configure automatic scaling.
762
+ #
763
+ # This number must be greater than or equal to the minimum size of the
764
+ # group and less than or equal to the maximum size of the group. If you
765
+ # do not specify a desired capacity, the default is the minimum size of
766
+ # the group.
685
767
  #
686
768
  # @option params [Integer] :default_cooldown
687
769
  # The amount of time, in seconds, after a scaling activity completes
@@ -807,7 +889,15 @@ module Aws::AutoScaling
807
889
  # One or more lifecycle hooks.
808
890
  #
809
891
  # @option params [Array<Types::Tag>] :tags
810
- # One or more tags.
892
+ # One or more tags. You can tag your Auto Scaling group and propagate
893
+ # the tags to the Amazon EC2 instances it launches.
894
+ #
895
+ # Tags are not propagated to Amazon EBS volumes. To add tags to Amazon
896
+ # EBS volumes, specify the tags in a launch template but use caution. If
897
+ # the launch template specifies an instance tag with a key that is also
898
+ # specified for the Auto Scaling group, Amazon EC2 Auto Scaling
899
+ # overrides the value of that instance tag with the value specified by
900
+ # the Auto Scaling group.
811
901
  #
812
902
  # For more information, see [Tagging Auto Scaling Groups and
813
903
  # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
@@ -830,13 +920,17 @@ module Aws::AutoScaling
830
920
  #
831
921
  # @option params [Integer] :max_instance_lifetime
832
922
  # The maximum amount of time, in seconds, that an instance can be in
833
- # service.
923
+ # service. The default is null.
924
+ #
925
+ # This parameter is optional, but if you specify a value for it, you
926
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
927
+ # previously set value, specify a new value of 0.
834
928
  #
835
929
  # For more information, see [Replacing Auto Scaling Instances Based on
836
930
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
837
931
  # Guide*.
838
932
  #
839
- # Valid Range: Minimum value of 604800.
933
+ # Valid Range: Minimum value of 0.
840
934
  #
841
935
  #
842
936
  #
@@ -976,10 +1070,9 @@ module Aws::AutoScaling
976
1070
  # Creates a launch configuration.
977
1071
  #
978
1072
  # If you exceed your maximum limit of launch configurations, the call
979
- # fails. For information about viewing this limit, see
980
- # DescribeAccountLimits. For information about updating this limit, see
981
- # [Amazon EC2 Auto Scaling Service Quotas][1] in the *Amazon EC2 Auto
982
- # Scaling User Guide*.
1073
+ # fails. To query this limit, call the DescribeAccountLimits API. For
1074
+ # information about updating this limit, see [Amazon EC2 Auto Scaling
1075
+ # Service Quotas][1] in the *Amazon EC2 Auto Scaling User Guide*.
983
1076
  #
984
1077
  # For more information, see [Launch Configurations][2] in the *Amazon
985
1078
  # EC2 Auto Scaling User Guide*.
@@ -1361,13 +1454,13 @@ module Aws::AutoScaling
1361
1454
  # associated action.
1362
1455
  #
1363
1456
  # To remove instances from the Auto Scaling group before deleting it,
1364
- # call DetachInstances with the list of instances and the option to
1365
- # decrement the desired capacity. This ensures that Amazon EC2 Auto
1457
+ # call the DetachInstances API with the list of instances and the option
1458
+ # to decrement the desired capacity. This ensures that Amazon EC2 Auto
1366
1459
  # Scaling does not launch replacement instances.
1367
1460
  #
1368
1461
  # To terminate all instances before deleting the Auto Scaling group,
1369
- # call UpdateAutoScalingGroup and set the minimum size and desired
1370
- # capacity of the Auto Scaling group to zero.
1462
+ # call the UpdateAutoScalingGroup API and set the minimum size and
1463
+ # desired capacity of the Auto Scaling group to zero.
1371
1464
  #
1372
1465
  # @option params [required, String] :auto_scaling_group_name
1373
1466
  # The name of the Auto Scaling group.
@@ -1705,7 +1798,18 @@ module Aws::AutoScaling
1705
1798
  req.send_request(options)
1706
1799
  end
1707
1800
 
1708
- # Describes the policy adjustment types for use with PutScalingPolicy.
1801
+ # Describes the available adjustment types for Amazon EC2 Auto Scaling
1802
+ # scaling policies. These settings apply to step scaling policies and
1803
+ # simple scaling policies; they do not apply to target tracking scaling
1804
+ # policies.
1805
+ #
1806
+ # The following adjustment types are supported:
1807
+ #
1808
+ # * ChangeInCapacity
1809
+ #
1810
+ # * ExactCapacity
1811
+ #
1812
+ # * PercentChangeInCapacity
1709
1813
  #
1710
1814
  # @return [Types::DescribeAdjustmentTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1711
1815
  #
@@ -1770,6 +1874,8 @@ module Aws::AutoScaling
1770
1874
  # * {Types::AutoScalingGroupsType#auto_scaling_groups #auto_scaling_groups} => Array&lt;Types::AutoScalingGroup&gt;
1771
1875
  # * {Types::AutoScalingGroupsType#next_token #next_token} => String
1772
1876
  #
1877
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1878
+ #
1773
1879
  #
1774
1880
  # @example Example: To describe an Auto Scaling group
1775
1881
  #
@@ -1901,6 +2007,13 @@ module Aws::AutoScaling
1901
2007
  # resp.auto_scaling_groups[0].max_instance_lifetime #=> Integer
1902
2008
  # resp.next_token #=> String
1903
2009
  #
2010
+ #
2011
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2012
+ #
2013
+ # * group_exists
2014
+ # * group_in_service
2015
+ # * group_not_exists
2016
+ #
1904
2017
  # @see http://docs.aws.amazon.com/goto/WebAPI/autoscaling-2011-01-01/DescribeAutoScalingGroups AWS API Documentation
1905
2018
  #
1906
2019
  # @overload describe_auto_scaling_groups(params = {})
@@ -1930,6 +2043,8 @@ module Aws::AutoScaling
1930
2043
  # * {Types::AutoScalingInstancesType#auto_scaling_instances #auto_scaling_instances} => Array&lt;Types::AutoScalingInstanceDetails&gt;
1931
2044
  # * {Types::AutoScalingInstancesType#next_token #next_token} => String
1932
2045
  #
2046
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2047
+ #
1933
2048
  #
1934
2049
  # @example Example: To describe one or more Auto Scaling instances
1935
2050
  #
@@ -2049,6 +2164,8 @@ module Aws::AutoScaling
2049
2164
  # * {Types::LaunchConfigurationsType#launch_configurations #launch_configurations} => Array&lt;Types::LaunchConfiguration&gt;
2050
2165
  # * {Types::LaunchConfigurationsType#next_token #next_token} => String
2051
2166
  #
2167
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2168
+ #
2052
2169
  #
2053
2170
  # @example Example: To describe Auto Scaling launch configurations
2054
2171
  #
@@ -2308,8 +2425,8 @@ module Aws::AutoScaling
2308
2425
  # Describes the load balancers for the specified Auto Scaling group.
2309
2426
  #
2310
2427
  # This operation describes only Classic Load Balancers. If you have
2311
- # Application Load Balancers or Network Load Balancers, use
2312
- # DescribeLoadBalancerTargetGroups instead.
2428
+ # Application Load Balancers or Network Load Balancers, use the
2429
+ # DescribeLoadBalancerTargetGroups API instead.
2313
2430
  #
2314
2431
  # @option params [required, String] :auto_scaling_group_name
2315
2432
  # The name of the Auto Scaling group.
@@ -2374,8 +2491,8 @@ module Aws::AutoScaling
2374
2491
  # Scaling.
2375
2492
  #
2376
2493
  # The `GroupStandbyInstances` metric is not returned by default. You
2377
- # must explicitly request this metric when calling
2378
- # EnableMetricsCollection.
2494
+ # must explicitly request this metric when calling the
2495
+ # EnableMetricsCollection API.
2379
2496
  #
2380
2497
  # @return [Types::DescribeMetricCollectionTypesAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2381
2498
  #
@@ -2460,6 +2577,8 @@ module Aws::AutoScaling
2460
2577
  # * {Types::DescribeNotificationConfigurationsAnswer#notification_configurations #notification_configurations} => Array&lt;Types::NotificationConfiguration&gt;
2461
2578
  # * {Types::DescribeNotificationConfigurationsAnswer#next_token #next_token} => String
2462
2579
  #
2580
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2581
+ #
2463
2582
  #
2464
2583
  # @example Example: To describe Auto Scaling notification configurations
2465
2584
  #
@@ -2540,6 +2659,8 @@ module Aws::AutoScaling
2540
2659
  # * {Types::PoliciesType#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
2541
2660
  # * {Types::PoliciesType#next_token #next_token} => String
2542
2661
  #
2662
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2663
+ #
2543
2664
  #
2544
2665
  # @example Example: To describe Auto Scaling policies
2545
2666
  #
@@ -2655,6 +2776,8 @@ module Aws::AutoScaling
2655
2776
  # * {Types::ActivitiesType#activities #activities} => Array&lt;Types::Activity&gt;
2656
2777
  # * {Types::ActivitiesType#next_token #next_token} => String
2657
2778
  #
2779
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2780
+ #
2658
2781
  #
2659
2782
  # @example Example: To describe the scaling activities for an Auto Scaling group
2660
2783
  #
@@ -2714,8 +2837,8 @@ module Aws::AutoScaling
2714
2837
  req.send_request(options)
2715
2838
  end
2716
2839
 
2717
- # Describes the scaling process types for use with ResumeProcesses and
2718
- # SuspendProcesses.
2840
+ # Describes the scaling process types for use with the ResumeProcesses
2841
+ # and SuspendProcesses APIs.
2719
2842
  #
2720
2843
  # @return [Types::ProcessesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2721
2844
  #
@@ -2775,7 +2898,7 @@ module Aws::AutoScaling
2775
2898
 
2776
2899
  # Describes the actions scheduled for your Auto Scaling group that
2777
2900
  # haven't run or that have not reached their end time. To describe the
2778
- # actions that have already run, use DescribeScalingActivities.
2901
+ # actions that have already run, call the DescribeScalingActivities API.
2779
2902
  #
2780
2903
  # @option params [String] :auto_scaling_group_name
2781
2904
  # The name of the Auto Scaling group.
@@ -2807,6 +2930,8 @@ module Aws::AutoScaling
2807
2930
  # * {Types::ScheduledActionsType#scheduled_update_group_actions #scheduled_update_group_actions} => Array&lt;Types::ScheduledUpdateGroupAction&gt;
2808
2931
  # * {Types::ScheduledActionsType#next_token #next_token} => String
2809
2932
  #
2933
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2934
+ #
2810
2935
  #
2811
2936
  # @example Example: To describe scheduled actions
2812
2937
  #
@@ -2879,6 +3004,13 @@ module Aws::AutoScaling
2879
3004
  # for a particular tag only if it matches all the filters. If there's
2880
3005
  # no match, no special message is returned.
2881
3006
  #
3007
+ # For more information, see [Tagging Auto Scaling Groups and
3008
+ # Instances][1] in the *Amazon EC2 Auto Scaling User Guide*.
3009
+ #
3010
+ #
3011
+ #
3012
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html
3013
+ #
2882
3014
  # @option params [Array<Types::Filter>] :filters
2883
3015
  # One or more filters to scope the tags to return. The maximum number of
2884
3016
  # filters per filter type (for example, `auto-scaling-group`) is 1000.
@@ -2896,6 +3028,8 @@ module Aws::AutoScaling
2896
3028
  # * {Types::TagsType#tags #tags} => Array&lt;Types::TagDescription&gt;
2897
3029
  # * {Types::TagsType#next_token #next_token} => String
2898
3030
  #
3031
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3032
+ #
2899
3033
  #
2900
3034
  # @example Example: To describe tags
2901
3035
  #
@@ -3151,13 +3285,13 @@ module Aws::AutoScaling
3151
3285
  # Scaling group.
3152
3286
  #
3153
3287
  # This operation detaches only Classic Load Balancers. If you have
3154
- # Application Load Balancers or Network Load Balancers, use
3155
- # DetachLoadBalancerTargetGroups instead.
3288
+ # Application Load Balancers or Network Load Balancers, use the
3289
+ # DetachLoadBalancerTargetGroups API instead.
3156
3290
  #
3157
3291
  # When you detach a load balancer, it enters the `Removing` state while
3158
3292
  # deregistering the instances in the group. When all instances are
3159
3293
  # deregistered, then you can no longer describe the load balancer using
3160
- # DescribeLoadBalancers. The instances remain running.
3294
+ # the DescribeLoadBalancers API call. The instances remain running.
3161
3295
  #
3162
3296
  # @option params [required, String] :auto_scaling_group_name
3163
3297
  # The name of the Auto Scaling group.
@@ -3202,8 +3336,7 @@ module Aws::AutoScaling
3202
3336
  # The name of the Auto Scaling group.
3203
3337
  #
3204
3338
  # @option params [Array<String>] :metrics
3205
- # One or more of the following metrics. If you omit this parameter, all
3206
- # metrics are disabled.
3339
+ # Specifies one or more of the following metrics:
3207
3340
  #
3208
3341
  # * `GroupMinSize`
3209
3342
  #
@@ -3221,6 +3354,18 @@ module Aws::AutoScaling
3221
3354
  #
3222
3355
  # * `GroupTotalInstances`
3223
3356
  #
3357
+ # * `GroupInServiceCapacity`
3358
+ #
3359
+ # * `GroupPendingCapacity`
3360
+ #
3361
+ # * `GroupStandbyCapacity`
3362
+ #
3363
+ # * `GroupTerminatingCapacity`
3364
+ #
3365
+ # * `GroupTotalCapacity`
3366
+ #
3367
+ # If you omit this parameter, all metrics are disabled.
3368
+ #
3224
3369
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3225
3370
  #
3226
3371
  #
@@ -3263,8 +3408,8 @@ module Aws::AutoScaling
3263
3408
  # The name of the Auto Scaling group.
3264
3409
  #
3265
3410
  # @option params [Array<String>] :metrics
3266
- # One or more of the following metrics. If you omit this parameter, all
3267
- # metrics are enabled.
3411
+ # Specifies which group-level metrics to start collecting. You can
3412
+ # specify one or more of the following metrics:
3268
3413
  #
3269
3414
  # * `GroupMinSize`
3270
3415
  #
@@ -3282,6 +3427,21 @@ module Aws::AutoScaling
3282
3427
  #
3283
3428
  # * `GroupTotalInstances`
3284
3429
  #
3430
+ # The instance weighting feature supports the following additional
3431
+ # metrics:
3432
+ #
3433
+ # * `GroupInServiceCapacity`
3434
+ #
3435
+ # * `GroupPendingCapacity`
3436
+ #
3437
+ # * `GroupStandbyCapacity`
3438
+ #
3439
+ # * `GroupTerminatingCapacity`
3440
+ #
3441
+ # * `GroupTotalCapacity`
3442
+ #
3443
+ # If you omit this parameter, all metrics are enabled.
3444
+ #
3285
3445
  # @option params [required, String] :granularity
3286
3446
  # The granularity to associate with the metrics to collect. The only
3287
3447
  # valid value is `1Minute`.
@@ -3583,11 +3743,11 @@ module Aws::AutoScaling
3583
3743
  # the instances launch or terminate.**
3584
3744
  #
3585
3745
  # 4. If you need more time, record the lifecycle action heartbeat to
3586
- # keep the instance in a pending state using
3587
- # RecordLifecycleActionHeartbeat.
3746
+ # keep the instance in a pending state using the
3747
+ # RecordLifecycleActionHeartbeat API call.
3588
3748
  #
3589
3749
  # 5. If you finish before the timeout period ends, complete the
3590
- # lifecycle action using CompleteLifecycleAction.
3750
+ # lifecycle action using the CompleteLifecycleAction API call.
3591
3751
  #
3592
3752
  # For more information, see [Amazon EC2 Auto Scaling Lifecycle Hooks][1]
3593
3753
  # in the *Amazon EC2 Auto Scaling User Guide*.
@@ -3595,9 +3755,10 @@ module Aws::AutoScaling
3595
3755
  # If you exceed your maximum limit of lifecycle hooks, which by default
3596
3756
  # is 50 per Auto Scaling group, the call fails.
3597
3757
  #
3598
- # You can view the lifecycle hooks for an Auto Scaling group using
3599
- # DescribeLifecycleHooks. If you are no longer using a lifecycle hook,
3600
- # you can delete it using DeleteLifecycleHook.
3758
+ # You can view the lifecycle hooks for an Auto Scaling group using the
3759
+ # DescribeLifecycleHooks API call. If you are no longer using a
3760
+ # lifecycle hook, you can delete it by calling the DeleteLifecycleHook
3761
+ # API.
3601
3762
  #
3602
3763
  #
3603
3764
  #
@@ -3655,8 +3816,8 @@ module Aws::AutoScaling
3655
3816
  #
3656
3817
  # If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
3657
3818
  # action that you specified in the `DefaultResult` parameter. You can
3658
- # prevent the lifecycle hook from timing out by calling
3659
- # RecordLifecycleActionHeartbeat.
3819
+ # prevent the lifecycle hook from timing out by calling the
3820
+ # RecordLifecycleActionHeartbeat API.
3660
3821
  #
3661
3822
  # @option params [String] :default_result
3662
3823
  # Defines the action the Auto Scaling group should take when the
@@ -3724,9 +3885,9 @@ module Aws::AutoScaling
3724
3885
  # Service (Amazon SNS) topic.
3725
3886
  #
3726
3887
  # @option params [required, Array<String>] :notification_types
3727
- # The type of event that causes the notification to be sent. For more
3728
- # information about notification types supported by Amazon EC2 Auto
3729
- # Scaling, see DescribeAutoScalingNotificationTypes.
3888
+ # The type of event that causes the notification to be sent. To query
3889
+ # the notification types supported by Amazon EC2 Auto Scaling, call the
3890
+ # DescribeAutoScalingNotificationTypes API.
3730
3891
  #
3731
3892
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3732
3893
  #
@@ -3763,12 +3924,14 @@ module Aws::AutoScaling
3763
3924
  # Creates or updates a scaling policy for an Auto Scaling group.
3764
3925
  #
3765
3926
  # For more information about using scaling policies to scale your Auto
3766
- # Scaling group automatically, see [Dynamic Scaling][1] in the *Amazon
3767
- # EC2 Auto Scaling User Guide*.
3927
+ # Scaling group, see [Target Tracking Scaling Policies][1] and [Step and
3928
+ # Simple Scaling Policies][2] in the *Amazon EC2 Auto Scaling User
3929
+ # Guide*.
3768
3930
  #
3769
3931
  #
3770
3932
  #
3771
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html
3933
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html
3934
+ # [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html
3772
3935
  #
3773
3936
  # @option params [required, String] :auto_scaling_group_name
3774
3937
  # The name of the Auto Scaling group.
@@ -3799,20 +3962,22 @@ module Aws::AutoScaling
3799
3962
  # instead.
3800
3963
  #
3801
3964
  # @option params [Integer] :min_adjustment_magnitude
3802
- # The minimum number of instances to scale. If the value of
3803
- # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
3804
- # changes the `DesiredCapacity` of the Auto Scaling group by at least
3805
- # this many instances. Otherwise, the error is `ValidationError`.
3965
+ # The minimum value to scale by when scaling by percentages. For
3966
+ # example, suppose that you create a step scaling policy to scale out an
3967
+ # Auto Scaling group by 25 percent and you specify a
3968
+ # `MinAdjustmentMagnitude` of 2. If the group has 4 instances and the
3969
+ # scaling policy is performed, 25 percent of 4 is 1. However, because
3970
+ # you specified a `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling
3971
+ # scales out the group by 2 instances.
3972
+ #
3973
+ # Valid only if the policy type is `StepScaling` or `SimpleScaling` and
3974
+ # the adjustment type is `PercentChangeInCapacity`. For more
3975
+ # information, see [Scaling Adjustment Types][1] in the *Amazon EC2 Auto
3976
+ # Scaling User Guide*.
3806
3977
  #
3807
- # This property replaces the `MinAdjustmentStep` property. For example,
3808
- # suppose that you create a step scaling policy to scale out an Auto
3809
- # Scaling group by 25 percent and you specify a `MinAdjustmentMagnitude`
3810
- # of 2. If the group has 4 instances and the scaling policy is
3811
- # performed, 25 percent of 4 is 1. However, because you specified a
3812
- # `MinAdjustmentMagnitude` of 2, Amazon EC2 Auto Scaling scales out the
3813
- # group by 2 instances.
3814
3978
  #
3815
- # Valid only if the policy type is `SimpleScaling` or `StepScaling`.
3979
+ #
3980
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment
3816
3981
  #
3817
3982
  # @option params [Integer] :scaling_adjustment
3818
3983
  # The amount by which a simple scaling policy scales the Auto Scaling
@@ -4018,14 +4183,16 @@ module Aws::AutoScaling
4018
4183
  # [1]: http://crontab.org
4019
4184
  #
4020
4185
  # @option params [Integer] :min_size
4021
- # The minimum number of instances in the Auto Scaling group.
4186
+ # The minimum size of the Auto Scaling group.
4022
4187
  #
4023
4188
  # @option params [Integer] :max_size
4024
- # The maximum number of instances in the Auto Scaling group.
4189
+ # The maximum size of the Auto Scaling group.
4025
4190
  #
4026
4191
  # @option params [Integer] :desired_capacity
4027
- # The number of EC2 instances that should be running in the Auto Scaling
4028
- # group.
4192
+ # The desired capacity is the initial capacity of the Auto Scaling group
4193
+ # after the scheduled action runs and the capacity it attempts to
4194
+ # maintain. It can scale beyond this capacity if you add more scaling
4195
+ # conditions.
4029
4196
  #
4030
4197
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4031
4198
  #
@@ -4069,7 +4236,7 @@ module Aws::AutoScaling
4069
4236
 
4070
4237
  # Records a heartbeat for the lifecycle action associated with the
4071
4238
  # specified token or instance. This extends the timeout by the length of
4072
- # time defined using PutLifecycleHook.
4239
+ # time defined using the PutLifecycleHook API call.
4073
4240
  #
4074
4241
  # This step is a part of the procedure for adding a lifecycle hook to an
4075
4242
  # Auto Scaling group:
@@ -4210,19 +4377,25 @@ module Aws::AutoScaling
4210
4377
 
4211
4378
  # Sets the size of the specified Auto Scaling group.
4212
4379
  #
4213
- # For more information about desired capacity, see [What Is Amazon EC2
4214
- # Auto Scaling?][1] in the *Amazon EC2 Auto Scaling User Guide*.
4380
+ # If a scale-in activity occurs as a result of a new `DesiredCapacity`
4381
+ # value that is lower than the current size of the group, the Auto
4382
+ # Scaling group uses its termination policy to determine which instances
4383
+ # to terminate.
4384
+ #
4385
+ # For more information, see [Manual Scaling][1] in the *Amazon EC2 Auto
4386
+ # Scaling User Guide*.
4215
4387
  #
4216
4388
  #
4217
4389
  #
4218
- # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html
4390
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-manual-scaling.html
4219
4391
  #
4220
4392
  # @option params [required, String] :auto_scaling_group_name
4221
4393
  # The name of the Auto Scaling group.
4222
4394
  #
4223
4395
  # @option params [required, Integer] :desired_capacity
4224
- # The number of EC2 instances that should be running in the Auto Scaling
4225
- # group.
4396
+ # The desired capacity is the initial capacity of the Auto Scaling group
4397
+ # after this operation completes and the capacity it attempts to
4398
+ # maintain.
4226
4399
  #
4227
4400
  # @option params [Boolean] :honor_cooldown
4228
4401
  # Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
@@ -4286,7 +4459,12 @@ module Aws::AutoScaling
4286
4459
  # not respect the grace period associated with the group.
4287
4460
  #
4288
4461
  # For more information about the health check grace period, see
4289
- # CreateAutoScalingGroup.
4462
+ # [CreateAutoScalingGroup][1] in the *Amazon EC2 Auto Scaling API
4463
+ # Reference*.
4464
+ #
4465
+ #
4466
+ #
4467
+ # [1]: https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_CreateAutoScalingGroup.html
4290
4468
  #
4291
4469
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4292
4470
  #
@@ -4385,12 +4563,12 @@ module Aws::AutoScaling
4385
4563
  # for the specified Auto Scaling group.
4386
4564
  #
4387
4565
  # If you suspend either the `Launch` or `Terminate` process types, it
4388
- # can prevent other process types from functioning properly.
4389
- #
4390
- # To resume processes that have been suspended, use ResumeProcesses.
4566
+ # can prevent other process types from functioning properly. For more
4567
+ # information, see [Suspending and Resuming Scaling Processes][1] in the
4568
+ # *Amazon EC2 Auto Scaling User Guide*.
4391
4569
  #
4392
- # For more information, see [Suspending and Resuming Scaling
4393
- # Processes][1] in the *Amazon EC2 Auto Scaling User Guide*.
4570
+ # To resume processes that have been suspended, call the ResumeProcesses
4571
+ # API.
4394
4572
  #
4395
4573
  #
4396
4574
  #
@@ -4450,10 +4628,12 @@ module Aws::AutoScaling
4450
4628
  end
4451
4629
 
4452
4630
  # Terminates the specified instance and optionally adjusts the desired
4453
- # group size. This call simply makes a termination request. The instance
4454
- # is not terminated immediately. When an instance is terminated, the
4455
- # instance status changes to `terminated`. You can't connect to or
4456
- # start an instance after you've terminated it.
4631
+ # group size.
4632
+ #
4633
+ # This call simply makes a termination request. The instance is not
4634
+ # terminated immediately. When an instance is terminated, the instance
4635
+ # status changes to `terminated`. You can't connect to or start an
4636
+ # instance after you've terminated it.
4457
4637
  #
4458
4638
  # If you do not specify the option to decrement the desired capacity,
4459
4639
  # Amazon EC2 Auto Scaling launches instances to replace the ones that
@@ -4546,7 +4726,7 @@ module Aws::AutoScaling
4546
4726
  # Note the following about changing `DesiredCapacity`, `MaxSize`, or
4547
4727
  # `MinSize`\:
4548
4728
  #
4549
- # * If a scale-in event occurs as a result of a new `DesiredCapacity`
4729
+ # * If a scale-in activity occurs as a result of a new `DesiredCapacity`
4550
4730
  # value that is lower than the current size of the group, the Auto
4551
4731
  # Scaling group uses its termination policy to determine which
4552
4732
  # instances to terminate.
@@ -4561,10 +4741,11 @@ module Aws::AutoScaling
4561
4741
  # current size of the group, this sets the group's `DesiredCapacity`
4562
4742
  # to the new `MaxSize` value.
4563
4743
  #
4564
- # To see which parameters have been set, use DescribeAutoScalingGroups.
4565
- # You can also view the scaling policies for an Auto Scaling group using
4566
- # DescribePolicies. If the group has scaling policies, you can update
4567
- # them using PutScalingPolicy.
4744
+ # To see which parameters have been set, call the
4745
+ # DescribeAutoScalingGroups API. To view the scaling policies for an
4746
+ # Auto Scaling group, call the DescribePolicies API. If the group has
4747
+ # scaling policies, you can update them by calling the PutScalingPolicy
4748
+ # API.
4568
4749
  #
4569
4750
  # @option params [required, String] :auto_scaling_group_name
4570
4751
  # The name of the Auto Scaling group.
@@ -4609,10 +4790,22 @@ module Aws::AutoScaling
4609
4790
  # @option params [Integer] :max_size
4610
4791
  # The maximum size of the Auto Scaling group.
4611
4792
  #
4793
+ # <note markdown="1"> With a mixed instances policy that uses instance weighting, Amazon EC2
4794
+ # Auto Scaling may need to go above `MaxSize` to meet your capacity
4795
+ # requirements. In this event, Amazon EC2 Auto Scaling will never go
4796
+ # above `MaxSize` by more than your maximum instance weight (weights
4797
+ # that define how many capacity units each instance contributes to the
4798
+ # capacity of the group).
4799
+ #
4800
+ # </note>
4801
+ #
4612
4802
  # @option params [Integer] :desired_capacity
4613
- # The number of EC2 instances that should be running in the Auto Scaling
4614
- # group. This number must be greater than or equal to the minimum size
4615
- # of the group and less than or equal to the maximum size of the group.
4803
+ # The desired capacity is the initial capacity of the Auto Scaling group
4804
+ # after this operation completes and the capacity it attempts to
4805
+ # maintain.
4806
+ #
4807
+ # This number must be greater than or equal to the minimum size of the
4808
+ # group and less than or equal to the maximum size of the group.
4616
4809
  #
4617
4810
  # @option params [Integer] :default_cooldown
4618
4811
  # The amount of time, in seconds, after a scaling activity completes
@@ -4708,13 +4901,17 @@ module Aws::AutoScaling
4708
4901
  #
4709
4902
  # @option params [Integer] :max_instance_lifetime
4710
4903
  # The maximum amount of time, in seconds, that an instance can be in
4711
- # service.
4904
+ # service. The default is null.
4905
+ #
4906
+ # This parameter is optional, but if you specify a value for it, you
4907
+ # must specify a value of at least 604,800 seconds (7 days). To clear a
4908
+ # previously set value, specify a new value of 0.
4712
4909
  #
4713
4910
  # For more information, see [Replacing Auto Scaling Instances Based on
4714
4911
  # Maximum Instance Lifetime][1] in the *Amazon EC2 Auto Scaling User
4715
4912
  # Guide*.
4716
4913
  #
4717
- # Valid Range: Minimum value of 604800.
4914
+ # Valid Range: Minimum value of 0.
4718
4915
  #
4719
4916
  #
4720
4917
  #
@@ -4821,7 +5018,7 @@ module Aws::AutoScaling
4821
5018
  params: params,
4822
5019
  config: config)
4823
5020
  context[:gem_name] = 'aws-sdk-autoscaling'
4824
- context[:gem_version] = '1.32.0'
5021
+ context[:gem_version] = '1.37.0'
4825
5022
  Seahorse::Client::Request.new(handlers, context)
4826
5023
  end
4827
5024
 
@@ -4887,11 +5084,11 @@ module Aws::AutoScaling
4887
5084
  # The following table lists the valid waiter names, the operations they call,
4888
5085
  # and the default `:delay` and `:max_attempts` values.
4889
5086
  #
4890
- # | waiter_name | params | :delay | :max_attempts |
4891
- # | ---------------- | ------------------------------- | -------- | ------------- |
4892
- # | group_exists | {#describe_auto_scaling_groups} | 5 | 10 |
4893
- # | group_in_service | {#describe_auto_scaling_groups} | 15 | 40 |
4894
- # | group_not_exists | {#describe_auto_scaling_groups} | 15 | 40 |
5087
+ # | waiter_name | params | :delay | :max_attempts |
5088
+ # | ---------------- | ------------------------------------- | -------- | ------------- |
5089
+ # | group_exists | {Client#describe_auto_scaling_groups} | 5 | 10 |
5090
+ # | group_in_service | {Client#describe_auto_scaling_groups} | 15 | 40 |
5091
+ # | group_not_exists | {Client#describe_auto_scaling_groups} | 15 | 40 |
4895
5092
  #
4896
5093
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
4897
5094
  # because the waiter has entered a state that it will not transition