Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeInstanceRefreshes #Action=Describe Instance Refreshes #Action=Describe Instance Refreshes API'
description: <fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
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
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
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)
security:
- hmac: []
tags:
- name: '#Action=DescribeInstanceRefreshes'
paths:
/#Action=DescribeInstanceRefreshes:
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'
get:
x-aws-operation-name: DescribeInstanceRefreshes
operationId: GET_DescribeInstanceRefreshes
description: <p>Gets information about the instance refreshes for the specified Auto Scaling group.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.</p> <p>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.</p>
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 is <code>50</code> and the maximum value is <code>100</code>.
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
tags:
- '#Action=DescribeInstanceRefreshes'
post:
x-aws-operation-name: DescribeInstanceRefreshes
operationId: POST_DescribeInstanceRefreshes
description: <p>Gets information about the instance refreshes for the specified Auto Scaling group.</p> <p>This operation is part of the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html">instance refresh feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.</p> <p>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.</p>
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
tags:
- '#Action=DescribeInstanceRefreshes'
components:
schemas:
VCpuCountRequest:
type: object
required:
- Min
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The minimum number of vCPUs.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The maximum number of vCPUs.
description: Specifies the minimum and maximum for the <code>VCpuCount</code> object when you specify <a>InstanceRequirements</a> for an Auto Scaling group.
NullablePositiveInteger:
type: integer
minimum: 0
ResourceContentionFault: {}
NullableBoolean:
type: boolean
BurstablePerformance:
type: string
enum:
- included
- excluded
- required
MixedInstanceSpotPrice:
type: string
minLength: 0
maxLength: 255
AcceleratorNames:
type: array
items:
$ref: '#/components/schemas/AcceleratorName'
StandbyInstances:
type: string
enum:
- Terminate
- Ignore
- Wait
CpuManufacturer:
type: string
enum:
- intel
- amd
- amazon-web-services
InstancesToUpdate:
type: integer
minimum: 0
MaxRecords:
type: integer
CheckpointDelay:
type: integer
minimum: 0
maximum: 172800
RefreshPreferences:
type: object
properties:
MinHealthyPercentage:
allOf:
- $ref: '#/components/schemas/IntPercent'
- description: <p>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 <code>90</code>.</p> <p>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. </p>
InstanceWarmup:
allOf:
- $ref: '#/components/schemas/RefreshInstanceWarmup'
- description: <p>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 <code>InService</code> state.</p> <p>This property is not required for normal usage. Instead, use the <code>DefaultInstanceWarmup</code> property of the Auto Scaling group. The <code>InstanceWarmup</code> and <code>DefaultInstanceWarmup</code> properties work the same way. Only specify this property if you must override the <code>DefaultInstanceWarmup</code> property. </p> <p> If you do not specify this property, the instance warmup by default is the value of the <code>DefaultInstanceWarmup</code> property, if defined (which is recommended in all cases), or the <code>HealthCheckGracePeriod</code> property otherwise.</p>
CheckpointPercentages:
allOf:
- $ref: '#/components/schemas/CheckpointPercentages'
- description: <p>(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 <code>100</code>.</p> <p>For usage examples, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html">Adding checkpoints to an instance refresh</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
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 for <code>CheckpointPercentages</code>. If you specify a value for <code>CheckpointPercentages</code> and not for <code>CheckpointDelay</code>, the <code>CheckpointDelay</code> defaults to <code>3600</code> (1 hour). '
SkipMatching:
allOf:
- $ref: '#/components/schemas/SkipMatching'
- description: <p>(Optional) Indicates whether skip matching is enabled. If enabled (<code>true</code>), 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 <code>false</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh-skip-matching.html">Use an instance refresh with skip matching</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
AutoRollback:
allOf:
- $ref: '#/components/schemas/AutoRollback'
- description: '<p>(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails. The default is <code>false</code>.</p> <p>A rollback is not supported in the following situations: </p> <ul> <li> <p>There is no desired configuration specified for the instance refresh.</p> </li> <li> <p>The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the <code>ImageId</code> property.</p> </li> <li> <p>The Auto Scaling group uses the launch template''s <code>$Latest</code> or <code>$Default</code> version.</p> </li> </ul>'
ScaleInProtectedInstances:
allOf:
- $ref: '#/components/schemas/ScaleInProtectedInstances'
- description: <p>Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found. </p> <p>The following lists the valid values:</p> <dl> <dt>Refresh</dt> <dd> <p>Amazon EC2 Auto Scaling replaces instances that are protected from scale in.</p> </dd> <dt>Ignore</dt> <dd> <p>Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.</p> </dd> <dt>Wait (default)</dt> <dd> <p>Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.</p> </dd> </dl>
StandbyInstances:
allOf:
- $ref: '#/components/schemas/StandbyInstances'
- description: <p>Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in <code>Standby</code> state are found.</p> <p>The following lists the valid values:</p> <dl> <dt>Terminate</dt> <dd> <p>Amazon EC2 Auto Scaling terminates instances that are in <code>Standby</code>.</p> </dd> <dt>Ignore</dt> <dd> <p>Amazon EC2 Auto Scaling ignores instances that are in <code>Standby</code> and continues to replace instances that are in the <code>InService</code> state.</p> </dd> <dt>Wait (default)</dt> <dd> <p>Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.</p> </dd> </dl>
description: Describes the preferences for an instance refresh.
AcceleratorManufacturer:
type: string
enum:
- nvidia
- amd
- amazon-web-services
- xilinx
TimestampType:
type: string
format: date-time
IntPercent:
type: integer
minimum: 0
maximum: 100
LaunchTemplateSpecification:
type: object
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: '<p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p> <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a <code>LaunchTemplateName</code>.</p>'
LaunchTemplateName:
allOf:
- $ref: '#/components/schemas/LaunchTemplateName'
- description: '<p>The name of the launch template. To get the template name, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p> <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a <code>LaunchTemplateName</code>.</p>'
Version:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The version number, <code>$Latest</code>, or <code>$Default</code>. To get the version number, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a> API operation. New launch template versions can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a> API. If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.
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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
OnDemandBaseCapacity:
type: integer
NullablePositiveDouble:
type: number
format: double
minimum: 0
InstanceGeneration:
type: string
enum:
- current
- previous
LocalStorageTypes:
type: array
items:
$ref: '#/components/schemas/LocalStorageType'
ScaleInProtectedInstances:
type: string
enum:
- Refresh
- Ignore
- Wait
DescribeInstanceRefreshesAnswer:
type: object
example:
InstanceRefreshes:
- AutoScalingGroupName: my-auto-scaling-group
InstanceRefreshId: 08b91cf7-8fa6-48af-b6a6-d227f40f1b9b
InstancesToUpdate: 5
PercentageComplete: 0
StartTime: 2020-06-02 18:11:27+00:00
Status: InProgress
- AutoScalingGroupName: my-auto-scaling-group
EndTime: 2020-06-02 16:53:37+00:00
InstanceRefreshId: dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1
InstancesToUpdate: 0
PercentageComplete: 100
StartTime: 2020-06-02 16:43:19+00:00
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 <code>NextToken</code> value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
LaunchTemplate:
type: object
properties:
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: The launch template.
example: example-string
Overrides:
allOf:
- $ref: '#/components/schemas/Overrides'
- description: Any properties that you specify override the same properties in the launch template.
example: example-id-1234
description: Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
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: <p>Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.</p> <p>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 <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
XmlStringMaxLen1023:
type: string
minLength: 1
maxLength: 1023
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
InstanceRequirements:
type: object
required:
- VCpuCount
- MemoryMiB
properties:
VCpuCount:
allOf:
- $ref: '#/components/schemas/VCpuCountRequest'
- description: The minimum and maximum number of vCPUs for an instance type.
MemoryMiB:
allOf:
- $ref: '#/components/schemas/MemoryMiBRequest'
- description: The minimum and maximum instance memory size for an instance type, in MiB.
CpuManufacturers:
allOf:
- $ref: '#/components/schemas/CpuManufacturers'
- description: '<p>Lists which specific CPU manufacturers to include.</p> <ul> <li> <p>For instance types with Intel CPUs, specify <code>intel</code>.</p> </li> <li> <p>For instance types with AMD CPUs, specify <code>amd</code>.</p> </li> <li> <p>For instance types with Amazon Web Services CPUs, specify <code>amazon-web-services</code>.</p> </li> </ul> <note> <p>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. </p> </note> <p>Default: Any manufacturer</p>'
MemoryGiBPerVCpu:
allOf:
- $ref: '#/components/schemas/MemoryGiBPerVCpuRequest'
- description: '<p>The minimum and maximum amount of memory per vCPU for an instance type, in GiB.</p> <p>Default: No minimum or maximum limits</p>'
ExcludedInstanceTypes:
allOf:
- $ref: '#/components/schemas/ExcludedInstanceTypes'
- description: '<p>The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (<code>*</code>), to exclude an instance family, type, size, or generation. The following are examples: <code>m5.8xlarge</code>, <code>c5*.*</code>, <code>m5a.*</code>, <code>r*</code>, <code>*3*</code>. </p> <p>For example, if you specify <code>c5*</code>, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify <code>m5a.*</code>, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.</p> <note> <p>If you specify <code>ExcludedInstanceTypes</code>, you can''t specify <code>AllowedInstanceTypes</code>.</p> </note> <p>Default: No excluded instance types</p>'
InstanceGenerations:
allOf:
- $ref: '#/components/schemas/InstanceGenerations'
- description: '<p>Indicates whether current or previous generation instance types are included.</p> <ul> <li> <p>For current generation instance types, specify <code>current</code>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> </li> <li> <p>For previous generation instance types, specify <code>previous</code>.</p> </li> </ul> <p>Default: Any current or previous generation</p>'
SpotMaxPricePercentageOverLowestPrice:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: '<p>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 <code>999999</code>. </p> <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price. </p> <p>Default: <code>100</code> </p>'
OnDemandMaxPricePercentageOverLowestPrice:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: '<p>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 <code>999999</code>. </p> <p>If you set <code>DesiredCapacityType</code> to <code>vcpu</code> or <code>memory-mib</code>, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price. </p> <p>Default: <code>20</code> </p>'
BareMetal:
allOf:
- $ref: '#/components/schemas/BareMetal'
- description: '<p>Indicates whether bare metal instance types are included, excluded, or required.</p> <p>Default: <code>excluded</code> </p>'
BurstablePerformance:
allOf:
- $ref: '#/components/schemas/BurstablePerformance'
- description: '<p>Indicates whether burstable performance instance types are included, excluded, or required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Default: <code>excluded</code> </p>'
RequireHibernateSupport:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: '<p>Indicates whether instance types must provide On-Demand Instance hibernation support.</p> <p>Default: <code>false</code> </p>'
NetworkInterfaceCount:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceCountRequest'
- description: '<p>The minimum and maximum number of network interfaces for an instance type.</p> <p>Default: No minimum or maximum limits</p>'
LocalStorage:
allOf:
- $ref: '#/components/schemas/LocalStorage'
- description: '<p>Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 instance store</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Default: <code>included</code> </p>'
LocalStorageTypes:
allOf:
- $ref: '#/components/schemas/LocalStorageTypes'
- description: '<p>Indicates the type of local storage that is required.</p> <ul> <li> <p>For instance types with hard disk drive (HDD) storage, specify <code>hdd</code>.</p> </li> <li> <p>For instance types with solid state drive (SSD) storage, specify <code>ssd</code>.</p> </li> </ul> <p>Default: Any local storage type</p>'
TotalLocalStorageGB:
allOf:
- $ref: '#/components/schemas/TotalLocalStorageGBRequest'
- description: '<p>The minimum and maximum total local storage size for an instance type, in GB.</p> <p>De
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/openapi/amazon-ec2-auto-scaling-action-describeinstancerefreshes-api-openapi.yml