EC2.Client.
get_instance_types_from_instance_requirements
(**kwargs)¶Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide , and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_instance_types_from_instance_requirements(
DryRun=True|False,
ArchitectureTypes=[
'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac',
],
VirtualizationTypes=[
'hvm'|'paravirtual',
],
InstanceRequirements={
'VCpuCount': {
'Min': 123,
'Max': 123
},
'MemoryMiB': {
'Min': 123,
'Max': 123
},
'CpuManufacturers': [
'intel'|'amd'|'amazon-web-services',
],
'MemoryGiBPerVCpu': {
'Min': 123.0,
'Max': 123.0
},
'ExcludedInstanceTypes': [
'string',
],
'InstanceGenerations': [
'current'|'previous',
],
'SpotMaxPricePercentageOverLowestPrice': 123,
'OnDemandMaxPricePercentageOverLowestPrice': 123,
'BareMetal': 'included'|'required'|'excluded',
'BurstablePerformance': 'included'|'required'|'excluded',
'RequireHibernateSupport': True|False,
'NetworkInterfaceCount': {
'Min': 123,
'Max': 123
},
'LocalStorage': 'included'|'required'|'excluded',
'LocalStorageTypes': [
'hdd'|'ssd',
],
'TotalLocalStorageGB': {
'Min': 123.0,
'Max': 123.0
},
'BaselineEbsBandwidthMbps': {
'Min': 123,
'Max': 123
},
'AcceleratorTypes': [
'gpu'|'fpga'|'inference',
],
'AcceleratorCount': {
'Min': 123,
'Max': 123
},
'AcceleratorManufacturers': [
'nvidia'|'amd'|'amazon-web-services'|'xilinx',
],
'AcceleratorNames': [
'a100'|'v100'|'k80'|'t4'|'m60'|'radeon-pro-v520'|'vu9p'|'inferentia'|'k520',
],
'AcceleratorTotalMemoryMiB': {
'Min': 123,
'Max': 123
},
'NetworkBandwidthGbps': {
'Min': 123.0,
'Max': 123.0
},
'AllowedInstanceTypes': [
'string',
]
},
MaxResults=123,
NextToken='string'
)
DryRunOperation
. Otherwise, it is UnauthorizedOperation
.[REQUIRED]
The processor architecture type.
[REQUIRED]
The virtualization type.
[REQUIRED]
The attributes required for the instance types.
The minimum and maximum number of vCPUs.
The minimum number of vCPUs. To specify no minimum limit, specify 0
.
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
The minimum and maximum amount of memory, in MiB.
The minimum amount of memory, in MiB. To specify no minimum limit, specify 0
.
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
The CPU manufacturers to include.
intel
.amd
.amazon-web-services
.Note
Don't confuse the CPU manufacturer with the CPU 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
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
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*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*
, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
Note
If you specify ExcludedInstanceTypes
, you can't specify AllowedInstanceTypes
.
Default: No excluded instance types
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide .
For current generation instance types, specify current
.
For previous generation instance types, specify previous
.
Default: Current and previous generation instance types
The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999
.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
If you set TargetCapacityUnitType
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 above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999
.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
If you set TargetCapacityUnitType
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 must be included, excluded, or required.
included
.required
.excluded
.Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
included
.required
.excluded
.Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide .
included
.required
.excluded
.Default: included
The type of local storage that is required.
hdd
.ssd
.Default: hdd
and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
The accelerator types that must be on the instance type.
gpu
.fpga
.inference
.Default: Any accelerator type
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max
to 0
.
Default: No minimum or maximum limits
The minimum number of accelerators. To specify no minimum limit, omit this parameter.
The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max
to 0
.
Indicates whether instance types must have accelerators by specific manufacturers.
nvidia
.amd
.amazon-web-services
.xilinx
.Default: Any manufacturer
The accelerators that must be on the instance type.
a100
.v100
.k80
.t4
.m60
.radeon-pro-v520
.vu9p
.inferentia
.k520
.Default: Any accelerator
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
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 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*
, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
Note
If you specify AllowedInstanceTypes
, you can't specify ExcludedInstanceTypes
.
Default: All instance types
dict
Response Syntax
{
'InstanceTypes': [
{
'InstanceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceTypes (list) --
The instance types with the specified instance attributes.
(dict) --
The list of instance types with the specified instance attributes.
InstanceType (string) --
The matching instance type.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null
when there are no more items to return.