openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: Auto Scaling
description:
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: autoscaling x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/autoscaling/ servers: - url: http://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: https://autoscaling.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Auto Scaling multi-region endpoint - url: http://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: https://autoscaling.amazonaws.com variables: {} description: The general Auto Scaling endpoint for US East (N. Virginia) - url: http://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) - url: https://autoscaling.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#Action=AttachInstances: get: x-aws-operation-name: AttachInstances operationId: GET_AttachInstances description:Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_AttachInstances480Example: summary: Default GET_AttachInstances 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: GET_AttachInstances481Example: summary: Default GET_AttachInstances 481 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: The IDs of the instances. You can specify up to 20 instances. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - AttachInstances - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Attach Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachInstances operationId: POST_AttachInstances description:Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_AttachInstances480Example: summary: Default POST_AttachInstances 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: POST_AttachInstances481Example: summary: Default POST_AttachInstances 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachInstancesQuery" parameters: - name: Action in: query required: true schema: type: string enum: - AttachInstances - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Attach Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=AttachLoadBalancerTargetGroups: get: x-aws-operation-name: AttachLoadBalancerTargetGroups operationId: GET_AttachLoadBalancerTargetGroups description: 'This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify
how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation
and AttachTrafficSources on the same Auto Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancerTargetGroupsResultType" examples: GET_AttachLoadBalancerTargetGroups200Example: summary: Default GET_AttachLoadBalancerTargetGroups 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_AttachLoadBalancerTargetGroups480Example: summary: Default GET_AttachLoadBalancerTargetGroups 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: GET_AttachLoadBalancerTargetGroups481Example: summary: Default GET_AttachLoadBalancerTargetGroups 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: TargetGroupARNs in: query required: true description: The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen511" - name: Action in: query required: true schema: type: string enum: - AttachLoadBalancerTargetGroups - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Attach Load Balancer Target Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachLoadBalancerTargetGroups operationId: POST_AttachLoadBalancerTargetGroups description: 'This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify
how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation
and AttachTrafficSources on the same Auto Scaling group.
Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
' responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancerTargetGroupsResultType" examples: POST_AttachLoadBalancerTargetGroups200Example: summary: Default POST_AttachLoadBalancerTargetGroups 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_AttachLoadBalancerTargetGroups480Example: summary: Default POST_AttachLoadBalancerTargetGroups 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: POST_AttachLoadBalancerTargetGroups481Example: summary: Default POST_AttachLoadBalancerTargetGroups 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancerTargetGroupsType" parameters: - name: Action in: query required: true schema: type: string enum: - AttachLoadBalancerTargetGroups - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Attach Load Balancer Target Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=AttachLoadBalancers: get: x-aws-operation-name: AttachLoadBalancers operationId: GET_AttachLoadBalancers description:This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to
simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and
AttachTrafficSources on the same Auto Scaling group.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancersResultType" examples: GET_AttachLoadBalancers200Example: summary: Default GET_AttachLoadBalancers 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_AttachLoadBalancers480Example: summary: Default GET_AttachLoadBalancers 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: GET_AttachLoadBalancers481Example: summary: Default GET_AttachLoadBalancers 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: LoadBalancerNames in: query required: true description: The names of the load balancers. You can specify up to 10 load balancers. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - AttachLoadBalancers - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Attach Load Balancers x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachLoadBalancers operationId: POST_AttachLoadBalancers description:This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to
simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and
AttachTrafficSources on the same Auto Scaling group.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancersResultType" examples: POST_AttachLoadBalancers200Example: summary: Default POST_AttachLoadBalancers 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_AttachLoadBalancers480Example: summary: Default POST_AttachLoadBalancers 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: POST_AttachLoadBalancers481Example: summary: Default POST_AttachLoadBalancers 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachLoadBalancersType" parameters: - name: Action in: query required: true schema: type: string enum: - AttachLoadBalancers - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Attach Load Balancers x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=AttachTrafficSources: get: x-aws-operation-name: AttachTrafficSources operationId: GET_AttachTrafficSources description:Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachTrafficSourcesResultType" examples: GET_AttachTrafficSources200Example: summary: Default GET_AttachTrafficSources 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_AttachTrafficSources480Example: summary: Default GET_AttachTrafficSources 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: GET_AttachTrafficSources481Example: summary: Default GET_AttachTrafficSources 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: TrafficSources in: query required: true description: The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources. schema: type: array items: $ref: "#/components/schemas/TrafficSourceIdentifier" - name: Action in: query required: true schema: type: string enum: - AttachTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Attach Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: AttachTrafficSources operationId: POST_AttachTrafficSources description:Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
Application Load Balancer
Classic Load Balancer
Gateway Load Balancer
Network Load Balancer
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AttachTrafficSourcesResultType" examples: POST_AttachTrafficSources200Example: summary: Default POST_AttachTrafficSources 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_AttachTrafficSources480Example: summary: Default POST_AttachTrafficSources 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: POST_AttachTrafficSources481Example: summary: Default POST_AttachTrafficSources 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/AttachTrafficSourcesType" parameters: - name: Action in: query required: true schema: type: string enum: - AttachTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Attach Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=BatchDeleteScheduledAction: get: x-aws-operation-name: BatchDeleteScheduledAction operationId: GET_BatchDeleteScheduledAction description: Deletes one or more scheduled actions for the specified Auto Scaling group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/BatchDeleteScheduledActionAnswer" examples: GET_BatchDeleteScheduledAction200Example: summary: Default GET_BatchDeleteScheduledAction 200 response x-microcks-default: true value: FailedScheduledActions: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_BatchDeleteScheduledAction480Example: summary: Default GET_BatchDeleteScheduledAction 480 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScheduledActionNames in: query required: true description: "The names of the scheduled actions to delete. The maximum number allowed is 50. " schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - BatchDeleteScheduledAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Batch Delete Scheduled Action x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: BatchDeleteScheduledAction operationId: POST_BatchDeleteScheduledAction description: Deletes one or more scheduled actions for the specified Auto Scaling group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/BatchDeleteScheduledActionAnswer" examples: POST_BatchDeleteScheduledAction200Example: summary: Default POST_BatchDeleteScheduledAction 200 response x-microcks-default: true value: FailedScheduledActions: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_BatchDeleteScheduledAction480Example: summary: Default POST_BatchDeleteScheduledAction 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/BatchDeleteScheduledActionType" parameters: - name: Action in: query required: true schema: type: string enum: - BatchDeleteScheduledAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Batch Delete Scheduled Action x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=BatchPutScheduledUpdateGroupAction: get: x-aws-operation-name: BatchPutScheduledUpdateGroupAction operationId: GET_BatchPutScheduledUpdateGroupAction description: Creates or updates one or more scheduled scaling actions for an Auto Scaling group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/BatchPutScheduledUpdateGroupActionAnswer" examples: GET_BatchPutScheduledUpdateGroupAction200Example: summary: Default GET_BatchPutScheduledUpdateGroupAction 200 response x-microcks-default: true value: FailedScheduledUpdateGroupActions: example-string "480": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: GET_BatchPutScheduledUpdateGroupAction480Example: summary: Default GET_BatchPutScheduledUpdateGroupAction 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_BatchPutScheduledUpdateGroupAction481Example: summary: Default GET_BatchPutScheduledUpdateGroupAction 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScheduledUpdateGroupActions in: query required: true description: One or more scheduled actions. The maximum number allowed is 50. schema: type: array items: $ref: "#/components/schemas/ScheduledUpdateGroupActionRequest" - name: Action in: query required: true schema: type: string enum: - BatchPutScheduledUpdateGroupAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Batch Put Scheduled Update Group Action x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: BatchPutScheduledUpdateGroupAction operationId: POST_BatchPutScheduledUpdateGroupAction description: Creates or updates one or more scheduled scaling actions for an Auto Scaling group. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/BatchPutScheduledUpdateGroupActionAnswer" examples: POST_BatchPutScheduledUpdateGroupAction200Example: summary: Default POST_BatchPutScheduledUpdateGroupAction 200 response x-microcks-default: true value: FailedScheduledUpdateGroupActions: example-string "480": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: POST_BatchPutScheduledUpdateGroupAction480Example: summary: Default POST_BatchPutScheduledUpdateGroupAction 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_BatchPutScheduledUpdateGroupAction481Example: summary: Default POST_BatchPutScheduledUpdateGroupAction 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/BatchPutScheduledUpdateGroupActionType" parameters: - name: Action in: query required: true schema: type: string enum: - BatchPutScheduledUpdateGroupAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Batch Put Scheduled Update Group Action x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=CancelInstanceRefresh: get: x-aws-operation-name: CancelInstanceRefresh operationId: GET_CancelInstanceRefresh description:Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error
occurs.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CancelInstanceRefreshAnswer" examples: GET_CancelInstanceRefresh200Example: summary: Default GET_CancelInstanceRefresh 200 response x-microcks-default: true value: InstanceRefreshId: example-id-1234 "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_CancelInstanceRefresh480Example: summary: Default GET_CancelInstanceRefresh 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_CancelInstanceRefresh481Example: summary: Default GET_CancelInstanceRefresh 481 response x-microcks-default: true value: {} "482": description: ActiveInstanceRefreshNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ActiveInstanceRefreshNotFoundFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - CancelInstanceRefresh - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Cancel Instance Refresh x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CancelInstanceRefresh operationId: POST_CancelInstanceRefresh description:Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error
occurs.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CancelInstanceRefreshAnswer" examples: POST_CancelInstanceRefresh200Example: summary: Default POST_CancelInstanceRefresh 200 response x-microcks-default: true value: InstanceRefreshId: example-id-1234 "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_CancelInstanceRefresh480Example: summary: Default POST_CancelInstanceRefresh 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_CancelInstanceRefresh481Example: summary: Default POST_CancelInstanceRefresh 481 response x-microcks-default: true value: {} "482": description: ActiveInstanceRefreshNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ActiveInstanceRefreshNotFoundFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CancelInstanceRefreshType" parameters: - name: Action in: query required: true schema: type: string enum: - CancelInstanceRefresh - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Cancel Instance Refresh x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=CompleteLifecycleAction: get: x-aws-operation-name: CompleteLifecycleAction operationId: GET_CompleteLifecycleAction description:Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CompleteLifecycleActionAnswer" examples: GET_CompleteLifecycleAction200Example: summary: Default GET_CompleteLifecycleAction 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_CompleteLifecycleAction480Example: summary: Default GET_CompleteLifecycleAction 480 response x-microcks-default: true value: {} parameters: - name: LifecycleHookName in: query required: true description: The name of the lifecycle hook. schema: type: string pattern: "[A-Za-z0-9\\-_\\/]+" minLength: 1 maxLength: 255 - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 1600 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: LifecycleActionToken in: query required: false description: A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook. schema: type: string minLength: 36 maxLength: 36 - name: LifecycleActionResult in: query required: true description: The action for the group to take. You can specify eitherCONTINUE or ABANDON.
schema:
type: string
- name: InstanceId
in: query
required: false
description: The ID of the instance.
schema:
type: string
minLength: 1
maxLength: 19
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: Action
in: query
required: true
schema:
type: string
enum:
- CompleteLifecycleAction
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Complete Lifecycle Action
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: CompleteLifecycleAction
operationId: POST_CompleteLifecycleAction
description: Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/CompleteLifecycleActionAnswer" examples: POST_CompleteLifecycleAction200Example: summary: Default POST_CompleteLifecycleAction 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_CompleteLifecycleAction480Example: summary: Default POST_CompleteLifecycleAction 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/CompleteLifecycleActionType" parameters: - name: Action in: query required: true schema: type: string enum: - CompleteLifecycleAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Complete Lifecycle Action x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=CreateAutoScalingGroup: get: x-aws-operation-name: CreateAutoScalingGroup operationId: GET_CreateAutoScalingGroup description: 'We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these
sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that
you use for weighting instances.
The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy)
or a launch configuration (LaunchConfigurationName or InstanceId).
Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate
or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
$Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions
can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the
value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2
Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch
templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
- name: MixedInstancesPolicy
in: query
required: false
description: The mixed instances policy. For more information, see Auto Scaling
groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
schema:
type: object
properties:
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplate"
- description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
InstancesDistribution:
allOf:
- $ref: "#/components/schemas/InstancesDistribution"
- description: The instances distribution.
description: Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- name: InstanceId in: query required: false description: The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide. schema: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MinSize in: query required: true description: The minimum size of the group. schema: type: integer - name: MaxSize in: query required: true description:The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize to
meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how many units
each instance contributes to the desired capacity of the group).
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: 300 seconds
VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
schema:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
- name: LoadBalancerNames
in: query
required: false
description: A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the
TargetGroupARNs property instead.
schema:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
- name: TargetGroupARNs
in: query
required: false
description: The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups.
The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling
group in the Amazon EC2 Auto Scaling User Guide.
schema:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen511"
- name: HealthCheckType
in: query
required: false
description: A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2
is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to
a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set
the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier with
AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
schema:
type: string
minLength: 1
maxLength: 2047
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: TerminationPolicies
in: query
required: false
description: 'A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour
| NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
schema:
type: string
minLength: 1
maxLength: 1600
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: MaxInstanceLifetime
in: query
required: false
description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than
86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on
maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
schema:
type: integer
- name: Context
in: query
required: false
description: Reserved.
schema:
type: string
- name: DesiredCapacityType
in: query
required: false
description: 'The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection
only. For more information, see Creating an Auto Scaling group using attribute-based
instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance
warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping
the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
' schema: type: integer - name: TrafficSources in: query required: false description: "The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice." schema: type: array items: $ref: "#/components/schemas/TrafficSourceIdentifier" - name: Action in: query required: true schema: type: string enum: - CreateAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Create Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateAutoScalingGroup operationId: POST_CreateAutoScalingGroup description: 'We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these
sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that
you use for weighting instances.
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
If you specify
InstanceId, an ImageId is not required.
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
schema: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: InstanceType in: query required: false description:Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId, an InstanceType is not required.
The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
description: Describes whether detailed monitoring is enabled for the Auto Scaling instances.
- name: SpotPrice
in: query
required: false
description: 'The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 0.001
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to Amazon
EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS
optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon
EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.
If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address.
For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User
Guide.
If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and
can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value
of this property to dedicated. For more information, see Configuring instance
tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier
when you create your group.
Valid values: default | dedicated
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If
the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials
without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are
returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role
credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
" HttpEndpoint: allOf: - $ref: "#/components/schemas/InstanceMetadataEndpointState" - description:This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_CreateOrUpdateTags480Example: summary: Default GET_CreateOrUpdateTags 480 response x-microcks-default: true value: {} "481": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: GET_CreateOrUpdateTags481Example: summary: Default GET_CreateOrUpdateTags 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" "483": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" parameters: - name: Tags in: query required: true description: One or more tags. schema: type: array items: $ref: "#/components/schemas/Tag" - name: Action in: query required: true schema: type: string enum: - CreateOrUpdateTags - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Create or Update Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: CreateOrUpdateTags operationId: POST_CreateOrUpdateTags description:Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_CreateOrUpdateTags480Example: summary: Default POST_CreateOrUpdateTags 480 response x-microcks-default: true value: {} "481": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: POST_CreateOrUpdateTags481Example: summary: Default POST_CreateOrUpdateTags 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" "483": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/CreateOrUpdateTagsType" parameters: - name: Action in: query required: true schema: type: string enum: - CreateOrUpdateTags - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Create or Update Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteAutoScalingGroup: get: x-aws-operation-name: DeleteAutoScalingGroup operationId: GET_DeleteAutoScalingGroup description:Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: GET_DeleteAutoScalingGroup480Example: summary: Default GET_DeleteAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: GET_DeleteAutoScalingGroup481Example: summary: Default GET_DeleteAutoScalingGroup 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ForceDelete in: query required: false description: Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This action also deletes any outstanding lifecycle actions associated with the group. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - DeleteAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteAutoScalingGroup operationId: POST_DeleteAutoScalingGroup description:Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: POST_DeleteAutoScalingGroup480Example: summary: Default POST_DeleteAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: POST_DeleteAutoScalingGroup481Example: summary: Default POST_DeleteAutoScalingGroup 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteAutoScalingGroupType" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteLaunchConfiguration: get: x-aws-operation-name: DeleteLaunchConfiguration operationId: GET_DeleteLaunchConfiguration description:Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: GET_DeleteLaunchConfiguration480Example: summary: Default GET_DeleteLaunchConfiguration 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DeleteLaunchConfiguration481Example: summary: Default GET_DeleteLaunchConfiguration 481 response x-microcks-default: true value: {} parameters: - name: LaunchConfigurationName in: query required: true description: The name of the launch configuration. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - DeleteLaunchConfiguration - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Launch Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteLaunchConfiguration operationId: POST_DeleteLaunchConfiguration description:Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: POST_DeleteLaunchConfiguration480Example: summary: Default POST_DeleteLaunchConfiguration 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DeleteLaunchConfiguration481Example: summary: Default POST_DeleteLaunchConfiguration 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/LaunchConfigurationNameType" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteLaunchConfiguration - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Launch Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteLifecycleHook: get: x-aws-operation-name: DeleteLifecycleHook operationId: GET_DeleteLifecycleHook description:Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances,
CONTINUE for terminating instances).
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances,
CONTINUE for terminating instances).
Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DeletePolicy480Example: summary: Default GET_DeletePolicy 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: GET_DeletePolicy481Example: summary: Default GET_DeletePolicy 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: PolicyName in: query required: true description: The name or Amazon Resource Name (ARN) of the policy. schema: type: string minLength: 1 maxLength: 1600 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - DeletePolicy - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeletePolicy operationId: POST_DeletePolicy description:Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DeletePolicy480Example: summary: Default POST_DeletePolicy 480 response x-microcks-default: true value: {} "481": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" examples: POST_DeletePolicy481Example: summary: Default POST_DeletePolicy 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeletePolicyType" parameters: - name: Action in: query required: true schema: type: string enum: - DeletePolicy - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteScheduledAction: get: x-aws-operation-name: DeleteScheduledAction operationId: GET_DeleteScheduledAction description: Deletes the specified scheduled action. responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DeleteScheduledAction480Example: summary: Default GET_DeleteScheduledAction 480 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScheduledActionName in: query required: true description: The name of the action to delete. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - DeleteScheduledAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Scheduled Action x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteScheduledAction operationId: POST_DeleteScheduledAction description: Deletes the specified scheduled action. responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DeleteScheduledAction480Example: summary: Default POST_DeleteScheduledAction 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteScheduledActionType" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteScheduledAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Scheduled Action x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteTags: get: x-aws-operation-name: DeleteTags operationId: GET_DeleteTags description: Deletes the specified tags. responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DeleteTags480Example: summary: Default GET_DeleteTags 480 response x-microcks-default: true value: {} "481": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: GET_DeleteTags481Example: summary: Default GET_DeleteTags 481 response x-microcks-default: true value: {} parameters: - name: Tags in: query required: true description: One or more tags. schema: type: array items: $ref: "#/components/schemas/Tag" - name: Action in: query required: true schema: type: string enum: - DeleteTags - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteTags operationId: POST_DeleteTags description: Deletes the specified tags. responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DeleteTags480Example: summary: Default POST_DeleteTags 480 response x-microcks-default: true value: {} "481": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: POST_DeleteTags481Example: summary: Default POST_DeleteTags 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteTagsType" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteTags - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DeleteWarmPool: get: x-aws-operation-name: DeleteWarmPool operationId: GET_DeleteWarmPool description:Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteWarmPoolAnswer" examples: GET_DeleteWarmPool200Example: summary: Default GET_DeleteWarmPool 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_DeleteWarmPool480Example: summary: Default GET_DeleteWarmPool 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DeleteWarmPool481Example: summary: Default GET_DeleteWarmPool 481 response x-microcks-default: true value: {} "482": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" "483": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ForceDelete in: query required: false description: Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - DeleteWarmPool - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Delete Warm Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DeleteWarmPool operationId: POST_DeleteWarmPool description:Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DeleteWarmPoolAnswer" examples: POST_DeleteWarmPool200Example: summary: Default POST_DeleteWarmPool 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_DeleteWarmPool480Example: summary: Default POST_DeleteWarmPool 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DeleteWarmPool481Example: summary: Default POST_DeleteWarmPool 481 response x-microcks-default: true value: {} "482": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" "483": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DeleteWarmPoolType" parameters: - name: Action in: query required: true schema: type: string enum: - DeleteWarmPool - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Delete Warm Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeAccountLimits: get: x-aws-operation-name: DescribeAccountLimits operationId: GET_DescribeAccountLimits description:Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeAccountLimitsAnswer" examples: GET_DescribeAccountLimits200Example: summary: Default GET_DescribeAccountLimits 200 response x-microcks-default: true value: MaxNumberOfAutoScalingGroups: example-string MaxNumberOfLaunchConfigurations: example-string NumberOfAutoScalingGroups: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeAccountLimits480Example: summary: Default GET_DescribeAccountLimits 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeAccountLimits - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Describe Account Limits x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeAccountLimits operationId: POST_DescribeAccountLimits description:Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeAccountLimitsAnswer" examples: POST_DescribeAccountLimits200Example: summary: Default POST_DescribeAccountLimits 200 response x-microcks-default: true value: MaxNumberOfAutoScalingGroups: example-string MaxNumberOfLaunchConfigurations: example-string NumberOfAutoScalingGroups: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeAccountLimits480Example: summary: Default POST_DescribeAccountLimits 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeAccountLimits - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Account Limits x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeAdjustmentTypes: get: x-aws-operation-name: DescribeAdjustmentTypes operationId: GET_DescribeAdjustmentTypes description:Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AutoScalingGroupsType" examples: GET_DescribeAutoScalingGroups200Example: summary: Default GET_DescribeAutoScalingGroups 200 response x-microcks-default: true value: AutoScalingGroups: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeAutoScalingGroups480Example: summary: Default GET_DescribeAutoScalingGroups 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeAutoScalingGroups481Example: summary: Default GET_DescribeAutoScalingGroups 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupNames in: query required: false description:The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords property.
If you omit this property, all Auto Scaling groups are described.
schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
schema:
type: integer
- name: Filters
in: query
required: false
description: "One or more filters to limit the results based on specific tags. "
schema:
type: array
items:
$ref: "#/components/schemas/Filter"
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Auto Scaling Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeAutoScalingGroups
operationId: POST_DescribeAutoScalingGroups
description: Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AutoScalingGroupsType" examples: POST_DescribeAutoScalingGroups200Example: summary: Default POST_DescribeAutoScalingGroups 200 response x-microcks-default: true value: AutoScalingGroups: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeAutoScalingGroups480Example: summary: Default POST_DescribeAutoScalingGroups 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeAutoScalingGroups481Example: summary: Default POST_DescribeAutoScalingGroups 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/AutoScalingGroupNamesType" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeAutoScalingGroups - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Auto Scaling Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeAutoScalingInstances: get: x-aws-operation-name: DescribeAutoScalingInstances operationId: GET_DescribeAutoScalingInstances description: Gets information about the Auto Scaling instances in the account and Region. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/AutoScalingInstancesType" examples: GET_DescribeAutoScalingInstances200Example: summary: Default GET_DescribeAutoScalingInstances 200 response x-microcks-default: true value: AutoScalingInstances: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeAutoScalingInstances480Example: summary: Default GET_DescribeAutoScalingInstances 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeAutoScalingInstances481Example: summary: Default GET_DescribeAutoScalingInstances 481 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: "The IDs of the instances. If you omit this property, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
Array Members: Maximum number of 50 items.
" schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 50.
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Auto Scaling Instances
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeAutoScalingInstances
operationId: POST_DescribeAutoScalingInstances
description: Gets information about the Auto Scaling instances in the account and Region.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/AutoScalingInstancesType"
examples:
POST_DescribeAutoScalingInstances200Example:
summary: Default POST_DescribeAutoScalingInstances 200 response
x-microcks-default: true
value:
AutoScalingInstances: example-string
NextToken: example-string
"480":
description: InvalidNextToken
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidNextToken"
examples:
POST_DescribeAutoScalingInstances480Example:
summary: Default POST_DescribeAutoScalingInstances 480 response
x-microcks-default: true
value: {}
"481":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
POST_DescribeAutoScalingInstances481Example:
summary: Default POST_DescribeAutoScalingInstances 481 response
x-microcks-default: true
value: {}
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeAutoScalingInstancesType"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Auto Scaling Instances
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/#Action=DescribeAutoScalingNotificationTypes:
get:
x-aws-operation-name: DescribeAutoScalingNotificationTypes
operationId: GET_DescribeAutoScalingNotificationTypes
description: Describes the notification types that are supported by Amazon EC2 Auto Scaling.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeAutoScalingNotificationTypesAnswer"
examples:
GET_DescribeAutoScalingNotificationTypes200Example:
summary: Default GET_DescribeAutoScalingNotificationTypes 200 response
x-microcks-default: true
value:
AutoScalingNotificationTypes: example-string
"480":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
GET_DescribeAutoScalingNotificationTypes480Example:
summary: Default GET_DescribeAutoScalingNotificationTypes 480 response
x-microcks-default: true
value: {}
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingNotificationTypes
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Auto Scaling Notification Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeAutoScalingNotificationTypes
operationId: POST_DescribeAutoScalingNotificationTypes
description: Describes the notification types that are supported by Amazon EC2 Auto Scaling.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeAutoScalingNotificationTypesAnswer"
examples:
POST_DescribeAutoScalingNotificationTypes200Example:
summary: Default POST_DescribeAutoScalingNotificationTypes 200 response
x-microcks-default: true
value:
AutoScalingNotificationTypes: example-string
"480":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
POST_DescribeAutoScalingNotificationTypes480Example:
summary: Default POST_DescribeAutoScalingNotificationTypes 480 response
x-microcks-default: true
value: {}
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingNotificationTypes
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Auto Scaling Notification Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/#Action=DescribeInstanceRefreshes:
get:
x-aws-operation-name: DescribeInstanceRefreshes
operationId: GET_DescribeInstanceRefreshes
description: Gets information about the instance refreshes for the specified Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeInstanceRefreshesAnswer" examples: GET_DescribeInstanceRefreshes200Example: summary: Default GET_DescribeInstanceRefreshes 200 response x-microcks-default: true value: InstanceRefreshes: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeInstanceRefreshes480Example: summary: Default GET_DescribeInstanceRefreshes 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeInstanceRefreshes481Example: summary: Default GET_DescribeInstanceRefreshes 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: InstanceRefreshIds in: query required: false description: One or more instance refresh IDs. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceRefreshes
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Instance Refreshes
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeInstanceRefreshes
operationId: POST_DescribeInstanceRefreshes
description: Gets information about the instance refreshes for the specified Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeInstanceRefreshesAnswer" examples: POST_DescribeInstanceRefreshes200Example: summary: Default POST_DescribeInstanceRefreshes 200 response x-microcks-default: true value: InstanceRefreshes: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeInstanceRefreshes480Example: summary: Default POST_DescribeInstanceRefreshes 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeInstanceRefreshes481Example: summary: Default POST_DescribeInstanceRefreshes 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeInstanceRefreshesType" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeInstanceRefreshes - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Instance Refreshes x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeLaunchConfigurations: get: x-aws-operation-name: DescribeLaunchConfigurations operationId: GET_DescribeLaunchConfigurations description: Gets information about the launch configurations in the account and Region. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/LaunchConfigurationsType" examples: GET_DescribeLaunchConfigurations200Example: summary: Default GET_DescribeLaunchConfigurations 200 response x-microcks-default: true value: LaunchConfigurations: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeLaunchConfigurations480Example: summary: Default GET_DescribeLaunchConfigurations 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeLaunchConfigurations481Example: summary: Default GET_DescribeLaunchConfigurations 481 response x-microcks-default: true value: {} parameters: - name: LaunchConfigurationNames in: query required: false description: "The launch configuration names. If you omit this property, all launch configurations are described.
Array Members: Maximum number of 50 items.
" schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Launch Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeLaunchConfigurations
operationId: POST_DescribeLaunchConfigurations
description: Gets information about the launch configurations in the account and Region.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/LaunchConfigurationsType"
examples:
POST_DescribeLaunchConfigurations200Example:
summary: Default POST_DescribeLaunchConfigurations 200 response
x-microcks-default: true
value:
LaunchConfigurations: example-string
NextToken: example-string
"480":
description: InvalidNextToken
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidNextToken"
examples:
POST_DescribeLaunchConfigurations480Example:
summary: Default POST_DescribeLaunchConfigurations 480 response
x-microcks-default: true
value: {}
"481":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
POST_DescribeLaunchConfigurations481Example:
summary: Default POST_DescribeLaunchConfigurations 481 response
x-microcks-default: true
value: {}
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/LaunchConfigurationNamesType"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Launch Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/#Action=DescribeLifecycleHookTypes:
get:
x-aws-operation-name: DescribeLifecycleHookTypes
operationId: GET_DescribeLifecycleHookTypes
description: Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups
API operation and DescribeTrafficSources on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State
value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled
for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService
state.
Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but
it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
100 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLoadBalancerTargetGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Load Balancer Target Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeLoadBalancerTargetGroups
operationId: POST_DescribeLoadBalancerTargetGroups
description: "This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups
API operation and DescribeTrafficSources on the same Auto Scaling group.
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State
value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled
for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService
state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService
state.
Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but
it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources
to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and
DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
To determine
the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is
Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the
Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state,
Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService
state.
Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but
it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeLoadBalancersResponse" examples: GET_DescribeLoadBalancers200Example: summary: Default GET_DescribeLoadBalancers 200 response x-microcks-default: true value: LoadBalancers: example-string NextToken: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeLoadBalancers480Example: summary: Default GET_DescribeLoadBalancers 480 response x-microcks-default: true value: {} "481": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeLoadBalancers481Example: summary: Default GET_DescribeLoadBalancers 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is100 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLoadBalancers
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Load Balancers
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeLoadBalancers
operationId: POST_DescribeLoadBalancers
description: "This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources
to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and
DescribeTrafficSources on the same Auto Scaling group.
Gets information about the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
To determine
the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is
Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the
Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state,
Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService
state.
Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but
it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.
For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeLoadBalancersResponse" examples: POST_DescribeLoadBalancers200Example: summary: Default POST_DescribeLoadBalancers 200 response x-microcks-default: true value: LoadBalancers: example-string NextToken: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeLoadBalancers480Example: summary: Default POST_DescribeLoadBalancers 480 response x-microcks-default: true value: {} "481": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeLoadBalancers481Example: summary: Default POST_DescribeLoadBalancers 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeLoadBalancersRequest" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeLoadBalancers - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Load Balancers x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeMetricCollectionTypes: get: x-aws-operation-name: DescribeMetricCollectionTypes operationId: GET_DescribeMetricCollectionTypes description: Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeMetricCollectionTypesAnswer" examples: GET_DescribeMetricCollectionTypes200Example: summary: Default GET_DescribeMetricCollectionTypes 200 response x-microcks-default: true value: Metrics: example-string Granularities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeMetricCollectionTypes480Example: summary: Default GET_DescribeMetricCollectionTypes 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeMetricCollectionTypes - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Describe Metric Collection Types x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeMetricCollectionTypes operationId: POST_DescribeMetricCollectionTypes description: Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeMetricCollectionTypesAnswer" examples: POST_DescribeMetricCollectionTypes200Example: summary: Default POST_DescribeMetricCollectionTypes 200 response x-microcks-default: true value: Metrics: example-string Granularities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeMetricCollectionTypes480Example: summary: Default POST_DescribeMetricCollectionTypes 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeMetricCollectionTypes - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Metric Collection Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeNotificationConfigurations: get: x-aws-operation-name: DescribeNotificationConfigurations operationId: GET_DescribeNotificationConfigurations description: Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups. responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeNotificationConfigurationsAnswer" examples: GET_DescribeNotificationConfigurations200Example: summary: Default GET_DescribeNotificationConfigurations 200 response x-microcks-default: true value: NotificationConfigurations: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeNotificationConfigurations480Example: summary: Default GET_DescribeNotificationConfigurations 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeNotificationConfigurations481Example: summary: Default GET_DescribeNotificationConfigurations 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupNames in: query required: false description: The name of the Auto Scaling group. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNotificationConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Notification Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeNotificationConfigurations
operationId: POST_DescribeNotificationConfigurations
description: Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeNotificationConfigurationsAnswer"
examples:
POST_DescribeNotificationConfigurations200Example:
summary: Default POST_DescribeNotificationConfigurations 200 response
x-microcks-default: true
value:
NotificationConfigurations: example-string
NextToken: example-string
"480":
description: InvalidNextToken
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidNextToken"
examples:
POST_DescribeNotificationConfigurations480Example:
summary: Default POST_DescribeNotificationConfigurations 480 response
x-microcks-default: true
value: {}
"481":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
POST_DescribeNotificationConfigurations481Example:
summary: Default POST_DescribeNotificationConfigurations 481 response
x-microcks-default: true
value: {}
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribeNotificationConfigurationsType"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNotificationConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Notification Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/#Action=DescribePolicies:
get:
x-aws-operation-name: DescribePolicies
operationId: GET_DescribePolicies
description: Gets information about the scaling policies in the account and Region.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/PoliciesType"
examples:
GET_DescribePolicies200Example:
summary: Default GET_DescribePolicies 200 response
x-microcks-default: true
value:
ScalingPolicies: example-string
NextToken: example-string
"480":
description: InvalidNextToken
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidNextToken"
examples:
GET_DescribePolicies480Example:
summary: Default GET_DescribePolicies 480 response
x-microcks-default: true
value: {}
"481":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
GET_DescribePolicies481Example:
summary: Default GET_DescribePolicies 481 response
x-microcks-default: true
value: {}
"482":
description: ServiceLinkedRoleFailure
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceLinkedRoleFailure"
parameters:
- name: AutoScalingGroupName
in: query
required: false
description: The name of the Auto Scaling group.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: PolicyNames
in: query
required: false
description: "The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
" schema: type: array items: $ref: "#/components/schemas/ResourceName" - name: PolicyTypes in: query required: false description: One or more policy types. The valid values areSimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.
schema:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen64"
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: MaxRecords
in: query
required: false
description: The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribePolicies
operationId: POST_DescribePolicies
description: Gets information about the scaling policies in the account and Region.
responses:
"200":
description: Success
content:
text/xml:
schema:
$ref: "#/components/schemas/PoliciesType"
examples:
POST_DescribePolicies200Example:
summary: Default POST_DescribePolicies 200 response
x-microcks-default: true
value:
ScalingPolicies: example-string
NextToken: example-string
"480":
description: InvalidNextToken
content:
text/xml:
schema:
$ref: "#/components/schemas/InvalidNextToken"
examples:
POST_DescribePolicies480Example:
summary: Default POST_DescribePolicies 480 response
x-microcks-default: true
value: {}
"481":
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: "#/components/schemas/ResourceContentionFault"
examples:
POST_DescribePolicies481Example:
summary: Default POST_DescribePolicies 481 response
x-microcks-default: true
value: {}
"482":
description: ServiceLinkedRoleFailure
content:
text/xml:
schema:
$ref: "#/components/schemas/ServiceLinkedRoleFailure"
requestBody:
content:
text/xml:
schema:
$ref: "#/components/schemas/DescribePoliciesType"
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePolicies
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Policies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/#Action=DescribeScalingActivities:
get:
x-aws-operation-name: DescribeScalingActivities
operationId: GET_DescribeScalingActivities
description: Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to
launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of
the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
Array Members: Maximum number of 50 IDs.
" schema: type: array items: $ref: "#/components/schemas/XmlString" - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: IncludeDeletedGroups in: query required: false description: Indicates whether to include scaling activity from deleted Auto Scaling groups. schema: type: boolean - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is100 and the maximum value is 100.
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeScalingActivities
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Scaling Activities
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeScalingActivities
operationId: POST_DescribeScalingActivities
description: Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to
launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of
the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ScheduledActionsType" examples: GET_DescribeScheduledActions200Example: summary: Default GET_DescribeScheduledActions 200 response x-microcks-default: true value: ScheduledUpdateGroupActions: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeScheduledActions480Example: summary: Default GET_DescribeScheduledActions 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeScheduledActions481Example: summary: Default GET_DescribeScheduledActions 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScheduledActionNames in: query required: false description: "The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
Array Members: Maximum number of 50 actions.
" schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: StartTime in: query required: false description: The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored. schema: type: string format: date-time - name: EndTime in: query required: false description: The latest scheduled start time to return. If scheduled action names are provided, this property is ignored. schema: type: string format: date-time - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a previous call.) schema: type: string x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeScheduledActions
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Scheduled Actions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeScheduledActions
operationId: POST_DescribeScheduledActions
description: Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ScheduledActionsType" examples: POST_DescribeScheduledActions200Example: summary: Default POST_DescribeScheduledActions 200 response x-microcks-default: true value: ScheduledUpdateGroupActions: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeScheduledActions480Example: summary: Default POST_DescribeScheduledActions 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeScheduledActions481Example: summary: Default POST_DescribeScheduledActions 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeScheduledActionsType" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeScheduledActions - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Scheduled Actions x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeTags: get: x-aws-operation-name: DescribeTags operationId: GET_DescribeTags description:Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/TagsType" examples: GET_DescribeTags200Example: summary: Default GET_DescribeTags 200 response x-microcks-default: true value: Tags: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeTags480Example: summary: Default GET_DescribeTags 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeTags481Example: summary: Default GET_DescribeTags 481 response x-microcks-default: true value: {} parameters: - name: Filters in: query required: false description: One or more filters to scope the tags to return. The maximum number of filters per filter type (for example,auto-scaling-group) is 1000.
schema:
type: array
items:
$ref: "#/components/schemas/Filter"
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: MaxRecords
in: query
required: false
description: The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTags
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeTags
operationId: POST_DescribeTags
description: Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/TagsType" examples: POST_DescribeTags200Example: summary: Default POST_DescribeTags 200 response x-microcks-default: true value: Tags: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeTags480Example: summary: Default POST_DescribeTags 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeTags481Example: summary: Default POST_DescribeTags 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeTagsType" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeTags - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeTerminationPolicyTypes: get: x-aws-operation-name: DescribeTerminationPolicyTypes operationId: GET_DescribeTerminationPolicyTypes description:Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeTerminationPolicyTypesAnswer" examples: GET_DescribeTerminationPolicyTypes200Example: summary: Default GET_DescribeTerminationPolicyTypes 200 response x-microcks-default: true value: TerminationPolicyTypes: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeTerminationPolicyTypes480Example: summary: Default GET_DescribeTerminationPolicyTypes 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeTerminationPolicyTypes - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Describe Termination Policy Types x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DescribeTerminationPolicyTypes operationId: POST_DescribeTerminationPolicyTypes description:Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeTerminationPolicyTypesAnswer" examples: POST_DescribeTerminationPolicyTypes200Example: summary: Default POST_DescribeTerminationPolicyTypes 200 response x-microcks-default: true value: TerminationPolicyTypes: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeTerminationPolicyTypes480Example: summary: Default POST_DescribeTerminationPolicyTypes 480 response x-microcks-default: true value: {} parameters: - name: Action in: query required: true schema: type: string enum: - DescribeTerminationPolicyTypes - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Termination Policy Types x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeTrafficSources: get: x-aws-operation-name: DescribeTrafficSources operationId: GET_DescribeTrafficSources description:Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeTrafficSourcesResponse" examples: GET_DescribeTrafficSources200Example: summary: Default GET_DescribeTrafficSources 200 response x-microcks-default: true value: TrafficSources: example-string NextToken: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DescribeTrafficSources480Example: summary: Default GET_DescribeTrafficSources 480 response x-microcks-default: true value: {} "481": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeTrafficSources481Example: summary: Default GET_DescribeTrafficSources 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: TrafficSourceType in: query required: false description:The traffic source type that you want to describe.
The following lists the valid values:
elb if the traffic source is a Classic Load
Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
vpc-lattice if the traffic source is VPC Lattice.
50.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficSources
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Traffic Sources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeTrafficSources
operationId: POST_DescribeTrafficSources
description: Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeTrafficSourcesResponse" examples: POST_DescribeTrafficSources200Example: summary: Default POST_DescribeTrafficSources 200 response x-microcks-default: true value: TrafficSources: example-string NextToken: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DescribeTrafficSources480Example: summary: Default POST_DescribeTrafficSources 480 response x-microcks-default: true value: {} "481": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeTrafficSources481Example: summary: Default POST_DescribeTrafficSources 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeTrafficSourcesRequest" parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DescribeWarmPool: get: x-aws-operation-name: DescribeWarmPool operationId: GET_DescribeWarmPool description:Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeWarmPoolAnswer" examples: GET_DescribeWarmPool200Example: summary: Default GET_DescribeWarmPool 200 response x-microcks-default: true value: WarmPoolConfiguration: example-string Instances: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: GET_DescribeWarmPool480Example: summary: Default GET_DescribeWarmPool 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_DescribeWarmPool481Example: summary: Default GET_DescribeWarmPool 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxRecords in: query required: false description: The maximum number of instances to return with this call. The maximum value is50.
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next set of instances to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeWarmPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Warm Pool
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: DescribeWarmPool
operationId: POST_DescribeWarmPool
description: Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DescribeWarmPoolAnswer" examples: POST_DescribeWarmPool200Example: summary: Default POST_DescribeWarmPool 200 response x-microcks-default: true value: WarmPoolConfiguration: example-string Instances: example-string NextToken: example-string "480": description: InvalidNextToken content: text/xml: schema: $ref: "#/components/schemas/InvalidNextToken" examples: POST_DescribeWarmPool480Example: summary: Default POST_DescribeWarmPool 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_DescribeWarmPool481Example: summary: Default POST_DescribeWarmPool 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/DescribeWarmPoolType" parameters: - name: Action in: query required: true schema: type: string enum: - DescribeWarmPool - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Warm Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DetachInstances: get: x-aws-operation-name: DetachInstances operationId: GET_DetachInstances description:Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DetachInstancesAnswer" examples: GET_DetachInstances200Example: summary: Default GET_DetachInstances 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_DetachInstances480Example: summary: Default GET_DetachInstances 480 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: The IDs of the instances. You can specify up to 20 instances. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ShouldDecrementDesiredCapacity in: query required: true description: Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - DetachInstances - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Detach Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DetachInstances operationId: POST_DetachInstances description:Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/DetachInstancesAnswer" examples: POST_DetachInstances200Example: summary: Default POST_DetachInstances 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DetachInstances480Example: summary: Default POST_DetachInstances 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DetachInstancesQuery" parameters: - name: Action in: query required: true schema: type: string enum: - DetachInstances - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Detach Instances x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=DetachLoadBalancerTargetGroups: get: x-aws-operation-name: DetachLoadBalancerTargetGroups operationId: GET_DetachLoadBalancerTargetGroups description:This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups
API operation and DetachTrafficSources on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
When you
detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target
group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.
You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups
API operation and DetachTrafficSources on the same Auto Scaling group.
Detaches one or more target groups from the specified Auto Scaling group.
When you
detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target
group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.
You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and
DetachTrafficSources on the same Auto Scaling group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer
describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to
simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and
DetachTrafficSources on the same Auto Scaling group.
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer
describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a taffic, it enters the Removing state while deregistering the
instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to
run.
Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a taffic, it enters the Removing state while deregistering the
instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to
run.
Identifies the metrics to disable.
You can specify one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you omit this property, all metrics are disabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - DisableMetricsCollection - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Disable Metrics Collection x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: DisableMetricsCollection operationId: POST_DisableMetricsCollection description: Disables group metrics collection for the specified Auto Scaling group. responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_DisableMetricsCollection480Example: summary: Default POST_DisableMetricsCollection 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/DisableMetricsCollectionQuery" parameters: - name: Action in: query required: true schema: type: string enum: - DisableMetricsCollection - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Disable Metrics Collection x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=EnableMetricsCollection: get: x-aws-operation-name: EnableMetricsCollection operationId: GET_EnableMetricsCollection description:Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_EnableMetricsCollection480Example: summary: Default GET_EnableMetricsCollection 480 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Metrics in: query required: false description:Identifies the metrics to enable.
You can specify one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you specify Granularity and don't specify any metrics, all metrics are enabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Granularity in: query required: true description: The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is1Minute.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableMetricsCollection
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Enable Metrics Collection
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: EnableMetricsCollection
operationId: POST_EnableMetricsCollection
description: Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_EnableMetricsCollection480Example: summary: Default POST_EnableMetricsCollection 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/EnableMetricsCollectionQuery" parameters: - name: Action in: query required: true schema: type: string enum: - EnableMetricsCollection - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Enable Metrics Collection x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=EnterStandby: get: x-aws-operation-name: EnterStandby operationId: GET_EnterStandby description:Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/EnterStandbyAnswer" examples: GET_EnterStandby200Example: summary: Default GET_EnterStandby 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_EnterStandby480Example: summary: Default GET_EnterStandby 480 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: The IDs of the instances. You can specify up to 20 instances. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ShouldDecrementDesiredCapacity in: query required: true description: Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved toStandby mode.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnterStandby
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Enter Standby
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
x-aws-operation-name: EnterStandby
operationId: POST_EnterStandby
description: Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/EnterStandbyAnswer" examples: POST_EnterStandby200Example: summary: Default POST_EnterStandby 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_EnterStandby480Example: summary: Default POST_EnterStandby 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/EnterStandbyQuery" parameters: - name: Action in: query required: true schema: type: string enum: - EnterStandby - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Enter Standby x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=ExecutePolicy: get: x-aws-operation-name: ExecutePolicy operationId: GET_ExecutePolicy description: Executes the specified policy. This can be useful for testing the design of your scaling policy. responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: GET_ExecutePolicy480Example: summary: Default GET_ExecutePolicy 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_ExecutePolicy481Example: summary: Default GET_ExecutePolicy 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: PolicyName in: query required: true description: The name or ARN of the policy. schema: type: string minLength: 1 maxLength: 1600 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: HonorCooldown in: query required: false description:Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
Valid only if the policy type is
SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the
Amazon EC2 Auto Scaling User Guide.
The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use.
For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.
If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
Required if the policy type is StepScaling and not supported
otherwise.
The breach threshold for the alarm.
Required if the policy type is StepScaling and not supported otherwise.
Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ExitStandbyAnswer" examples: GET_ExitStandby200Example: summary: Default GET_ExitStandby 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_ExitStandby480Example: summary: Default GET_ExitStandby 480 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: The IDs of the instances. You can specify up to 20 instances. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - ExitStandby - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Exit Standby x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ExitStandby operationId: POST_ExitStandby description:Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ExitStandbyAnswer" examples: POST_ExitStandby200Example: summary: Default POST_ExitStandby 200 response x-microcks-default: true value: Activities: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_ExitStandby480Example: summary: Default POST_ExitStandby 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/ExitStandbyQuery" parameters: - name: Action in: query required: true schema: type: string enum: - ExitStandby - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Exit Standby x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=GetPredictiveScalingForecast: get: x-aws-operation-name: GetPredictiveScalingForecast operationId: GET_GetPredictiveScalingForecast description:Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPredictiveScalingForecastAnswer" examples: GET_GetPredictiveScalingForecast200Example: summary: Default GET_GetPredictiveScalingForecast 200 response x-microcks-default: true value: LoadForecast: example-string CapacityForecast: example-string UpdateTime: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_GetPredictiveScalingForecast480Example: summary: Default GET_GetPredictiveScalingForecast 480 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: PolicyName in: query required: true description: The name of the policy. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: StartTime in: query required: true description: The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time. schema: type: string format: date-time - name: EndTime in: query required: true description:The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.
schema: type: string format: date-time - name: Action in: query required: true schema: type: string enum: - GetPredictiveScalingForecast - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Get Predictive Scaling Forecast x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: GetPredictiveScalingForecast operationId: POST_GetPredictiveScalingForecast description:Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/GetPredictiveScalingForecastAnswer" examples: POST_GetPredictiveScalingForecast200Example: summary: Default POST_GetPredictiveScalingForecast 200 response x-microcks-default: true value: LoadForecast: example-string CapacityForecast: example-string UpdateTime: example-string "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_GetPredictiveScalingForecast480Example: summary: Default POST_GetPredictiveScalingForecast 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/GetPredictiveScalingForecastType" parameters: - name: Action in: query required: true schema: type: string enum: - GetPredictiveScalingForecast - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Get Predictive Scaling Forecast x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=PutLifecycleHook: get: x-aws-operation-name: PutLifecycleHook operationId: GET_PutLifecycleHook description:Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PutLifecycleHookAnswer" examples: GET_PutLifecycleHook200Example: summary: Default GET_PutLifecycleHook 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_PutLifecycleHook480Example: summary: Default GET_PutLifecycleHook 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_PutLifecycleHook481Example: summary: Default GET_PutLifecycleHook 481 response x-microcks-default: true value: {} parameters: - name: LifecycleHookName in: query required: true description: The name of the lifecycle hook. schema: type: string pattern: "[A-Za-z0-9\\-_\\/]+" minLength: 1 maxLength: 255 - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: LifecycleTransition in: query required: false description:The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
Required for new lifecycle hooks, but optional when updating existing hooks.
schema: type: string - name: RoleARN in: query required: false description:The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: NotificationTargetARN in: query required: false description: 'The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a
test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
30 to 7200 seconds. The default value is
3600 seconds (1 hour).
schema:
type: integer
- name: DefaultResult
in: query
required: false
description: "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.
Valid values:
CONTINUE | ABANDON
Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PutLifecycleHookAnswer" examples: POST_PutLifecycleHook200Example: summary: Default POST_PutLifecycleHook 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_PutLifecycleHook480Example: summary: Default POST_PutLifecycleHook 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_PutLifecycleHook481Example: summary: Default POST_PutLifecycleHook 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/PutLifecycleHookType" parameters: - name: Action in: query required: true schema: type: string enum: - PutLifecycleHook - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Lifecycle Hook x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=PutNotificationConfiguration: get: x-aws-operation-name: PutNotificationConfiguration operationId: GET_PutNotificationConfiguration description:Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
responses: "200": description: Success "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_PutNotificationConfiguration480Example: summary: Default GET_PutNotificationConfiguration 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_PutNotificationConfiguration481Example: summary: Default GET_PutNotificationConfiguration 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: TopicARN in: query required: true description: The Amazon Resource Name (ARN) of the Amazon SNS topic. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: NotificationTypes in: query required: true description: The type of event that causes the notification to be sent. To query the notification types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - PutNotificationConfiguration - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Put Notification Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: PutNotificationConfiguration operationId: POST_PutNotificationConfiguration description:Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
responses: "200": description: Success "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_PutNotificationConfiguration480Example: summary: Default POST_PutNotificationConfiguration 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_PutNotificationConfiguration481Example: summary: Default POST_PutNotificationConfiguration 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" requestBody: content: text/xml: schema: $ref: "#/components/schemas/PutNotificationConfigurationType" parameters: - name: Action in: query required: true schema: type: string enum: - PutNotificationConfiguration - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Notification Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=PutScalingPolicy: get: x-aws-operation-name: PutScalingPolicy operationId: GET_PutScalingPolicy description:Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PolicyARNType" examples: GET_PutScalingPolicy200Example: summary: Default GET_PutScalingPolicy 200 response x-microcks-default: true value: PolicyARN: arn:aws:service:us-east-1:123456789012:resource/example Alarms: example-string "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_PutScalingPolicy480Example: summary: Default GET_PutScalingPolicy 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_PutScalingPolicy481Example: summary: Default GET_PutScalingPolicy 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: PolicyName in: query required: true description: The name of the policy. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: PolicyType in: query required: false description: "One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)
PredictiveScaling
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
Required if the policy type is StepScaling or SimpleScaling. For more information, see
Scaling adjustment types in the Amazon EC2 Auto Scaling User
Guide.
MinAdjustmentMagnitude instead.
schema:
type: integer
deprecated: true
- name: MinAdjustmentMagnitude
in: query
required: false
description: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto
Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However,
because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
Valid only if the policy type is
StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User
Guide.
Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest
instance weight.
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
Required if the policy type is SimpleScaling. (Not used with any other policy type.)
A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
Valid only if
the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide.
Default: None
' schema: type: integer - name: MetricAggregationType in: query required: false description:The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the
value is treated as Average.
Valid only if the policy type is StepScaling.
A set of adjustments that enable you to scale based on the size of the alarm breach.
Required if the policy type is StepScaling. (Not used with any other
policy type.)
Not needed if the default instance warmup is defined for the group.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is TargetTrackingScaling or StepScaling.
The default is to use the value for the default
instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
A target tracking scaling policy. Provides support for predefined or custom metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property with
the PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is TargetTrackingScaling.
The target value for the metric.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
false.
description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
- name: Enabled
in: query
required: false
description: Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling
User Guide.
schema:
type: boolean
- name: PredictiveScalingConfiguration
in: query
required: false
description: A predictive scaling policy. Provides support for predefined and custom metrics.
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is PredictiveScaling.
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Mode: allOf: - $ref: "#/components/schemas/PredictiveScalingMode" - description: The predictive scaling mode. Defaults toForecastOnly if not specified.
SchedulingBufferTime:
allOf:
- $ref: "#/components/schemas/PredictiveScalingSchedulingBufferTime"
- description: The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
MaxCapacityBreachBehavior: allOf: - $ref: "#/components/schemas/PredictiveScalingMaxCapacityBreachBehavior" - description:Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to
HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out
capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale
out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the
value for MaxCapacityBuffer.
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if
the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PolicyARNType" examples: POST_PutScalingPolicy200Example: summary: Default POST_PutScalingPolicy 200 response x-microcks-default: true value: PolicyARN: arn:aws:service:us-east-1:123456789012:resource/example Alarms: example-string "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_PutScalingPolicy480Example: summary: Default POST_PutScalingPolicy 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_PutScalingPolicy481Example: summary: Default POST_PutScalingPolicy 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" requestBody: content: text/xml: schema: $ref: "#/components/schemas/PutScalingPolicyType" parameters: - name: Action in: query required: true schema: type: string enum: - PutScalingPolicy - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Scaling Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=PutScheduledUpdateGroupAction: get: x-aws-operation-name: PutScheduledUpdateGroupAction operationId: GET_PutScheduledUpdateGroupAction description:Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
responses: "200": description: Success "480": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: GET_PutScheduledUpdateGroupAction480Example: summary: Default GET_PutScheduledUpdateGroupAction 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_PutScheduledUpdateGroupAction481Example: summary: Default GET_PutScheduledUpdateGroupAction 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScheduledActionName in: query required: true description: The name of this scaling action. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Time in: query required: false description: This property is no longer used. schema: type: string format: date-time - name: StartTime in: query required: false description:The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z").
If you
specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
"2021-06-01T00:00:00Z".
schema:
type: string
format: date-time
- name: Recurrence
in: query
required: false
description: 'The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must
be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
When StartTime and EndTime
are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
' schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MinSize in: query required: false description: The minimum size of the Auto Scaling group. schema: type: integer - name: MaxSize in: query required: false description: The maximum size of the Auto Scaling group. schema: type: integer - name: DesiredCapacity in: query required: false description: "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.
You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity.
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones,
derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
responses: "200": description: Success "480": description: AlreadyExistsFault content: text/xml: schema: $ref: "#/components/schemas/AlreadyExistsFault" examples: POST_PutScheduledUpdateGroupAction480Example: summary: Default POST_PutScheduledUpdateGroupAction 480 response x-microcks-default: true value: {} "481": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_PutScheduledUpdateGroupAction481Example: summary: Default POST_PutScheduledUpdateGroupAction 481 response x-microcks-default: true value: {} "482": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/PutScheduledUpdateGroupActionType" parameters: - name: Action in: query required: true schema: type: string enum: - PutScheduledUpdateGroupAction - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Scheduled Update Group Action x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=PutWarmPool: get: x-aws-operation-name: PutWarmPool operationId: GET_PutWarmPool description:Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PutWarmPoolAnswer" examples: GET_PutWarmPool200Example: summary: Default GET_PutWarmPool 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_PutWarmPool480Example: summary: Default GET_PutWarmPool 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_PutWarmPool481Example: summary: Default GET_PutWarmPool 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: MaxGroupPreparedCapacity in: query required: false description:Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an optional
property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.
If a
value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity.
If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity
instead.
The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute
size.
If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless you specify a
value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.
Stopped.
schema:
type: string
enum:
- Stopped
- Running
- Hibernated
- name: InstanceReusePolicy
in: query
required: false
description: Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group
scales in.
schema:
type: object
properties:
ReuseOnScaleIn:
allOf:
- $ref: "#/components/schemas/ReuseOnScaleIn"
- description: "Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in. "
description: Describes an instance reuse policy for a warm pool.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- name: Action in: query required: true schema: type: string enum: - PutWarmPool - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Put Warm Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: PutWarmPool operationId: POST_PutWarmPool description:Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/PutWarmPoolAnswer" examples: POST_PutWarmPool200Example: summary: Default POST_PutWarmPool 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_PutWarmPool480Example: summary: Default POST_PutWarmPool 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_PutWarmPool481Example: summary: Default POST_PutWarmPool 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/PutWarmPoolType" parameters: - name: Action in: query required: true schema: type: string enum: - PutWarmPool - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Put Warm Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=RecordLifecycleActionHeartbeat: get: x-aws-operation-name: RecordLifecycleActionHeartbeat operationId: GET_RecordLifecycleActionHeartbeat description:Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RecordLifecycleActionHeartbeatAnswer" examples: GET_RecordLifecycleActionHeartbeat200Example: summary: Default GET_RecordLifecycleActionHeartbeat 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_RecordLifecycleActionHeartbeat480Example: summary: Default GET_RecordLifecycleActionHeartbeat 480 response x-microcks-default: true value: {} parameters: - name: LifecycleHookName in: query required: true description: The name of the lifecycle hook. schema: type: string pattern: "[A-Za-z0-9\\-_\\/]+" minLength: 1 maxLength: 255 - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 1600 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: LifecycleActionToken in: query required: false description: A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook. schema: type: string minLength: 36 maxLength: 36 - name: InstanceId in: query required: false description: The ID of the instance. schema: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - RecordLifecycleActionHeartbeat - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Record Lifecycle Action Heartbeat x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RecordLifecycleActionHeartbeat operationId: POST_RecordLifecycleActionHeartbeat description:Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RecordLifecycleActionHeartbeatAnswer" examples: POST_RecordLifecycleActionHeartbeat200Example: summary: Default POST_RecordLifecycleActionHeartbeat 200 response x-microcks-default: true value: {} "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_RecordLifecycleActionHeartbeat480Example: summary: Default POST_RecordLifecycleActionHeartbeat 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/RecordLifecycleActionHeartbeatType" parameters: - name: Action in: query required: true schema: type: string enum: - RecordLifecycleActionHeartbeat - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Record Lifecycle Action Heartbeat x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=ResumeProcesses: get: x-aws-operation-name: ResumeProcesses operationId: GET_ResumeProcesses description:Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: GET_ResumeProcesses480Example: summary: Default GET_ResumeProcesses 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_ResumeProcesses481Example: summary: Default GET_ResumeProcesses 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScalingProcesses in: query required: false description:One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this property, all processes are specified.
schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - ResumeProcesses - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Resume Processes x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: ResumeProcesses operationId: POST_ResumeProcesses description:Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: POST_ResumeProcesses480Example: summary: Default POST_ResumeProcesses 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_ResumeProcesses481Example: summary: Default POST_ResumeProcesses 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/ScalingProcessQuery" parameters: - name: Action in: query required: true schema: type: string enum: - ResumeProcesses - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Resume Processes x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=RollbackInstanceRefresh: get: x-aws-operation-name: RollbackInstanceRefresh operationId: GET_RollbackInstanceRefresh description: "Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon
Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or $Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
" responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RollbackInstanceRefreshAnswer" examples: GET_RollbackInstanceRefresh200Example: summary: Default GET_RollbackInstanceRefresh 200 response x-microcks-default: true value: InstanceRefreshId: example-id-1234 "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_RollbackInstanceRefresh480Example: summary: Default GET_RollbackInstanceRefresh 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_RollbackInstanceRefresh481Example: summary: Default GET_RollbackInstanceRefresh 481 response x-microcks-default: true value: {} "482": description: ActiveInstanceRefreshNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ActiveInstanceRefreshNotFoundFault" "483": description: IrreversibleInstanceRefreshFault content: text/xml: schema: $ref: "#/components/schemas/IrreversibleInstanceRefreshFault" parameters: - name: AutoScalingGroupName in: query required: false description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: Action in: query required: true schema: type: string enum: - RollbackInstanceRefresh - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Rollback Instance Refresh x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: RollbackInstanceRefresh operationId: POST_RollbackInstanceRefresh description: "Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon
Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or $Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
" responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/RollbackInstanceRefreshAnswer" examples: POST_RollbackInstanceRefresh200Example: summary: Default POST_RollbackInstanceRefresh 200 response x-microcks-default: true value: InstanceRefreshId: example-id-1234 "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_RollbackInstanceRefresh480Example: summary: Default POST_RollbackInstanceRefresh 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_RollbackInstanceRefresh481Example: summary: Default POST_RollbackInstanceRefresh 481 response x-microcks-default: true value: {} "482": description: ActiveInstanceRefreshNotFoundFault content: text/xml: schema: $ref: "#/components/schemas/ActiveInstanceRefreshNotFoundFault" "483": description: IrreversibleInstanceRefreshFault content: text/xml: schema: $ref: "#/components/schemas/IrreversibleInstanceRefreshFault" requestBody: content: text/xml: schema: $ref: "#/components/schemas/RollbackInstanceRefreshType" parameters: - name: Action in: query required: true schema: type: string enum: - RollbackInstanceRefresh - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Rollback Instance Refresh x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=SetDesiredCapacity: get: x-aws-operation-name: SetDesiredCapacity operationId: GET_SetDesiredCapacity description:Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current
size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: GET_SetDesiredCapacity480Example: summary: Default GET_SetDesiredCapacity 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_SetDesiredCapacity481Example: summary: Default GET_SetDesiredCapacity 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: DesiredCapacity in: query required: true description: The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. schema: type: integer - name: HonorCooldown in: query required: false description: Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - SetDesiredCapacity - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Set Desired Capacity x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SetDesiredCapacity operationId: POST_SetDesiredCapacity description:Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current
size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: POST_SetDesiredCapacity480Example: summary: Default POST_SetDesiredCapacity 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_SetDesiredCapacity481Example: summary: Default POST_SetDesiredCapacity 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/SetDesiredCapacityType" parameters: - name: Action in: query required: true schema: type: string enum: - SetDesiredCapacity - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Set Desired Capacity x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=SetInstanceHealth: get: x-aws-operation-name: SetInstanceHealth operationId: GET_SetInstanceHealth description:Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_SetInstanceHealth480Example: summary: Default GET_SetInstanceHealth 480 response x-microcks-default: true value: {} parameters: - name: InstanceId in: query required: true description: The ID of the instance. schema: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: HealthStatus in: query required: true description: The health status of the instance. Set toHealthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon
EC2 Auto Scaling terminates and replaces the unhealthy instance.
schema:
type: string
minLength: 1
maxLength: 32
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: ShouldRespectGracePeriod
in: query
required: false
description: If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this
to False, to have the call not respect the grace period associated with the group.
For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.
schema: type: boolean - name: Action in: query required: true schema: type: string enum: - SetInstanceHealth - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Set Instance Health x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SetInstanceHealth operationId: POST_SetInstanceHealth description:Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success "480": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_SetInstanceHealth480Example: summary: Default POST_SetInstanceHealth 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/SetInstanceHealthQuery" parameters: - name: Action in: query required: true schema: type: string enum: - SetInstanceHealth - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Set Instance Health x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=SetInstanceProtection: get: x-aws-operation-name: SetInstanceProtection operationId: GET_SetInstanceProtection description:Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/SetInstanceProtectionAnswer" examples: GET_SetInstanceProtection200Example: summary: Default GET_SetInstanceProtection 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: GET_SetInstanceProtection480Example: summary: Default GET_SetInstanceProtection 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_SetInstanceProtection481Example: summary: Default GET_SetInstanceProtection 481 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: true description: One or more instance IDs. You can specify up to 50 instances. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen19" - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ProtectedFromScaleIn in: query required: true description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - SetInstanceProtection - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Set Instance Protection x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SetInstanceProtection operationId: POST_SetInstanceProtection description:Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/SetInstanceProtectionAnswer" examples: POST_SetInstanceProtection200Example: summary: Default POST_SetInstanceProtection 200 response x-microcks-default: true value: {} "480": description: LimitExceededFault content: text/xml: schema: $ref: "#/components/schemas/LimitExceededFault" examples: POST_SetInstanceProtection480Example: summary: Default POST_SetInstanceProtection 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_SetInstanceProtection481Example: summary: Default POST_SetInstanceProtection 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/SetInstanceProtectionQuery" parameters: - name: Action in: query required: true schema: type: string enum: - SetInstanceProtection - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Set Instance Protection x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=StartInstanceRefresh: get: x-aws-operation-name: StartInstanceRefresh operationId: GET_StartInstanceRefresh description:Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling update of instances in an Auto Scaling group. Instances are terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons,
such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby state or protected from scale in. You can
monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.
If you enable auto rollback, your Auto
Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback
property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
Rolling.
schema:
type: string
enum:
- Rolling
- name: DesiredConfiguration
in: query
required: false
description: The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.
Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.
When you specify a new launch template or a
new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling
skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates.
Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
description:Describes the desired configuration for an instance refresh.
If you specify a desired configuration, you must specify either a LaunchTemplate or a
MixedInstancesPolicy.
Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum healthy percentage, and the
behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You can also choose to enable additional
features, such as the following:
Auto rollback
Checkpoints
Skip matching
The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue. The value is expressed as a percentage of
the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
InstanceWarmup: allOf: - $ref: "#/components/schemas/RefreshInstanceWarmup" - description:A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the InService
state.
This property is not required for normal usage. Instead, use the DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup
and DefaultInstanceWarmup properties work the same way. Only specify this property if you must override the DefaultInstanceWarmup property.
If you
do not specify this property, the instance warmup by default is the value of the DefaultInstanceWarmup property, if defined (which is recommended in all cases), or the
HealthCheckGracePeriod property otherwise.
(Optional) Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in
the array must be 100.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
CheckpointDelay: allOf: - $ref: "#/components/schemas/CheckpointDelay" - description: "(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value forCheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay
defaults to 3600 (1 hour). "
SkipMatching:
allOf:
- $ref: "#/components/schemas/SkipMatching"
- description: (Optional) Indicates whether skip matching is enabled. If enabled (true), then Amazon EC2 Auto Scaling skips replacing instances that match the desired
configuration. If no desired configuration is specified, then it skips replacing instances that have the same launch template and instance types that the Auto Scaling group was using
before the start of the instance refresh. The default is false.
For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.
AutoRollback: allOf: - $ref: "#/components/schemas/AutoRollback" - description: "(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails. The default is false.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group
has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses
the launch template's $Latest or $Default version.
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
The following lists the valid values:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.
The following lists the valid values:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores
instances that are in Standby and continues to replace instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling update of instances in an Auto Scaling group. Instances are terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons,
such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby state or protected from scale in. You can
monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.
If you enable auto rollback, your Auto
Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback
property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the Launch or
Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User
Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: GET_SuspendProcesses480Example: summary: Default GET_SuspendProcesses 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_SuspendProcesses481Example: summary: Default GET_SuspendProcesses 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ScalingProcesses in: query required: false description:One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this property, all processes are specified.
schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: Action in: query required: true schema: type: string enum: - SuspendProcesses - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Suspend Processes x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: SuspendProcesses operationId: POST_SuspendProcesses description:Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the Launch or
Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User
Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
responses: "200": description: Success "480": description: ResourceInUseFault content: text/xml: schema: $ref: "#/components/schemas/ResourceInUseFault" examples: POST_SuspendProcesses480Example: summary: Default POST_SuspendProcesses 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_SuspendProcesses481Example: summary: Default POST_SuspendProcesses 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/ScalingProcessQuery" parameters: - name: Action in: query required: true schema: type: string enum: - SuspendProcesses - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Suspend Processes x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=TerminateInstanceInAutoScalingGroup: get: x-aws-operation-name: TerminateInstanceInAutoScalingGroup operationId: GET_TerminateInstanceInAutoScalingGroup description:Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a
termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an
instance after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ActivityType" examples: GET_TerminateInstanceInAutoScalingGroup200Example: summary: Default GET_TerminateInstanceInAutoScalingGroup 200 response x-microcks-default: true value: Activity: example-string "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: GET_TerminateInstanceInAutoScalingGroup480Example: summary: Default GET_TerminateInstanceInAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_TerminateInstanceInAutoScalingGroup481Example: summary: Default GET_TerminateInstanceInAutoScalingGroup 481 response x-microcks-default: true value: {} parameters: - name: InstanceId in: query required: true description: The ID of the instance. schema: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: ShouldDecrementDesiredCapacity in: query required: true description: Indicates whether terminating the instance also decrements the size of the Auto Scaling group. schema: type: boolean - name: Action in: query required: true schema: type: string enum: - TerminateInstanceInAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Terminate Instance in Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: x-aws-operation-name: TerminateInstanceInAutoScalingGroup operationId: POST_TerminateInstanceInAutoScalingGroup description:Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a
termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an
instance after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
responses: "200": description: Success content: text/xml: schema: $ref: "#/components/schemas/ActivityType" examples: POST_TerminateInstanceInAutoScalingGroup200Example: summary: Default POST_TerminateInstanceInAutoScalingGroup 200 response x-microcks-default: true value: Activity: example-string "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: POST_TerminateInstanceInAutoScalingGroup480Example: summary: Default POST_TerminateInstanceInAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_TerminateInstanceInAutoScalingGroup481Example: summary: Default POST_TerminateInstanceInAutoScalingGroup 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: "#/components/schemas/TerminateInstanceInAutoScalingGroupType" parameters: - name: Action in: query required: true schema: type: string enum: - TerminateInstanceInAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Terminate Instance in Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK /#Action=UpdateAutoScalingGroup: get: x-aws-operation-name: UpdateAutoScalingGroup operationId: GET_UpdateAutoScalingGroup description:We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination
policy to determine which instances to terminate.
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new
MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.
If you specify a
new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the
group's DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: GET_UpdateAutoScalingGroup480Example: summary: Default GET_UpdateAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: GET_UpdateAutoScalingGroup481Example: summary: Default GET_UpdateAutoScalingGroup 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" parameters: - name: AutoScalingGroupName in: query required: true description: The name of the Auto Scaling group. schema: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" - name: LaunchConfigurationName in: query required: false description: The name of the launch configuration. If you specifyLaunchConfigurationName in your update request, you can't specify LaunchTemplate or
MixedInstancesPolicy.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: LaunchTemplate
in: query
required: false
description: The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify
LaunchConfigurationName or MixedInstancesPolicy.
schema:
type: object
properties:
LaunchTemplateId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: 'The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
$Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions
can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the
value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2
Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch
templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
- name: MixedInstancesPolicy
in: query
required: false
description: The mixed instances policy. For more information, see Auto Scaling
groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
schema:
type: object
properties:
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplate"
- description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
InstancesDistribution:
allOf:
- $ref: "#/components/schemas/InstancesDistribution"
- description: The instances distribution.
description: Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- name: MinSize in: query required: false description: The minimum size of the Auto Scaling group. schema: type: integer - name: MaxSize in: query required: false description:The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights
that define how many units each instance contributes to the desired capacity of the group).
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
schema: type: integer - name: AvailabilityZones in: query required: false description: One or more Availability Zones for the group. schema: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" - name: HealthCheckType in: query required: false description:A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2
is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling
User Guide.
schema:
type: integer
- name: PlacementGroup
in: query
required: false
description: The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier with AvailabilityZones, the subnets that you
specify must reside in those Availability Zones.
schema:
type: string
minLength: 1
maxLength: 2047
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
- name: TerminationPolicies
in: query
required: false
description: 'A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour
| NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection
only. For more information, see Creating an Auto Scaling group using attribute-based
instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the
InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0
seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup
enabled by specifying a value of 0 or other nominal value.
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity, MaxSize, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination
policy to determine which instances to terminate.
If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new
MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.
If you specify a
new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the
group's DesiredCapacity to the new MaxSize value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
responses: "200": description: Success "480": description: ScalingActivityInProgressFault content: text/xml: schema: $ref: "#/components/schemas/ScalingActivityInProgressFault" examples: POST_UpdateAutoScalingGroup480Example: summary: Default POST_UpdateAutoScalingGroup 480 response x-microcks-default: true value: {} "481": description: ResourceContentionFault content: text/xml: schema: $ref: "#/components/schemas/ResourceContentionFault" examples: POST_UpdateAutoScalingGroup481Example: summary: Default POST_UpdateAutoScalingGroup 481 response x-microcks-default: true value: {} "482": description: ServiceLinkedRoleFailure content: text/xml: schema: $ref: "#/components/schemas/ServiceLinkedRoleFailure" requestBody: content: text/xml: schema: $ref: "#/components/schemas/UpdateAutoScalingGroupType" parameters: - name: Action in: query required: true schema: type: string enum: - UpdateAutoScalingGroup - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Update Auto Scaling Group x-microcks-operation: delay: 0 dispatcher: FALLBACK components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: XmlStringMaxLen19: type: string minLength: 1 maxLength: 19 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" ResourceContentionFault: {} ServiceLinkedRoleFailure: {} AttachLoadBalancerTargetGroupsResultType: type: object properties: {} XmlStringMaxLen511: type: string minLength: 1 maxLength: 511 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" AttachLoadBalancersResultType: type: object properties: {} XmlStringMaxLen255: type: string minLength: 1 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" AttachTrafficSourcesResultType: type: object example: {} properties: {} TrafficSourceIdentifier: type: object required: - Identifier properties: Identifier: allOf: - $ref: "#/components/schemas/XmlStringMaxLen511" - description: 'Identifies the traffic source.
For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.
For example:
Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
Classic Load Balancer name:
my-classic-load-balancer
VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
' example: example-id-1234 Type: allOf: - $ref: "#/components/schemas/XmlStringMaxLen511" - description:Provides additional context for the value of Identifier.
The following lists the valid values:
elb if
Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load
Balancer, or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
example: example-string description: Identifying information for a traffic source. BatchDeleteScheduledActionAnswer: type: object properties: FailedScheduledActions: allOf: - $ref: "#/components/schemas/FailedScheduledUpdateGroupActionRequests" - description: The names of the scheduled actions that could not be deleted, including an error message. example: example-string BatchPutScheduledUpdateGroupActionAnswer: type: object properties: FailedScheduledUpdateGroupActions: allOf: - $ref: "#/components/schemas/FailedScheduledUpdateGroupActionRequests" - description: The names of the scheduled actions that could not be created or updated, including an error message. example: example-string ScheduledUpdateGroupActionRequest: type: object required: - ScheduledActionName properties: ScheduledActionName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the scaling action. example: example-resource-name StartTime: allOf: - $ref: "#/components/schemas/TimestampType" - description:The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").
If you
specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
example: example-string EndTime: allOf: - $ref: "#/components/schemas/TimestampType" - description: The date and time for the recurring schedule to end, in UTC. example: example-string Recurrence: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: 'The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year]
[Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
When
StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
' example: example-string MinSize: allOf: - $ref: "#/components/schemas/AutoScalingGroupMinSize" - description: The minimum size of the Auto Scaling group. example: example-string MaxSize: allOf: - $ref: "#/components/schemas/AutoScalingGroupMaxSize" - description: The maximum size of the Auto Scaling group. example: example-string DesiredCapacity: allOf: - $ref: "#/components/schemas/AutoScalingGroupDesiredCapacity" - description: The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. example: example-string TimeZone: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description:Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones,
derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
Default: 0
" example: example-string OnDemandPercentageAboveBaseCapacity: allOf: - $ref: "#/components/schemas/OnDemandPercentageAboveBaseCapacity" - description: "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,
20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
Default: 100
" example: example-string SpotAllocationStrategy: allOf: - $ref: "#/components/schemas/XmlString" - description:The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Requests Spot Instances using pools that are optimally chosen based on the available
Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the
list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to
prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the
SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to
high interruption rates because this strategy only considers instance price and not available capacity.
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only
when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.
Default: 2
" example: example-string SpotMaxPrice: allOf: - $ref: "#/components/schemas/MixedInstanceSpotPrice" - description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
Valid Range: Minimum value of 0.001
' example: example-string description: Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. XmlStringMaxLen1600: type: string minLength: 1 maxLength: 1600 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" LifecycleHookSpecification: type: object required: - LifecycleHookName - LifecycleTransition properties: LifecycleHookName: allOf: - $ref: "#/components/schemas/AsciiStringMaxLen255" - description: The name of the lifecycle hook. example: example-resource-name LifecycleTransition: allOf: - $ref: "#/components/schemas/LifecycleTransition" - description:The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
30 to 7200 seconds. The default value is
3600 seconds (1 hour).
example: example-string
DefaultResult:
allOf:
- $ref: "#/components/schemas/LifecycleActionResult"
- description: "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.
Valid values:
CONTINUE | ABANDON
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
example: arn:aws:service:us-east-1:123456789012:resource/example description:Describes information used to specify a lifecycle hook for an Auto Scaling group.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
Tag: type: object required: - Key properties: ResourceId: allOf: - $ref: "#/components/schemas/XmlString" - description: The name of the Auto Scaling group. example: example-id-1234 ResourceType: allOf: - $ref: "#/components/schemas/XmlString" - description: The type of resource. The only supported value isauto-scaling-group.
example: example-string
Key:
allOf:
- $ref: "#/components/schemas/TagKey"
- description: The tag key.
example: example-string
Value:
allOf:
- $ref: "#/components/schemas/TagValue"
- description: The tag value.
example: example-string
PropagateAtLaunch:
allOf:
- $ref: "#/components/schemas/PropagateAtLaunch"
- description: Determines whether the tag is added to new instances as they are launched in the group.
example: example-string
description: Describes a tag for an Auto Scaling group.
XmlString:
type: string
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
BlockDeviceMapping:
type: object
required:
- DeviceName
properties:
VirtualName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting
from zero (0), for example, ephemeral0.
example: example-resource-name
DeviceName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: 'The device name assigned to the volume (for example, /dev/sdh or xvdh). For more information, see Device
naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the following
properties: Ebs, NoDevice, or VirtualName.
Setting this value to true prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at
launch.
If NoDevice is true for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement
instances.
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
Filter:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: "The name of the filter.
The valid values for Name depend on which API operation you're using with the filter (DescribeAutoScalingGroups or DescribeTags).
DescribeAutoScalingGroups
Valid values for Name include the following:
tag-key - Accepts tag keys. The results only include
information about the Auto Scaling groups associated with these tag keys.
tag-value - Accepts tag values. The results only include information about the Auto
Scaling groups associated with these tag values.
tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the
tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for Name include the following:
auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information
about the tags associated with these Auto Scaling groups.
key - Accepts tag keys. The results only include information about the tags associated with these
tag keys.
value - Accepts tag values. The results only include information about the tags associated with these tag values.
propagate-at-launch
- Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an
OR, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for
the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".
Describes a filter that is used to return a more specific list of results from a describe operation.
If you specify multiple filters, the filters are automatically
logically joined with an AND, and the request returns only the results that match all of the specified filters.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
InvalidNextToken: {} AutoScalingInstancesType: type: object example: AutoScalingInstances: - AutoScalingGroupName: my-auto-scaling-group AvailabilityZone: us-west-2c HealthStatus: HEALTHY InstanceId: i-4ba0837f LaunchConfigurationName: my-launch-config LifecycleState: InService ProtectedFromScaleIn: false properties: AutoScalingInstances: allOf: - $ref: "#/components/schemas/AutoScalingInstances" - description: The instances. example: example-string NextToken: allOf: - $ref: "#/components/schemas/XmlString" - description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for theNextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
DescribeAutoScalingNotificationTypesAnswer:
type: object
example:
AutoScalingNotificationTypes:
- autoscaling:EC2_INSTANCE_LAUNCH
- autoscaling:EC2_INSTANCE_LAUNCH_ERROR
- autoscaling:EC2_INSTANCE_TERMINATE
- autoscaling:EC2_INSTANCE_TERMINATE_ERROR
- autoscaling:TEST_NOTIFICATION
properties:
AutoScalingNotificationTypes:
allOf:
- $ref: "#/components/schemas/AutoScalingNotificationTypes"
- description: The notification types.
example: example-string
DescribeInstanceRefreshesAnswer:
type: object
example:
InstanceRefreshes:
- AutoScalingGroupName: my-auto-scaling-group
InstanceRefreshId: 08b91cf7-8fa6-48af-b6a6-d227f40f1b9b
InstancesToUpdate: 5
PercentageComplete: 0
StartTime: 2020-06-02T18:11:27Z
Status: InProgress
- AutoScalingGroupName: my-auto-scaling-group
EndTime: 2020-06-02T16:53:37Z
InstanceRefreshId: dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1
InstancesToUpdate: 0
PercentageComplete: 100
StartTime: 2020-06-02T16:43:19Z
Status: Successful
properties:
InstanceRefreshes:
allOf:
- $ref: "#/components/schemas/InstanceRefreshes"
- description: The instance refreshes for the specified group, sorted by creation timestamp in descending order.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
LaunchConfigurationsType:
type: object
required:
- LaunchConfigurations
example:
LaunchConfigurations:
- AssociatePublicIpAddress: true
BlockDeviceMappings: []
CreatedTime: 2014-05-07T17:39:28.599000Z
EbsOptimized: false
ImageId: ami-043a5034
InstanceMonitoring:
Enabled: true
InstanceType: t1.micro
LaunchConfigurationARN: arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config
LaunchConfigurationName: my-launch-config
SecurityGroups:
- sg-67ef0308
properties:
LaunchConfigurations:
allOf:
- $ref: "#/components/schemas/LaunchConfigurations"
- description: The launch configurations.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
DescribeLifecycleHookTypesAnswer:
type: object
example:
LifecycleHookTypes:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
properties:
LifecycleHookTypes:
allOf:
- $ref: "#/components/schemas/AutoScalingNotificationTypes"
- description: The lifecycle hook types.
example: example-string
DescribeLifecycleHooksAnswer:
type: object
example:
LifecycleHooks:
- AutoScalingGroupName: my-auto-scaling-group
DefaultResult: ABANDON
GlobalTimeout: 172800
HeartbeatTimeout: 3600
LifecycleHookName: my-lifecycle-hook
LifecycleTransition: autoscaling:EC2_INSTANCE_LAUNCHING
NotificationTargetARN: arn:aws:sns:us-west-2:123456789012:my-sns-topic
RoleARN: arn:aws:iam::123456789012:role/my-auto-scaling-role
properties:
LifecycleHooks:
allOf:
- $ref: "#/components/schemas/LifecycleHooks"
- description: The lifecycle hooks for the specified group.
example: example-string
AsciiStringMaxLen255:
type: string
pattern: "[A-Za-z0-9\\-_\\/]+"
minLength: 1
maxLength: 255
DescribeLoadBalancerTargetGroupsResponse:
type: object
example:
LoadBalancerTargetGroups:
- LoadBalancerTargetGroupARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
State: Added
properties:
LoadBalancerTargetGroups:
allOf:
- $ref: "#/components/schemas/LoadBalancerTargetGroupStates"
- description: Information about the target groups.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
DescribeLoadBalancersResponse:
type: object
example:
LoadBalancers:
- LoadBalancerName: my-load-balancer
State: Added
properties:
LoadBalancers:
allOf:
- $ref: "#/components/schemas/LoadBalancerStates"
- description: The load balancers.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
DescribeMetricCollectionTypesAnswer:
type: object
example:
Granularities:
- Granularity: 1Minute
Metrics:
- Metric: GroupMinSize
- Metric: GroupMaxSize
- Metric: GroupDesiredCapacity
- Metric: GroupInServiceInstances
- Metric: GroupPendingInstances
- Metric: GroupTerminatingInstances
- Metric: GroupStandbyInstances
- Metric: GroupTotalInstances
properties:
Metrics:
allOf:
- $ref: "#/components/schemas/MetricCollectionTypes"
- description: The metrics.
example: example-string
Granularities:
allOf:
- $ref: "#/components/schemas/MetricGranularityTypes"
- description: The granularities for the metrics.
example: example-string
DescribeNotificationConfigurationsAnswer:
type: object
required:
- NotificationConfigurations
example:
NotificationConfigurations:
- AutoScalingGroupName: my-auto-scaling-group
NotificationType: autoscaling:TEST_NOTIFICATION
TopicARN: arn:aws:sns:us-west-2:123456789012:my-sns-topic-2
- AutoScalingGroupName: my-auto-scaling-group
NotificationType: autoscaling:TEST_NOTIFICATION
TopicARN: arn:aws:sns:us-west-2:123456789012:my-sns-topic
properties:
NotificationConfigurations:
allOf:
- $ref: "#/components/schemas/NotificationConfigurations"
- description: The notification configurations.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
PoliciesType:
type: object
example:
ScalingPolicies:
- AdjustmentType: ChangeInCapacity
Alarms: []
AutoScalingGroupName: my-auto-scaling-group
PolicyARN: arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn
PolicyName: ScaleIn
ScalingAdjustment: -1
- AdjustmentType: PercentChangeInCapacity
Alarms: []
AutoScalingGroupName: my-auto-scaling-group
Cooldown: 60
MinAdjustmentStep: 2
PolicyARN: arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange
PolicyName: ScalePercentChange
ScalingAdjustment: 25
properties:
ScalingPolicies:
allOf:
- $ref: "#/components/schemas/ScalingPolicies"
- description: The scaling policies.
example: example-string
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
XmlStringMaxLen64:
type: string
minLength: 1
maxLength: 64
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
ActivitiesType:
type: object
required:
- Activities
example:
Activities:
- ActivityId: f9f2d65b-f1f2-43e7-b46d-d86756459699
AutoScalingGroupName: my-auto-scaling-group
Cause: At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a
difference between desired and actual capacity, increasing the capacity from 0 to 1.
Description: "Launching a new EC2 instance: i-4ba0837f"
Details: details
EndTime: 2013-08-19T20:54:02Z
Progress: 100
StartTime: 2013-08-19T20:53:29.930000Z
StatusCode: Successful
properties:
Activities:
allOf:
- $ref: "#/components/schemas/Activities"
- description: The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
ProcessesType:
type: object
example:
Processes:
- ProcessName: AZRebalance
- ProcessName: AddToLoadBalancer
- ProcessName: AlarmNotification
- ProcessName: HealthCheck
- ProcessName: Launch
- ProcessName: ReplaceUnhealthy
- ProcessName: ScheduledActions
- ProcessName: Terminate
properties:
Processes:
allOf:
- $ref: "#/components/schemas/Processes"
- description: The names of the process types.
ScheduledActionsType:
type: object
example:
ScheduledUpdateGroupActions:
- AutoScalingGroupName: my-auto-scaling-group
DesiredCapacity: 4
MaxSize: 6
MinSize: 2
Recurrence: 30 0 1 12 0
ScheduledActionARN:
arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action
ScheduledActionName: my-scheduled-action
StartTime: 2016-12-01T00:30:00Z
Time: 2016-12-01T00:30:00Z
properties:
ScheduledUpdateGroupActions:
allOf:
- $ref: "#/components/schemas/ScheduledUpdateGroupActions"
- description: The scheduled actions.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
TagsType:
type: object
example:
Tags:
- Key: Dept
PropagateAtLaunch: true
ResourceId: my-auto-scaling-group
ResourceType: auto-scaling-group
Value: Research
- Key: Role
PropagateAtLaunch: true
ResourceId: my-auto-scaling-group
ResourceType: auto-scaling-group
Value: WebServer
properties:
Tags:
allOf:
- $ref: "#/components/schemas/TagDescriptionList"
- description: One or more tags.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
DescribeTerminationPolicyTypesAnswer:
type: object
example:
TerminationPolicyTypes:
- ClosestToNextInstanceHour
- Default
- NewestInstance
- OldestInstance
- OldestLaunchConfiguration
properties:
TerminationPolicyTypes:
allOf:
- $ref: "#/components/schemas/TerminationPolicies"
- description: "The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour,
Default, OldestLaunchTemplate, and AllocationStrategy."
DescribeTrafficSourcesResponse:
type: object
example:
NextToken: ""
TrafficSources:
- Identifier: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE
State: InService
Type: vpc-lattice
properties:
TrafficSources:
allOf:
- $ref: "#/components/schemas/TrafficSourceStates"
- description: Information about the traffic sources.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
DescribeWarmPoolAnswer:
type: object
properties:
WarmPoolConfiguration:
allOf:
- $ref: "#/components/schemas/WarmPoolConfiguration"
- description: "The warm pool configuration details. "
Instances:
allOf:
- $ref: "#/components/schemas/Instances"
- description: The instances that are currently in the warm pool.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextToken value when requesting the next set of items. This value is null when there are no more items to return.
DetachInstancesAnswer:
type: object
example:
Activities:
- ActivityId: 5091cb52-547a-47ce-a236-c9ccbc2cb2c9
AutoScalingGroupName: my-auto-scaling-group
Cause: At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.
Description: "Detaching EC2 instance: i-93633f9b"
Details: details
Progress: 50
StartTime: 2015-04-12T15:02:16.179000Z
StatusCode: InProgress
properties:
Activities:
allOf:
- $ref: "#/components/schemas/Activities"
- description: The activities related to detaching the instances from the Auto Scaling group.
DetachLoadBalancerTargetGroupsResultType:
type: object
properties: {}
DetachLoadBalancersResultType:
type: object
properties: {}
DetachTrafficSourcesResultType:
type: object
example: {}
properties: {}
EnterStandbyAnswer:
type: object
example:
Activities:
- ActivityId: ffa056b4-6ed3-41ba-ae7c-249dfae6eba1
AutoScalingGroupName: my-auto-scaling-group
Cause: At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.
Description: "Moving EC2 instance to Standby: i-93633f9b"
Details: details
Progress: 50
StartTime: 2015-04-12T15:10:23.640000Z
StatusCode: InProgress
properties:
Activities:
allOf:
- $ref: "#/components/schemas/Activities"
- description: The activities related to moving instances into Standby mode.
ExitStandbyAnswer:
type: object
example:
Activities:
- ActivityId: 142928e1-a2dc-453a-9b24-b85ad6735928
AutoScalingGroupName: my-auto-scaling-group
Cause: At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.
Description: "Moving EC2 instance out of Standby: i-93633f9b"
Details: details
Progress: 30
StartTime: 2015-04-12T15:14:29.886000Z
StatusCode: PreInService
properties:
Activities:
allOf:
- $ref: "#/components/schemas/Activities"
- description: The activities related to moving instances out of Standby mode.
GetPredictiveScalingForecastAnswer:
type: object
required:
- LoadForecast
- CapacityForecast
- UpdateTime
properties:
LoadForecast:
allOf:
- $ref: "#/components/schemas/LoadForecasts"
- description: The load forecast.
CapacityForecast:
allOf:
- $ref: "#/components/schemas/CapacityForecast"
- description: The capacity forecast.
UpdateTime:
allOf:
- $ref: "#/components/schemas/TimestampType"
- description: The time the forecast was made.
PutLifecycleHookAnswer:
type: object
properties: {}
PolicyARNType:
type: object
example:
Alarms:
- AlarmARN: arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e
AlarmName: TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e
- AlarmARN: arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2
AlarmName: TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2
PolicyARN:
arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy
properties:
PolicyARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the policy.
Alarms:
allOf:
- $ref: "#/components/schemas/Alarms"
- description: The CloudWatch alarms created for the target tracking scaling policy.
description: Contains the output of PutScalingPolicy.
StepAdjustment:
type: object
required:
- ScalingAdjustment
properties:
MetricIntervalLowerBound:
allOf:
- $ref: "#/components/schemas/MetricScale"
- description: The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the
metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value
indicates negative infinity.
MetricIntervalUpperBound:
allOf:
- $ref: "#/components/schemas/MetricScale"
- description: The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
ScalingAdjustment: allOf: - $ref: "#/components/schemas/PolicyIncrement" - description:The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a
percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
Describes information used to create a step adjustment for a step scaling policy.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.
To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can't overlap or have a gap.
At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can't be null in the same step adjustment.
For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide.
PredefinedMetricSpecification: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: "#/components/schemas/MetricType" - description:The metric type. The following predefined metrics are available:
ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling
group.
ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
ALBRequestCountPerTarget -
Average Application Load Balancer request count per target for your Auto Scaling group.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description: Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling. CustomizedMetricSpecification: type: object properties: MetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. Namespace: allOf: - $ref: "#/components/schemas/MetricNamespace" - description: The namespace of the metric. Dimensions: allOf: - $ref: "#/components/schemas/MetricDimensions" - description: "The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
" Statistic: allOf: - $ref: "#/components/schemas/MetricStatistic" - description: The statistic of the metric. Unit: allOf: - $ref: "#/components/schemas/MetricUnit" - description: The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. Metrics: allOf: - $ref: "#/components/schemas/TargetTrackingMetricDataQueries" - description: The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. description:Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
To create your customized metric specification:
Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish custom metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts.
Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
$Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can
be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is
$Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling
selects the default version of the launch template when launching instances. The default value is $Default.
description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates,
see Launch templates in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy:
type: object
properties:
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplate"
- description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
InstancesDistribution:
allOf:
- $ref: "#/components/schemas/InstancesDistribution"
- description: The instances distribution.
description: Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
IntPercent: type: integer minimum: 0 maximum: 100 RefreshInstanceWarmup: type: integer minimum: 0 CheckpointPercentages: type: array items: $ref: "#/components/schemas/NonZeroIntPercent" CheckpointDelay: type: integer minimum: 0 maximum: 172800 SkipMatching: type: boolean AutoRollback: type: boolean ScaleInProtectedInstances: type: string enum: - Refresh - Ignore - Wait StandbyInstances: type: string enum: - Terminate - Ignore - Wait InstanceRefreshInProgressFault: {} ActivityType: type: object properties: Activity: allOf: - $ref: "#/components/schemas/Activity" - description: A scaling activity. NullablePositiveInteger: type: integer minimum: 0 AcceleratorCountRequest: type: object properties: Min: allOf: - $ref: "#/components/schemas/NullablePositiveInteger" - description: The minimum value. Max: allOf: - $ref: "#/components/schemas/NullablePositiveInteger" - description: The maximum value. description: Specifies the minimum and maximum for theAcceleratorCount object when you specify InstanceRequirements for an Auto Scaling group.
AcceleratorManufacturer:
type: string
enum:
- nvidia
- amd
- amazon-web-services
- xilinx
AcceleratorManufacturers:
type: array
items:
$ref: "#/components/schemas/AcceleratorManufacturer"
AcceleratorName:
type: string
enum:
- a100
- v100
- k80
- t4
- m60
- radeon-pro-v520
- vu9p
AcceleratorNames:
type: array
items:
$ref: "#/components/schemas/AcceleratorName"
AcceleratorTotalMemoryMiBRequest:
type: object
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The memory minimum in MiB.
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The memory maximum in MiB.
description: Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
AcceleratorType:
type: string
enum:
- gpu
- fpga
- inference
AcceleratorTypes:
type: array
items:
$ref: "#/components/schemas/AcceleratorType"
Activity:
type: object
required:
- ActivityId
- AutoScalingGroupName
- Cause
- StartTime
- StatusCode
properties:
ActivityId:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The ID of the activity.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
Description:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: A friendly, more verbose description of the activity.
Cause:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen1023"
- description: The reason the activity began.
StartTime:
allOf:
- $ref: "#/components/schemas/TimestampType"
- description: The start time of the activity.
EndTime:
allOf:
- $ref: "#/components/schemas/TimestampType"
- description: The end time of the activity.
StatusCode:
allOf:
- $ref: "#/components/schemas/ScalingActivityStatusCode"
- description: The current status of the activity.
StatusMessage:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: A friendly, more verbose description of the activity status.
Progress:
allOf:
- $ref: "#/components/schemas/Progress"
- description: A value between 0 and 100 that indicates the progress of the activity.
Details:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The details about the activity.
AutoScalingGroupState:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupState"
- description: The state of the Auto Scaling group, which is either InService or Deleted.
AutoScalingGroupARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the Auto Scaling group.
description: Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
Activities:
type: array
items:
$ref: "#/components/schemas/Activity"
XmlStringMaxLen1023:
type: string
minLength: 1
maxLength: 1023
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
TimestampType:
type: string
format: date-time
ScalingActivityStatusCode:
type: string
enum:
- PendingSpotBidPlacement
- WaitingForSpotInstanceRequestId
- WaitingForSpotInstanceId
- WaitingForInstanceId
- PreInService
- InProgress
- WaitingForELBConnectionDraining
- MidLifecycleAction
- WaitingForInstanceWarmup
- Successful
- Failed
- Cancelled
- WaitingForConnectionDraining
Progress:
type: integer
AutoScalingGroupState:
type: string
minLength: 1
maxLength: 32
ActivityIds:
type: array
items:
$ref: "#/components/schemas/XmlString"
AdjustmentType:
type: object
properties:
AdjustmentType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
description: Describes a policy adjustment type.
AdjustmentTypes:
type: array
items:
$ref: "#/components/schemas/AdjustmentType"
Alarm:
type: object
properties:
AlarmName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the alarm.
AlarmARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the alarm.
description: Describes an alarm.
Alarms:
type: array
items:
$ref: "#/components/schemas/Alarm"
AllowedInstanceType:
type: string
pattern: "[a-zA-Z0-9\\.\\*]+"
minLength: 1
maxLength: 30
AllowedInstanceTypes:
type: array
items:
$ref: "#/components/schemas/AllowedInstanceType"
maxItems: 400
AssociatePublicIpAddress:
type: boolean
InstanceIds:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen19"
AttachInstancesQuery:
type: object
required:
- AutoScalingGroupName
title: AttachInstancesQuery
properties:
InstanceIds:
allOf:
- $ref: "#/components/schemas/InstanceIds"
- description: The IDs of the instances. You can specify up to 20 instances.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
TargetGroupARNs:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen511"
AttachLoadBalancerTargetGroupsType:
type: object
required:
- AutoScalingGroupName
- TargetGroupARNs
title: AttachLoadBalancerTargetGroupsType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
TargetGroupARNs:
allOf:
- $ref: "#/components/schemas/TargetGroupARNs"
- description: The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.
LoadBalancerNames:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
AttachLoadBalancersType:
type: object
required:
- AutoScalingGroupName
- LoadBalancerNames
title: AttachLoadBalancersType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
LoadBalancerNames:
allOf:
- $ref: "#/components/schemas/LoadBalancerNames"
- description: The names of the load balancers. You can specify up to 10 load balancers.
TrafficSources:
type: array
items:
$ref: "#/components/schemas/TrafficSourceIdentifier"
AttachTrafficSourcesType:
type: object
required:
- AutoScalingGroupName
- TrafficSources
title: AttachTrafficSourcesType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
TrafficSources:
allOf:
- $ref: "#/components/schemas/TrafficSources"
- description: The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.
AutoScalingGroupMinSize:
type: integer
AutoScalingGroupMaxSize:
type: integer
AutoScalingGroupDesiredCapacity:
type: integer
AutoScalingGroupPredictedCapacity:
type: integer
Cooldown:
type: integer
AvailabilityZones:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
XmlStringMaxLen32:
type: string
minLength: 1
maxLength: 32
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
HealthCheckGracePeriod:
type: integer
Instances:
type: array
items:
$ref: "#/components/schemas/Instance"
SuspendedProcesses:
type: array
items:
$ref: "#/components/schemas/SuspendedProcess"
XmlStringMaxLen2047:
type: string
minLength: 1
maxLength: 2047
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
EnabledMetrics:
type: array
items:
$ref: "#/components/schemas/EnabledMetric"
TagDescriptionList:
type: array
items:
$ref: "#/components/schemas/TagDescription"
TerminationPolicies:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen1600"
InstanceProtected:
type: boolean
MaxInstanceLifetime:
type: integer
CapacityRebalanceEnabled:
type: boolean
WarmPoolConfiguration:
type: object
properties:
MaxGroupPreparedCapacity:
allOf:
- $ref: "#/components/schemas/MaxGroupPreparedCapacity"
- description: The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.
MinSize:
allOf:
- $ref: "#/components/schemas/WarmPoolMinSize"
- description: The minimum number of instances to maintain in the warm pool.
PoolState:
allOf:
- $ref: "#/components/schemas/WarmPoolState"
- description: The instance state to transition to after the lifecycle actions are complete.
Status:
allOf:
- $ref: "#/components/schemas/WarmPoolStatus"
- description: The status of a warm pool that is marked for deletion.
InstanceReusePolicy:
allOf:
- $ref: "#/components/schemas/InstanceReusePolicy"
- description: The instance reuse policy.
description: "Describes a warm pool configuration. "
WarmPoolSize:
type: integer
Context:
type: string
DefaultInstanceWarmup:
type: integer
AutoScalingGroup:
type: object
required:
- AutoScalingGroupName
- MinSize
- MaxSize
- DesiredCapacity
- DefaultCooldown
- AvailabilityZones
- HealthCheckType
- CreatedTime
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
AutoScalingGroupARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the Auto Scaling group.
LaunchConfigurationName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the associated launch configuration.
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplateSpecification"
- description: The launch template for the group.
MixedInstancesPolicy:
allOf:
- $ref: "#/components/schemas/MixedInstancesPolicy"
- description: The mixed instances policy for the group.
MinSize:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupMinSize"
- description: The minimum size of the group.
MaxSize:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupMaxSize"
- description: The maximum size of the group.
DesiredCapacity:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupDesiredCapacity"
- description: The desired size of the group.
PredictedCapacity:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupPredictedCapacity"
- description: The predicted capacity of the group when it has a predictive scaling policy.
DefaultCooldown:
allOf:
- $ref: "#/components/schemas/Cooldown"
- description: The duration of the default cooldown period, in seconds.
AvailabilityZones:
allOf:
- $ref: "#/components/schemas/AvailabilityZones"
- description: One or more Availability Zones for the group.
LoadBalancerNames:
allOf:
- $ref: "#/components/schemas/LoadBalancerNames"
- description: One or more load balancers associated with the group.
TargetGroupARNs:
allOf:
- $ref: "#/components/schemas/TargetGroupARNs"
- description: The Amazon Resource Names (ARN) of the target groups for your load balancer.
HealthCheckType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: A comma-separated value string of one or more health check types.
HealthCheckGracePeriod:
allOf:
- $ref: "#/components/schemas/HealthCheckGracePeriod"
- description: The duration of the health check grace period, in seconds.
Instances:
allOf:
- $ref: "#/components/schemas/Instances"
- description: The EC2 instances associated with the group.
CreatedTime:
allOf:
- $ref: "#/components/schemas/TimestampType"
- description: The date and time the group was created.
SuspendedProcesses:
allOf:
- $ref: "#/components/schemas/SuspendedProcesses"
- description: The suspended processes associated with the group.
PlacementGroup:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the placement group into which to launch your instances, if any.
VPCZoneIdentifier:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen2047"
- description: One or more subnet IDs, if applicable, separated by commas.
EnabledMetrics:
allOf:
- $ref: "#/components/schemas/EnabledMetrics"
- description: The metrics enabled for the group.
Status:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The current state of the group when the DeleteAutoScalingGroup operation is in progress.
Tags:
allOf:
- $ref: "#/components/schemas/TagDescriptionList"
- description: The tags for the group.
TerminationPolicies:
allOf:
- $ref: "#/components/schemas/TerminationPolicies"
- description: The termination policies for the group.
NewInstancesProtectedFromScaleIn:
allOf:
- $ref: "#/components/schemas/InstanceProtected"
- description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
ServiceLinkedRoleARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
MaxInstanceLifetime:
allOf:
- $ref: "#/components/schemas/MaxInstanceLifetime"
- description: "The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
" CapacityRebalance: allOf: - $ref: "#/components/schemas/CapacityRebalanceEnabled" - description: Indicates whether Capacity Rebalancing is enabled. WarmPoolConfiguration: allOf: - $ref: "#/components/schemas/WarmPoolConfiguration" - description: The warm pool for the group. WarmPoolSize: allOf: - $ref: "#/components/schemas/WarmPoolSize" - description: The current size of the warm pool. Context: allOf: - $ref: "#/components/schemas/Context" - description: Reserved. DesiredCapacityType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supportsDesiredCapacityType for attribute-based instance type
selection only.
DefaultInstanceWarmup:
allOf:
- $ref: "#/components/schemas/DefaultInstanceWarmup"
- description: The duration of the default instance warmup, in seconds.
TrafficSources:
allOf:
- $ref: "#/components/schemas/TrafficSources"
- description: The traffic sources associated with this Auto Scaling group.
description: Describes an Auto Scaling group.
AutoScalingGroupNames:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
MaxRecords:
type: integer
Filters:
type: array
items:
$ref: "#/components/schemas/Filter"
AutoScalingGroupNamesType:
type: object
title: AutoScalingGroupNamesType
properties:
AutoScalingGroupNames:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupNames"
- description: The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords
property.
If you omit this property, all Auto Scaling groups are described.
NextToken: allOf: - $ref: "#/components/schemas/XmlString" - description: The token for the next set of items to return. (You received this token from a previous call.) MaxRecords: allOf: - $ref: "#/components/schemas/MaxRecords" - description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
Filters:
allOf:
- $ref: "#/components/schemas/Filters"
- description: "One or more filters to limit the results based on specific tags. "
AutoScalingGroups:
type: array
items:
$ref: "#/components/schemas/AutoScalingGroup"
AutoScalingInstanceDetails:
type: object
required:
- InstanceId
- AutoScalingGroupName
- AvailabilityZone
- LifecycleState
- HealthStatus
- ProtectedFromScaleIn
properties:
InstanceId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen19"
- description: The ID of the instance.
InstanceType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The instance type of the EC2 instance.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group for the instance.
AvailabilityZone:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The Availability Zone for the instance.
LifecycleState:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: 'The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance
lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid values: Pending | Pending:Wait | Pending:Proceed | Quarantined
| InService | Terminating | Terminating:Wait | Terminating:Proceed | Terminated | Detaching | Detached
| EnteringStandby | Standby | Warmed:Pending | Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating
| Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated | Warmed:Stopped | Warmed:Running
Healthy means that the instance is healthy and should remain in service. Unhealthy means that the
instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
LaunchConfigurationName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplateSpecification"
- description: The launch template for the instance.
ProtectedFromScaleIn:
allOf:
- $ref: "#/components/schemas/InstanceProtected"
- description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
WeightedCapacity:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: "The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
" description: Describes an EC2 instance associated with an Auto Scaling group. AutoScalingInstances: type: array items: $ref: "#/components/schemas/AutoScalingInstanceDetails" AutoScalingNotificationTypes: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" BareMetal: type: string enum: - included - excluded - required BaselineEbsBandwidthMbpsRequest: type: object properties: Min: allOf: - $ref: "#/components/schemas/NullablePositiveInteger" - description: The minimum value in Mbps. Max: allOf: - $ref: "#/components/schemas/NullablePositiveInteger" - description: The maximum value in Mbps. description: Specifies the minimum and maximum for theBaselineEbsBandwidthMbps object when you specify InstanceRequirements for an Auto Scaling group.
FailedScheduledUpdateGroupActionRequests:
type: array
items:
$ref: "#/components/schemas/FailedScheduledUpdateGroupActionRequest"
ScheduledActionNames:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
BatchDeleteScheduledActionType:
type: object
required:
- AutoScalingGroupName
- ScheduledActionNames
title: BatchDeleteScheduledActionType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ScheduledActionNames:
allOf:
- $ref: "#/components/schemas/ScheduledActionNames"
- description: "The names of the scheduled actions to delete. The maximum number allowed is 50. "
ScheduledUpdateGroupActionRequests:
type: array
items:
$ref: "#/components/schemas/ScheduledUpdateGroupActionRequest"
BatchPutScheduledUpdateGroupActionType:
type: object
required:
- AutoScalingGroupName
- ScheduledUpdateGroupActions
title: BatchPutScheduledUpdateGroupActionType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ScheduledUpdateGroupActions:
allOf:
- $ref: "#/components/schemas/ScheduledUpdateGroupActionRequests"
- description: One or more scheduled actions. The maximum number allowed is 50.
BlockDeviceEbsDeleteOnTermination:
type: boolean
BlockDeviceEbsEncrypted:
type: boolean
BlockDeviceEbsIops:
type: integer
minimum: 100
maximum: 20000
BlockDeviceEbsThroughput:
type: integer
minimum: 125
maximum: 1000
BlockDeviceEbsVolumeSize:
type: integer
minimum: 1
maximum: 16384
BlockDeviceEbsVolumeType:
type: string
minLength: 1
maxLength: 255
Ebs:
type: object
properties:
SnapshotId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The snapshot ID of the volume to use.
You must specify either a VolumeSize or a SnapshotId.
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
You must specify either
a SnapshotId or a VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the
snapshot.
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide for Linux Instances.
Valid values: standard | io1 | gp2 | st1 | sc1 | gp3
true.
Iops:
allOf:
- $ref: "#/components/schemas/BlockDeviceEbsIops"
- description: 'The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3 and io1 volumes, this represents the number of IOPS
that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances built on
the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
Iops is supported when the volume type is gp3 or io1
and required only when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide.
gp3 volume.
description: Describes information used to set up an Amazon EBS volume specified in a block device mapping.
NoDevice:
type: boolean
BlockDeviceMappings:
type: array
items:
$ref: "#/components/schemas/BlockDeviceMapping"
BurstablePerformance:
type: string
enum:
- included
- excluded
- required
CancelInstanceRefreshType:
type: object
required:
- AutoScalingGroupName
title: CancelInstanceRefreshType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
PredictiveScalingForecastTimestamps:
type: array
items:
$ref: "#/components/schemas/TimestampType"
PredictiveScalingForecastValues:
type: array
items:
$ref: "#/components/schemas/MetricScale"
CapacityForecast:
type: object
required:
- Timestamps
- Values
properties:
Timestamps:
allOf:
- $ref: "#/components/schemas/PredictiveScalingForecastTimestamps"
- description: The timestamps for the data points, in UTC format.
Values:
allOf:
- $ref: "#/components/schemas/PredictiveScalingForecastValues"
- description: The values of the data points.
description: "A GetPredictiveScalingForecast call returns the capacity forecast for a predictive scaling policy. This structure includes the data points for that capacity forecast, along
with the timestamps of those data points. "
NonZeroIntPercent:
type: integer
minimum: 1
maximum: 100
ClassicLinkVPCSecurityGroups:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
LifecycleActionToken:
type: string
minLength: 36
maxLength: 36
LifecycleActionResult:
type: string
CompleteLifecycleActionType:
type: object
required:
- LifecycleHookName
- AutoScalingGroupName
- LifecycleActionResult
title: CompleteLifecycleActionType
properties:
LifecycleHookName:
allOf:
- $ref: "#/components/schemas/AsciiStringMaxLen255"
- description: The name of the lifecycle hook.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The name of the Auto Scaling group.
LifecycleActionToken:
allOf:
- $ref: "#/components/schemas/LifecycleActionToken"
- description: A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification
target you specified when you created the lifecycle hook.
LifecycleActionResult:
allOf:
- $ref: "#/components/schemas/LifecycleActionResult"
- description: The action for the group to take. You can specify either CONTINUE or ABANDON.
InstanceId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen19"
- description: The ID of the instance.
CpuManufacturer:
type: string
enum:
- intel
- amd
- amazon-web-services
CpuManufacturers:
type: array
items:
$ref: "#/components/schemas/CpuManufacturer"
LifecycleHookSpecifications:
type: array
items:
$ref: "#/components/schemas/LifecycleHookSpecification"
Tags:
type: array
items:
$ref: "#/components/schemas/Tag"
CreateAutoScalingGroupType:
type: object
required:
- AutoScalingGroupName
- MinSize
- MaxSize
title: CreateAutoScalingGroupType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy)
or a launch configuration (LaunchConfigurationName or InstanceId).
Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate
or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight (weights that define how
many units each instance contributes to the desired capacity of the group).
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: 300 seconds
VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
LoadBalancerNames:
allOf:
- $ref: "#/components/schemas/LoadBalancerNames"
- description: A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the
TargetGroupARNs property instead.
TargetGroupARNs:
allOf:
- $ref: "#/components/schemas/TargetGroupARNs"
- description: The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target
groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling
group in the Amazon EC2 Auto Scaling User Guide.
HealthCheckType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE.
EC2 is the default health check and cannot be disabled. For more information, see Health
checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due
to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set
the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier
with AvailabilityZones, the subnets that you specify must reside in those Availability Zones.
TerminationPolicies:
allOf:
- $ref: "#/components/schemas/TerminationPolicies"
- description: 'A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour
| NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
MaxInstanceLifetime:
allOf:
- $ref: "#/components/schemas/MaxInstanceLifetime"
- description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than
86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on
maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
Context:
allOf:
- $ref: "#/components/schemas/Context"
- description: Reserved.
DesiredCapacityType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: 'The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection
only. For more information, see Creating an Auto Scaling group using attribute-based
instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the
default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly
recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value.
Default: None
' TrafficSources: allOf: - $ref: "#/components/schemas/TrafficSources" - description: "The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice." SecurityGroups: type: array items: $ref: "#/components/schemas/XmlString" XmlStringUserData: type: string maxLength: 21847 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" InstanceMonitoring: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/MonitoringEnabled" - description: Iftrue, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
description: Describes whether detailed monitoring is enabled for the Auto Scaling instances.
SpotPrice:
type: string
minLength: 1
maxLength: 255
EbsOptimized:
type: boolean
InstanceMetadataOptions:
type: object
properties:
HttpTokens:
allOf:
- $ref: "#/components/schemas/InstanceMetadataHttpTokensState"
- description: The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the
state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a
token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the
state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the
version 2.0 credentials; the version 1.0 credentials are not available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
" HttpEndpoint: allOf: - $ref: "#/components/schemas/InstanceMetadataEndpointState" - description:This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
If you specify
InstanceId, an ImageId is not required.
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
InstanceType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description:Specifies the instance type of the EC2 instance. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId, an InstanceType is not required.
The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
The default value is
true (enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 0.001
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to
Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you
enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-optimized instances in the Amazon EC2 User Guide for Linux Instances.
The
default value is false.
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.
If you specify true, each instance in the Auto Scaling group receives a unique
public IPv4 address. For more information, see Launching Auto Scaling instances in a VPC in the
Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware
and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set
the value of this property to dedicated. For more information, see Configuring
instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet
for VPCZoneIdentifier when you create your group.
Valid values: default | dedicated
The IDs of the instances. If you omit this property, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
Array Members: Maximum number of 50 items.
" MaxRecords: allOf: - $ref: "#/components/schemas/MaxRecords" - description: The maximum number of items to return with this call. The default value is50 and the maximum value is 50.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
InstanceRefreshes:
type: array
items:
$ref: "#/components/schemas/InstanceRefresh"
InstanceRefreshIds:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen255"
DescribeInstanceRefreshesType:
type: object
required:
- AutoScalingGroupName
title: DescribeInstanceRefreshesType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
InstanceRefreshIds:
allOf:
- $ref: "#/components/schemas/InstanceRefreshIds"
- description: One or more instance refresh IDs.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
LifecycleHooks:
type: array
items:
$ref: "#/components/schemas/LifecycleHook"
LifecycleHookNames:
type: array
items:
$ref: "#/components/schemas/AsciiStringMaxLen255"
maxItems: 50
DescribeLifecycleHooksType:
type: object
required:
- AutoScalingGroupName
title: DescribeLifecycleHooksType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
LifecycleHookNames:
allOf:
- $ref: "#/components/schemas/LifecycleHookNames"
- description: The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.
DescribeLoadBalancerTargetGroupsRequest:
type: object
required:
- AutoScalingGroupName
title: DescribeLoadBalancerTargetGroupsRequest
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
LoadBalancerTargetGroupStates:
type: array
items:
$ref: "#/components/schemas/LoadBalancerTargetGroupState"
DescribeLoadBalancersRequest:
type: object
required:
- AutoScalingGroupName
title: DescribeLoadBalancersRequest
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
LoadBalancerStates:
type: array
items:
$ref: "#/components/schemas/LoadBalancerState"
MetricCollectionTypes:
type: array
items:
$ref: "#/components/schemas/MetricCollectionType"
MetricGranularityTypes:
type: array
items:
$ref: "#/components/schemas/MetricGranularityType"
NotificationConfigurations:
type: array
items:
$ref: "#/components/schemas/NotificationConfiguration"
DescribeNotificationConfigurationsType:
type: object
title: DescribeNotificationConfigurationsType
properties:
AutoScalingGroupNames:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupNames"
- description: The name of the Auto Scaling group.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
PolicyNames:
type: array
items:
$ref: "#/components/schemas/ResourceName"
PolicyTypes:
type: array
items:
$ref: "#/components/schemas/XmlStringMaxLen64"
DescribePoliciesType:
type: object
title: DescribePoliciesType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
PolicyNames:
allOf:
- $ref: "#/components/schemas/PolicyNames"
- description: "The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
" PolicyTypes: allOf: - $ref: "#/components/schemas/PolicyTypes" - description: One or more policy types. The valid values areSimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
IncludeDeletedGroups:
type: boolean
DescribeScalingActivitiesType:
type: object
title: DescribeScalingActivitiesType
properties:
ActivityIds:
allOf:
- $ref: "#/components/schemas/ActivityIds"
- description: "The activity IDs of the desired scaling activities. If you omit this property, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
Array Members: Maximum number of 50 IDs.
" AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. IncludeDeletedGroups: allOf: - $ref: "#/components/schemas/IncludeDeletedGroups" - description: Indicates whether to include scaling activity from deleted Auto Scaling groups. MaxRecords: allOf: - $ref: "#/components/schemas/MaxRecords" - description: The maximum number of items to return with this call. The default value is100 and the maximum value is 100.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
DescribeScheduledActionsType:
type: object
title: DescribeScheduledActionsType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ScheduledActionNames:
allOf:
- $ref: "#/components/schemas/ScheduledActionNames"
- description: "The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
Array Members: Maximum number of 50 actions.
" StartTime: allOf: - $ref: "#/components/schemas/TimestampType" - description: The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored. EndTime: allOf: - $ref: "#/components/schemas/TimestampType" - description: The latest scheduled start time to return. If scheduled action names are provided, this property is ignored. NextToken: allOf: - $ref: "#/components/schemas/XmlString" - description: The token for the next set of items to return. (You received this token from a previous call.) MaxRecords: allOf: - $ref: "#/components/schemas/MaxRecords" - description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
DescribeTagsType:
type: object
title: DescribeTagsType
properties:
Filters:
allOf:
- $ref: "#/components/schemas/Filters"
- description: One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
DescribeTrafficSourcesRequest:
type: object
required:
- AutoScalingGroupName
title: DescribeTrafficSourcesRequest
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
TrafficSourceType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The traffic source type that you want to describe.
The following lists the valid values:
elb if the traffic source is a Classic Load
Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
vpc-lattice if the traffic source is VPC Lattice.
50.
TrafficSourceStates:
type: array
items:
$ref: "#/components/schemas/TrafficSourceState"
DescribeWarmPoolType:
type: object
required:
- AutoScalingGroupName
title: DescribeWarmPoolType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
MaxRecords:
allOf:
- $ref: "#/components/schemas/MaxRecords"
- description: The maximum number of instances to return with this call. The maximum value is 50.
NextToken:
allOf:
- $ref: "#/components/schemas/XmlString"
- description: The token for the next set of instances to return. (You received this token from a previous call.)
DesiredConfiguration:
type: object
properties:
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplateSpecification"
- description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch
templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy:
allOf:
- $ref: "#/components/schemas/MixedInstancesPolicy"
- description: Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
description:Describes the desired configuration for an instance refresh.
If you specify a desired configuration, you must specify either a LaunchTemplate or a
MixedInstancesPolicy.
Identifies the metrics to disable.
You can specify one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you omit this property, all metrics are disabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
EnableMetricsCollectionQuery: type: object required: - AutoScalingGroupName - Granularity title: EnableMetricsCollectionQuery properties: AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. Metrics: allOf: - $ref: "#/components/schemas/Metrics" - description:Identifies the metrics to enable.
You can specify one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you specify Granularity and don't specify any metrics, all metrics are enabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
Granularity: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is1Minute.
EnabledMetric:
type: object
properties:
Metric:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
Granularity: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The granularity of the metric. The only valid value is1Minute.
description: Describes an enabled Auto Scaling group metric.
EnterStandbyQuery:
type: object
required:
- AutoScalingGroupName
- ShouldDecrementDesiredCapacity
title: EnterStandbyQuery
properties:
InstanceIds:
allOf:
- $ref: "#/components/schemas/InstanceIds"
- description: The IDs of the instances. You can specify up to 20 instances.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ShouldDecrementDesiredCapacity:
allOf:
- $ref: "#/components/schemas/ShouldDecrementDesiredCapacity"
- description: Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.
EstimatedInstanceWarmup:
type: integer
ExcludedInstance:
type: string
pattern: "[a-zA-Z0-9\\.\\*]+"
minLength: 1
maxLength: 30
ExcludedInstanceTypes:
type: array
items:
$ref: "#/components/schemas/ExcludedInstance"
maxItems: 400
HonorCooldown:
type: boolean
ExecutePolicyType:
type: object
required:
- PolicyName
title: ExecutePolicyType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
PolicyName:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The name or ARN of the policy.
HonorCooldown:
allOf:
- $ref: "#/components/schemas/HonorCooldown"
- description: Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
Valid only if the policy type is
SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in
the Amazon EC2 Auto Scaling User Guide.
The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to
use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.
If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
Required if the policy type is StepScaling and not
supported otherwise.
The breach threshold for the alarm.
Required if the policy type is StepScaling and not supported otherwise.
The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.
GlobalTimeout: type: integer HeartbeatTimeout: type: integer LifecycleState: type: string enum: - Pending - Pending:Wait - Pending:Proceed - Quarantined - InService - Terminating - Terminating:Wait - Terminating:Proceed - Terminated - Detaching - Detached - EnteringStandby - Standby - Warmed:Pending - Warmed:Pending:Wait - Warmed:Pending:Proceed - Warmed:Terminating - Warmed:Terminating:Wait - Warmed:Terminating:Proceed - Warmed:Terminated - Warmed:Stopped - Warmed:Running - Warmed:Hibernated Instance: type: object required: - InstanceId - AvailabilityZone - LifecycleState - HealthStatus - ProtectedFromScaleIn properties: InstanceId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen19" - description: The ID of the instance. InstanceType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The instance type of the EC2 instance. AvailabilityZone: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The Availability Zone in which the instance is running. LifecycleState: allOf: - $ref: "#/components/schemas/LifecycleState" - description: 'A description of the current lifecycle state. TheQuarantined state is not used. For information about lifecycle states, see Instance
lifecycle in the Amazon EC2 Auto Scaling User Guide. '
HealthStatus:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the
instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
LaunchConfigurationName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The launch configuration associated with the instance.
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplateSpecification"
- description: The launch template for the instance.
ProtectedFromScaleIn:
allOf:
- $ref: "#/components/schemas/InstanceProtected"
- description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
WeightedCapacity:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: "The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
" description: Describes an EC2 instance. InstanceGeneration: type: string enum: - current - previous InstanceGenerations: type: array items: $ref: "#/components/schemas/InstanceGeneration" InstanceRefreshStatus: type: string enum: - Pending - InProgress - Successful - Failed - Cancelling - Cancelled - RollbackInProgress - RollbackFailed - RollbackSuccessful InstancesToUpdate: type: integer minimum: 0 InstanceRefreshProgressDetails: type: object properties: LivePoolProgress: allOf: - $ref: "#/components/schemas/InstanceRefreshLivePoolProgress" - description: Reports progress on replacing instances that are in the Auto Scaling group. WarmPoolProgress: allOf: - $ref: "#/components/schemas/InstanceRefreshWarmPoolProgress" - description: Reports progress on replacing instances that are in the warm pool. description: Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool). RefreshPreferences: type: object properties: MinHealthyPercentage: allOf: - $ref: "#/components/schemas/IntPercent" - description:The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue. The value is expressed as a percentage of the
desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
InstanceWarmup: allOf: - $ref: "#/components/schemas/RefreshInstanceWarmup" - description:A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the InService
state.
This property is not required for normal usage. Instead, use the DefaultInstanceWarmup property of the Auto Scaling group. The InstanceWarmup and
DefaultInstanceWarmup properties work the same way. Only specify this property if you must override the DefaultInstanceWarmup property.
If you do not
specify this property, the instance warmup by default is the value of the DefaultInstanceWarmup property, if defined (which is recommended in all cases), or the
HealthCheckGracePeriod property otherwise.
(Optional) Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the
array must be 100.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
CheckpointDelay: allOf: - $ref: "#/components/schemas/CheckpointDelay" - description: "(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value forCheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to
3600 (1 hour). "
SkipMatching:
allOf:
- $ref: "#/components/schemas/SkipMatching"
- description: (Optional) Indicates whether skip matching is enabled. If enabled (true), then Amazon EC2 Auto Scaling skips replacing instances that match the desired
configuration. If no desired configuration is specified, then it skips replacing instances that have the same launch template and instance types that the Auto Scaling group was using
before the start of the instance refresh. The default is false.
For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.
AutoRollback: allOf: - $ref: "#/components/schemas/AutoRollback" - description: "(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails. The default is false.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch
template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's
$Latest or $Default version.
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
The following lists the valid values:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.
The following lists the valid values:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that
are in Standby and continues to replace instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
PercentageComplete at the time the rollback started.
InstancesToUpdateOnRollback:
allOf:
- $ref: "#/components/schemas/InstancesToUpdate"
- description: Indicates the value of InstancesToUpdate at the time the rollback started.
ProgressDetailsOnRollback:
allOf:
- $ref: "#/components/schemas/InstanceRefreshProgressDetails"
- description: Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto
Scaling group (the live pool).
description: Details about an instance refresh rollback.
InstanceRefresh:
type: object
properties:
InstanceRefreshId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The instance refresh ID.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
Status:
allOf:
- $ref: "#/components/schemas/InstanceRefreshStatus"
- description: The current status for the instance refresh operation:
Pending - The request was created, but the instance refresh has not started.
InProgress - An instance refresh is in progress.
Successful - An instance refresh completed successfully.
Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
Cancelling - An
ongoing instance refresh is being cancelled.
Cancelled - The instance refresh is cancelled.
RollbackInProgress - An
instance refresh is being rolled back.
RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling
activities.
RollbackSuccessful - The rollback completed successfully.
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate
shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
VCpuCount object when you specify InstanceRequirements for an Auto Scaling group.
MemoryMiBRequest:
type: object
required:
- Min
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The memory minimum in MiB.
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The memory maximum in MiB.
description: Specifies the minimum and maximum for the MemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
MemoryGiBPerVCpuRequest:
type: object
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The memory minimum in GiB.
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The memory maximum in GiB.
description: Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you specify InstanceRequirements for an Auto Scaling group.
NullableBoolean:
type: boolean
NetworkInterfaceCountRequest:
type: object
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The minimum number of network interfaces.
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveInteger"
- description: The maximum number of network interfaces.
description: Specifies the minimum and maximum for the NetworkInterfaceCount object when you specify InstanceRequirements for an Auto Scaling group.
LocalStorage:
type: string
enum:
- included
- excluded
- required
LocalStorageTypes:
type: array
items:
$ref: "#/components/schemas/LocalStorageType"
TotalLocalStorageGBRequest:
type: object
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The storage minimum in GB.
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The storage maximum in GB.
description: Specifies the minimum and maximum for the TotalLocalStorageGB object when you specify InstanceRequirements for an Auto Scaling group.
NetworkBandwidthGbpsRequest:
type: object
properties:
Min:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The minimum amount of network bandwidth, in gigabits per second (Gbps).
Max:
allOf:
- $ref: "#/components/schemas/NullablePositiveDouble"
- description: The maximum amount of network bandwidth, in gigabits per second (Gbps).
description: Specifies the minimum and maximum for the NetworkBandwidthGbps object when you specify InstanceRequirements for an Auto Scaling group.
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide for Linux Instances.
Lists which specific CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with
AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
" MemoryGiBPerVCpu: allOf: - $ref: "#/components/schemas/MemoryGiBPerVCpuRequest" - description: "The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
" ExcludedInstanceTypes: allOf: - $ref: "#/components/schemas/ExcludedInstanceTypes" - description: "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation.
The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*, you are
excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types,
but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.
Default: No excluded instance types
" InstanceGenerations: allOf: - $ref: "#/components/schemas/InstanceGenerations" - description: 'Indicates whether current or previous generation instance types are included.
For current generation instance types, specify current. The current
generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance
types in the Amazon EC2 User Guide for Linux Instances.
For previous generation instance types, specify previous.
Default: Any current or previous generation
' SpotMaxPricePercentageOverLowestPrice: allOf: - $ref: "#/components/schemas/NullablePositiveInteger" - description: "The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the least expensive current generation
M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than
your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead
of the per instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the least expensive current
generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is
higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead
of the per instance price.
Default: 20
Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded
Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.
Default: excluded
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
" LocalStorage: allOf: - $ref: "#/components/schemas/LocalStorage" - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.
Default: included
Indicates the type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For
instance types with solid state drive (SSD) storage, specify ssd.
Default: Any local storage type
" TotalLocalStorageGB: allOf: - $ref: "#/components/schemas/TotalLocalStorageGBRequest" - description: "The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
" BaselineEbsBandwidthMbps: allOf: - $ref: "#/components/schemas/BaselineEbsBandwidthMbpsRequest" - description: 'The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.
Default: No minimum or maximum limits
' AcceleratorTypes: allOf: - $ref: "#/components/schemas/AcceleratorTypes" - description: "Lists the accelerator types that must be on an instance type.
For instance types with GPU accelerators, specify gpu.
For instance
types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
" AcceleratorCount: allOf: - $ref: "#/components/schemas/AcceleratorCountRequest" - description: "The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types,
set Max to 0.
Default: No minimum or maximum limits
" AcceleratorManufacturers: allOf: - $ref: "#/components/schemas/AcceleratorManufacturers" - description: "Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
" AcceleratorNames: allOf: - $ref: "#/components/schemas/AcceleratorNames" - description: "Lists the accelerators that must be on an instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance
types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA
T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
" AcceleratorTotalMemoryMiB: allOf: - $ref: "#/components/schemas/AcceleratorTotalMemoryMiBRequest" - description: "The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
" NetworkBandwidthGbps: allOf: - $ref: "#/components/schemas/NetworkBandwidthGbpsRequest" - description: "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
" AllowedInstanceTypes: allOf: - $ref: "#/components/schemas/AllowedInstanceTypes" - description: "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings
with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*,
m5a.*, r*, *3*.
For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes
all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.
If you specify
AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
" description:The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The
instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance
types to exclude from the list, even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other attributes
are optional. Any unspecified optional attribute is set to its default.
For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the Amazon EC2 User Guide for Linux Instances.
InstanceReusePolicy: type: object properties: ReuseOnScaleIn: allOf: - $ref: "#/components/schemas/ReuseOnScaleIn" - description: "Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in. " description:Describes an instance reuse policy for a warm pool.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
OnDemandBaseCapacity: type: integer OnDemandPercentageAboveBaseCapacity: type: integer SpotInstancePools: type: integer MixedInstanceSpotPrice: type: string minLength: 0 maxLength: 255 LaunchConfiguration: type: object required: - LaunchConfigurationName - ImageId - InstanceType - CreatedTime properties: LaunchConfigurationName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the launch configuration. LaunchConfigurationARN: allOf: - $ref: "#/components/schemas/ResourceName" - description: The Amazon Resource Name (ARN) of the launch configuration. ImageId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances. KeyName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description:The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
SecurityGroups: allOf: - $ref: "#/components/schemas/SecurityGroups" - description: A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. ClassicLinkVPCId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: Available for backward compatibility. ClassicLinkVPCSecurityGroups: allOf: - $ref: "#/components/schemas/ClassicLinkVPCSecurityGroups" - description: Available for backward compatibility. UserData: allOf: - $ref: "#/components/schemas/XmlStringUserData" - description: The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. InstanceType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The instance type for the instances. For information about available instance types, see Available instance types in the Amazon EC2 User Guide for Linux Instances. KernelId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The ID of the kernel associated with the AMI. RamdiskId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The ID of the RAM disk associated with the AMI. BlockDeviceMappings: allOf: - $ref: "#/components/schemas/BlockDeviceMappings" - description: The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances. InstanceMonitoring: allOf: - $ref: "#/components/schemas/InstanceMonitoring" - description:Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.
For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
SpotPrice: allOf: - $ref: "#/components/schemas/SpotPrice" - description: The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide. IamInstanceProfile: allOf: - $ref: "#/components/schemas/XmlStringMaxLen1600" - description: The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide. CreatedTime: allOf: - $ref: "#/components/schemas/TimestampType" - description: The creation date and time for the launch configuration. EbsOptimized: allOf: - $ref: "#/components/schemas/EbsOptimized" - description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
AssociatePublicIpAddress:
allOf:
- $ref: "#/components/schemas/AssociatePublicIpAddress"
- description: Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address,
unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address,
unless you enabled the option to assign a public IPv4 address on the subnet. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
PlacementTenancy:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen64"
- description: The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware
and can only be launched into a VPC.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
MetadataOptions: allOf: - $ref: "#/components/schemas/InstanceMetadataOptions" - description: The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide. description: Describes a launch configuration. LaunchConfigurationNameType: type: object required: - LaunchConfigurationName title: LaunchConfigurationNameType properties: LaunchConfigurationName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the launch configuration. LaunchConfigurationNames: type: array items: $ref: "#/components/schemas/XmlStringMaxLen255" LaunchConfigurationNamesType: type: object title: LaunchConfigurationNamesType properties: LaunchConfigurationNames: allOf: - $ref: "#/components/schemas/LaunchConfigurationNames" - description: "The launch configuration names. If you omit this property, all launch configurations are described.
Array Members: Maximum number of 50 items.
" NextToken: allOf: - $ref: "#/components/schemas/XmlString" - description: The token for the next set of items to return. (You received this token from a previous call.) MaxRecords: allOf: - $ref: "#/components/schemas/MaxRecords" - description: The maximum number of items to return with this call. The default value is50 and the maximum value is 100.
LaunchConfigurations:
type: array
items:
$ref: "#/components/schemas/LaunchConfiguration"
Overrides:
type: array
items:
$ref: "#/components/schemas/LaunchTemplateOverrides"
LaunchTemplateOverrides:
type: object
properties:
InstanceType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more
information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
You can specify up to 40 instance types per Auto Scaling group.
WeightedCapacity: allOf: - $ref: "#/components/schemas/XmlStringMaxLen32" - description:If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage,
throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling
launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2
Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more
information, see Configuring instance weighting for Amazon
EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.
If you specify a value for WeightedCapacity for one
instance type, you must specify a value for WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters
(DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed
instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a
different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance
type in the Amazon EC2 Auto Scaling User Guide.
You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and
in the LaunchTemplate definition count towards this limit.
The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.
If you specify InstanceRequirements, you can't specify InstanceType.
Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:
Override the instance type that is specified in the launch template.
Use multiple instance types.
Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
LifecycleTransition: type: string NotificationTargetResourceName: type: string minLength: 0 maxLength: 255 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" LifecycleHook: type: object properties: LifecycleHookName: allOf: - $ref: "#/components/schemas/AsciiStringMaxLen255" - description: The name of the lifecycle hook. AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group for the lifecycle hook. LifecycleTransition: allOf: - $ref: "#/components/schemas/LifecycleTransition" - description: "The lifecycle transition.
Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING
DefaultResult property.
GlobalTimeout:
allOf:
- $ref: "#/components/schemas/GlobalTimeout"
- description: The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is
smaller.
DefaultResult:
allOf:
- $ref: "#/components/schemas/LifecycleActionResult"
- description: "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
Valid values: CONTINUE | ABANDON
One of the following load balancer states:
Adding - The Auto Scaling instances are being registered with the load balancer.
Added - All Auto Scaling instances are registered with the load balancer.
InService - At least one Auto Scaling instance passed an
ELB health check.
Removing - The Auto Scaling instances are being deregistered from the load balancer. If connection draining is enabled,
Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
Removed - All Auto Scaling instances are deregistered
from the load balancer.
The state of the target group.
Adding - The Auto Scaling instances are being registered with the target group.
Added - All Auto Scaling instances are registered with the target group.
InService - At least one Auto Scaling instance passed an
ELB health check.
Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled,
Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
Removed - All Auto Scaling instances are deregistered
from the target group.
Specifies the target utilization.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
This structure specifies the metrics and target utilization settings for a predictive scaling policy.
You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.
Example
You create a predictive scaling policy and specify
ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding
target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group.
The number of requests the
target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the
RequestCount and RequestCountPerTarget metrics, respectively.
For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization.
Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.)
After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times.
For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
LoadForecast: type: object required: - Timestamps - Values - MetricSpecification properties: Timestamps: allOf: - $ref: "#/components/schemas/PredictiveScalingForecastTimestamps" - description: The timestamps for the data points, in UTC format. Values: allOf: - $ref: "#/components/schemas/PredictiveScalingForecastValues" - description: The values of the data points. MetricSpecification: allOf: - $ref: "#/components/schemas/PredictiveScalingMetricSpecification" - description: The metric specification for the load forecast. description: "AGetPredictiveScalingForecast call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with
the timestamps of those data points and the metric specification. "
LocalStorageType:
type: string
enum:
- hdd
- ssd
MaxGroupPreparedCapacity:
type: integer
minimum: -1
NullablePositiveDouble:
type: number
format: double
minimum: 0
Metric:
type: object
required:
- Namespace
- MetricName
properties:
Namespace:
allOf:
- $ref: "#/components/schemas/MetricNamespace"
- description: The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the
Amazon CloudWatch User Guide.
MetricName:
allOf:
- $ref: "#/components/schemas/MetricName"
- description: The name of the metric.
Dimensions:
allOf:
- $ref: "#/components/schemas/MetricDimensions"
- description: 'The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
' description: "Represents a specific metric. " MetricCollectionType: type: object properties: Metric: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description:One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
MetricDataQuery objects specified for a single scaling policy.
If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers,
and underscores. The first character must be a lowercase letter. "
Expression:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen1023"
- description: "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer
to those metrics, and can also use the Id of other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery object, you
must specify either Expression or MetricStat, but not both.
Information about the metric data to return.
Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat,
but not both.
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only
the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the
metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default
(true).
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
MetricDataQueries: type: array items: $ref: "#/components/schemas/MetricDataQuery" MetricStat: type: object required: - Metric - Stat properties: Metric: allOf: - $ref: "#/components/schemas/Metric" - description: The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. Stat: allOf: - $ref: "#/components/schemas/XmlStringMetricStat" - description:The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most
commonly used metrics for predictive scaling are Average and Sum.
This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
XmlStringMetricLabel: type: string maxLength: 2047 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" ReturnData: type: boolean MetricDimensionName: type: string MetricDimensionValue: type: string MetricDimension: type: object required: - Name - Value properties: Name: allOf: - $ref: "#/components/schemas/MetricDimensionName" - description: The name of the dimension. Value: allOf: - $ref: "#/components/schemas/MetricDimensionValue" - description: The value of the dimension. description: Describes the dimension of a metric. MetricGranularityType: type: object properties: Granularity: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The granularity. The only valid value is1Minute.
description: Describes a granularity of a metric.
XmlStringMetricStat:
type: string
minLength: 1
maxLength: 100
x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
MetricType:
type: string
enum:
- ASGAverageCPUUtilization
- ASGAverageNetworkIn
- ASGAverageNetworkOut
- ALBRequestCountPerTarget
MinAdjustmentMagnitude:
type: integer
MinAdjustmentStep:
type: integer
deprecated: true
NotificationConfiguration:
type: object
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
TopicARN:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The Amazon Resource Name (ARN) of the Amazon SNS topic.
NotificationType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
Mode: allOf: - $ref: "#/components/schemas/PredictiveScalingMode" - description: The predictive scaling mode. Defaults toForecastOnly if not specified.
SchedulingBufferTime:
allOf:
- $ref: "#/components/schemas/PredictiveScalingSchedulingBufferTime"
- description: The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
MaxCapacityBreachBehavior: allOf: - $ref: "#/components/schemas/PredictiveScalingMaxCapacityBreachBehavior" - description:Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to
HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out
capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out
capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value
for MaxCapacityBuffer.
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if the
MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.
ASGCPUUtilization, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric."
ResourceLabel:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen1023"
- description: A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description: "Represents a metric pair for a predictive scaling policy. " PredictiveScalingPredefinedScalingMetric: type: object required: - PredefinedMetricType properties: PredefinedMetricType: allOf: - $ref: "#/components/schemas/PredefinedScalingMetricType" - description: The metric type. ResourceLabel: allOf: - $ref: "#/components/schemas/XmlStringMaxLen1023" - description:A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description:Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy
uses individually specified load and scaling metrics instead of a metric pair.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
description:Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses
individually specified load and scaling metrics instead of a metric pair.
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
Describes a process type.
For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
Processes: type: array items: $ref: "#/components/schemas/ProcessType" PropagateAtLaunch: type: boolean ProtectedFromScaleIn: type: boolean PutLifecycleHookType: type: object required: - LifecycleHookName - AutoScalingGroupName title: PutLifecycleHookType properties: LifecycleHookName: allOf: - $ref: "#/components/schemas/AsciiStringMaxLen255" - description: The name of the lifecycle hook. AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. LifecycleTransition: allOf: - $ref: "#/components/schemas/LifecycleTransition" - description:The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.
Required for new lifecycle hooks, but optional when updating existing hooks.
RoleARN: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description:The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
NotificationTargetARN: allOf: - $ref: "#/components/schemas/NotificationTargetResourceName" - description: 'The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it
a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
30 to 7200 seconds. The default value is
3600 seconds (1 hour).
DefaultResult:
allOf:
- $ref: "#/components/schemas/LifecycleActionResult"
- description: "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.
Valid values:
CONTINUE | ABANDON
The target value for the metric.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
false.
description: Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
ScalingPolicyEnabled:
type: boolean
PutScalingPolicyType:
type: object
required:
- AutoScalingGroupName
- PolicyName
title: PutScalingPolicyType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
PolicyName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the policy.
PolicyType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen64"
- description: "One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)
PredictiveScaling
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
Required if the policy type is StepScaling or SimpleScaling. For more information,
see Scaling adjustment types in the Amazon EC2 Auto Scaling User
Guide.
MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude:
allOf:
- $ref: "#/components/schemas/MinAdjustmentMagnitude"
- description: The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an
Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1.
However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
Valid only if the policy type is
StepScaling or SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User
Guide.
Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest
instance weight.
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
Required if the policy type is SimpleScaling. (Not used with any other policy type.)
A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
Valid only
if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: None
' MetricAggregationType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen32" - description:The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null,
the value is treated as Average.
Valid only if the policy type is StepScaling.
A set of adjustments that enable you to scale based on the size of the alarm breach.
Required if the policy type is StepScaling. (Not used with any
other policy type.)
Not needed if the default instance warmup is defined for the group.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is TargetTrackingScaling or StepScaling.
The default is to use the value for the
default instance warmup defined for the group. If default instance warmup is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
A target tracking scaling policy. Provides support for predefined or custom metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
If you specify ALBRequestCountPerTarget for the metric, you must specify the ResourceLabel property
with the PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is TargetTrackingScaling.
A predictive scaling policy. Provides support for predefined and custom metrics.
Predefined metrics include CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is PredictiveScaling.
The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2021-06-01T00:00:00Z").
If you
specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
"2021-06-01T00:00:00Z".
Recurrence:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: 'The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value
must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
When StartTime and
EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
' MinSize: allOf: - $ref: "#/components/schemas/AutoScalingGroupMinSize" - description: The minimum size of the Auto Scaling group. MaxSize: allOf: - $ref: "#/components/schemas/AutoScalingGroupMaxSize" - description: The maximum size of the Auto Scaling group. DesiredCapacity: allOf: - $ref: "#/components/schemas/AutoScalingGroupDesiredCapacity" - description: "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.
You must specify at least one of the following properties: MaxSize, MinSize, or DesiredCapacity.
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones,
derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. This is an
optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.
If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity
and its desired capacity. If you specify a value for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity
and the desired capacity instead.
The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does
the warm pool have an absolute size.
If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the capacity of the
warm pool is 0, unless you specify a value for MinSize. To remove a value that you previously set, include the property but specify -1 for the value.
Stopped.
InstanceReusePolicy:
allOf:
- $ref: "#/components/schemas/InstanceReusePolicy"
- description: Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the
group scales in.
RecordLifecycleActionHeartbeatType:
type: object
required:
- LifecycleHookName
- AutoScalingGroupName
title: RecordLifecycleActionHeartbeatType
properties:
LifecycleHookName:
allOf:
- $ref: "#/components/schemas/AsciiStringMaxLen255"
- description: The name of the lifecycle hook.
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The name of the Auto Scaling group.
LifecycleActionToken:
allOf:
- $ref: "#/components/schemas/LifecycleActionToken"
- description: A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you
specified when you created the lifecycle hook.
InstanceId:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen19"
- description: The ID of the instance.
RefreshStrategy:
type: string
enum:
- Rolling
RollbackInstanceRefreshType:
type: object
title: RollbackInstanceRefreshType
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ScalingPolicy:
type: object
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
PolicyName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the scaling policy.
PolicyARN:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The Amazon Resource Name (ARN) of the policy.
PolicyType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen64"
- description: 'One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling
(default)
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
' AdjustmentType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity,
ExactCapacity, and PercentChangeInCapacity.
MinAdjustmentStep:
allOf:
- $ref: "#/components/schemas/MinAdjustmentStep"
- description: Available for backward compatibility. Use MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude:
allOf:
- $ref: "#/components/schemas/MinAdjustmentMagnitude"
- description: "The minimum value to scale by when the adjustment type is PercentChangeInCapacity. "
ScalingAdjustment:
allOf:
- $ref: "#/components/schemas/PolicyIncrement"
- description: The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Cooldown:
allOf:
- $ref: "#/components/schemas/Cooldown"
- description: The duration of the policy's cooldown period, in seconds.
StepAdjustments:
allOf:
- $ref: "#/components/schemas/StepAdjustments"
- description: A set of adjustments that enable you to scale based on the size of the alarm breach.
MetricAggregationType:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen32"
- description: The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
EstimatedInstanceWarmup:
allOf:
- $ref: "#/components/schemas/EstimatedInstanceWarmup"
- description: The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
Alarms:
allOf:
- $ref: "#/components/schemas/Alarms"
- description: The CloudWatch alarms related to the policy.
TargetTrackingConfiguration:
allOf:
- $ref: "#/components/schemas/TargetTrackingConfiguration"
- description: A target tracking scaling policy.
Enabled:
allOf:
- $ref: "#/components/schemas/ScalingPolicyEnabled"
- description: Indicates whether the policy is enabled (true) or disabled (false).
PredictiveScalingConfiguration:
allOf:
- $ref: "#/components/schemas/PredictiveScalingConfiguration"
- description: A predictive scaling policy.
description: Describes a scaling policy.
ScalingProcessQuery:
type: object
required:
- AutoScalingGroupName
title: ScalingProcessQuery
properties:
AutoScalingGroupName:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of the Auto Scaling group.
ScalingProcesses:
allOf:
- $ref: "#/components/schemas/ProcessNames"
- description: One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this property, all processes are specified.
ScheduledUpdateGroupActions: type: array items: $ref: "#/components/schemas/ScheduledUpdateGroupAction" ScheduledUpdateGroupAction: type: object properties: AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. ScheduledActionName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the scheduled action. ScheduledActionARN: allOf: - $ref: "#/components/schemas/ResourceName" - description: The Amazon Resource Name (ARN) of the scheduled action. Time: allOf: - $ref: "#/components/schemas/TimestampType" - description: This property is no longer used. StartTime: allOf: - $ref: "#/components/schemas/TimestampType" - description: 'The date and time in UTC for this action to start. For example,"2019-06-01T00:00:00Z". '
EndTime:
allOf:
- $ref: "#/components/schemas/TimestampType"
- description: 'The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z". '
Recurrence:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The recurring schedule for the action, in Unix cron syntax format.
When StartTime and EndTime are specified with Recurrence,
they form the boundaries of when the recurring action starts and stops.
Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service.
Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
ShouldRespectGracePeriod:
allOf:
- $ref: "#/components/schemas/ShouldRespectGracePeriod"
- description: If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set
this to False, to have the call not respect the grace period associated with the group.
For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.
SetInstanceProtectionQuery: type: object required: - InstanceIds - AutoScalingGroupName - ProtectedFromScaleIn title: SetInstanceProtectionQuery properties: InstanceIds: allOf: - $ref: "#/components/schemas/InstanceIds" - description: One or more instance IDs. You can specify up to 50 instances. AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. ProtectedFromScaleIn: allOf: - $ref: "#/components/schemas/ProtectedFromScaleIn" - description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. StartInstanceRefreshType: type: object required: - AutoScalingGroupName title: StartInstanceRefreshType properties: AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. Strategy: allOf: - $ref: "#/components/schemas/RefreshStrategy" - description: The strategy to use for the instance refresh. The only valid value isRolling.
DesiredConfiguration:
allOf:
- $ref: "#/components/schemas/DesiredConfiguration"
- description: The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.
Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.
When you specify a new launch
template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon
EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to
apply updates.
Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum healthy percentage, and the
behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You can also choose to enable additional
features, such as the following:
Auto rollback
Checkpoints
Skip matching
Describes an auto scaling process that has been suspended.
For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
TagKey: type: string minLength: 1 maxLength: 128 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" TagValue: type: string minLength: 0 maxLength: 256 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" TagDescription: type: object properties: ResourceId: allOf: - $ref: "#/components/schemas/XmlString" - description: The name of the group. ResourceType: allOf: - $ref: "#/components/schemas/XmlString" - description: The type of resource. The only supported value isauto-scaling-group.
Key:
allOf:
- $ref: "#/components/schemas/TagKey"
- description: The tag key.
Value:
allOf:
- $ref: "#/components/schemas/TagValue"
- description: The tag value.
PropagateAtLaunch:
allOf:
- $ref: "#/components/schemas/PropagateAtLaunch"
- description: Determines whether the tag is added to new instances as they are launched in the group.
description: Describes a tag for an Auto Scaling group.
TargetTrackingMetricDataQuery:
type: object
required:
- Id
properties:
Id:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: "A short name that identifies the object's results in the response. This name must be unique among all TargetTrackingMetricDataQuery objects specified for a single
scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters
are letters, numbers, and underscores. The first character must be a lowercase letter. "
Expression:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen2047"
- description: "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer
to those metrics, and can also use the Id of other expressions to use the result of those expressions.
Conditional: Within each TargetTrackingMetricDataQuery
object, you must specify either Expression or MetricStat, but not both.
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression
or MetricStat, but not both.
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only
the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the
metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default
(true).
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most
commonly used metric for scaling is Average.
This structure defines the CloudWatch metric to return, along with the statistic and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
TerminateInstanceInAutoScalingGroupType: type: object required: - InstanceId - ShouldDecrementDesiredCapacity title: TerminateInstanceInAutoScalingGroupType properties: InstanceId: allOf: - $ref: "#/components/schemas/XmlStringMaxLen19" - description: The ID of the instance. ShouldDecrementDesiredCapacity: allOf: - $ref: "#/components/schemas/ShouldDecrementDesiredCapacity" - description: Indicates whether terminating the instance also decrements the size of the Auto Scaling group. TrafficSourceState: type: object properties: TrafficSource: allOf: - $ref: "#/components/schemas/XmlStringMaxLen511" - deprecated: true description: This is replaced byIdentifier.TrafficSource has been replaced by Identifier
State:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: Describes the current state of a traffic source.
The state values are as follows:
Adding - The Auto Scaling instances are being
registered with the load balancer or target group.
Added - All Auto Scaling instances are registered with the load balancer or target group.
InService - For an Elastic Load Balancing load balancer or target group, at least one Auto Scaling instance passed an ELB health check. For VPC
Lattice, at least one Auto Scaling instance passed an VPC_LATTICE health check.
Removing - The Auto Scaling instances are being deregistered
from the load balancer or target group. If connection draining (deregistration delay) is enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to complete before
deregistering the instances.
Removed - All Auto Scaling instances are deregistered from the load balancer or target group.
Provides additional context for the value of Identifier.
The following lists the valid values:
elb if
Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load
Balancer, or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
description: Describes the state of a traffic source. UpdateAutoScalingGroupType: type: object required: - AutoScalingGroupName title: UpdateAutoScalingGroupType properties: AutoScalingGroupName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the Auto Scaling group. LaunchConfigurationName: allOf: - $ref: "#/components/schemas/XmlStringMaxLen255" - description: The name of the launch configuration. If you specifyLaunchConfigurationName in your update request, you can't specify LaunchTemplate or
MixedInstancesPolicy.
LaunchTemplate:
allOf:
- $ref: "#/components/schemas/LaunchTemplateSpecification"
- description: The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify
LaunchConfigurationName or MixedInstancesPolicy.
MixedInstancesPolicy:
allOf:
- $ref: "#/components/schemas/MixedInstancesPolicy"
- description: The mixed instances policy. For more information, see Auto Scaling
groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
MinSize:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupMinSize"
- description: The minimum size of the Auto Scaling group.
MaxSize:
allOf:
- $ref: "#/components/schemas/AutoScalingGroupMaxSize"
- description: The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance weight
(weights that define how many units each instance contributes to the desired capacity of the group).
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
AvailabilityZones: allOf: - $ref: "#/components/schemas/AvailabilityZones" - description: One or more Availability Zones for the group. HealthCheckType: allOf: - $ref: "#/components/schemas/XmlStringMaxLen32" - description:A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE.
EC2 is the default health check and cannot be disabled. For more information, see Health
checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto
Scaling User Guide.
PlacementGroup:
allOf:
- $ref: "#/components/schemas/XmlStringMaxLen255"
- description: The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier with AvailabilityZones, the subnets that you
specify must reside in those Availability Zones.
TerminationPolicies:
allOf:
- $ref: "#/components/schemas/TerminationPolicies"
- description: 'A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour
| NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection
only. For more information, see Creating an Auto Scaling group using attribute-based
instance type selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the
InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to
0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance
warmup enabled by specifying a value of 0 or other nominal value.