AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) GetInstanceTypesFromInstanceRequirements API operation.

Syntax

Get-EC2InstanceTypesFromInstanceRequirement
-InstanceRequirements_AcceleratorManufacturer <String[]>
-InstanceRequirements_AcceleratorName <String[]>
-InstanceRequirements_AcceleratorType <String[]>
-InstanceRequirements_AllowedInstanceType <String[]>
-ArchitectureType <String[]>
-InstanceRequirements_BareMetal <BareMetal>
-InstanceRequirements_BurstablePerformance <BurstablePerformance>
-InstanceRequirements_CpuManufacturer <String[]>
-InstanceRequirements_ExcludedInstanceType <String[]>
-InstanceRequirements_InstanceGeneration <String[]>
-InstanceRequirements_LocalStorage <LocalStorage>
-InstanceRequirements_LocalStorageType <String[]>
-AcceleratorCount_Max <Int32>
-AcceleratorTotalMemoryMiB_Max <Int32>
-BaselineEbsBandwidthMbps_Max <Int32>
-MemoryGiBPerVCpu_Max <Double>
-MemoryMiB_Max <Int32>
-NetworkBandwidthGbps_Max <Double>
-NetworkInterfaceCount_Max <Int32>
-TotalLocalStorageGB_Max <Double>
-VCpuCount_Max <Int32>
-InstanceRequirements_MaxSpotPriceAsPercentageOfOptimalOnDemandPrice <Int32>
-AcceleratorCount_Min <Int32>
-AcceleratorTotalMemoryMiB_Min <Int32>
-BaselineEbsBandwidthMbps_Min <Int32>
-MemoryGiBPerVCpu_Min <Double>
-MemoryMiB_Min <Int32>
-NetworkBandwidthGbps_Min <Double>
-NetworkInterfaceCount_Min <Int32>
-TotalLocalStorageGB_Min <Double>
-VCpuCount_Min <Int32>
-InstanceRequirements_OnDemandMaxPricePercentageOverLowestPrice <Int32>
-InstanceRequirements_RequireHibernateSupport <Boolean>
-InstanceRequirements_SpotMaxPricePercentageOverLowestPrice <Int32>
-VirtualizationType <String[]>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

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.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-AcceleratorCount_Max <Int32>
The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorCount_Max
-AcceleratorCount_Min <Int32>
The minimum number of accelerators. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorCount_Min
-AcceleratorTotalMemoryMiB_Max <Int32>
The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorTotalMemoryMiB_Max
-AcceleratorTotalMemoryMiB_Min <Int32>
The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorTotalMemoryMiB_Min
-ArchitectureType <String[]>
The processor architecture type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesArchitectureTypes
-BaselineEbsBandwidthMbps_Max <Int32>
The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_BaselineEbsBandwidthMbps_Max
-BaselineEbsBandwidthMbps_Min <Int32>
The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_BaselineEbsBandwidthMbps_Min
-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_AcceleratorManufacturer <String[]>
Indicates whether instance types must have accelerators by specific manufacturers.
  • For instance types with Amazon Web Services devices, specify amazon-web-services.
  • For instance types with AMD devices, specify amd.
  • For instance types with Habana devices, specify habana.
  • For instance types with NVIDIA devices, specify nvidia.
  • For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorManufacturers
-InstanceRequirements_AcceleratorName <String[]>
The accelerators that must be on the instance type.
  • For instance types with NVIDIA A10G GPUs, specify a10g.
  • For instance types with NVIDIA A100 GPUs, specify a100.
  • For instance types with NVIDIA H100 GPUs, specify h100.
  • For instance types with Amazon Web Services Inferentia chips, specify inferentia.
  • For instance types with NVIDIA GRID K520 GPUs, specify k520.
  • For instance types with NVIDIA K80 GPUs, specify k80.
  • 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 NVIDIA T4 GPUs, specify t4.
  • For instance types with NVIDIA T4G GPUs, specify t4g.
  • For instance types with Xilinx VU9P FPGAs, specify vu9p.
  • For instance types with NVIDIA V100 GPUs, specify v100.
Default: Any accelerator
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorNames
-InstanceRequirements_AcceleratorType <String[]>
The accelerator types that must be on the instance type.
  • To include instance types with GPU hardware, specify gpu.
  • To include instance types with FPGA hardware, specify fpga.
  • To include instance types with inference hardware, specify inference.
Default: Any accelerator type
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AcceleratorTypes
-InstanceRequirements_AllowedInstanceType <String[]>
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.If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.Default: All instance types
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_AllowedInstanceTypes
-InstanceRequirements_BareMetal <BareMetal>
Indicates whether bare metal instance types must be included, excluded, or required.
  • To include bare metal instance types, specify included.
  • To require only bare metal instance types, specify required.
  • To exclude bare metal instance types, specify excluded.
Default: excluded
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_BurstablePerformance <BurstablePerformance>
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
  • To include burstable performance instance types, specify included.
  • To require only burstable performance instance types, specify required.
  • To exclude burstable performance instance types, specify excluded.
Default: excluded
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_CpuManufacturer <String[]>
The 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 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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_CpuManufacturers
-InstanceRequirements_ExcludedInstanceType <String[]>
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.If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.Default: No excluded instance types
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_ExcludedInstanceTypes
-InstanceRequirements_InstanceGeneration <String[]>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_InstanceGenerations
-InstanceRequirements_LocalStorage <LocalStorage>
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.
  • To include instance types with instance store volumes, specify included.
  • To require only instance types with instance store volumes, specify required.
  • To exclude instance types with instance store volumes, specify excluded.
Default: included
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_LocalStorageType <String[]>
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: hdd and ssd
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_LocalStorageTypes
-InstanceRequirements_MaxSpotPriceAsPercentageOfOptimalOnDemandPrice <Int32>
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.The parameter accepts an integer, which Amazon EC2 interprets as a percentage.To indicate no price protection threshold, specify a high value, such as 999999.If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, then SpotMaxPricePercentageOverLowestPrice is used and the value for that parameter defaults to 100.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_OnDemandMaxPricePercentageOverLowestPrice <Int32>
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.The parameter accepts an integer, which Amazon EC2 interprets as a percentage.To indicate no price protection threshold, specify a high value, such as 999999.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_RequireHibernateSupport <Boolean>
Indicates whether instance types must support hibernation for On-Demand Instances.This parameter is not supported for GetSpotPlacementScores.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceRequirements_SpotMaxPricePercentageOverLowestPrice <Int32>
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.The parameter accepts an integer, which Amazon EC2 interprets as a percentage.To indicate no price protection threshold, specify a high value, such as 999999.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.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, then SpotMaxPricePercentageOverLowestPrice is used and the value for that parameter defaults to 100.Default: 100
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-MemoryGiBPerVCpu_Max <Double>
The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_MemoryGiBPerVCpu_Max
-MemoryGiBPerVCpu_Min <Double>
The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_MemoryGiBPerVCpu_Min
-MemoryMiB_Max <Int32>
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_MemoryMiB_Max
-MemoryMiB_Min <Int32>
The minimum amount of memory, in MiB. To specify no minimum limit, specify 0.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_MemoryMiB_Min
-NetworkBandwidthGbps_Max <Double>
The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_NetworkBandwidthGbps_Max
-NetworkBandwidthGbps_Min <Double>
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_NetworkBandwidthGbps_Min
-NetworkInterfaceCount_Max <Int32>
The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_NetworkInterfaceCount_Max
-NetworkInterfaceCount_Min <Int32>
The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_NetworkInterfaceCount_Min
-NextToken <String>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'InstanceTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.GetInstanceTypesFromInstanceRequirementsResponse). Specifying the name of a property of type Amazon.EC2.Model.GetInstanceTypesFromInstanceRequirementsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TotalLocalStorageGB_Max <Double>
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_TotalLocalStorageGB_Max
-TotalLocalStorageGB_Min <Double>
The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_TotalLocalStorageGB_Min
-VCpuCount_Max <Int32>
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_VCpuCount_Max
-VCpuCount_Min <Int32>
The minimum number of vCPUs. To specify no minimum limit, specify 0.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceRequirements_VCpuCount_Min
-VirtualizationType <String[]>
The virtualization type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVirtualizationTypes

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a collection of Amazon.EC2.Model.InstanceTypeInfoFromInstanceRequirements objects. The service call response (type Amazon.EC2.Model.GetInstanceTypesFromInstanceRequirementsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z