View
246
Download
0
Category
Preview:
Citation preview
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 1/83
Auto Scaling
API Reference
API Version 2011-01-01
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 2/83
Auto Scaling: API ReferenceCopyright © 2011 - 2012 Amazon Web Services LLC or its affiliates. All rights reserved.
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 3/83
Welcome ................................................................................................................................................. 1Actions .................................................................................................................................................... 2CreateAutoScalingGroup ........................................................................................................................ 4CreateLaunchConfiguration .................................................................................................................... 7CreateOrUpdateTags ............................................................................................................................ 10DeleteAutoScalingGroup ...................................................................................................................... 11
DeleteLaunchConfiguration .................................................................................................................. 12DeleteNotificationConfiguration ............................................................................................................ 13DeletePolicy .......................................................................................................................................... 14DeleteScheduledAction ........................................................................................................................ 15DeleteTags ............................................................................................................................................ 16DescribeAdjustmentTypes .................................................................................................................... 17DescribeAutoScalingGroups ................................................................................................................. 18DescribeAutoScalingInstances ............................................................................................................. 20DescribeAutoScalingNotificationTypes ................................................................................................. 22DescribeLaunchConfigurations ............................................................................................................. 23DescribeMetricCollectionTypes ............................................................................................................ 24DescribeNotificationConfigurations ....................................................................................................... 25DescribePolicies ................................................................................................................................... 26DescribeScalingActivities ..................................................................................................................... 28
DescribeScalingProcessTypes ............................................................................................................. 30DescribeScheduledActions ................................................................................................................... 31DescribeTags ........................................................................................................................................ 33DescribeTerminationPolicyTypes .......................................................................................................... 35DisableMetricsCollection ...................................................................................................................... 36EnableMetricsCollection ....................................................................................................................... 37ExecutePolicy ....................................................................................................................................... 38PutNotificationConfiguration ................................................................................................................. 39PutScalingPolicy ................................................................................................................................... 40PutScheduledUpdateGroupAction ........................................................................................................ 42ResumeProcesses ................................................................................................................................ 44SetDesiredCapacity .............................................................................................................................. 45SetInstanceHealth ................................................................................................................................ 47SuspendProcesses ............................................................................................................................... 48
TerminateInstanceInAutoScalingGroup ................................................................................................ 49UpdateAutoScalingGroup ..................................................................................................................... 50Data Types ............................................................................................................................................ 53Activity .................................................................................................................................................. 54AdjustmentType .................................................................................................................................... 55Alarm .................................................................................................................................................... 55AutoScalingGroup ................................................................................................................................. 56AutoScalingInstanceDetails .................................................................................................................. 58BlockDeviceMapping ............................................................................................................................ 59DescribeAdjustmentTypesResult .......................................................................................................... 59DescribeAutoScalingGroupsResult ...................................................................................................... 59DescribeAutoScalingInstancesResult ...................................................................................................60DescribeAutoScalingNotificationTypesResult ....................................................................................... 60DescribeLaunchConfigurationsResult .................................................................................................. 61
DescribeMetricCollectionTypesResult .................................................................................................. 61DescribeNotificationConfigurationsResult ............................................................................................ 61DescribePoliciesResult ......................................................................................................................... 62DescribeScalingActivitiesResult ........................................................................................................... 62DescribeScalingProcessTypesResult ................................................................................................... 63DescribeScheduledActionsResult ........................................................................................................ 63DescribeTagsResult .............................................................................................................................. 63DescribeTerminationPolicyTypesResult ................................................................................................64Ebs ....................................................................................................................................................... 64EnabledMetric ....................................................................................................................................... 64
API Version 2011-01-01
3
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 4/83
Filter ...................................................................................................................................................... 65Instance ................................................................................................................................................ 65InstanceMonitoring ............................................................................................................................... 66LaunchConfiguration ............................................................................................................................. 66MetricCollectionType ............................................................................................................................ 68MetricGranularityType ........................................................................................................................... 68
NotificationConfiguration ....................................................................................................................... 68ProcessType ......................................................................................................................................... 69PutScalingPolicyResult ......................................................................................................................... 70ScalingPolicy ........................................................................................................................................ 71ScheduledUpdateGroupAction ............................................................................................................. 72SuspendedProcess ............................................................................................................................... 73Tag ........................................................................................................................................................ 73TagDescription ...................................................................................................................................... 74TerminateInstanceInAutoScalingGroupResult ...................................................................................... 75Common Query Parameters ................................................................................................................. 76Common Errors .................................................................................................................................... 78
API Version 2011-01-01
4
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 5/83
Welcome
This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors.
For detailed information about Auto Scaling features and their associated API calls, go to the Auto ScalingDeveloper Guide.
Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic ComputeCloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. Thisservice is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services.
This reference is based on the current WSDL, which is available at:
http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl
Endpoints
For information about this product's regions and endpoints, go to Regions and Endpoints in the AmazonWeb Services General Reference.
This document was last updated on November 16, 2012.
API Version 2011-01-01
1
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 6/83
Actions
The actions described in this guide are called by using the AWS Query protocol.
The following actions are supported:
• CreateAutoScalingGroup (p. 4)
• CreateLaunchConfiguration (p. 7)
• CreateOrUpdateTags (p. 10)
• DeleteAutoScalingGroup (p. 11)
• DeleteLaunchConfiguration (p. 12)
• DeleteNotificationConfiguration (p. 13)
• DeletePolicy (p. 14)
• DeleteScheduledAction (p. 15)
• DeleteTags (p. 16)
• DescribeAdjustmentTypes (p. 17)• DescribeAutoScalingGroups (p. 18)
• DescribeAutoScalingInstances (p. 20)
• DescribeAutoScalingNotificationTypes (p. 22)
• DescribeLaunchConfigurations (p. 23)
• DescribeMetricCollectionTypes (p. 24)
• DescribeNotificationConfigurations (p. 25)
• DescribePolicies (p. 26)
• DescribeScalingActivities (p. 28)
• DescribeScalingProcessTypes (p. 30)
• DescribeScheduledActions (p. 31)
• DescribeTags (p. 33)• DescribeTerminationPolicyTypes (p. 35)
• DisableMetricsCollection (p. 36)
• EnableMetricsCollection (p. 37)
• ExecutePolicy (p.38)
• PutNotificationConfiguration (p. 39)
• PutScalingPolicy (p. 40)
• PutScheduledUpdateGroupAction (p. 42)
API Version 2011-01-01
2
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 7/83
• ResumeProcesses (p. 44)
• SetDesiredCapacity (p. 45)
• SetInstanceHealth (p. 47)
• SuspendProcesses (p. 48)
• TerminateInstanceInAutoScalingGroup (p. 49)
• UpdateAutoScalingGroup (p. 50)
API Version 2011-01-01
3
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 8/83
CreateAutoScalingGroup
Description
Creates a new Auto Scaling group with the specified name and other attributes.When the creation requestis completed, the Auto Scaling group is ready to be used in other calls.
NoteThe Auto Scaling group name must be unique within the scope of your AWS account, and underthe quota of Auto Scaling groups allowed for your account.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required:Yes
AvailabilityZones.member.NA list of Availability Zones for the Auto Scaling group. This is required unless you have specifiedsubnets.
Type: String list
Length constraints: Minimum of 1 item(s) in the list.
Required: No
DefaultCooldownThe amount of time, in seconds, after a scaling activity completes before any further trigger-relatedscaling activities can start.
Type: Integer
Required: No
DesiredCapacityThe number of Amazon EC2 instances that should be running in the group.
Type: Integer
Required: No
HealthCheckGracePeriodLength of time in seconds after a new Amazon EC2 instance comes into service that Auto Scalingstarts checking its health.
Type: Integer
Required: No
HealthCheckTypeThe service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid valuesare EC2 or ELB.
Type: String
API Version 2011-01-01
4
Auto Scaling API Reference
CreateAutoScalingGroup
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 9/83
Length constraints: Minimum length of 1. Maximum length of 32.
Required: No
LaunchConfigurationNameThe name of the launch configuration to use with the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
LoadBalancerNames.member.NA list of load balancers to use.
Type: String list
Required: No
MaxSizeThe maximum size of the Auto Scaling group.
Type: Integer
Required:Yes
MinSizeThe minimum size of the Auto Scaling group.
Type: Integer
Required:Yes
PlacementGroupPhysical location of your cluster placement group created in Amazon EC2. For more informationabout cluster placement group, see Using Cluster Instances
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
Tags.member.NThe tag to be created or updated. Each tag should be defined by its resource type, resource ID, key,value, and a propagate flag. Valid values: key=value , value=value , propagate=true or false . Valueand propagate are optional parameters.
Type: Tag (p. 73) list
Required: No
TerminationPolicies.member.NA standalone termination policy or a list of termination policies used to select the instance to terminate.The policies are executed in the order that they are listed.
For more information on configuring a termination policy for your Auto Scaling group, go to InstanceTermination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide .
Type: String list
Required: No
VPCZoneIdentifierA comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
API Version 2011-01-01
5
Auto Scaling API Reference
Request Parameters
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 10/83
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zonesmatch the Availability Zones specified.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
AlreadyExistsThe named Auto Scaling group or launch configuration already exists.
HTTP Status Code: 400
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
6
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 11/83
CreateLaunchConfiguration
Description
Creates a new launch configuration.The launch configuration name must be unique within the scope ofthe client's AWS account.The maximum limit of launch configurations, which by default is 100, must notyet have been met; otherwise, the call will fail. When created, the new launch configuration is availablefor immediate use.
You can create a launch configuration with Amazon EC2 security groups or with Amazon VPC securitygroups. However, you can't use Amazon EC2 security groups together with Amazon VPC security groups,or vice versa.
NoteAt this time, Auto Scaling launch configurations don't support compressed (e.g. zipped) userdata files.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
BlockDeviceMappings.member.NA list of mappings that specify how block devices are exposed to the instance. Each mapping is madeup of a VirtualName , a DeviceName , and an ebs data structure that contains information about theassociated Elastic Block Storage volume. For more information about Amazon EC2BlockDeviceMappings, go to Block Device Mapping in the Amazon EC2 product documentation.
Type: BlockDeviceMapping (p. 59) list
Required: No
EbsOptimizedWhether the instance is optimized for EBS I/O.This optimization provides dedicated throughput to
Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. Thisoptimization is not available with all instance types. Additional usage charges apply when using anEBS Optimized instance. For information about EBS-optimized instances, go to EBS-OptimizedInstances in the Amazon Elastic Compute Cloud User Guide .
Type: Boolean
Required: No
IamInstanceProfileThe name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM rolefor the instance. For information on launching EC2 instances with an IAM role, go to Launching AutoScaling Instances With an IAM Role in the Auto Scaling Developer Guide .
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
ImageIdUnique ID of the Amazon Machine Image (AMI) which was assigned during registration. For moreinformation about Amazon EC2 images, please see Amazon EC2 product documentation.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
API Version 2011-01-01
7
Auto Scaling API Reference
CreateLaunchConfiguration
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 12/83
Required:Yes
InstanceMonitoringEnables detailed monitoring, which is enabled by default.
When detailed monitoring is enabled, CloudWatch will generate metrics every minute and youraccount will be charged a fee.When you disable detailed monitoring, by specifyingFalse, Cloudwatch
will generate metrics every 5 minutes. For information about monitoring, see the Amazon CloudWatchproduct page.
Type: InstanceMonitoring (p. 66)
Required: No
InstanceTypeThe instance type of the Amazon EC2 instance. For more information about Amazon EC2 instancetypes, please see Amazon EC2 product documentation
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required:Yes
KernelIdThe ID of the kernel associated with the Amazon EC2 AMI.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
KeyNameThe name of the Amazon EC2 key pair.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
LaunchConfigurationNameThe name of the launch configuration to create.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required:Yes
RamdiskIdThe ID of the RAM disk associated with the Amazon EC2 AMI.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
SecurityGroups.member.NThe names of the security groups with which to associate Amazon EC2 or Amazon VPC instances.Specify Amazon EC2 security groups using security group names, such as websrv. Specify Amazon
VPC security groups using security group IDs, such as sg-12345678. For more information aboutAmazon EC2 security groups, go to Using Security Groups in the Amazon EC2 product
API Version 2011-01-01
8
Auto Scaling API Reference
Request Parameters
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 13/83
documentation. For more information about Amazon VPC security groups, go to Security Groups inthe Amazon VPC product documentation.
Type: String list
Required: No
SpotPriceThe maximum hourly price to be paid for any Spot Instance launched to fulfill the request. SpotInstances are launched when the price you specify exceeds the current Spot market price. For moreinformation on launching Spot Instances, go to Using Auto Scaling to Launch Spot Instances in theAuto Scaling Developer Guide .
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
UserDataThe user data available to the launched Amazon EC2 instances. For more information about AmazonEC2 user data, please see Amazon EC2 product documentation.
Type: String
Length constraints: Minimum length of 0. Maximum length of 21847.
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
AlreadyExistsThe named Auto Scaling group or launch configuration already exists.
HTTP Status Code: 400
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
9
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 14/83
CreateOrUpdateTags
Description
Creates new tags or updates existing tags for an Auto Scaling group.NoteA tag's definition is composed of a resource ID, resource type, key and value, and the propagateflag. Value and the propagate flag are optional parameters. See the Request Parameters formore information.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
Tags.member.NThe tag to be created or updated. Each tag should be defined by its resource type, resource ID, key,value, and a propagate flag.The resource type and resource ID identify the type and name of resource
for which the tag is created. Currently, auto-scaling-group is the only supported resource type.The valid value for the resource ID is groupname .
The PropagateAtLaunch flag defines whether the new tag will be applied to instances launchedby the Auto Scaling group.Valid values are true or false. However, instances that are already
running will not get the new or updated tag. Likewise, when you modify a tag, the updated versionwill be applied only to new instances launched by the Auto Scaling group after the change. Runninginstances that had the previous version of the tag will continue to have the older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites theprevious tag definition, but you will not get an error message.
Type: Tag (p. 73) list
Required:Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
AlreadyExistsThe named Auto Scaling group or launch configuration already exists.
HTTP Status Code: 400
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
10
Auto Scaling API Reference
CreateOrUpdateTags
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 15/83
DeleteAutoScalingGroup
Description
Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress.NoteTo remove all instances before calling DeleteAutoScalingGroup (p. 11), you can callUpdateAutoScalingGroup (p.50) to set the minimum and maximum size of the AutoScalingGroupto zero.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
ForceDeleteStarting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along withall instances associated with the group, without waiting for all instances to be terminated.
Type: Boolean
Required: No
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 78).
ResourceInUseThis is returned when you cannot delete a launch configuration or Auto Scaling group because it isbeing used.
HTTP Status Code: 400
ScalingActivityInProgressYou cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
HTTP Status Code: 400
API Version 2011-01-01
11
Auto Scaling API Reference
DeleteAutoScalingGroup
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 16/83
DeleteLaunchConfiguration
Description
Deletes the specified LaunchConfiguration (p. 66).
The specified launch configuration must not be attached to an Auto Scaling group.When this call completes,the launch configuration is no longer available for use.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
LaunchConfigurationNameThe name of the launch configuration.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
ResourceInUseThis is returned when you cannot delete a launch configuration or Auto Scaling group because it isbeing used.
HTTP Status Code: 400
API Version 2011-01-01
12
Auto Scaling API Reference
DeleteLaunchConfiguration
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 17/83
DeleteNotificationConfiguration
Description
Deletes notifications created by PutNotificationConfiguration (p. 39).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
TopicARNThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
API Version 2011-01-01
13
Auto Scaling API Reference
DeleteNotificationConfiguration
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 18/83
DeletePolicy
Description
Deletes a policy created by PutScalingPolicy (p. 40).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
PolicyNameThe name or PolicyARN of the policy you want to delete.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
API Version 2011-01-01
14
Auto Scaling API Reference
DeletePolicy
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 19/83
DeleteScheduledAction
Description
Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction (p. 42).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
ScheduledActionNameThe name of the action you want to delete.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
API Version 2011-01-01
15
Auto Scaling API Reference
DeleteScheduledAction
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 20/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 21/83
DescribeAdjustmentTypes
Description
Returns policy adjustment types for use in the PutScalingPolicy (p. 40) action.
Response Elements
The following element is returned in a DescribeAdjustmentTypesResult structure.
AdjustmentTypesA list of specific policy adjustment types.
Type: AdjustmentType (p. 55) list
API Version 2011-01-01
17
Auto Scaling API Reference
DescribeAdjustmentTypes
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 22/83
DescribeAutoScalingGroups
Description
Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2instances that are members of the group. If a list of names is not provided, the service returns the fulldetails of all Auto Scaling groups.
This action supports pagination by returning a token if there are more pages to retrieve. To get the nextpage, call this action again with the returned token as the NextToken parameter.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNames.member.NA list of Auto Scaling group names.
Type: String list
Required: No
MaxRecordsThe maximum number of records to return.
Type: Integer
Required: No
NextTokenA string that marks the start of the next batch of returned results.
Type: String
Required: No
Response Elements
The following elements are returned in a DescribeAutoScalingGroupsResult structure.
AutoScalingGroupsA list of Auto Scaling groups.
Type: AutoScalingGroup (p. 56) list
NextTokenA string that marks the start of the next batch of returned results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
API Version 2011-01-01
18
Auto Scaling API Reference
DescribeAutoScalingGroups
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 23/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 24/83
DescribeAutoScalingInstances
Description
Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, theservice returns the full details of all instances up to a maximum of 50. By default, the service returns alist of 20 items.
This action supports pagination by returning a token if there are more pages to retrieve. To get the nextpage, call this action again with the returned token as the NextToken parameter.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
InstanceIds.member.NThe list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances aredescribed. The list of requested instances cannot contain more than 50 items. If unknown instances
are requested, they are ignored with no error.
Type: String list
Required: No
MaxRecordsThe maximum number of Auto Scaling instances to be described with each call.
Type: Integer
Required: No
NextTokenThe token returned by a previous call to indicate that there is more data available.
Type: String
Required: No
Response Elements
The following elements are returned in a DescribeAutoScalingInstancesResult structure.
AutoScalingInstancesA list of Auto Scaling instances.
Type: AutoScalingInstanceDetails (p. 58) list
NextTokenA string that marks the start of the next batch of returned results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
API Version 2011-01-01
20
Auto Scaling API Reference
DescribeAutoScalingInstances
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 25/83
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
21
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 26/83
DescribeAutoScalingNotificationTypes
Description
Returns a list of all notification types that are supported by Auto Scaling.
Response Elements
The following element is returned in a DescribeAutoScalingNotificationTypesResult structure.
AutoScalingNotificationTypesNotification types supported by Auto Scaling. They are: autoscaling:EC2_INSTANCE_LAUNCH,autoscaling:EC2_INSTANCE_LAUNCH_ERROR, autoscaling:EC2_INSTANCE_TERMINATE,autoscaling:EC2_INSTANCE_TERMINATE_ERROR, autoscaling:TEST_NOTIFICATION
Type: String list
API Version 2011-01-01
22
Auto Scaling API Reference
DescribeAutoScalingNotificationTypes
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 27/83
DescribeLaunchConfigurations
Description
Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
If no name is specified, then the full details of all launch configurations are returned.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
LaunchConfigurationNames.member.NA list of launch configuration names.
Type: String list
Required: No
MaxRecordsThe maximum number of launch configurations.The default is 100.
Type: Integer
Required: No
NextTokenA string that marks the start of the next batch of returned results.
Type: String
Required: No
Response ElementsThe following elements are returned in a DescribeLaunchConfigurationsResult structure.
LaunchConfigurationsA list of launch configurations.
Type: LaunchConfiguration (p. 66) list
NextTokenA string that marks the start of the next batch of returned results.
Type: String
ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
23
Auto Scaling API Reference
DescribeLaunchConfigurations
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 28/83
DescribeMetricCollectionTypes
Description
Returns a list of metrics and a corresponding list of granularities for each metric.
Response Elements
The following elements are returned in a DescribeMetricCollectionTypesResult structure.
GranularitiesA list of granularities for the listed Metrics.
Type: MetricGranularityType (p. 68) list
MetricsThe list of Metrics collected.The following metrics are supported:
• GroupMinSize
• GroupMaxSize• GroupDesiredCapacity
• GroupInServiceInstances
• GroupPendingInstances
• GroupTerminatingInstances
• GroupTotalInstances
Type: MetricCollectionType (p. 68) list
API Version 2011-01-01
24
Auto Scaling API Reference
DescribeMetricCollectionTypes
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 29/83
DescribeNotificationConfigurations
Description
Returns a list of notification actions associated with Auto Scaling groups for specified events.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNames.member.NThe name of the Auto Scaling group.
Type: String list
Required: No
MaxRecordsMaximum number of records to be returned.
Type: Integer
Required: No
NextTokenA string that is used to mark the start of the next batch of returned results for pagination.
Type: String
Required: No
Response Elements
The following elements are returned in a DescribeNotificationConfigurationsResult structure.
NextTokenA string that is used to mark the start of the next batch of returned results for pagination.
Type: String
NotificationConfigurationsThe list of notification configurations.
Type: NotificationConfiguration (p. 68) list
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
25
Auto Scaling API Reference
DescribeNotificationConfigurations
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 30/83
DescribePolicies
Description
Returns descriptions of what each policy does. This action supports pagination. If the response includesa token, there are more records available.To get the additional records, repeat the request with theresponse token as the NextToken parameter.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
MaxRecordsThe maximum number of policies that will be described with each call.
Type: Integer
Required: No
NextTokenA string that is used to mark the start of the next batch of returned results for pagination.
Type: String
Required: No
PolicyNames.member.NA list of policy names or policy ARNs to be described. If this list is omitted, all policy names aredescribed. If an auto scaling group name is provided, the results are limited to that group.The list ofrequested policy names cannot contain more than 50 items. If unknown policy names are requested,they are ignored with no error.
Type: String list
Required: No
Response Elements
The following elements are returned in a DescribePoliciesResult structure.
NextTokenA string that marks the start of the next batch of returned results.
Type: String
ScalingPoliciesA list of scaling policies.
Type: ScalingPolicy (p. 71) list
API Version 2011-01-01
26
Auto Scaling API Reference
DescribePolicies
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 31/83
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
27
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 32/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 33/83
NextTokenActs as a paging mechanism for large result sets. Set to a non-empty string if there are additionalresults waiting to be returned. Pass this in to subsequent calls to return additional results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
29
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 34/83
DescribeScalingProcessTypes
Description
Returns scaling process types for use in the ResumeProcesses (p. 44) and SuspendProcesses (p. 48)actions.
Response Elements
The following element is returned in a DescribeScalingProcessTypesResult structure.
ProcessesA list of ProcessType (p. 69) names.
Type: ProcessType (p. 69) list
API Version 2011-01-01
30
Auto Scaling API Reference
DescribeScalingProcessTypes
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 35/83
DescribeScheduledActions
Description
Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list ofactions already executed, see the activity record returned in DescribeScalingActivities (p. 28).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: NoEndTime
The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.
Type: DateTime
Required: No
MaxRecordsThe maximum number of scheduled actions to return.
Type: Integer
Required: No
NextToken
A string that marks the start of the next batch of returned results.
Type: String
Required: No
ScheduledActionNames.member.NA list of scheduled actions to be described. If this list is omitted, all scheduled actions are described.The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling groupname is provided, the results are limited to that group. If unknown scheduled actions are requested,they are ignored with no error.
Type: String list
Required: No
StartTimeThe earliest scheduled start time to return. If scheduled action names are provided, this field will beignored.
Type: DateTime
API Version 2011-01-01
31
Auto Scaling API Reference
DescribeScheduledActions
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 36/83
Required: No
Response Elements
The following elements are returned in a DescribeScheduledActionsResult structure.
NextTokenA string that marks the start of the next batch of returned results.
Type: String
ScheduledUpdateGroupActionsA list of scheduled actions designed to update an Auto Scaling group.
Type: ScheduledUpdateGroupAction (p. 72) list
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
32
Auto Scaling API Reference
Response Elements
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 37/83
DescribeTags
Description
Lists the Auto Scaling group tags.
You can use filters to limit results when describing tags. For example, you can query for tags of a particularAuto Scaling group.You can specify multiple values for a filter. A tag must match at least one of thespecified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matchesall your filters. If there's no match, no special message is returned.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
Filters.member.N
The value of the filter type used to identify the tags to be returned. For example, you can filter so thattags are returned according to Auto Scaling group, the key and value, or whether the new tag will beapplied to instances launched after the tag is created (PropagateAtLaunch).
Type: Filter (p.65) list
Required: No
MaxRecordsThe maximum number of records to return.
Type: Integer
Required: No
NextToken
A string that marks the start of the next batch of returned results.
Type: String
Required: No
Response Elements
The following elements are returned in a DescribeTagsResult structure.
NextTokenA string used to mark the start of the next batch of returned results.
Type: StringTags
The list of tags.
Type: TagDescription (p. 74) list
API Version 2011-01-01
33
Auto Scaling API Reference
DescribeTags
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 38/83
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
InvalidNextTokenThe NextToken value is invalid.
HTTP Status Code: 400
API Version 2011-01-01
34
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 39/83
DescribeTerminationPolicyTypes
Description
Returns a list of all termination policies supported by Auto Scaling.
Response Elements
The following element is returned in a DescribeTerminationPolicyTypesResult structure.
TerminationPolicyTypesTermination policies supported by Auto Scaling. They are: OldestInstance,OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default
Type: String list
API Version 2011-01-01
35
Auto Scaling API Reference
DescribeTerminationPolicyTypes
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 40/83
DisableMetricsCollection
Description
Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName.You can specify the list of affected metrics with the Metrics parameter.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or ARN of the Auto Scaling Group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:YesMetrics.member.N
The list of metrics to disable. If no metrics are specified, all metrics are disabled.The following metricsare supported:
• GroupMinSize
• GroupMaxSize
• GroupDesiredCapacity
• GroupInServiceInstances
• GroupPendingInstances
• GroupTerminatingInstances
• GroupTotalInstances
Type: String list
Required: No
API Version 2011-01-01
36
Auto Scaling API Reference
DisableMetricsCollection
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 41/83
EnableMetricsCollection
Description
Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName.You can specify the list of enabled metrics with the Metrics parameter.
Auto scaling metrics collection can be turned on only if the InstanceMonitoring flag, in the AutoScaling group's launch configuration, is set to True.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or ARN of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
GranularityThe granularity to associate with the metrics to collect. Currently, the only legal granularity is "1Minute".
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required:Yes
Metrics.member.NThe list of metrics to collect. If no metrics are specified, all metrics are enabled.The following metrics
are supported:• GroupMinSize
• GroupMaxSize
• GroupDesiredCapacity
• GroupInServiceInstances
• GroupPendingInstances
• GroupTerminatingInstances
• GroupTotalInstances
Type: String list
Required: No
API Version 2011-01-01
37
Auto Scaling API Reference
EnableMetricsCollection
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 42/83
ExecutePolicy
Description
Runs the policy you create for your Auto Scaling group in PutScalingPolicy (p. 40).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or ARN of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
HonorCooldownSet to True if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.
Type: Boolean
Required: No
PolicyNameThe name or PolicyARN of the policy you want to run.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
ScalingActivityInProgressYou cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
HTTP Status Code: 400
API Version 2011-01-01
38
Auto Scaling API Reference
ExecutePolicy
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 43/83
PutNotificationConfiguration
Description
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers tothis topic can have messages for events delivered to an endpoint such as a web server or email address.
A new PutNotificationConfiguration overwrites an existing configuration.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
NotificationTypes.member.NThe type of events that will trigger the notification. For more information, go toDescribeAutoScalingNotificationTypes (p. 22).
Type: String list
Required:Yes
TopicARNThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
39
Auto Scaling API Reference
PutNotificationConfiguration
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 44/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 45/83
ScalingAdjustmentThe number of instances by which to scale. AdjustmentType determines the interpretation of thisnumber (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). Apositive increment adds to the current capacity and a negative value removes from the currentcapacity.
Type: Integer
Required:Yes
Response Elements
The following element is returned in a PutScalingPolicyResult structure.
PolicyARNA policy's Amazon Resource Name (ARN).
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
41
Auto Scaling API Reference
Response Elements
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 46/83
PutScheduledUpdateGroupAction
Description
Creates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified, thecorresponding value remains unchanged in the affected Auto Scaling group.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or ARN of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:YesDesiredCapacity
The number of Amazon EC2 instances that should be running in the group.
Type: Integer
Required: No
EndTimeThe time for this action to end.
Type: DateTime
Required: No
MaxSize
The maximum size for the Auto Scaling group.
Type: Integer
Required: No
MinSizeThe minimum size for the new Auto Scaling group.
Type: Integer
Required: No
RecurrenceThe time when recurring future actions will start. Start time is specified by the user following the Unixcron syntax format. For information about cron syntax, go to Wikipedia, The Free Encyclopedia.
When StartTime and EndTime are specified with Recurrence, they form the boundaries of whenthe recurring action will start and stop.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
API Version 2011-01-01
42
Auto Scaling API Reference
PutScheduledUpdateGroupAction
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 47/83
ScheduledActionNameThe name of this scaling action.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required:Yes
StartTimeThe time for this action to start, as in --start-time 2010-06-01T00:00:00Z.
When StartTime and EndTime are specified with Recurrence, they form the boundaries of whenthe recurring action will start and stop.
Type: DateTime
Required: No
TimeTime is deprecated.
The time for this action to start. Time is an alias for StartTime and can be specified instead ofStartTime, or vice versa. If both Time and StartTime are specified, their values should be identical.Otherwise, PutScheduledUpdateGroupAction will return an error.
Type: DateTime
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
AlreadyExistsThe named Auto Scaling group or launch configuration already exists.
HTTP Status Code: 400
LimitExceededThe quota for capacity groups or launch configurations for this customer has already been reached.
HTTP Status Code: 400
API Version 2011-01-01
43
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 48/83
ResumeProcesses
Description
Resumes Auto Scaling processes for an Auto Scaling group. For more information, seeSuspendProcesses (p. 48) and ProcessType (p. 69).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or Amazon Resource Name (ARN) of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:YesScalingProcesses.member.N
The processes that you want to suspend or resume, which can include one or more of the following:
• Launch
• Terminate
• HealthCheck
• ReplaceUnhealthy
• AZRebalance
• AlarmNotification
• ScheduledActions
• AddToLoadBalancer
To suspend all process types, omit this parameter.
Type: String list
Required: No
API Version 2011-01-01
44
Auto Scaling API Reference
ResumeProcesses
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 49/83
SetDesiredCapacity
Description
Adjusts the desired size of the AutoScalingGroup (p. 56) by initiating scaling activities. When reducingthe size of the group, it is not possible to define which Amazon EC2 instances will be terminated.Thisapplies to any Auto Scaling decisions that might result in terminating instances.
There are two common use cases for SetDesiredCapacity: one for users of the Auto Scaling triggeringsystem, and another for developers who write their own triggering systems. Both use cases relate to theconcept of cooldown.
In the first case, if you use the Auto Scaling triggering system, SetDesiredCapacity changes the sizeof your Auto Scaling group without regard to the cooldown period.This could be useful, for example, ifAuto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, AutoScaling would normally reject requests to change the size of the group for that entire 10-minute period.The SetDesiredCapacity command allows you to circumvent this restriction and change the size ofthe group before the end of the cooldown period.
In the second case, if you write your own triggering system, you can use SetDesiredCapacity to controlthe size of your Auto Scaling group. If you want the same cooldown functionality that Auto Scaling offers,you can configure SetDesiredCapacity to honor cooldown by setting the HonorCooldown parameterto true.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
DesiredCapacityThe new capacity setting for the Auto Scaling group.
Type: Integer
Required:Yes
HonorCooldownBy default, SetDesiredCapacity overrides any cooldown period. Set to True if you want AutoScaling to reject this request when the Auto Scaling group is in cooldown.
Type: Boolean
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
API Version 2011-01-01
45
Auto Scaling API Reference
SetDesiredCapacity
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 50/83
ScalingActivityInProgressYou cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
HTTP Status Code: 400
API Version 2011-01-01
46
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 51/83
SetInstanceHealth
Description
Sets the health status of an instance.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
HealthStatusThe health status of the instance. "Healthy" means that the instance is healthy and should remain inservice. "Unhealthy" means that the instance is unhealthy. Auto Scaling should terminate and replaceit.
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
Required:Yes
InstanceIdThe identifier of the Amazon EC2 instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16.
Required:Yes
ShouldRespectGracePeriodIf True, this call should respect the grace period associated with the group.
Type: Boolean
Required: No
API Version 2011-01-01
47
Auto Scaling API Reference
SetInstanceHealth
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 52/83
SuspendProcesses
Description
Suspends Auto Scaling processes for an Auto Scaling group.To suspend specific process types, specifythem by name with the ScalingProcesses.member.N parameter.To suspend all process types, omitthe ScalingProcesses.member.N parameter.
Important
Suspending either of the two primary process types, Launch or Terminate, can prevent otherprocess types from functioning properly. For more information about processes and theirdependencies, see ProcessType (p. 69).
To resume processes that have been suspended, use ResumeProcesses (p. 44).
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupNameThe name or Amazon Resource Name (ARN) of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
ScalingProcesses.member.NThe processes that you want to suspend or resume, which can include one or more of the following:
• Launch
• Terminate
• HealthCheck
• ReplaceUnhealthy
• AZRebalance
• AlarmNotification
• ScheduledActions
• AddToLoadBalancer
To suspend all process types, omit this parameter.
Type: String list
Required: No
API Version 2011-01-01
48
Auto Scaling API Reference
SuspendProcesses
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 53/83
TerminateInstanceInAutoScalingGroup
Description
Terminates the specified instance. Optionally, the desired group size can be adjusted.NoteThis call simply registers a termination request.The termination of the instance cannot happenimmediately.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
InstanceIdThe ID of the Amazon EC2 instance to be terminated.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16.
Required:Yes
ShouldDecrementDesiredCapacitySpecifies whether (true ) or not (false ) terminating this instance should also decrement the size of theAutoScalingGroup (p. 56).
Type: Boolean
Required:Yes
Response Elements
The following element is returned in a TerminateInstanceInAutoScalingGroupResult structure.
ActivityA scaling Activity.
Type: Activity (p.54)
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
ScalingActivityInProgress
You cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
HTTP Status Code: 400
API Version 2011-01-01
49
Auto Scaling API Reference
TerminateInstanceInAutoScalingGroup
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 54/83
UpdateAutoScalingGroup
Description
Updates the configuration for the specified AutoScalingGroup (p. 56).Note
To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring
flag set to False, you must first ensure that collection of group metrics is disabled. Otherwise,calls to UpdateAutoScalingGroup (p. 50) will fail. If you have previously enabled group metricscollection, you can disable collection of all group metrics by callingDisableMetricsCollection (p. 36).
The new settings are registered upon the completion of this call. Any launch configuration settings takeeffect on any triggers after this call returns. Triggers that are currently in progress aren't affected.
Note
• If a new value is specified for MinSize without specifying the value for DesiredCapacity , andif the new MinSize is larger than the current size of the Auto Scaling Group, there will be animplicit call to SetDesiredCapacity (p. 45) to set the group to the new MinSize .
• If a new value is specified for MaxSize without specifying the value for DesiredCapacity , andthe new MaxSize is smaller than the current size of the Auto Scaling Group, there will be animplicit call to SetDesiredCapacity (p. 45) to set the group to the new MaxSize .
• All other optional parameters are left unchanged if not passed in the request.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters (p.76).
AutoScalingGroupName
The name of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required:Yes
AvailabilityZones.member.NAvailability Zones for the group.
Type: String list
Length constraints: Minimum of 1 item(s) in the list.
Required: NoDefaultCooldown
The amount of time, in seconds, after a scaling activity completes before any further trigger-relatedscaling activities can start.
Type: Integer
Required: No
DesiredCapacityThe desired capacity for the Auto Scaling group.
API Version 2011-01-01
50
Auto Scaling API Reference
UpdateAutoScalingGroup
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 55/83
Type: Integer
Required: No
HealthCheckGracePeriodThe length of time that Auto Scaling waits before checking an instance's health status. The graceperiod begins when an instance comes into service.
Type: Integer
Required: No
HealthCheckTypeThe service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for ElasticLoad Balancing.
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
Required: No
LaunchConfigurationName
The name of the launch configuration.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
Required: No
MaxSizeThe maximum size of the Auto Scaling group.
Type: Integer
Required: No
MinSizeThe minimum size of the Auto Scaling group.
Type: Integer
Required: No
PlacementGroupThe name of the cluster placement group, if applicable. For more information, go to Using ClusterInstances in the Amazon EC2 User Guide.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
TerminationPolicies.member.N
A standalone termination policy or a list of termination policies used to select the instance to terminate.The policies are executed in the order that they are listed.
For more information on creating a termination policy for your Auto Scaling group, go to InstanceTermination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide .
Type: String list
Required: No
API Version 2011-01-01
51
Auto Scaling API Reference
Request Parameters
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 56/83
VPCZoneIdentifierThe subnet identifier for the Amazon VPC connection, if applicable.You can specify several subnetsin a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets'Availability Zones match the values you specify for AvailabilityZones.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors (p. 78).
ScalingActivityInProgressYou cannot delete an Auto Scaling group while there are scaling activities in progress for that group.
HTTP Status Code: 400
API Version 2011-01-01
52
Auto Scaling API Reference
Errors
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 57/83
Data Types
The Auto Scaling API contains several data types that various actions use. This section describes each
data type in detail.NoteThe order of each element in the response is not guaranteed. Applications should not assumea particular order.
The following data types are supported:
• Activity (p. 54)
• AdjustmentType (p. 55)
• Alarm (p. 55)
• AutoScalingGroup (p. 56)
• AutoScalingInstanceDetails (p. 58)
• BlockDeviceMapping (p. 59)
• DescribeAdjustmentTypesResult (p. 59)
• DescribeAutoScalingGroupsResult (p. 59)
• DescribeAutoScalingInstancesResult (p. 60)
• DescribeAutoScalingNotificationTypesResult (p. 60)
• DescribeLaunchConfigurationsResult (p. 61)
• DescribeMetricCollectionTypesResult (p. 61)
• DescribeNotificationConfigurationsResult (p. 61)
• DescribePoliciesResult (p. 62)
• DescribeScalingActivitiesResult (p. 62)
• DescribeScalingProcessTypesResult (p. 63)
• DescribeScheduledActionsResult (p. 63)
• DescribeTagsResult (p. 63)
• DescribeTerminationPolicyTypesResult (p. 64)
• Ebs (p. 64)
• EnabledMetric (p. 64)
• Filter (p. 65)
• Instance (p.65)
• InstanceMonitoring (p. 66)
API Version 2011-01-01
53
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 58/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 59/83
ProgressSpecifies a value between 0 and 100 that indicates the progress of the activity.
Type: Integer
StartTimeProvides the start time of this activity.
Type: DateTime
StatusCodeContains the current status of the activity.
Type: String
Valid Values: WaitingForSpotInstanceRequestId | WaitingForSpotInstanceId |WaitingForInstanceId | PreInService | InProgress | Successful | Failed |
Cancelled
StatusMessageContains a friendly, more verbose description of the activity status.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AdjustmentType
Description
Specifies whether the PutScalingPolicy (p. 40) ScalingAdjustment parameter is an absolute numberor a percentage of the current capacity.
Contents
AdjustmentTypeA policy adjustment type.Valid values are ChangeInCapacity, ExactCapacity, andPercentChangeInCapacity.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Alarm
DescriptionThe Alarm data type.
Contents
AlarmARNThe Amazon Resource Name (ARN) of the alarm.
API Version 2011-01-01
55
Auto Scaling API Reference
AdjustmentType
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 60/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
AlarmNameThe name of the alarm.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AutoScalingGroup
Description
The AutoScalingGroup data type.
Contents
AutoScalingGroupARNThe Amazon Resource Name (ARN) of the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
AutoScalingGroupNameSpecifies the name of the group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AvailabilityZones
Contains a list of Availability Zones for the group.
Type: String list
Length constraints: Minimum of 1 item(s) in the list.
CreatedTimeSpecifies the date and time the Auto Scaling group was created.
Type: DateTime
DefaultCooldownThe number of seconds after a scaling activity completes before any further scaling activities canstart.
Type: Integer
DesiredCapacitySpecifies the desired capacity for the Auto Scaling group.
Type: Integer
EnabledMetricsA list of metrics enabled for this Auto Scaling group.
Type: EnabledMetric (p. 64) list
API Version 2011-01-01
56
Auto Scaling API Reference
AutoScalingGroup
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 61/83
HealthCheckGracePeriodThe length of time that Auto Scaling waits before checking an instance's health status. The graceperiod begins when an instance comes into service.
Type: Integer
HealthCheckType
The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for ElasticLoad Balancing.
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
InstancesProvides a summary list of Amazon EC2 instances.
Type: Instance (p. 65) list
LaunchConfigurationNameSpecifies the name of the associated LaunchConfiguration (p. 66).
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
LoadBalancerNamesA list of load balancers associated with this Auto Scaling group.
Type: String list
MaxSizeContains the maximum size of the Auto Scaling group.
Type: Integer
MinSizeContains the minimum size of the Auto Scaling group.
Type: Integer
PlacementGroupThe name of the cluster placement group, if applicable. For more information, go to Using ClusterInstances in the Amazon EC2 User Guide.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
StatusA list of status conditions for the Auto Scaling group.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
SuspendedProcesses
Suspended processes associated with this Auto Scaling group.
Type: SuspendedProcess (p. 73) list
TagsA list of tags for the Auto Scaling group.
Type: TagDescription (p. 74) list
TerminationPoliciesA standalone termination policy or a list of termination policies for this Auto Scaling group.
API Version 2011-01-01
57
Auto Scaling API Reference
Contents
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 62/83
Type: String list
VPCZoneIdentifierThe subnet identifier for the Amazon VPC connection, if applicable.You can specify several subnetsin a comma-separated list.
When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the subnets'
Availability Zones match the values you specify for AvailabilityZones.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AutoScalingInstanceDetails
Description
The AutoScalingInstanceDetails data type.
Contents
AutoScalingGroupNameThe name of the Auto Scaling group associated with this instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AvailabilityZoneThe Availability Zone in which this instance resides.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.HealthStatus
The health status of this instance. "Healthy" means that the instance is healthy and should remainin service. "Unhealthy" means that the instance is unhealthy. Auto Scaling should terminate andreplace it.
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
InstanceIdThe instance ID of the Amazon EC2 instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16.LaunchConfigurationName
The launch configuration associated with this instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
LifecycleStateThe life cycle state of this instance.
API Version 2011-01-01
58
Auto Scaling API Reference
AutoScalingInstanceDetails
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 63/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
BlockDeviceMappingDescription
The BlockDeviceMapping data type.
Contents
DeviceNameThe name of the device within Amazon EC2.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.Ebs
The Elastic Block Storage volume information.
Type: Ebs (p. 64)
VirtualNameThe virtual name associated with the device.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
DescribeAdjustmentTypesResultDescription
The output of the DescribeAdjustmentTypes (p. 17) action.
Contents
AdjustmentTypesA list of specific policy adjustment types.
Type: AdjustmentType (p. 55) list
DescribeAutoScalingGroupsResult
Description
The AutoScalingGroupsType data type.
API Version 2011-01-01
59
Auto Scaling API Reference
BlockDeviceMapping
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 64/83
Contents
AutoScalingGroupsA list of Auto Scaling groups.
Type: AutoScalingGroup (p. 56) list
NextTokenA string that marks the start of the next batch of returned results.
Type: String
DescribeAutoScalingInstancesResult
Description
The AutoScalingInstancesType data type.
Contents
AutoScalingInstancesA list of Auto Scaling instances.
Type: AutoScalingInstanceDetails (p. 58) list
NextTokenA string that marks the start of the next batch of returned results.
Type: String
DescribeAutoScalingNotificationTypesResultDescription
The AutoScalingNotificationTypes data type.
Contents
AutoScalingNotificationTypesNotification types supported by Auto Scaling. They are: autoscaling:EC2_INSTANCE_LAUNCH,autoscaling:EC2_INSTANCE_LAUNCH_ERROR, autoscaling:EC2_INSTANCE_TERMINATE,autoscaling:EC2_INSTANCE_TERMINATE_ERROR, autoscaling:TEST_NOTIFICATION
Type: String list
API Version 2011-01-01
60
Auto Scaling API Reference
Contents
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 65/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 66/83
Contents
NextTokenA string that is used to mark the start of the next batch of returned results for pagination.
Type: String
NotificationConfigurationsThe list of notification configurations.
Type: NotificationConfiguration (p. 68) list
DescribePoliciesResult
Description
The PoliciesType data type.
Contents
NextTokenA string that marks the start of the next batch of returned results.
Type: String
ScalingPoliciesA list of scaling policies.
Type: ScalingPolicy (p. 71) list
DescribeScalingActivitiesResultDescription
The output for the DescribeScalingActivities (p. 28) action.
Contents
ActivitiesA list of the requested scaling activities.
Type: Activity (p.54) list
NextTokenActs as a paging mechanism for large result sets. Set to a non-empty string if there are additionalresults waiting to be returned. Pass this in to subsequent calls to return additional results.
Type: String
API Version 2011-01-01
62
Auto Scaling API Reference
Contents
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 67/83
DescribeScalingProcessTypesResult
Description
The output of the DescribeScalingProcessTypes (p. 30) action.
Contents
ProcessesA list of ProcessType (p. 69) names.
Type: ProcessType (p. 69) list
DescribeScheduledActionsResult
DescriptionA scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty daysin advance.
Starting with API version 2011-01-01, you can use recurrence to specify that a scaling action occursregularly on a schedule.
Contents
NextTokenA string that marks the start of the next batch of returned results.
Type: StringScheduledUpdateGroupActions
A list of scheduled actions designed to update an Auto Scaling group.
Type: ScheduledUpdateGroupAction (p. 72) list
DescribeTagsResult
Description
Contents
NextTokenA string used to mark the start of the next batch of returned results.
Type: String
TagsThe list of tags.
Type: TagDescription (p. 74) list
API Version 2011-01-01
63
Auto Scaling API Reference
DescribeScalingProcessTypesResult
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 68/83
DescribeTerminationPolicyTypesResult
Description
The TerminationPolicyTypes data type.
Contents
TerminationPolicyTypesTermination policies supported by Auto Scaling. They are: OldestInstance,OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default
Type: String list
Ebs
Description
The Ebs data type.
Contents
SnapshotIdThe snapshot ID.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
VolumeSizeThe volume size, in gigabytes.
Type: Integer
EnabledMetric
Description
The EnabledMetric data type.
ContentsGranularity
The granularity of the enabled metric.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
MetricThe name of the enabled metric.
API Version 2011-01-01
64
Auto Scaling API Reference
DescribeTerminationPolicyTypesResult
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 69/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
FilterDescription
The Filter data type.
Contents
NameThe name of the filter. Valid Name values are: "auto-scaling-group", "key", "value", and"propagate-at-launch".
Type: String
ValuesThe value of the filter.
Type: String list
Instance
Description
The Instance data type.
ContentsAvailabilityZone
Availability Zones associated with this instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
HealthStatusThe instance's health status.
Type: String
Length constraints: Minimum length of 1. Maximum length of 32.
InstanceIdSpecifies the ID of the Amazon EC2 instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 16.
LaunchConfigurationNameThe launch configuration associated with this instance.
API Version 2011-01-01
65
Auto Scaling API Reference
Filter
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 70/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
LifecycleStateContains a description of the current lifecycle state.
Type: String
Valid Values: Pending | Quarantined | InService | Terminating | Terminated
InstanceMonitoring
Description
The InstanceMonitoring data type.
Contents
EnabledIf True, instance monitoring is enabled.
Type: Boolean
LaunchConfiguration
Description
The LaunchConfiguration data type.
Contents
BlockDeviceMappingsSpecifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName .
Type: BlockDeviceMapping (p. 59) list
CreatedTimeProvides the creation date and time for this launch configuration.
Type: DateTime
EbsOptimized
Specifies whether the instance is optimized for EBS I/O (true ) or not (false ).
Type: Boolean
IamInstanceProfileProvides the name or the Amazon Resource Name (ARN) of the instance profile associated with theIAM role for the instance.The instance profile contains the IAM role.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
API Version 2011-01-01
66
Auto Scaling API Reference
InstanceMonitoring
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 71/83
ImageIdProvides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
InstanceMonitoringControls whether instances in this group are launched with detailed monitoring or not.
Type: InstanceMonitoring (p. 66)
InstanceTypeSpecifies the instance type of the Amazon EC2 instance.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
KernelIdProvides the ID of the kernel associated with the Amazon EC2 AMI.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
KeyNameProvides the name of the Amazon EC2 key pair.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
LaunchConfigurationARNThe launch configuration's Amazon Resource Name (ARN).
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
LaunchConfigurationNameSpecifies the name of the launch configuration.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
RamdiskIdProvides ID of the RAM disk associated with the Amazon EC2 AMI.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
SecurityGroupsA description of the security groups to associate with the Amazon EC2 instances.
Type: String list
SpotPriceSpecifies the price to bid when launching Spot Instances.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
UserDataThe user data available to the launched Amazon EC2 instances.
API Version 2011-01-01
67
Auto Scaling API Reference
Contents
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 72/83
Type: String
Length constraints: Minimum length of 0. Maximum length of 21847.
MetricCollectionTypeDescription
The MetricCollectionType data type.
Contents
MetricType: String
Length constraints: Minimum length of 1. Maximum length of 255.
MetricGranularityType
Description
The MetricGranularityType data type.
Contents
GranularityThe granularity of a Metric.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
NotificationConfiguration
Description
The NotificationConfiguration data type.
ContentsAutoScalingGroupName
Specifies the Auto Scaling group name.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
NotificationTypeThe types of events for an action to start.
API Version 2011-01-01
68
Auto Scaling API Reference
MetricCollectionType
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 73/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
TopicARNThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
ProcessType
Description
There are two primary Auto Scaling process types--Launch and Terminate.The Launch process createsa new Amazon EC2 instance for an Auto Scaling group, and the Terminate process removes an existingAmazon EC2 instance.
The remaining Auto Scaling process types relate to specific Auto Scaling features:
• AddToLoadBalancer
• AlarmNotification
• AZRebalance
• HealthCheck
• ReplaceUnhealthy
• ScheduledActions
Important
If you suspend Launch or Terminate, all other process types are affected to varying degrees.
The following descriptions discuss how each process type is affected by a suspension of Launchor Terminate.
The AddToLoadBalancer process type adds instances to the the load balancer when the instances are
launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to theload balancer. If you resume the AddToLoadBalancer process, Auto Scaling will also resume addingnew instances to the load balancer when they are launched. However, Auto Scaling will not add runninginstances that were launched while the process was suspended; those instances must be added manuallyusing the the RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference .
The AlarmNotification process type accepts notifications from Amazon CloudWatch alarms that areassociated with the Auto Scaling group. If you suspend the AlarmNotification process type, AutoScaling will not automatically execute scaling policies that would be triggered by alarms.
Although the AlarmNotification process type is not directly affected by a suspension of Launch orTerminate, alarm notifications are often used to signal that a change in the size of the Auto Scaling
group is warranted. If you suspend Launch or Terminate, Auto Scaling might not be able to implementthe alarm's associated policy.
The AZRebalance process type seeks to maintain a balanced number of instances across AvailabilityZones within a Region. If you remove an Availability Zone from your Auto Scaling group or an AvailabilityZone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffectedAvailability Zone before terminating the unhealthy or unavailable instances.When the unhealthy Availability
API Version 2011-01-01
69
Auto Scaling API Reference
ProcessType
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 74/83
Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenlyacross all of the designated Availability Zones.
Important
If you call SuspendProcesses (p. 48) on the launch process type, the AZRebalance processwill neither launch new instances nor terminate existing instances.This is because the
AZRebalance process terminates existing instances only after launching the replacementinstances.
If you call SuspendProcesses (p.48) on the terminate process type, the AZRebalance process
can cause your Auto Scaling group to grow up to ten percent larger than the maximum size.This is because Auto Scaling allows groups to temporarily grow larger than the maximum sizeduring rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling groupcould remain up to ten percent larger than the maximum size until you resume the terminate
process type.
The HealthCheck process type checks the health of the instances. Auto Scaling marks an instance asunhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy.The HealthCheck process can override the health status of an instance that you set with
SetInstanceHealth (p. 47).
The ReplaceUnhealthy process type terminates instances that are marked as unhealthy andsubsequently creates new instances to replace them. This process calls both of the primary processtypes--first Terminate and then Launch.
Important
The HealthCheck process type works in conjunction with the ReplaceUnhealthly processtype to provide health check functionality. If you suspend either Launch or Terminate, theReplaceUnhealthy process type will not function properly.
The ScheduledActions process type performs scheduled actions that you create withPutScheduledUpdateGroupAction (p. 42). Scheduled actions often involve launching new instances orterminating existing instances. If you suspend either Launch or Terminate, your scheduled actionsmight not function as expected.
Contents
ProcessNameThe name of a process.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
PutScalingPolicyResult
Description
The PolicyARNType data type.
Contents
PolicyARNA policy's Amazon Resource Name (ARN).
API Version 2011-01-01
70
Auto Scaling API Reference
Contents
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 75/83
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
ScalingPolicyDescription
The ScalingPolicy data type.
Contents
AdjustmentTypeSpecifies whether the ScalingAdjustment is an absolute number or a percentage of the currentcapacity.Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
AlarmsA list of CloudWatch Alarms related to the policy.
Type: Alarm (p.55) list
AutoScalingGroupNameThe name of the Auto Scaling group associated with this scaling policy.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
CooldownThe amount of time, in seconds, after a scaling activity completes before any further trigger-related
scaling activities can start.
Type: Integer
MinAdjustmentStepChanges the DesiredCapacity of the Auto Scaling group by at least the specified number ofinstances.
Type: Integer
PolicyARNThe Amazon Resource Name (ARN) of the policy.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
PolicyNameThe name of the scaling policy.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
ScalingAdjustmentThe number associated with the specified adjustment type. A positive value adds to the currentcapacity and a negative value removes from the current capacity.
API Version 2011-01-01
71
Auto Scaling API Reference
ScalingPolicy
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 76/83
Type: Integer
ScheduledUpdateGroupAction
DescriptionThis data type stores information about a scheduled update to an Auto Scaling group.
Contents
AutoScalingGroupNameThe name of the Auto Scaling group to be updated.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
DesiredCapacity
The number of instances you prefer to maintain in your Auto Scaling group.
Type: Integer
EndTimeThe time that the action is scheduled to end. This value can be up to one month in the future.
Type: DateTime
MaxSizeThe maximum size of the Auto Scaling group.
Type: Integer
MinSizeThe minimum size of the Auto Scaling group.
Type: Integer
RecurrenceThe regular schedule that an action occurs.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
ScheduledActionARNThe Amazon Resource Name (ARN) of this scheduled action.
Type: String
Length constraints: Minimum length of 1. Maximum length of 1600.
ScheduledActionNameThe name of this scheduled action.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
StartTimeThe time that the action is scheduled to begin. This value can be up to one month in the future.
API Version 2011-01-01
72
Auto Scaling API Reference
ScheduledUpdateGroupAction
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 77/83
When StartTime and EndTime are specified with Recurrence, they form the boundaries of whenthe recurring action will start and stop.
Type: DateTime
TimeTime is deprecated.
The time that the action is scheduled to begin. Time is an alias for StartTime.
Type: DateTime
SuspendedProcess
Description
An Auto Scaling process that has been suspended. For more information, see ProcessType (p. 69).
ContentsProcessName
The name of the suspended process.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
SuspensionReasonThe reason that the process was suspended.
Type: String
Length constraints: Minimum length of 1. Maximum length of 255.
Tag
Description
The tag applied to an Auto Scaling group.
Contents
KeyThe key of the tag.
Type: String
Length constraints: Minimum length of 1. Maximum length of 128.
PropagateAtLaunchSpecifies whether the new tag will be applied to instances launched after the tag is created.Thesame behavior applies to updates: If you change a tag, the changed tag will be applied to all instanceslaunched after you made the change.
Type: Boolean
API Version 2011-01-01
73
Auto Scaling API Reference
SuspendedProcess
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 78/83
ResourceIdThe name of the Auto Scaling group.
Type: String
ResourceTypeThe kind of resource to which the tag is applied. Currently, Auto Scaling supports the
auto-scaling-group resource type.
Type: String
ValueThe value of the tag.
Type: String
Length constraints: Minimum length of 0. Maximum length of 256.
TagDescription
DescriptionThe tag applied to an Auto Scaling group.
Contents
KeyThe key of the tag.
Type: String
Length constraints: Minimum length of 1. Maximum length of 128.
PropagateAtLaunch
Specifies whether the new tag will be applied to instances launched after the tag is created.Thesame behavior applies to updates: If you change a tag, the changed tag will be applied to all instanceslaunched after you made the change.
Type: Boolean
ResourceIdThe name of the Auto Scaling group.
Type: String
ResourceTypeThe kind of resource to which the tag is applied. Currently, Auto Scaling supports theauto-scaling-group resource type.
Type: String
ValueThe value of the tag.
Type: String
Length constraints: Minimum length of 0. Maximum length of 256.
API Version 2011-01-01
74
Auto Scaling API Reference
TagDescription
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 79/83
TerminateInstanceInAutoScalingGroupResult
Description
The output for the TerminateInstanceInAutoScalingGroup (p. 49) action.
Contents
ActivityA scaling Activity.
Type: Activity (p.54)
API Version 2011-01-01
75
Auto Scaling API Reference
TerminateInstanceInAutoScalingGroupResult
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 80/83
Common Query Parameters
This section lists the request parameters that all actions use. Any action-specific parameters are listed
in the topic for the action.
RequiredDescriptionParameter Name
YesThe action to be performed.
Default: None
Type: Str ing
Action
ConditionalThe parameters that are required to authenticate aConditional request.
Contains:
AWSAccessKeyID
SignatureVersion
TimestampSignature
Default: None
AuthParams
YesThe access key ID that corresponds to the secretaccess key that you used to sign the request.
Default: None
Type: Str ing
AWSAccessKeyId
ConditionalThe date and time when the request signature expires,expressed in the format YYYY-MM-DDThh:mm:ssZ,as specified in the ISO 8601 standard.
Condition: Requests must include either Timestamp
or Expires, but not both.
Default: None
Type: Str ing
Expires
API Version 2011-01-01
76
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 81/83
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 82/83
Common Errors
This section lists the common errors that all actions return. Any action-specific errors are listed in the
topic for the action.
HTTPStatusCode
DescriptionError
400The request signature does not conform toAWS standards.
IncompleteSignature
500The request processing has failed because ofan unknown error, exception or failure.
InternalFailure
400The action or operation requested is invalid.Verify that the action is typed correctly.
InvalidAction
403The X.509 certificate or AWS access key IDprovided does not exist in our records.
InvalidClientTokenId
400Parameters that must not be used togetherwere used together.
InvalidParameterCombination
400An invalid or out-of-range value was suppliedfor the input parameter.
InvalidParameterValue
400AWS query string is malformed, does notadhere to AWS standards.
InvalidQueryParameter
404The query string contains a syntax error.MalformedQueryString
400The request is missing an action or a required
parameter.
MissingAction
403Request must contain either a valid (registered)AWS access key ID or X.509 certificate.
MissingAuthenticationToken
400A required parameter for the specified actionis not supplied.
MissingParameter
403The AWS access key ID needs a subscriptionfor the service.
OptInRequired
API Version 2011-01-01
78
Auto Scaling API Reference
8/11/2019 aws api scaling
http://slidepdf.com/reader/full/aws-api-scaling 83/83
Recommended