describe_instance_types¶
Operation¶
describe_instance_types
¶
describe_instance_types(request: DescribeInstanceTypesInput | DescribeInstanceTypesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceTypesInputDict]) -> DescribeInstanceTypesOutput
Describes the specified instance types. By default, all instance types
for the current Region are described. Alternatively, you can filter the
results. To include instance types that are not supported in the current
Region, set IncludeUnsupportedInRegion to true.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeInstanceTypesInput | DescribeInstanceTypesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeInstanceTypesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceTypesOutput
|
An instance of |
describe_instance_types
async
¶
describe_instance_types(request: DescribeInstanceTypesInput | DescribeInstanceTypesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceTypesInputDict]) -> DescribeInstanceTypesOutput
Describes the specified instance types. By default, all instance types
for the current Region are described. Alternatively, you can filter the
results. To include instance types that are not supported in the current
Region, set IncludeUnsupportedInRegion to true.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeInstanceTypesInput | DescribeInstanceTypesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeInstanceTypesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceTypesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeInstanceTypesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeInstanceTypesInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
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). -
dedicated-hosts-supported- Indicates whether the instance type supports Dedicated Hosts. (true|false) -
ebs-info.attachment-limit-type- The type of Amazon EBS volume attachment limit (shared|dedicated). -
ebs-info.maximum-ebs-attachments- The maximum number of Amazon EBS volumes that can be attached to the instance type. -
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- A Boolean that indicates whether this instance type can be used under the Amazon Web Services 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 examplec5.2xlargeor c5*). -
memory-info.size-in-mib- The memory size. -
network-info.bandwidth-weightings- For instances that support bandwidth weighting to boost performance (default,vpc-1,ebs-1). -
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.flexible-ena-queues-support- Indicates whether an instance supports flexible ENA queues (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). -
reboot-migration-support- Indicates whether enabling reboot migration is supported (supported|unsupported). -
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|capacity-block). -
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".
include_unsupported_in_region
instance-attribute
¶
include_unsupported_in_region: bool | None
If true, the response includes instance types that are not supported
in the current Region, in addition to the supported types. Default:
false.
max_results
instance-attribute
¶
max_results: int | None
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.
DescribeInstanceTypesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTypesInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
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). -
dedicated-hosts-supported- Indicates whether the instance type supports Dedicated Hosts. (true|false) -
ebs-info.attachment-limit-type- The type of Amazon EBS volume attachment limit (shared|dedicated). -
ebs-info.maximum-ebs-attachments- The maximum number of Amazon EBS volumes that can be attached to the instance type. -
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- A Boolean that indicates whether this instance type can be used under the Amazon Web Services 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 examplec5.2xlargeor c5*). -
memory-info.size-in-mib- The memory size. -
network-info.bandwidth-weightings- For instances that support bandwidth weighting to boost performance (default,vpc-1,ebs-1). -
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.flexible-ena-queues-support- Indicates whether an instance supports flexible ENA queues (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). -
reboot-migration-support- Indicates whether enabling reboot migration is supported (supported|unsupported). -
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|capacity-block). -
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".
include_unsupported_in_region
class-attribute
instance-attribute
¶
include_unsupported_in_region: bool | None = ...
If true, the response includes instance types that are not supported
in the current Region, in addition to the supported types. Default:
false.
instance_types
class-attribute
instance-attribute
¶
The instance types.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
Output¶
DescribeInstanceTypesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTypesOutput structure.
Attributes¶
instance_types
class-attribute
instance-attribute
¶
instance_types: list[InstanceTypeInfo] | None = ...
The instance type.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.