\n Auto Scaling is a web service designed\n to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on\n user-defined policies, schedules, and health checks. \n This service is used in conjunction with Amazon CloudWatch \n and Elastic Load Balancing services.\n
\n \nAuto Scaling provides APIs that you can call by submitting a Query Request. \n Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named Action\n or Operation that specifies the API you are calling. Action is used throughout this documentation, although Operation \n is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs.
\nCalling the API using a Query request is the most direct way to access the web service, but requires that your application handle\n low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a \n Query request is that you are assured of having access to the complete functionality of the API. For information about signing a \n a query request, see Use Query Requests to Call Auto Scaling APIs
\n\n This guide provides detailed information \n about Auto Scaling actions, data types, parameters, and errors. For detailed information \n about Auto Scaling features and their associated API actions, go to the \n Auto Scaling Developer Guide.\n
\n \nThis reference is based on the current WSDL, which is available at:
\nhttp://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl\n
\nEndpoints
\nThe examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
\nYou can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see\n Regions and Endpoints \n in the Amazon Web Services General Reference.\n
\n ", "operations": { "AttachInstances": { "name": "AttachInstances", "input": { "shape_name": "AttachInstancesQuery", "type": "structure", "members": { "InstanceIds": { "shape_name": "InstanceIds", "type": "list", "members": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": null }, "documentation": "\n\n One or more IDs of the Amazon EC2 instances to attach to the specified Auto Scaling group. \n You must specify at least one instance ID. \n
\n \n " }, "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of the Auto Scaling group to which to attach the specified instance(s). \n
\n ", "required": true } }, "documentation": "\n \n " }, "output": null, "errors": [], "documentation": "\n\n Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. \n After the instance(s) is attached, it becomes a part of the Auto Scaling group.\n
\nFor more information, see Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n " }, "CreateAutoScalingGroup": { "name": "CreateAutoScalingGroup", "input": { "shape_name": "CreateAutoScalingGroupType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of an existing launch configuration to use to launch new instances. Use this attribute \n if you want to create an Auto Scaling group using an existing launch configuration instead of an EC2 instance.\n
\n " }, "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n\n The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this attribute\n if you want to create an Auto Scaling group using an EC2 instance instead of a launch configuration. \n
\n\n When you use an instance to create an Auto Scaling group, a new launch configuration is first created \n and then associated with the Auto Scaling group. The new launch configuration derives \n all its attributes from the instance that is used to create the Auto Scaling group, \n with the exception of BlockDeviceMapping. \n
For more information, see Create an Auto Scaling Group Using EC2 Instance\n in the Auto Scaling Developer Guide.
\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n\n The minimum size of the Auto Scaling group.\n
\n ", "required": true }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n\n The maximum size of the Auto Scaling group.\n
\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n The number of Amazon EC2 instances that should be\n running in the group. The desired capacity must be greater than or equal to the minimum size and less than or \n equal to the maximum size specified for the Auto Scaling group. \n
\n " }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n\n The amount of time, in seconds, between a successful scaling activity and the succeeding scaling activity.
\nIf a DefaultCooldown\n period is not specified, Auto Scaling uses the default value of 300 as the default cool down period for the Auto Scaling group. For more information, \n see Cooldown Period\n
\n A list of Availability Zones for the Auto Scaling group.\n This is required unless you have specified subnets.\n
\n " }, "LoadBalancerNames": { "shape_name": "LoadBalancerNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\nA list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.
\nFor information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n \n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\nThe service you want the health checks from,\n Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, \n see Health Check.
\n " }, "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", "documentation": "\nLength of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health. During this time any health check failure for the that instance is ignored.
\nThis is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, \n before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to \n match the expected startup period of your application.
Physical location of an existing cluster placement group\n into which you want to launch your instances. For information about cluster placement group, see \n Using Cluster Instances
\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\nA comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
\nIf you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n
\nFor information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC\n in the Auto Scaling Developer Guide\n .
\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\nA standalone termination policy or a list of termination policies used to select the instance to terminate. \n The policies are executed in the order that they are listed.\n
\n\n For more information on configuring a termination policy for your Auto Scaling group, see \n Instance Termination Policy for Your Auto Scaling Group in \n the Auto Scaling Developer Guide. \n
\n " }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The name of the Auto Scaling group.\n
\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n
\n The key of the tag.\n
\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n\n The value of the tag. \n
\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n
\n " } }, "documentation": "\n\n The tag applied to an Auto Scaling group.\n
\n " }, "documentation": "\n\n The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, \n and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.
\nFor information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances\n in the Auto Scaling Developer Guide.\n
\n " } }, "documentation": "\n\n\n
\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The named Auto Scaling group or launch configuration already exists.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], "documentation": "\n\n Creates a new Auto Scaling group with the specified name and other attributes.\n When the creation request is completed,\n the Auto Scaling group is ready to be used in other calls.\n
\n\n The name of the launch configuration to create.\n
\n ", "required": true }, "ImageId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Unique ID of the Amazon Machine Image (AMI) you want to use to launch your EC2 instances.\n For information about finding Amazon EC2 AMIs,\n see Finding a Suitable AMI\n in the Amazon Elastic Compute Cloud User Guide.
\n " }, "KeyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Amazon EC2 key pair. \n For more information, see Getting a Key Pair in the Amazon Elastic Compute Cloud User Guide.\n
\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n\n The security groups with which to associate Amazon EC2 or Amazon VPC \n instances.
\nIf your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs.\n For more information about Amazon EC2 security groups, see Using Security Groups \n in the Amazon Elastic Compute Cloud User Guide.
\nIf your instances are launched within VPC, specify Amazon VPC security group IDs. \n For more information about Amazon VPC security groups, see Security Groups\n in the Amazon Virtual Private Cloud User Guide.
\n " }, "UserData": { "shape_name": "XmlStringUserData", "type": "blob", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "max_length": 21847, "documentation": "\n\n The user data to make available to the launched Amazon EC2 instances.\n For more information about Amazon EC2 user data,\n see User Data Retrieval\n in the Amazon Elastic Compute Cloud User Guide.\n
\n\n The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this attribute if you want \n the launch configuration to derive its attributes from an EC2 instance. \n
\n\n When you use an instance to create a launch configuration, all you need to specify is the InstanceId. \n The new launch configuration, by default, derives all the attributes from the specified instance with the exception \n of BlockDeviceMapping. \n
If you want to create a launch configuration with BlockDeviceMapping or override any other instance \n attributes, specify them as part of the same request.
For more information on using an InstanceID to create a launch configuration, see \n Create a Launch Configuration Using an Amazon EC2 Instance in \n the Auto Scaling Developer Guide.
\n " }, "InstanceType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The instance type of the Amazon EC2 instance.\n For information about available Amazon EC2 instance types,\n see \n Available Instance Types in the Amazon Elastic Cloud Compute User Guide.\n
\n " }, "KernelId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The ID of the kernel associated with the Amazon EC2 AMI.\n
\n " }, "RamdiskId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The ID of the RAM disk associated with the Amazon EC2 AMI.\n
\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappings", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\nThe virtual name associated with the device.\n
\n " }, "DeviceName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh).\n
\n ", "required": true }, "Ebs": { "shape_name": "Ebs", "type": "structure", "members": { "SnapshotId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The snapshot ID.\n
\n " }, "VolumeSize": { "shape_name": "BlockDeviceEbsVolumeSize", "type": "integer", "min_length": 1, "max_length": 1024, "documentation": "\nThe volume size, in gigabytes.
\nValid values: If the volume type is io1, the minimum size of the volume is 10.
Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.
\nRequired: Required when the volume type is io1.
The volume type.
\nValid values: standard | io1
Default: standard
Indicates whether to delete the volume on instance termination.
\nDefault: true
The number of I/O operations per second (IOPS) that the volume supports.
\nThe maximum ratio of IOPS to volume size is 30.0
\nValid Values: Range is 100 to 4000.
\nDefault: None.
\n \n " } }, "documentation": "\n\n The Elastic Block Storage volume information.\n
\n " }, "NoDevice": { "shape_name": "NoDevice", "type": "boolean", "documentation": "\n\n Suppresses the device mapping. \n
\nNoDevice is set to true for the root device, the instance might fail the EC2 health check. \n Auto Scaling launches a replacement instance if the instance fails the health check.\n The BlockDeviceMapping data type.\n
\n A list of mappings that specify how block devices are exposed to the instance.\n Each mapping is made up of a VirtualName, a DeviceName,\n and an ebs data structure that contains information about the\n associated Elastic Block Storage volume.\n For more information about Amazon EC2 BlockDeviceMappings,\n go to\n \n Block Device Mapping in the Amazon EC2 product documentation.\n
\n " }, "InstanceMonitoring": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "Enabled": { "shape_name": "MonitoringEnabled", "type": "boolean", "documentation": "\n\n If True, instance monitoring is enabled.\n
Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default.
\n\n When detailed monitoring is enabled, Amazon Cloudwatch will generate metrics every minute and your account will be charged a fee. \n When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. \n For more information, see Monitor Your Auto Scaling Instances.\n For information about Amazon CloudWatch, see the Amazon CloudWatch Developer Guide. \n
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the \n price you specify exceeds the current Spot market price. For more information on launching Spot Instances, see\n Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.\n
\n " }, "IamInstanceProfile": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
\nAmazon EC2 instances launched with an IAM role will \n automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances \n to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role\n in the Auto Scaling Developer Guide.
\n " }, "EbsOptimized": { "shape_name": "EbsOptimized", "type": "boolean", "documentation": "\n\n Whether the instance is optimized for EBS I/O. The optimization provides \n dedicated throughput to Amazon EBS and an optimized configuration stack to provide \n optimal EBS I/O performance. This optimization is not available with all instance \n types. Additional usage charges apply when using an EBS Optimized instance. By default\n the instance is not optimized for EBS I/O. \n For information about EBS-optimized instances, go to EBS-Optimized Instances \n in the Amazon Elastic Compute Cloud User Guide.
\n \n " }, "AssociatePublicIpAddress": { "shape_name": "AssociatePublicIpAddress", "type": "boolean", "documentation": "\nUsed for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC.
\nIf you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
\nDefault: If the instance is launched into a default subnet in a default VPC, the default is true. \n If the instance is launched into a nondefault subnet in a VPC, the default is false. \n For information about the platforms supported by Auto Scaling, see \n Get Started with Auto Scaling Using the Command Line Interface.
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.
For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
\nValid values: default | dedicated
\n\n
\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The named Auto Scaling group or launch configuration already exists.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], "documentation": "\n\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n
\n \n\n The name of the Auto Scaling group.\n
\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n
\n The key of the tag.\n
\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n\n The value of the tag. \n
\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n
\n " } }, "documentation": "\n\n The tag applied to an Auto Scaling group.\n
\n " }, "documentation": "\n\n The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, \n and a propagate flag. The resource type and resource ID identify the type and name of resource for which the \n tag is created. Currently, auto-scaling-group is the only supported resource type. The valid \n value for the resource ID is groupname.\n
The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by \n the Auto Scaling group. Valid values are true or false. However, instances that are already \n running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be \n applied only to new instances launched by the Auto Scaling group after the change. Running instances that had \n the previous version of the tag will continue to have the older tag. \n
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag \n definition, but you will not get an error message.\n
\n ", "required": true } }, "documentation": "\n\n
\n " }, "output": null, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " }, { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The named Auto Scaling group or launch configuration already exists.\n
\n " } ], "documentation": "\n\n Creates new tags or updates existing tags for an Auto Scaling group.\n
\nFor information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
\n\n The name of the Auto Scaling group to delete.\n
\n ", "required": true }, "ForceDelete": { "shape_name": "ForceDelete", "type": "boolean", "documentation": "\nStarting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. \n
\n " } }, "documentation": "\n\n\n
\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n
\n " }, { "shape_name": "ResourceInUseFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n This is returned when you cannot delete a launch\n configuration or Auto Scaling group because it is being used.\n
\n " } ], "documentation": "\n\n Deletes the specified Auto Scaling group if the group has no\n instances and no scaling activities in progress.\n
\n\n The name of the launch configuration.\n
\n ", "required": true } }, "documentation": "\n\n\n
\n " }, "output": null, "errors": [ { "shape_name": "ResourceInUseFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n This is returned when you cannot delete a launch\n configuration or Auto Scaling group because it is being used.\n
\n " } ], "documentation": "\n\n Deletes the specified LaunchConfiguration.\n
\n\n The specified launch configuration must not be \n attached to an Auto Scaling group. When this call completes,\n the launch configuration is no longer available for use.\n
\nThe name of the Auto Scaling group.
\n ", "required": true }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
\n ", "required": true } }, "documentation": "\n \t\n " }, "output": null, "errors": [], "documentation": "\nDeletes notifications created by PutNotificationConfiguration.
\n \n \n " }, "DeletePolicy": { "name": "DeletePolicy", "input": { "shape_name": "DeletePolicyType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe name of the Auto Scaling group.
\n " }, "PolicyName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe name or PolicyARN of the policy you want to delete.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes a policy created by PutScalingPolicy.
\n " }, "DeleteScheduledAction": { "name": "DeleteScheduledAction", "input": { "shape_name": "DeleteScheduledActionType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe name of the Auto Scaling group.
\n " }, "ScheduledActionName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe name of the action you want to delete.
\n ", "required": true } }, "documentation": "\n \n " }, "output": null, "errors": [], "documentation": "\nDeletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
\n " }, "DeleteTags": { "name": "DeleteTags", "input": { "shape_name": "DeleteTagsType", "type": "structure", "members": { "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The name of the Auto Scaling group.\n
\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n
\n The key of the tag.\n
\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n\n The value of the tag. \n
\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n
\n " } }, "documentation": "\n\n The tag applied to an Auto Scaling group.\n
\n " }, "documentation": "\nEach tag should be defined by its resource type, resource ID, key, value, and a propagate flag. \n Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, \n key=value, value=value, propagate=true or false.\n
\n \n ", "required": true } }, "documentation": "\n\n \n
\n " }, "output": null, "errors": [], "documentation": "\nRemoves the specified tags or a set of tags from a set of resources.
\n " }, "DescribeAccountLimits": { "name": "DescribeAccountLimits", "input": null, "output": { "shape_name": "DescribeAccountLimitsAnswer", "type": "structure", "members": { "MaxNumberOfAutoScalingGroups": { "shape_name": "MaxNumberOfAutoScalingGroups", "type": "integer", "documentation": "\n\n The maximum number of Auto Scaling groups allowed for your AWS account.\n
\n " }, "MaxNumberOfLaunchConfigurations": { "shape_name": "MaxNumberOfLaunchConfigurations", "type": "integer", "documentation": "\n\n The maximum number of launch configurations allowed for your AWS account.\n
\n " } }, "documentation": "\n\n The output of the DescribeAccountLimitsResult action.\n
\n " }, "errors": [], "documentation": "\n\n Returns the limits for the Auto Scaling resources currently allowed for your AWS account.\n
\nYour AWS account comes with default limits on resources for Auto Scaling. \n There is a default limit of 20 Auto Scaling groups and 100\n launch configurations per region.
If you reach the limits for the number of Auto Scaling groups or the launch configurations,\n you can go to the Support Center and place a \n request to raise the limits.
\nA policy adjustment type. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.
\n Specifies whether the PutScalingPolicy \n ScalingAdjustment parameter is \n an absolute number or a percentage of the current\n capacity. \n
\n A list of specific policy adjustment types.\n
\n " } }, "documentation": "\n\n The output of the DescribeAdjustmentTypes action.\n
\n " }, "errors": [], "documentation": "\n\n Returns policy adjustment types for use in the PutScalingPolicy action.\n
\n\n A list of Auto Scaling group names.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of records to return.\n
\n " } }, "documentation": "\n\n The AutoScalingGroupNamesType data type.\n
\n Specifies the name of the group.\n
\n ", "required": true }, "AutoScalingGroupARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The Amazon Resource Name (ARN) of the Auto Scaling group.\n
\n " }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Specifies the name of the associated LaunchConfiguration.\n
\n ", "required": true }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n\n Contains the minimum size of the Auto Scaling group.\n
\n ", "required": true }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n\n Contains the maximum size of the Auto Scaling group.\n
\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n Specifies the desired capacity for the Auto Scaling group.\n
\n ", "required": true }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n\n The number of seconds after a scaling activity completes\n before any further scaling activities can start.\n
\n ", "required": true }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "documentation": "\n\n Contains a list of Availability Zones for the group.\n
\n ", "required": true }, "LoadBalancerNames": { "shape_name": "LoadBalancerNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n\n A list of load balancers associated with this Auto Scaling group.\n
\n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n\n The service of interest for the health status check,\n either \"EC2\" for Amazon EC2 or \"ELB\" for Elastic Load Balancing.\n
\n ", "required": true }, "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", "documentation": "\n\n The length of time that Auto Scaling waits\n before checking an instance's health status.\n The grace period begins when an instance\n comes into service.\n
\n " }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n\n Specifies the ID of the Amazon EC2 instance.\n
\n ", "required": true }, "AvailabilityZone": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Availability Zones associated with this instance.\n
\n ", "required": true }, "LifecycleState": { "shape_name": "LifecycleState", "type": "string", "enum": [ "Pending", "Quarantined", "InService", "Terminating", "Terminated" ], "documentation": "\n\n Contains a description of the current lifecycle state. \n
\nThe Quarantined lifecycle state is currently not used.
\n The instance's health status.\n
\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The launch configuration associated with this instance.\n
\n ", "required": true } }, "documentation": "\n\n The Instance data type.\n
\n Provides a summary list of Amazon EC2 instances.\n
\n " }, "CreatedTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Specifies the date and time the Auto Scaling group was created.\n
\n ", "required": true }, "SuspendedProcesses": { "shape_name": "SuspendedProcesses", "type": "list", "members": { "shape_name": "SuspendedProcess", "type": "structure", "members": { "ProcessName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the suspended process.\n
\n " }, "SuspensionReason": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The reason that the process was suspended.\n
\n " } }, "documentation": "\n\n An Auto Scaling process that has been suspended.\n For more information, see ProcessType.\n
\n " }, "documentation": "\n\n Suspended processes associated with this Auto Scaling group.\n
\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the cluster placement group, if applicable. For\n more information, go to \n \n Using Cluster Instances in the Amazon EC2 User Guide.\n
\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a \n comma-separated list. \n
\n\n When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the \n subnets' Availability Zones match the values you specify for AvailabilityZones.\n
\n The name of the enabled metric.\n
\n " }, "Granularity": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The granularity of the enabled metric. \n
\n " } }, "documentation": "\n\n The EnabledMetric data type.\n
\n A list of metrics enabled for this Auto Scaling group.\n
\n " }, "Status": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t\n\t\t The current state of the Auto Scaling group when a DeleteAutoScalingGroup action is in progress.\n
\n " }, "Tags": { "shape_name": "TagDescriptionList", "type": "list", "members": { "shape_name": "TagDescription", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The name of the Auto Scaling group.\n
\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n
\n The key of the tag.\n
\n " }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n\n The value of the tag.\n
\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n
\n " } }, "documentation": "\n\n The tag applied to an Auto Scaling group.\n
\n " }, "documentation": "\n\n A list of tags for the Auto Scaling group.\n
\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n\n A standalone termination policy or a list of termination policies for this Auto Scaling group.\n
\n " } }, "documentation": "\n\n The AutoScalingGroup data type.\n
\n " }, "documentation": "\n\n A list of Auto Scaling groups.\n
\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " } }, "documentation": "\n\n The AutoScalingGroupsType data type.\n
\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns a full description of each Auto Scaling group in the given list. \n This includes all Amazon EC2 instances that are members of the group. \n If a list of names is not provided, the service returns the\n full details of all Auto Scaling groups.\n
\n\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n
\n The list of Auto Scaling instances to describe. \n If this list is omitted, all auto scaling instances are described. \n The list of requested instances cannot contain more than\n 50 items. If unknown instances are requested,\n they are ignored with no error.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of Auto Scaling instances to be described\n with each call.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The token returned by a previous call \n to indicate that there is more data available.\n
\n " } }, "documentation": "\n " }, "output": { "shape_name": "AutoScalingInstancesType", "type": "structure", "members": { "AutoScalingInstances": { "shape_name": "AutoScalingInstances", "type": "list", "members": { "shape_name": "AutoScalingInstanceDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n\n The instance ID of the Amazon EC2 instance.\n
\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group associated with this instance.\n
\n ", "required": true }, "AvailabilityZone": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The Availability Zone in which this instance resides.\n
\n ", "required": true }, "LifecycleState": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n\n The life cycle state of this instance. for more information, see\n Instance Lifecycle State\n in the Auto Scaling Developer Guide.
\n ", "required": true }, "HealthStatus": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n\n The health status of this instance. \n \"Healthy\" means that the instance is healthy and should\n remain in service.\n \"Unhealthy\" means that the instance is unhealthy. Auto\n Scaling should terminate and replace it. \n
\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The launch configuration associated with this instance.\n
\n ", "required": true } }, "documentation": "\n\n The AutoScalingInstanceDetails data type.\n
\n A list of Auto Scaling instances.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " } }, "documentation": "\n\n The AutoScalingInstancesType data type.\n
\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns a description of each Auto Scaling instance in the InstanceIds list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n
\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n
Returns a list of all notification types supported by Auto Scaling. They are:
\nautoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
The AutoScalingNotificationTypes data type.
\n Returns a list of all notification types that are supported by Auto Scaling.\n \n
\n " }, "DescribeLaunchConfigurations": { "name": "DescribeLaunchConfigurations", "input": { "shape_name": "LaunchConfigurationNamesType", "type": "structure", "members": { "LaunchConfigurationNames": { "shape_name": "LaunchConfigurationNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n\n A list of launch configuration names.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of launch configurations. The default is 100.\n
\n " } }, "documentation": "\n\n The LaunchConfigurationNamesType data type.\n
\n Specifies the name of the launch configuration.\n
\n ", "required": true }, "LaunchConfigurationARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The launch configuration's Amazon Resource Name (ARN).\n
\n " }, "ImageId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Provides the unique ID of the Amazon Machine Image (AMI)\n that was assigned during registration.\n
\n ", "required": true }, "KeyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Provides the name of the Amazon EC2 key pair.\n
\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n\n A description of the security\n groups to associate with the Amazon EC2 instances.\n
\n " }, "UserData": { "shape_name": "XmlStringUserData", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "max_length": 21847, "documentation": "\n\n The user data available to the launched Amazon EC2 instances.\n
\n " }, "InstanceType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Specifies the instance type of the Amazon EC2 instance.\n
\n ", "required": true }, "KernelId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Provides the ID of the kernel associated with the Amazon EC2 AMI.\n
\n " }, "RamdiskId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Provides ID of the RAM disk associated with the Amazon EC2 AMI.\n
\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappings", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\nThe virtual name associated with the device.\n
\n " }, "DeviceName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh).\n
\n ", "required": true }, "Ebs": { "shape_name": "Ebs", "type": "structure", "members": { "SnapshotId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The snapshot ID.\n
\n " }, "VolumeSize": { "shape_name": "BlockDeviceEbsVolumeSize", "type": "integer", "min_length": 1, "max_length": 1024, "documentation": "\nThe volume size, in gigabytes.
\nValid values: If the volume type is io1, the minimum size of the volume is 10.
Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size.
\nRequired: Required when the volume type is io1.
The volume type.
\nValid values: standard | io1
Default: standard
Indicates whether to delete the volume on instance termination.
\nDefault: true
The number of I/O operations per second (IOPS) that the volume supports.
\nThe maximum ratio of IOPS to volume size is 30.0
\nValid Values: Range is 100 to 4000.
\nDefault: None.
\n \n " } }, "documentation": "\n\n The Elastic Block Storage volume information.\n
\n " }, "NoDevice": { "shape_name": "NoDevice", "type": "boolean", "documentation": "\n\n Suppresses the device mapping. \n
\nNoDevice is set to true for the root device, the instance might fail the EC2 health check. \n Auto Scaling launches a replacement instance if the instance fails the health check.\n The BlockDeviceMapping data type.\n
\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n
\n " }, "InstanceMonitoring": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "Enabled": { "shape_name": "MonitoringEnabled", "type": "boolean", "documentation": "\n\n If True, instance monitoring is enabled.\n
\n Controls whether instances in this group are launched with\n detailed monitoring or not. \n
\n " }, "SpotPrice": { "shape_name": "SpotPrice", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nSpecifies the price to bid when launching Spot Instances.
\n " }, "IamInstanceProfile": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n \nProvides the name or the Amazon Resource Name (ARN) of the \n instance profile associated with the IAM role for the instance. \n The instance profile contains the IAM role.\n
\n " }, "CreatedTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Provides the creation date and time for this launch configuration.\n
\n ", "required": true }, "EbsOptimized": { "shape_name": "EbsOptimized", "type": "boolean", "documentation": "\nSpecifies whether the instance is optimized for EBS I/O (true) or not (false).
\n " }, "AssociatePublicIpAddress": { "shape_name": "AssociatePublicIpAddress", "type": "boolean", "documentation": "\nSpecifies whether the instance is associated with a public IP address (true) or not (false).
Specifies the tenancy of the instance. It can be either default or dedicated. \n An instance with dedicated tenancy runs in an isolated, single-tenant hardware and it can only be launched in a VPC.
\n The LaunchConfiguration data type.\n
\n A list of launch configurations.\n
\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " } }, "documentation": "\n\n The LaunchConfigurationsType data type.\n
\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns a full description of the launch configurations, or the specified launch configurations,\n if they exist.\n
\n\n If no name is specified, then the full details of\n all launch configurations are returned.\n
\n\n The MetricCollectionType data type.\n
\n " }, "documentation": "\nThe list of Metrics collected. The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
\n The granularity of a Metric.\n
\n " } }, "documentation": "\n\n The MetricGranularityType data type.\n
\n " }, "documentation": "\nA list of granularities for the listed Metrics.
\n " } }, "documentation": "\nThe output of the DescribeMetricCollectionTypes action.
\n " }, "errors": [], "documentation": "\n\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n
\n\n The name of the Auto Scaling group.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that is used to mark the start of the next\n batch of returned results for pagination.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\nMaximum number of records to be returned.\n
\n " } }, "documentation": "\n " }, "output": { "shape_name": "DescribeNotificationConfigurationsAnswer", "type": "structure", "members": { "NotificationConfigurations": { "shape_name": "NotificationConfigurations", "type": "list", "members": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n Specifies the Auto Scaling group name.\n
\n " }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.\n
\n " }, "NotificationType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The types of events for an action to start.\n
\n " } }, "documentation": "\n\n The NotificationConfiguration data type.\n
The list of notification configurations.
\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\nA string that is used to mark the start of the next\n batch of returned results for pagination.
\n " } }, "documentation": "\nThe output of the DescribeNotificationConfigurations action.
\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns a list of notification actions associated with Auto Scaling groups \n for specified events.\n
\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "NotificationConfigurations", "py_input_token": "next_token" } }, "DescribePolicies": { "name": "DescribePolicies", "input": { "shape_name": "DescribePoliciesType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of the Auto Scaling group.\n
\n " }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n\n A list of policy names or policy ARNs to be\n described. If this list is omitted, all policy names\n are described. If an auto scaling group name is\n provided, the results are limited to that group. The\n list of requested policy names cannot contain more\n than 50 items. If unknown policy names are\n requested, they are ignored with no error.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that is used to mark the start of the next\n batch of returned results for pagination.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of policies that will be described\n with each call.\n
\n " } }, "documentation": "\n " }, "output": { "shape_name": "PoliciesType", "type": "structure", "members": { "ScalingPolicies": { "shape_name": "ScalingPolicies", "type": "list", "members": { "shape_name": "ScalingPolicy", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group associated with this scaling policy.\n
\n " }, "PolicyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the scaling policy.\n
\n " }, "ScalingAdjustment": { "shape_name": "PolicyIncrement", "type": "integer", "documentation": "\n\n The number associated with the specified \n adjustment type.\n A positive value adds to the current capacity\n and a negative value removes from the current capacity.\n
\n " }, "AdjustmentType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Specifies whether the ScalingAdjustment is \n an absolute number or a percentage of the current\n capacity. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.\n
\n The amount of time, in seconds, after a scaling activity\n completes before any further trigger-related scaling activities\n can start.\n
\n " }, "PolicyARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The Amazon Resource Name (ARN) of the policy.\n
\n " }, "Alarms": { "shape_name": "Alarms", "type": "list", "members": { "shape_name": "Alarm", "type": "structure", "members": { "AlarmName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": " \nThe name of the alarm.
\n " }, "AlarmARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\nThe Amazon Resource Name (ARN) of the alarm.
\n " } }, "documentation": "\nThe Alarm data type.
\n " }, "documentation": "\n\n A list of CloudWatch Alarms related to the policy.\n
\n " }, "MinAdjustmentStep": { "shape_name": "MinAdjustmentStep", "type": "integer", "documentation": "\n\n Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.\n
\n The ScalingPolicy data type.\n
\n A list of scaling policies.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results. \n
\n " } }, "documentation": "\n\n The PoliciesType data type.\n
\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns descriptions of what each policy does.\n This action supports pagination. If the response includes a token, \n there are more records available. To get the additional records, repeat\n the request with the response token as the NextToken parameter.\n
\n A list containing the activity IDs of the desired scaling activities.\n If this list is omitted, all activities are described. \n If an AutoScalingGroupName is provided, the results\n are limited to that group. The list of requested\n activities cannot contain more than 50 items. If\n unknown activities are requested, they are ignored\n with no error.\n
\n The name of the AutoScalingGroup.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of scaling activities to return.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results for pagination.\n
\n " } }, "documentation": "\n\n\n
\n " }, "output": { "shape_name": "ActivitiesType", "type": "structure", "members": { "Activities": { "shape_name": "Activities", "type": "list", "members": { "shape_name": "Activity", "type": "structure", "members": { "ActivityId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Specifies the ID of the activity.\n
\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "Description": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Contains a friendly, more verbose description of the scaling activity.\n
\n " }, "Cause": { "shape_name": "XmlStringMaxLen1023", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1023, "documentation": "\n\n Contains the reason the activity was begun.\n
\n ", "required": true }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Provides the start time of this activity.\n
\n ", "required": true }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Provides the end time of this activity.\n
\n " }, "StatusCode": { "shape_name": "ScalingActivityStatusCode", "type": "string", "enum": [ "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "Successful", "Failed", "Cancelled" ], "documentation": "\n\n Contains the current status of the activity.\n
\n ", "required": true }, "StatusMessage": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Contains a friendly, more verbose description of the activity status.\n
\n " }, "Progress": { "shape_name": "Progress", "type": "integer", "documentation": "\n\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n
\n " }, "Details": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Contains details of the scaling activity.\n
\n " } }, "documentation": "\n\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n
\n " }, "documentation": "\n\n A list of the requested scaling activities.\n
\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Acts as a paging mechanism for large result sets.\n Set to a non-empty string if there are additional\n results waiting to be returned.\n Pass this in to subsequent calls to return additional results.\n
\n " } }, "documentation": "\n\n The output for the DescribeScalingActivities action.\n
\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Returns the scaling activities for the specified Auto Scaling group.\n
\n\n If the specified ActivityIds list is empty,\n all the activities from the past six weeks are returned.\n Activities are sorted by the start time.\n Activities still in progress appear first on the list.\n
\n This action supports pagination. If the response includes a token, \n there are more records available. To get the additional records, repeat\n the request with the response token as the NextToken parameter. \n
\n The name of a process.\n
\n ", "required": true } }, "documentation": "\n\n There are two primary Auto Scaling process types--Launch\n and Terminate. The Launch process creates a new\n Amazon EC2 instance for an Auto Scaling group, and the Terminate\n process removes an existing Amazon EC2 instance.\n
\n The remaining Auto Scaling process types relate to specific Auto Scaling features:\n
\n If you suspend Launch or Terminate,\n all other process types are affected to varying degrees.\n The following descriptions discuss how each process type\n is affected by a suspension of Launch or\n Terminate.\n
\n The AddToLoadBalancer process type adds instances to the load balancer \n when the instances are launched. If you suspend this process, Auto Scaling will launch \n the instances but will not add them to the load balancer. If you resume the \n AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load \n balancer when they are launched. However, Auto Scaling will not add running instances that\n were launched while the process was suspended; those instances must be added manually using the \n the \n RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference.\n
\n The AlarmNotification process type accepts notifications from\n Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you\n suspend the AlarmNotification process type, Auto Scaling will not\n automatically execute scaling policies that would be triggered by alarms.\n
\n Although the AlarmNotification process type is not directly\n affected by a suspension of Launch or Terminate,\n alarm notifications are often used to signal that a change in the size\n of the Auto Scaling group is warranted. If you suspend Launch\n or Terminate, Auto Scaling might not be able to implement the alarm's\n associated policy.\n
\n The AZRebalance process type seeks to maintain a balanced number of \n instances across Availability Zones within a Region. If you remove an Availability\n Zone from your Auto Scaling group or an Availability Zone otherwise\n becomes unhealthy or unavailable, Auto Scaling launches new instances in an \n unaffected Availability Zone before terminating the unhealthy or unavailable instances. \n When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically\n redistributes the application instances evenly across all of the designated Availability Zones.\n
\n If you call SuspendProcesses on the launch process type, the AZRebalance\n process will neither launch new instances nor terminate existing instances. \n This is because the AZRebalance process terminates existing instances only\n after launching the replacement instances. \n
\n If you call SuspendProcesses on the terminate process type, the AZRebalance\n process can cause your Auto Scaling group to grow up to ten percent larger than\n the maximum size. This is because Auto Scaling allows groups to temporarily grow\n larger than the maximum size during rebalancing activities.\n If Auto Scaling cannot terminate instances, your Auto Scaling group could remain\n up to ten percent larger than the maximum size until you resume the terminate\n process type.\n
\n The HealthCheck process type checks the health of the instances.\n Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing \n informs Auto Scaling that the instance is unhealthy. The HealthCheck\n process can override the health status of an instance that you set with SetInstanceHealth.\n
\n The ReplaceUnhealthy process type terminates instances that are marked\n as unhealthy and subsequently creates new instances to replace them. This process\n calls both of the primary process types--first Terminate and\n then Launch. \n
\n The HealthCheck process type works in conjunction with the \n ReplaceUnhealthly process type to provide health check functionality.\n If you suspend either Launch or Terminate, the\n ReplaceUnhealthy process type will not function properly.\n
\n The ScheduledActions process type performs scheduled actions that you\n create with PutScheduledUpdateGroupAction. Scheduled actions often involve\n launching new instances or terminating existing instances. If you suspend either \n Launch or Terminate, your scheduled actions might not\n function as expected.\n
\n A list of ProcessType names.\n
\n " } }, "documentation": "\n\n The output of the DescribeScalingProcessTypes action.\n
\n " }, "errors": [], "documentation": "\nReturns scaling process types for use in the ResumeProcesses \n and SuspendProcesses actions.
\n\n The name of the Auto Scaling group.\n
\n " }, "ScheduledActionNames": { "shape_name": "ScheduledActionNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n\n A list of scheduled actions to be described. If this\n list is omitted, all scheduled actions are described.\n The list of requested scheduled actions cannot\n contain more than 50 items. If an auto scaling\n group name is provided, the results are limited to\n that group. If unknown scheduled actions are\n requested, they are ignored with no error.\n
\n " }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n The earliest scheduled start time to return. If scheduled\n action names are provided, this field will be ignored.\n
\n " }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n The latest scheduled start time to return. If scheduled\n action names are provided, this field is ignored.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of scheduled actions to return.\n
\n " } }, "documentation": "\n " }, "output": { "shape_name": "ScheduledActionsType", "type": "structure", "members": { "ScheduledUpdateGroupActions": { "shape_name": "ScheduledUpdateGroupActions", "type": "list", "members": { "shape_name": "ScheduledUpdateGroupAction", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group to be updated.\n
\n " }, "ScheduledActionName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of this scheduled action.\n
\n " }, "ScheduledActionARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The Amazon Resource Name (ARN) of this scheduled action.\n
\n " }, "Time": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Time is deprecated.
The time that the action is scheduled to begin.\n Time is an alias for StartTime.\n
\n The time that the action is scheduled to begin.\n This value can be up to one month in the future.\n
\nWhen StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.
\n The time that the action is scheduled to end.\n This value can be up to one month in the future.\n
\n " }, "Recurrence": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The regular schedule that an action occurs.\n
\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n\n The minimum size of the Auto Scaling group.\n
\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n\n The maximum size of the Auto Scaling group.\n
\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n The number of instances you prefer to maintain in your\n Auto Scaling group. \n
\n " } }, "documentation": "\n\n This data type stores information about a\n scheduled update to an Auto Scaling group.\n
\n " }, "documentation": "\n\n A list of scheduled actions designed to update an Auto Scaling group.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch of returned results.\n
\n " } }, "documentation": "\n\n A scaling action that is scheduled for a future time and date.\n An action can be scheduled up to thirty days in advance.\n
\n\n \tStarting with API version 2011-01-01, you can use recurrence \n \tto specify that a scaling action occurs regularly on a schedule. \n
\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of\n actions already executed, see the activity record returned in DescribeScalingActivities. \n
\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "ScheduledUpdateGroupActions", "py_input_token": "next_token" } }, "DescribeTags": { "name": "DescribeTags", "input": { "shape_name": "DescribeTagsType", "type": "structure", "members": { "Filters": { "shape_name": "Filters", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The name of the filter. Valid Name values are: \n \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".\n
\n The value of the filter.\n
\n " } }, "documentation": "\nThe Filter data type.
\n The value of the filter type used to identify the tags \n to be returned. For example, you can filter so that tags are returned \n according to Auto Scaling group, the key and value, or whether \n the new tag will be applied to instances launched after the \n tag is created (PropagateAtLaunch). \n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string that marks the start of the next batch \n of returned results.\n
\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "documentation": "\n\n The maximum number of records to return.\n
\n " } }, "documentation": "\n\n
\n " }, "output": { "shape_name": "TagsType", "type": "structure", "members": { "Tags": { "shape_name": "TagDescriptionList", "type": "list", "members": { "shape_name": "TagDescription", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The name of the Auto Scaling group.\n
\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n
\n The key of the tag.\n
\n " }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n\n The value of the tag.\n
\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n
\n " } }, "documentation": "\n\n The tag applied to an Auto Scaling group.\n
\n " }, "documentation": "\n\n The list of tags.\n
\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n A string used to mark the start of the next\n batch of returned results. \n
\n " } }, "documentation": "\n\n
\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The NextToken value is invalid.\n
\n Lists the Auto Scaling group tags. \n
\n\n You can use filters to limit results when describing tags. For example, you can query for \n tags of a particular Auto Scaling group. You can specify multiple values for a filter. A \n tag must match at least one of the specified values for it to be included in the results. \n
\n\n You can also specify multiple filters. The result includes information for a particular \n tag only if it matches all your filters. If there's no match, no special message is returned.\n
\n\n Termination policies supported by Auto Scaling. They are:\n OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, \n Default\n
The TerminationPolicyTypes data type.
\n Returns a list of all termination policies supported by Auto Scaling. \n
\nThe name or ARN of the Auto Scaling Group.
\n ", "required": true }, "Metrics": { "shape_name": "Metrics", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
\n Disables monitoring of group metrics for the\n Auto Scaling group specified in AutoScalingGroupName.\n You can specify the list of affected metrics with the\n Metrics parameter.\n
The name or ARN of the Auto Scaling group.
\n ", "required": true }, "Metrics": { "shape_name": "Metrics", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
\n The granularity to associate with the metrics to collect.\n Currently, the only legal granularity is \"1Minute\".\n
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\n Enables monitoring of group metrics for the\n Auto Scaling group specified in AutoScalingGroupName.\n You can specify the list of enabled metrics with the\n Metrics parameter.\n
\n Auto Scaling metrics collection can be turned on only \n if the InstanceMonitoring flag, \n in the Auto Scaling group's launch configuration, \n is set to True.\n
\n The name or the Amazon Resource Name (ARN) of the Auto Scaling group.\n
\n " }, "PolicyName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name or ARN of the policy you want to run.\n
\n ", "required": true }, "HonorCooldown": { "shape_name": "HonorCooldown", "type": "boolean", "documentation": "\n \nSet to True if you want Auto Scaling to wait \n for the cooldown period associated with the Auto Scaling group \n to complete before executing the policy.
Set to False if you want Auto Scaling to \n circumvent the cooldown period associated with the \n Auto Scaling group and execute the policy before the \n cooldown period ends. \n
For information about cooldown period, see Cooldown Period \n in the Auto Scaling Developer Guide.
\n " } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n
\n " } ], "documentation": "\nExecutes the specified policy.
\n " }, "PutNotificationConfiguration": { "name": "PutNotificationConfiguration", "input": { "shape_name": "PutNotificationConfigurationType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.\n
\n ", "required": true }, "NotificationTypes": { "shape_name": "AutoScalingNotificationTypes", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\nThe type of event that will cause the notification to be sent. For details \n about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], "documentation": "\n\n Configures an Auto Scaling group to send notifications when \n specified events take place. Subscribers to this topic can have \n messages for events delivered to an endpoint such as a web server \n or email address. \n
\nFor more information see Get Email Notifications When Your Auto Scaling Group Changes
\nA new PutNotificationConfiguration overwrites an existing configuration.
\n The name or ARN of the Auto Scaling group.\n
\n ", "required": true }, "PolicyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\nThe name of the policy you want to create or update.
\n ", "required": true }, "ScalingAdjustment": { "shape_name": "PolicyIncrement", "type": "integer", "documentation": "\n\n The number of instances by which to scale. \n AdjustmentType determines the interpretation\n of this number (e.g., as an absolute number or as\n a percentage of the existing Auto Scaling group\n size). A positive increment adds to the current\n capacity and a negative value removes from the\n current capacity.\n
\n Specifies whether the ScalingAdjustment is \n an absolute number or a percentage of the current\n capacity. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.\n
For more information about the adjustment types supported by Auto Scaling, see Scale Based on Demand.
\n ", "required": true }, "Cooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n\n The amount of time, in seconds, after a scaling \n activity completes and before the next scaling activity can start.\n
\nFor more information, see Cooldown Period
\n " }, "MinAdjustmentStep": { "shape_name": "MinAdjustmentStep", "type": "integer", "documentation": "\n\n Used with AdjustmentType with the value PercentChangeInCapacity, \n the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.\n
\n You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType\n other than PercentChangeInCapacity.\n
\n A policy's Amazon Resource Name (ARN).\n
\n " } }, "documentation": "\n\n The PolicyARNType data type.\n
\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], "documentation": "\n\n Creates or updates a policy for an Auto Scaling group. \n To update an existing policy, use the existing\n policy name and set the parameter(s) you want to change. \n Any existing parameter not changed in an update to an\n existing policy is not changed in this update request.\n
\n\n The name or ARN of the Auto Scaling group.\n
\n ", "required": true }, "ScheduledActionName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of this scaling action.\n
\n ", "required": true }, "Time": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\nTime is deprecated.
The time for this action to start. Time is an alias for StartTime \n and can be specified instead of StartTime, \n or vice versa. If both Time and StartTime are specified, \n their values should be identical. Otherwise,\n PutScheduledUpdateGroupAction will return an error.
The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.
If you try to schedule your action in the past, Auto Scaling returns an error message.
\nWhen StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.
The time for this action to end.
\n " }, "Recurrence": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\t\tThe time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information \n\t\tabout cron syntax, go to Wikipedia, The Free Encyclopedia.
\nWhen StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.
\n The minimum size for the new Auto Scaling group.\n
\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n\n The maximum size for the Auto Scaling group.\n
\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n The number of Amazon EC2 instances that should be running in the group.\n
\n " } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The named Auto Scaling group or launch configuration already exists.\n
\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], "documentation": "\n\n Creates or updates a scheduled scaling action for an Auto Scaling group. \n When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value \n remains unchanged in the affected Auto Scaling group.\n
\nFor information on creating or updating a scheduled action for your Auto Scaling group, \n see Scale Based on a Schedule.
\nAuto Scaling supports the date and time expressed in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only.
\n\n The name or Amazon Resource Name (ARN) of the Auto Scaling group.\n
\n ", "required": true }, "ScalingProcesses": { "shape_name": "ProcessNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n\n The processes that you want to suspend or resume,\n which can include one or more of the following:\n
\n\n To suspend all process types, omit this parameter.\n
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\n Resumes all suspended Auto Scaling processes for an Auto Scaling group.\n For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process.\n
\n " }, "SetDesiredCapacity": { "name": "SetDesiredCapacity", "input": { "shape_name": "SetDesiredCapacityType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n The new capacity setting for the Auto Scaling group.\n
\n ", "required": true }, "HonorCooldown": { "shape_name": "HonorCooldown", "type": "boolean", "documentation": "\n\n By default, SetDesiredCapacity overrides\n any cooldown period associated with the Auto Scaling group. Set to \n True if you want Auto Scaling to wait for the cooldown \n period associated with the Auto Scaling group to complete before \n initiating a scaling activity to set your Auto Scaling group\n to the new capacity setting.\n
\n\n
\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n
\n " } ], "documentation": "\n\n Sets the desired size of the specified AutoScalingGroup. \n
\n\n The identifier of the Amazon EC2 instance.\n
\n ", "required": true }, "HealthStatus": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n\n The health status of the instance. \n Set to Healthy if you want the instance to remain in service.\n Set to Unhealthy if you want the instance to be out of service. Auto\n Scaling will terminate and replace the unhealthy instance.\n
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod \n specified for the group, by default, this call will respect the grace period. Set this \n to False, if you do not want the call to respect the grace period associated \n with the group.
For more information, see the HealthCheckGracePeriod parameter description in the \n CreateAutoScalingGroup action.
\n Sets the health status of a specified instance that belongs to any of your Auto Scaling groups. \n
\nFor more information, see Configure Health Checks for Your Auto Scaling group.
\n " }, "SuspendProcesses": { "name": "SuspendProcesses", "input": { "shape_name": "ScalingProcessQuery", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name or Amazon Resource Name (ARN) of the Auto Scaling group.\n
\n ", "required": true }, "ScalingProcesses": { "shape_name": "ProcessNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n\n The processes that you want to suspend or resume,\n which can include one or more of the following:\n
\n\n To suspend all process types, omit this parameter.\n
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\n Suspends Auto Scaling processes for an Auto Scaling group.\n To suspend specific process types, specify them by name\n with the ScalingProcesses.member.N parameter.\n To suspend all process types, omit the ScalingProcesses.member.N\n parameter. \n
\n Suspending either of the two primary process types,\n Launch or Terminate,\n can prevent other process types from functioning\n properly. \n
\n To resume processes that have been suspended,\n use ResumeProcesses For more information on suspending and resuming Auto Scaling process, \n see Suspend and Resume Auto Scaling Process.\n
\n " }, "TerminateInstanceInAutoScalingGroup": { "name": "TerminateInstanceInAutoScalingGroup", "input": { "shape_name": "TerminateInstanceInAutoScalingGroupType", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n\n The ID of the Amazon EC2 instance to be terminated.\n
\n ", "required": true }, "ShouldDecrementDesiredCapacity": { "shape_name": "ShouldDecrementDesiredCapacity", "type": "boolean", "documentation": "\n\n Specifies whether (true) or not (false)\n terminating this instance should also decrement the\n size of the AutoScalingGroup.\n
\n ", "required": true } }, "documentation": "\n\n\n
\n " }, "output": { "shape_name": "ActivityType", "type": "structure", "members": { "Activity": { "shape_name": "Activity", "type": "structure", "members": { "ActivityId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Specifies the ID of the activity.\n
\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "Description": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Contains a friendly, more verbose description of the scaling activity.\n
\n " }, "Cause": { "shape_name": "XmlStringMaxLen1023", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1023, "documentation": "\n\n Contains the reason the activity was begun.\n
\n ", "required": true }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Provides the start time of this activity.\n
\n ", "required": true }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n\n Provides the end time of this activity.\n
\n " }, "StatusCode": { "shape_name": "ScalingActivityStatusCode", "type": "string", "enum": [ "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "Successful", "Failed", "Cancelled" ], "documentation": "\n\n Contains the current status of the activity.\n
\n ", "required": true }, "StatusMessage": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n Contains a friendly, more verbose description of the activity status.\n
\n " }, "Progress": { "shape_name": "Progress", "type": "integer", "documentation": "\n\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n
\n " }, "Details": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n\n Contains details of the scaling activity.\n
\n " } }, "documentation": "\n\n A scaling Activity.\n
\n " } }, "documentation": "\n\n The output for the TerminateInstanceInAutoScalingGroup action.\n
\n " }, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n
\n " } ], "documentation": "\n\n Terminates the specified instance.\n Optionally, the desired group size can be adjusted.\n
\n\n The name of the Auto Scaling group.\n
\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n\n The name of the launch configuration.\n
\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n\n The minimum size of the Auto Scaling group.\n
\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n\n The maximum size of the Auto Scaling group.\n
\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n\n The desired capacity for the Auto Scaling group.\n
\n " }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n\n The amount of time, in seconds, after a scaling activity \n completes before any further scaling activities can start.\n For more information, \n see Cooldown Period. \n
\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "documentation": "\n\n Availability Zones for the group.\n
\n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n\n The type of health check for the instances in the Auto Scaling group. \n The health check type can either be EC2 for Amazon EC2 or ELB for Elastic Load Balancing.\n
\n The length of time that Auto Scaling waits\n before checking an instance's health status.\n The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see \n DescribeInstanceStatus.\n
\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The name of the cluster placement group, if applicable. For\n more information, go to \n \n Using Cluster Instances\n in the Amazon EC2 User Guide.\n
\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a \n comma-separated list. \n
\n\n When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the \n subnets' Availability Zones match the values you specify for AvailabilityZones.\n
\n For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see \n Launch Auto Scaling Instances into Amazon VPC in the \n the Auto Scaling Developer Guide.\n
\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n\n A standalone termination policy or a list of termination policies used to select the instance to terminate. \n The policies are executed in the order that they are listed. \n
\n\n For more information on creating a termination policy for your Auto Scaling group, go to \n Instance Termination Policy for Your Auto Scaling Group in the \n the Auto Scaling Developer Guide.\n
\n " } }, "documentation": "\n\n \n
\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\n\n
\n " } }, "documentation": "\n\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n
\n " } ], "documentation": "\n\n Updates the configuration for the specified AutoScalingGroup.\n
\n\n To update an Auto Scaling group with a launch configuration\n that has the InstanceMonitoring flag\n set to False, you must first ensure that collection\n of group metrics is disabled. Otherwise, calls to \n UpdateAutoScalingGroup will fail.\n If you have previously enabled group metrics collection, \n you can disable collection of all group metrics\n by calling DisableMetricsCollection.\n \n
\n The new settings are registered upon the completion of this call.\n Any launch configuration settings take effect on any triggers after\n this call returns.\n Scaling activities that are currently in progress aren't affected.\n
\nIf a new value is specified for MinSize without specifying the value for DesiredCapacity, \n and if the new MinSize is larger than the current size of the Auto Scaling Group, there\n will be an implicit call to SetDesiredCapacity to set the group to the new MinSize.
\nIf a new value is specified for MaxSize without specifying the value for DesiredCapacity, and \n the new MaxSize is smaller than the current size of the Auto Scaling Group, there will \n be an implicit call to SetDesiredCapacity to set the group to the new MaxSize.
\nAll other optional parameters are left unchanged if not passed in the request.
\n