openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeInstanceRefreshes 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
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
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:
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
AcceleratorType:
type: string
enum:
- gpu
- fpga
- inference
LaunchTemplateOverrides:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>The instance type, such as <code>m3.xlarge</code>. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can specify up to 40 instance types per Auto Scaling group.</p>
WeightedCapacity:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: <p>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 <code>WeightedCapacity</code> of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html">Configuring instance weighting for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p> <p>If you specify a value for <code>WeightedCapacity</code> for one instance type, you must specify a value for <code>WeightedCapacity</code> for all of them.</p> <important> <p>Every Auto Scaling group has three size parameters (<code>DesiredCapacity</code>, <code>MaxSize</code>, and <code>MinSize</code>). 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. </p> </important>
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: <p>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 <code>LaunchTemplate</code> definition. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html">Specifying a different launch template for an instance type</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p> <p>You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the <code>LaunchTemplate</code> definition count towards this limit.</p>
InstanceRequirements:
allOf:
- $ref: '#/components/schemas/InstanceRequirements'
- description: <p>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.</p> <p>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. </p> <note> <p>If you specify <code>InstanceRequirements</code>, you can't specify <code>InstanceType</code>.</p> </note>
description: <p>Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:</p> <ul> <li> <p>Override the instance type that is specified in the launch template.</p> </li> <li> <p>Use multiple instance types.</p> </li> </ul> <p>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.</p> <p>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.</p>
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: <p>Specifies the minimum and maximum for the <code>NetworkBandwidthGbps</code> object when you specify <a>InstanceRequirements</a> for an Auto Scaling group.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth">Available instance bandwidth</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> </note>
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 <code>TotalLocalStorageGB</code> object when you specify <a>InstanceRequirements</a> for an Auto Scaling group.
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 <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>.
MixedInstancesPolicy:
allOf:
- $ref: '#/components/schemas/MixedInstancesPolicy'
- 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>
description: <p>Describes the desired configuration for an instance refresh. </p> <p>If you specify a desired configuration, you must specify either a <code>LaunchTemplate</code> or a <code>MixedInstancesPolicy</code>. </p>
InstanceRefreshIds:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
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>Default: No minimum or maximum limits</p>'
BaselineEbsBandwidthMbps:
allOf:
- $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest'
- description: '<p>The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html">Amazon EBS–optimized instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Default: No minimum or maximum limits</p>'
AcceleratorTypes:
allOf:
- $ref: '#/components/schemas/AcceleratorTypes'
- description: '<p>Lists the accelerator types that must be on an instance type.</p> <ul> <li> <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p> </li> <li> <p>For instance types with FPGA accelerators, specify <code>fpga</code>.</p> </li> <li> <p>For instance types with inference accelerators, specify <code>inference</code>.</p> </li> </ul> <p>Default: Any accelerator type</p>'
AcceleratorCount:
allOf:
- $ref: '#/components/schemas/AcceleratorCountRequest'
- description: '<p>The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.</p> <p>To exclude accelerator-enabled instance types, set <code>Max</code> to <code>0</code>.</p> <p>Default: No minimum or maximum limits</p>'
AcceleratorManufacturers:
allOf:
- $ref: '#/components/schemas/AcceleratorManufacturers'
- description: '<p>Indicates whether instance types must have accelerators by specific manufacturers.</p> <ul> <li> <p>For instance types with NVIDIA devices, specify <code>nvidia</code>.</p> </li> <li> <p>For instance types with AMD devices, specify <code>amd</code>.</p> </li> <li> <p>For instance types with Amazon Web Services devices, specify <code>amazon-web-services</code>.</p> </li> <li> <p>For instance types with Xilinx devices, specify <code>xilinx</code>.</p> </li> </ul> <p>Default: Any manufacturer</p>'
AcceleratorNames:
allOf:
- $ref: '#/components/schemas/AcceleratorNames'
- description: '<p>Lists the accelerators that must be on an instance type.</p> <ul> <li> <p>For instance types with NVIDIA A100 GPUs, specify <code>a100</code>.</p> </li> <li> <p>For instance types with NVIDIA V100 GPUs, specify <code>v100</code>.</p> </li> <li> <p>For instance types with NVIDIA K80 GPUs, specify <code>k80</code>.</p> </li> <li> <p>For instance types with NVIDIA T4 GPUs, specify <code>t4</code>.</p> </li> <li> <p>For instance types with NVIDIA M60 GPUs, specify <code>m60</code>.</p> </li> <li> <p>For instance types with AMD Radeon Pro V520 GPUs, specify <code>radeon-pro-v520</code>.</p> </li> <li> <p>For instance types with Xilinx VU9P FPGAs, specify <code>vu9p</code>.</p> </li> </ul> <p>Default: Any accelerator</p>'
AcceleratorTotalMemoryMiB:
allOf:
- $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest'
- description: '<p>The minimum and maximum total memory size for the accelerators on an instance type, in MiB.</p> <p>Default: No minimum or maximum limits</p>'
NetworkBandwidthGbps:
allOf:
- $ref: '#/components/schemas/NetworkBandwidthGbpsRequest'
- description: '<p>The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).</p> <p>Default: No minimum or maximum limits</p>'
AllowedInstanceTypes:
allOf:
- $ref: '#/components/schemas/AllowedInstanceTypes'
- description: '<p>The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.</p> <p>You can use strings with one or more wild cards, represented by an asterisk (<code>*</code>), to allow an instance 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>, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify <code>m5a.*</code>, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.</p> <note> <p>If you specify <code>AllowedInstanceTypes</code>, you can''t specify <code>ExcludedInstanceTypes</code>.</p> </note> <p>Default: All instance types</p>'
description: <p>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.</p> <p>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.</p> <p>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 p
# --- 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