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) DescribeInstanceTypes API operation.

Syntax

Get-EC2InstanceType
-Filter <Filter[]>
-InstanceType <String[]>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.

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

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <Filter[]>
One or more filters. Filter names and values are case-sensitive.
  • auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
  • bare-metal - Indicates whether it is a bare metal instance type (true | false).
  • burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
  • current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
  • ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
  • ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
  • ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
  • ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
  • ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
  • ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
  • ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
  • ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
  • ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
  • free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
  • hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
  • hypervisor - The hypervisor (nitro | xen).
  • instance-storage-info.disk.count - The number of local disks.
  • instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
  • instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
  • instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
  • instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
  • instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
  • instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
  • instance-type - The instance type (for example c5.2xlarge or c5*).
  • memory-info.size-in-mib - The memory size.
  • network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
  • network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
  • network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
  • network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
  • network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
  • network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
  • network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
  • network-info.maximum-network-cards - The maximum number of network cards per instance.
  • network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
  • network-info.network-performance - The network performance (for example, "25 Gigabit").
  • nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
  • nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
  • nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
  • processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
  • processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
  • processor-info.supported-features - The supported CPU features (amd-sev-snp).
  • supported-boot-mode - The boot mode (legacy-bios | uefi).
  • supported-root-device-type - The root device type (ebs | instance-store).
  • supported-usage-class - The usage class (on-demand | spot).
  • supported-virtualization-type - The virtualization type (hvm | paravirtual).
  • vcpu-info.default-cores - The default number of cores for the instance type.
  • vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
  • vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
  • vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
  • vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters
-InstanceType <String[]>
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceTypes
-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.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-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.DescribeInstanceTypesResponse). Specifying the name of a property of type Amazon.EC2.Model.DescribeInstanceTypesResponse 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)

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

Amazon.EC2.Model.InstanceTypeInfo or Amazon.EC2.Model.DescribeInstanceTypesResponse
This cmdlet returns a collection of Amazon.EC2.Model.InstanceTypeInfo objects. The service call response (type Amazon.EC2.Model.DescribeInstanceTypesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

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