lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.0.0.rc4 vs lib/aws-sdk-autoscaling/client.rb in aws-sdk-autoscaling-1.0.0.rc5

- old
+ new

@@ -151,11 +151,11 @@ # When you attach instances, Auto Scaling increases the desired capacity # of the group by the number of instances being attached. If the number # of instances being attached plus the desired capacity of the group # exceeds the maximum size of the group, the operation fails. # - # If there is a Classic load balancer attached to your Auto Scaling + # If there is a Classic Load Balancer attached to your Auto Scaling # group, the instances are also registered with the load balancer. If # there are target groups attached to your Auto Scaling group, the # instances are also registered with the target groups. # # For more information, see [Attach EC2 Instances to Your Auto Scaling @@ -225,14 +225,14 @@ def attach_load_balancer_target_groups(params = {}, options = {}) req = build_request(:attach_load_balancer_target_groups, params) req.send_request(options) end - # Attaches one or more Classic load balancers to the specified Auto + # Attaches one or more Classic Load Balancers to the specified Auto # Scaling group. # - # To attach an Application load balancer instead, see + # To attach an Application Load Balancer instead, see # AttachLoadBalancerTargetGroups. # # To describe the load balancers for an Auto Scaling group, use # DescribeLoadBalancers. To detach the load balancer from the Auto # Scaling group, use DetachLoadBalancers. @@ -384,11 +384,13 @@ # The maximum size of the group. # # @option params [Integer] :desired_capacity # The number of EC2 instances that should be running in the group. This # number must be greater than or equal to the minimum size of the group - # and less than or equal to the maximum size of the group. + # and less than or equal to the maximum size of the group. If you do not + # specify a desired capacity, the default is the minimum size of the + # group. # # @option params [Integer] :default_cooldown # The amount of time, in seconds, after a scaling activity completes # before another scaling activity can start. The default is 300. # @@ -402,12 +404,12 @@ # @option params [Array<String>] :availability_zones # One or more Availability Zones for the group. This parameter is # optional if you specify one or more subnets. # # @option params [Array<String>] :load_balancer_names - # One or more Classic load balancers. To specify an Application load - # balancer, use `TargetGroupARNs` instead. + # One or more Classic Load Balancers. To specify an Application Load + # Balancer, use `TargetGroupARNs` instead. # # For more information, see [Using a Load Balancer With an Auto Scaling # Group][1] in the *Auto Scaling User Guide*. # # @@ -552,15 +554,19 @@ # The name of the launch configuration. This name must be unique within # the scope of your AWS account. # # @option params [String] :image_id # The ID of the Amazon Machine Image (AMI) to use to launch your EC2 - # instances. For more information, see [Finding an AMI][1] in the - # *Amazon Elastic Compute Cloud User Guide*. + # instances. # + # If you do not specify `InstanceId`, you must specify `ImageId`. # + # For more information, see [Finding an AMI][1] in the *Amazon Elastic + # Compute Cloud User Guide*. # + # + # # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html # # @option params [String] :key_name # The name of the key pair. For more information, see [Amazon EC2 Key # Pairs][1] in the *Amazon Elastic Compute Cloud User Guide*. @@ -615,14 +621,16 @@ # # # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html # # @option params [String] :instance_id - # The ID of the instance to use to create the launch configuration. + # The ID of the instance to use to create the launch configuration. The + # new launch configuration derives attributes from the instance, with + # the exception of the block device mapping. # - # The new launch configuration derives attributes from the instance, - # with the exception of the block device mapping. + # If you do not specify `InstanceId`, you must specify both `ImageId` + # and `InstanceType`. # # To create a launch configuration with a block device mapping or # override any other instance attributes, specify them as part of the # same request. # @@ -632,16 +640,19 @@ # # # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html # # @option params [String] :instance_type - # The instance type of the EC2 instance. For information about available - # instance types, see [ Available Instance Types][1] in the *Amazon - # Elastic Compute Cloud User Guide.* + # The instance type of the EC2 instance. # + # If you do not specify `InstanceId`, you must specify `InstanceType`. # + # For information about available instance types, see [Available + # Instance Types][1] in the *Amazon Elastic Compute Cloud User Guide.* # + # + # # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes # # @option params [String] :kernel_id # The ID of the kernel associated with the AMI. # @@ -657,11 +668,11 @@ # # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html # # @option params [Types::InstanceMonitoring] :instance_monitoring # Enables detailed monitoring (`true`) or basic monitoring (`false`) for - # the Auto Scaling instances. + # the Auto Scaling instances. The default is `true`. # # @option params [String] :spot_price # The maximum hourly price to be paid for any Spot Instance launched to # fulfill the request. Spot Instances are launched when the price you # specify exceeds the current Spot market price. For more information, @@ -1105,11 +1116,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::AutoScalingGroupsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AutoScalingGroupsType#auto_scaling_groups #auto_scaling_groups} => Array&lt;Types::AutoScalingGroup&gt; # * {Types::AutoScalingGroupsType#next_token #next_token} => String @@ -1183,11 +1195,12 @@ # The instances to describe; up to 50 instance IDs. If you omit this # parameter, all Auto Scaling instances are described. If you specify an # ID that does not exist, it is ignored with no error. # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -1254,12 +1267,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. The default is - # 100. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::LaunchConfigurationsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::LaunchConfigurationsType#launch_configurations #launch_configurations} => Array&lt;Types::LaunchConfiguration&gt; # * {Types::LaunchConfigurationsType#next_token #next_token} => String @@ -1386,11 +1399,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::DescribeLoadBalancerTargetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLoadBalancerTargetGroupsResponse#load_balancer_target_groups #load_balancer_target_groups} => Array&lt;Types::LoadBalancerTargetGroupState&gt; # * {Types::DescribeLoadBalancerTargetGroupsResponse#next_token #next_token} => String @@ -1419,23 +1433,24 @@ req.send_request(options) end # Describes the load balancers for the specified Auto Scaling group. # - # Note that this operation describes only Classic load balancers. If you - # have Application load balancers, use DescribeLoadBalancerTargetGroups + # Note that this operation describes only Classic Load Balancers. If you + # have Application Load Balancers, use DescribeLoadBalancerTargetGroups # instead. # # @option params [required, String] :auto_scaling_group_name # The name of the group. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::DescribeLoadBalancersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLoadBalancersResponse#load_balancers #load_balancers} => Array&lt;Types::LoadBalancerState&gt; # * {Types::DescribeLoadBalancersResponse#next_token #next_token} => String @@ -1500,11 +1515,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::DescribeNotificationConfigurationsAnswer] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeNotificationConfigurationsAnswer#notification_configurations #notification_configurations} => Array&lt;Types::NotificationConfiguration&gt; # * {Types::DescribeNotificationConfigurationsAnswer#next_token #next_token} => String @@ -1553,11 +1569,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to be returned with each call. + # The maximum number of items to be returned with each call. The default + # value is 50 and the maximum value is 100. # # @return [Types::PoliciesType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PoliciesType#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt; # * {Types::PoliciesType#next_token #next_token} => String @@ -1616,11 +1633,12 @@ # # @option params [String] :auto_scaling_group_name # The name of the group. # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 100. # # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # @@ -1710,11 +1728,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::ScheduledActionsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ScheduledActionsType#scheduled_update_group_actions #scheduled_update_group_actions} => Array&lt;Types::ScheduledUpdateGroupAction&gt; # * {Types::ScheduledActionsType#next_token #next_token} => String @@ -1771,11 +1790,12 @@ # @option params [String] :next_token # The token for the next set of items to return. (You received this # token from a previous call.) # # @option params [Integer] :max_records - # The maximum number of items to return with this call. + # The maximum number of items to return with this call. The default + # value is 50 and the maximum value is 100. # # @return [Types::TagsType] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::TagsType#tags #tags} => Array&lt;Types::TagDescription&gt; # * {Types::TagsType#next_token #next_token} => String @@ -1832,17 +1852,17 @@ req.send_request(options) end # Removes one or more instances from the specified Auto Scaling group. # - # After the instances are detached, you can manage them independently - # from the rest of the Auto Scaling group. + # After the instances are detached, you can manage them independent of + # the Auto Scaling group. # # If you do not specify the option to decrement the desired capacity, # Auto Scaling launches instances to replace the ones that are detached. # - # If there is a Classic load balancer attached to the Auto Scaling + # If there is a Classic Load Balancer attached to the Auto Scaling # group, the instances are deregistered from the load balancer. If there # are target groups attached to the Auto Scaling group, the instances # are deregistered from the target groups. # # For more information, see [Detach EC2 Instances from Your Auto Scaling @@ -1922,15 +1942,15 @@ def detach_load_balancer_target_groups(params = {}, options = {}) req = build_request(:detach_load_balancer_target_groups, params) req.send_request(options) end - # Detaches one or more Classic load balancers from the specified Auto + # Detaches one or more Classic Load Balancers from the specified Auto # Scaling group. # - # Note that this operation detaches only Classic load balancers. If you - # have Application load balancers, use DetachLoadBalancerTargetGroups + # Note that this operation detaches only Classic Load Balancers. If you + # have Application Load Balancers, use DetachLoadBalancerTargetGroups # instead. # # When you detach a load balancer, it enters the `Removing` state while # deregistering the instances in the group. When all instances are # deregistered, then you can no longer describe the load balancer using @@ -2055,18 +2075,18 @@ def enable_metrics_collection(params = {}, options = {}) req = build_request(:enable_metrics_collection, params) req.send_request(options) end - # Moves the specified instances into `Standby` mode. + # Moves the specified instances into the standby state. # - # For more information, see [Auto Scaling Lifecycle][1] in the *Auto - # Scaling User Guide*. + # For more information, see [Temporarily Removing Instances from Your + # Auto Scaling Group][1] in the *Auto Scaling User Guide*. # # # - # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html + # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html # # @option params [Array<String>] :instance_ids # One or more instances to move into `Standby` mode. You must specify at # least one instance ID. # @@ -2175,18 +2195,18 @@ def execute_policy(params = {}, options = {}) req = build_request(:execute_policy, params) req.send_request(options) end - # Moves the specified instances out of `Standby` mode. + # Moves the specified instances out of the standby state. # - # For more information, see [Auto Scaling Lifecycle][1] in the *Auto - # Scaling User Guide*. + # For more information, see [Temporarily Removing Instances from Your + # Auto Scaling Group][1] in the *Auto Scaling User Guide*. # # # - # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html + # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html # # @option params [Array<String>] :instance_ids # One or more instance IDs. You must specify at least one instance ID. # # @option params [required, String] :auto_scaling_group_name @@ -2938,21 +2958,20 @@ req.send_request(options) end # Updates the configuration for the specified Auto Scaling group. # + # The new settings take effect on any scaling activities after this call + # returns. Scaling activities that are currently in progress aren't + # affected. + # # To update an Auto Scaling group with a launch configuration with - # `InstanceMonitoring` set to `False`, you must first disable the + # `InstanceMonitoring` set to `false`, you must first disable the # collection of group metrics. Otherwise, you will get an error. If you # have previously enabled the collection of group metrics, you can # disable it using DisableMetricsCollection. # - # The new settings are registered upon the completion of this call. Any - # launch configuration settings take effect on any triggers after this - # call returns. Scaling activities that are currently in progress - # aren't affected. - # # Note the following: # # * If you specify a new value for `MinSize` without specifying a value # for `DesiredCapacity`, and the new `MinSize` is larger than the # current size of the group, we implicitly call SetDesiredCapacity to @@ -3092,10 +3111,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-autoscaling' - context[:gem_version] = '1.0.0.rc4' + context[:gem_version] = '1.0.0.rc5' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #