Amazon Elastic Compute Cloud

2021/10/28 - Amazon Elastic Compute Cloud - 26 updated api methods

Changes  Added new read-only DenyAllIGWTraffic network interface attribute. Added support for DL1 24xlarge instances powered by Habana Gaudi Accelerators for deep learning model training workloads

CreateCapacityReservationFleet (updated) Link ¶
Changes (request, response)
Request
{'InstanceTypeSpecifications': {'InstanceType': {'dl1.24xlarge'}}}
Response
{'FleetCapacityReservations': {'InstanceType': {'dl1.24xlarge'}}}

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

client.create_capacity_reservation_fleet(
    AllocationStrategy='string',
    ClientToken='string',
    InstanceTypeSpecifications=[
        {
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
            'Weight': 123.0,
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'EbsOptimized': True|False,
            'Priority': 123
        },
    ],
    Tenancy='default',
    TotalTargetCapacity=123,
    EndDate=datetime(2015, 1, 1),
    InstanceMatchCriteria='open',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)
type AllocationStrategy

string

param AllocationStrategy

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.

Valid values: prioritized

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency .

This field is autopopulated if not provided.

type InstanceTypeSpecifications

list

param InstanceTypeSpecifications

[REQUIRED]

Information about the instance types for which to reserve the capacity.

  • (dict) --

    Information about an instance type to use in a Capacity Reservation Fleet.

    • InstanceType (string) --

      The instance type for which the Capacity Reservation Fleet reserves capacity.

    • InstancePlatform (string) --

      The type of operating system for which the Capacity Reservation Fleet reserves capacity.

    • Weight (float) --

      The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

    • AvailabilityZone (string) --

      The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.

    • AvailabilityZoneId (string) --

      The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.

    • EbsOptimized (boolean) --

      Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types.

    • Priority (integer) --

      The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide.

type Tenancy

string

param Tenancy

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

  • default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

type TotalTargetCapacity

integer

param TotalTargetCapacity

[REQUIRED]

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

type EndDate

datetime

param EndDate

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019 .

type InstanceMatchCriteria

string

param InstanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

type TagSpecifications

list

param TagSpecifications

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

  • (dict) --

    The tags to apply to a resource when the resource is being created.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

      • (dict) --

        Describes a tag.

        • Key (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

        • Value (string) --

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'CapacityReservationFleetId': 'string',
    'State': 'submitted'|'modifying'|'active'|'partially_fulfilled'|'expiring'|'expired'|'cancelling'|'cancelled'|'failed',
    'TotalTargetCapacity': 123,
    'TotalFulfilledCapacity': 123.0,
    'InstanceMatchCriteria': 'open',
    'AllocationStrategy': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'EndDate': datetime(2015, 1, 1),
    'Tenancy': 'default',
    'FleetCapacityReservations': [
        {
            'CapacityReservationId': 'string',
            'AvailabilityZoneId': 'string',
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
            'AvailabilityZone': 'string',
            'TotalInstanceCount': 123,
            'FulfilledCapacity': 123.0,
            'EbsOptimized': True|False,
            'CreateDate': datetime(2015, 1, 1),
            'Weight': 123.0,
            'Priority': 123
        },
    ],
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • CapacityReservationFleetId (string) --

      The ID of the Capacity Reservation Fleet.

    • State (string) --

      The status of the Capacity Reservation Fleet.

    • TotalTargetCapacity (integer) --

      The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

    • TotalFulfilledCapacity (float) --

      The requested capacity units that have been successfully reserved.

    • InstanceMatchCriteria (string) --

      The instance matching criteria for the Capacity Reservation Fleet.

    • AllocationStrategy (string) --

      The allocation strategy used by the Capacity Reservation Fleet.

    • CreateTime (datetime) --

      The date and time at which the Capacity Reservation Fleet was created.

    • EndDate (datetime) --

      The date and time at which the Capacity Reservation Fleet expires.

    • Tenancy (string) --

      Indicates the tenancy of Capacity Reservation Fleet.

    • FleetCapacityReservations (list) --

      Information about the individual Capacity Reservations in the Capacity Reservation Fleet.

      • (dict) --

        Information about a Capacity Reservation in a Capacity Reservation Fleet.

        • CapacityReservationId (string) --

          The ID of the Capacity Reservation.

        • AvailabilityZoneId (string) --

          The ID of the Availability Zone in which the Capacity Reservation reserves capacity.

        • InstanceType (string) --

          The instance type for which the Capacity Reservation reserves capacity.

        • InstancePlatform (string) --

          The type of operating system for which the Capacity Reservation reserves capacity.

        • AvailabilityZone (string) --

          The Availability Zone in which the Capacity Reservation reserves capacity.

        • TotalInstanceCount (integer) --

          The total number of instances for which the Capacity Reservation reserves capacity.

        • FulfilledCapacity (float) --

          The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.

        • EbsOptimized (boolean) --

          Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.

        • CreateDate (datetime) --

          The date and time at which the Capacity Reservation was created.

        • Weight (float) --

          The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the Amazon EC2 User Guide.

        • Priority (integer) --

          The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the Amazon EC2 User Guide.

    • Tags (list) --

      The tags assigned to the Capacity Reservation Fleet.

      • (dict) --

        Describes a tag.

        • Key (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

        • Value (string) --

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

CreateFleet (updated) Link ¶
Changes (request, response)
Request
{'LaunchTemplateConfigs': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}}
Response
{'Errors': {'LaunchTemplateAndOverrides': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}},
 'Instances': {'InstanceType': {'dl1.24xlarge'},
               'LaunchTemplateAndOverrides': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}}}

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.create_fleet(
    DryRun=True|False,
    ClientToken='string',
    SpotOptions={
        'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized',
        'MaintenanceStrategies': {
            'CapacityRebalance': {
                'ReplacementStrategy': 'launch'
            }
        },
        'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
        'InstancePoolsToUseCount': 123,
        'SingleInstanceType': True|False,
        'SingleAvailabilityZone': True|False,
        'MinTargetCapacity': 123,
        'MaxTotalPrice': 'string'
    },
    OnDemandOptions={
        'AllocationStrategy': 'lowest-price'|'prioritized',
        'CapacityReservationOptions': {
            'UsageStrategy': 'use-capacity-reservations-first'
        },
        'SingleInstanceType': True|False,
        'SingleAvailabilityZone': True|False,
        'MinTargetCapacity': 123,
        'MaxTotalPrice': 'string'
    },
    ExcessCapacityTerminationPolicy='no-termination'|'termination',
    LaunchTemplateConfigs=[
        {
            'LaunchTemplateSpecification': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'Overrides': [
                {
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'MaxPrice': 'string',
                    'SubnetId': 'string',
                    'AvailabilityZone': 'string',
                    'WeightedCapacity': 123.0,
                    'Priority': 123.0,
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'Affinity': 'string',
                        'GroupName': 'string',
                        'PartitionNumber': 123,
                        'HostId': 'string',
                        'Tenancy': 'default'|'dedicated'|'host',
                        'SpreadDomain': 'string',
                        'HostResourceGroupArn': 'string'
                    },
                    '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',
                        ],
                        'AcceleratorTotalMemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        }
                    }
                },
            ]
        },
    ],
    TargetCapacitySpecification={
        'TotalTargetCapacity': 123,
        'OnDemandTargetCapacity': 123,
        'SpotTargetCapacity': 123,
        'DefaultTargetCapacityType': 'spot'|'on-demand',
        'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units'
    },
    TerminateInstancesWithExpiration=True|False,
    Type='request'|'maintain'|'instant',
    ValidFrom=datetime(2015, 1, 1),
    ValidUntil=datetime(2015, 1, 1),
    ReplaceUnhealthyInstances=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    Context='string'
)
type DryRun

boolean

param DryRun

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 .

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

type SpotOptions

dict

param SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

  • AllocationStrategy (string) --

    Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

    If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

    If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

    If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.

  • MaintenanceStrategies (dict) --

    The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

    • CapacityRebalance (dict) --

      The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

      • ReplacementStrategy (string) --

        The replacement strategy to use. Only available for fleets of type maintain .

        To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch . You must specify a value, otherwise you get an error.

        Note

        When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.

  • InstanceInterruptionBehavior (string) --

    The behavior when a Spot Instance is interrupted. The default is terminate .

  • InstancePoolsToUseCount (integer) --

    The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

    Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

  • SingleInstanceType (boolean) --

    Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .

  • SingleAvailabilityZone (boolean) --

    Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .

  • MinTargetCapacity (integer) --

    The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

  • MaxTotalPrice (string) --

    The maximum amount per hour for Spot Instances that you're willing to pay.

type OnDemandOptions

dict

param OnDemandOptions

Describes the configuration of On-Demand Instances in an EC2 Fleet.

  • AllocationStrategy (string) --

    The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .

  • CapacityReservationOptions (dict) --

    The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .

    • UsageStrategy (string) --

      Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

      If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).

      If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

  • SingleInstanceType (boolean) --

    Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .

  • SingleAvailabilityZone (boolean) --

    Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .

  • MinTargetCapacity (integer) --

    The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

  • MaxTotalPrice (string) --

    The maximum amount per hour for On-Demand Instances that you're willing to pay.

type ExcessCapacityTerminationPolicy

string

param ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

type LaunchTemplateConfigs

list

param LaunchTemplateConfigs

[REQUIRED]

The configuration for the EC2 Fleet.

  • (dict) --

    Describes a launch template and overrides.

    • LaunchTemplateSpecification (dict) --

      The launch template to use. You must specify either the launch template ID or launch template name in the request.

      • LaunchTemplateId (string) --

        The ID of the launch template. If you specify the template ID, you can't specify the template name.

      • LaunchTemplateName (string) --

        The name of the launch template. If you specify the template name, you can't specify the template ID.

      • Version (string) --

        The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

        If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

        If the value is $Default , Amazon EC2 uses the default version of the launch template.

    • Overrides (list) --

      Any parameters that you specify override the same parameters in the launch template.

      For fleets of type request and maintain , a maximum of 300 items is allowed across all launch templates.

      • (dict) --

        Describes overrides for a launch template.

        • InstanceType (string) --

          The instance type.

          Note

          If you specify InstanceTypes , you can't specify InstanceRequirements .

        • MaxPrice (string) --

          The maximum price per unit hour that you are willing to pay for a Spot Instance.

        • SubnetId (string) --

          The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2 ). A request of type instant can have only one subnet ID.

        • AvailabilityZone (string) --

          The Availability Zone in which to launch the instances.

        • WeightedCapacity (float) --

          The number of units provided by the specified instance type.

        • Priority (float) --

          The priority for the launch template override. The highest priority is launched first.

          If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

          If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

          Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.

        • Placement (dict) --

          The location where the instance launched, if applicable.

          • AvailabilityZone (string) --

            The Availability Zone of the instance.

            If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

            This parameter is not supported by CreateFleet .

          • Affinity (string) --

            The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

          • GroupName (string) --

            The name of the placement group the instance is in.

          • PartitionNumber (integer) --

            The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .

            This parameter is not supported by CreateFleet .

          • HostId (string) --

            The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

          • Tenancy (string) --

            The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

            T3 instances that use the unlimited CPU credit option do not support host tenancy.

          • SpreadDomain (string) --

            Reserved for future use.

            This parameter is not supported by CreateFleet .

          • HostResourceGroupArn (string) --

            The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

            This parameter is not supported by CreateFleet .

        • InstanceRequirements (dict) --

          The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

          Note

          If you specify InstanceRequirements , you can't specify InstanceTypes .

          • VCpuCount (dict) -- [REQUIRED]

            The minimum and maximum number of vCPUs.

            • Min (integer) -- [REQUIRED]

              The minimum number of vCPUs. To specify no minimum limit, specify 0 .

            • Max (integer) --

              The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

          • MemoryMiB (dict) -- [REQUIRED]

            The minimum and maximum amount of memory, in MiB.

            • Min (integer) -- [REQUIRED]

              The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .

            • Max (integer) --

              The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.

          • CpuManufacturers (list) --

            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 .

            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

            • (string) --

          • MemoryGiBPerVCpu (dict) --

            The minimum and maximum amount of memory per vCPU, in GiB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.

            • Max (float) --

              The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.

          • ExcludedInstanceTypes (list) --

            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 (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

            Default: No excluded instance types

            • (string) --

          • InstanceGenerations (list) --

            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

            • (string) --

          • SpotMaxPricePercentageOverLowestPrice (integer) --

            The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest 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 .

            Default: 100

          • OnDemandMaxPricePercentageOverLowestPrice (integer) --

            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 cheapest 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 .

            Default: 20

          • BareMetal (string) --

            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

          • BurstablePerformance (string) --

            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

          • RequireHibernateSupport (boolean) --

            Indicates whether instance types must support hibernation for On-Demand Instances.

            This parameter is not supported for GetSpotPlacementScores .

            Default: false

          • NetworkInterfaceCount (dict) --

            The minimum and maximum number of network interfaces.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum number of network interfaces. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum number of network interfaces. To specify no maximum limit, omit this parameter.

          • LocalStorage (string) --

            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

          • LocalStorageTypes (list) --

            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 (SDD) storage, specify sdd .

            Default: hdd and sdd

            • (string) --

          • TotalLocalStorageGB (dict) --

            The minimum and maximum amount of total local storage, in GB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.

            • Max (float) --

              The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.

          • BaselineEbsBandwidthMbps (dict) --

            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

            • Min (integer) --

              The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.

          • AcceleratorTypes (list) --

            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

            • (string) --

          • AcceleratorCount (dict) --

            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

            • Min (integer) --

              The minimum number of accelerators. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .

          • AcceleratorManufacturers (list) --

            Indicates whether instance types must have accelerators by specific manufacturers.

            • For instance types with NVIDIA devices, specify nvidia .

            • For instance types with AMD devices, specify amd .

            • For instance types with Amazon Web Services devices, specify amazon-web-services .

            • For instance types with Xilinx devices, specify xilinx .

            Default: Any manufacturer

            • (string) --

          • AcceleratorNames (list) --

            The accelerators that must be on the instance type.

            • For instance types with NVIDIA A100 GPUs, specify a100 .

            • For instance types with NVIDIA V100 GPUs, specify v100 .

            • For instance types with NVIDIA K80 GPUs, specify k80 .

            • For instance types with NVIDIA T4 GPUs, specify t4 .

            • 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 Xilinx VU9P FPGAs, specify vu9p .

            Default: Any accelerator

            • (string) --

          • AcceleratorTotalMemoryMiB (dict) --

            The minimum and maximum amount of total accelerator memory, in MiB.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

type TargetCapacitySpecification

dict

param TargetCapacitySpecification

[REQUIRED]

The number of units to request.

  • TotalTargetCapacity (integer) -- [REQUIRED]

    The number of units to request, filled using DefaultTargetCapacityType .

  • OnDemandTargetCapacity (integer) --

    The number of On-Demand units to request.

  • SpotTargetCapacity (integer) --

    The number of Spot units to request.

  • DefaultTargetCapacityType (string) --

    The default TotalTargetCapacity , which is either Spot or On-Demand .

  • TargetCapacityUnitType (string) --

    The unit for the target capacity.

    Default: units (translates to number of instances)

type TerminateInstancesWithExpiration

boolean

param TerminateInstancesWithExpiration

Indicates whether running instances should be terminated when the EC2 Fleet expires.

type Type

string

param Type

The fleet type. The default value is maintain .

  • maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.

  • request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.

  • instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide .

type ValidFrom

datetime

param ValidFrom

The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.

type ValidUntil

datetime

param ValidUntil

The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

type ReplaceUnhealthyInstances

boolean

param ReplaceUnhealthyInstances

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .

type TagSpecifications

list

param TagSpecifications

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources .

If the fleet type is instant , specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.

If the fleet type is maintain or request , specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance . To tag instances at launch, specify the tags in a launch template .

  • (dict) --

    The tags to apply to a resource when the resource is being created.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

      • (dict) --

        Describes a tag.

        • Key (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

        • Value (string) --

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

type Context

string

param Context

Reserved.

rtype

dict

returns

Response Syntax

{
    'FleetId': 'string',
    'Errors': [
        {
            'LaunchTemplateAndOverrides': {
                'LaunchTemplateSpecification': {
                    'LaunchTemplateId': 'string',
                    'LaunchTemplateName': 'string',
                    'Version': 'string'
                },
                'Overrides': {
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'MaxPrice': 'string',
                    'SubnetId': 'string',
                    'AvailabilityZone': 'string',
                    'WeightedCapacity': 123.0,
                    'Priority': 123.0,
                    'Placement': {
                        'GroupName': 'string'
                    },
                    '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',
                        ],
                        'AcceleratorTotalMemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        }
                    }
                }
            },
            'Lifecycle': 'spot'|'on-demand',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'Instances': [
        {
            'LaunchTemplateAndOverrides': {
                'LaunchTemplateSpecification': {
                    'LaunchTemplateId': 'string',
                    'LaunchTemplateName': 'string',
                    'Version': 'string'
                },
                'Overrides': {
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'MaxPrice': 'string',
                    'SubnetId': 'string',
                    'AvailabilityZone': 'string',
                    'WeightedCapacity': 123.0,
                    'Priority': 123.0,
                    'Placement': {
                        'GroupName': 'string'
                    },
                    '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',
                        ],
                        'AcceleratorTotalMemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        }
                    }
                }
            },
            'Lifecycle': 'spot'|'on-demand',
            'InstanceIds': [
                'string',
            ],
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'Platform': 'Windows'
        },
    ]
}

Response Structure

  • (dict) --

    • FleetId (string) --

      The ID of the EC2 Fleet.

    • Errors (list) --

      Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant .

      • (dict) --

        Describes the instances that could not be launched by the fleet.

        • LaunchTemplateAndOverrides (dict) --

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification (dict) --

            The launch template.

            • LaunchTemplateId (string) --

              The ID of the launch template. If you specify the template ID, you can't specify the template name.

            • LaunchTemplateName (string) --

              The name of the launch template. If you specify the template name, you can't specify the template ID.

            • Version (string) --

              The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

              If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

              If the value is $Default , Amazon EC2 uses the default version of the launch template.

          • Overrides (dict) --

            Any parameters that you specify override the same parameters in the launch template.

            • InstanceType (string) --

              The instance type.

              Note

              If you specify InstanceTypes , you can't specify InstanceRequirements .

            • MaxPrice (string) --

              The maximum price per unit hour that you are willing to pay for a Spot Instance.

            • SubnetId (string) --

              The ID of the subnet in which to launch the instances.

            • AvailabilityZone (string) --

              The Availability Zone in which to launch the instances.

            • WeightedCapacity (float) --

              The number of units provided by the specified instance type.

            • Priority (float) --

              The priority for the launch template override. The highest priority is launched first.

              If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

              If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

              Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

            • Placement (dict) --

              The location where the instance launched, if applicable.

              • GroupName (string) --

                The name of the placement group that the instance is in.

            • InstanceRequirements (dict) --

              The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

              Note

              If you specify InstanceRequirements , you can't specify InstanceTypes .

              • VCpuCount (dict) --

                The minimum and maximum number of vCPUs.

                • Min (integer) --

                  The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                • Max (integer) --

                  The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

              • MemoryMiB (dict) --

                The minimum and maximum amount of memory, in MiB.

                • Min (integer) --

                  The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

              • CpuManufacturers (list) --

                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 .

                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

                • (string) --

              • MemoryGiBPerVCpu (dict) --

                The minimum and maximum amount of memory per vCPU, in GiB.

                Default: No minimum or maximum limits

                • Min (float) --

                  The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                • Max (float) --

                  The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

              • ExcludedInstanceTypes (list) --

                The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                Default: No excluded instance types

                • (string) --

              • InstanceGenerations (list) --

                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

                • (string) --

              • SpotMaxPricePercentageOverLowestPrice (integer) --

                The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                Default: 100

              • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                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 cheapest 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 .

                Default: 20

              • BareMetal (string) --

                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

              • BurstablePerformance (string) --

                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

              • RequireHibernateSupport (boolean) --

                Indicates whether instance types must support hibernation for On-Demand Instances.

                This parameter is not supported for GetSpotPlacementScores .

                Default: false

              • NetworkInterfaceCount (dict) --

                The minimum and maximum number of network interfaces.

                Default: No minimum or maximum limits

                • Min (integer) --

                  The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

              • LocalStorage (string) --

                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

              • LocalStorageTypes (list) --

                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 (SDD) storage, specify sdd .

                Default: hdd and sdd

                • (string) --

              • TotalLocalStorageGB (dict) --

                The minimum and maximum amount of total local storage, in GB.

                Default: No minimum or maximum limits

                • Min (float) --

                  The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                • Max (float) --

                  The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

              • BaselineEbsBandwidthMbps (dict) --

                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

                • Min (integer) --

                  The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

              • AcceleratorTypes (list) --

                The accelerator types that must be on the instance type.

                • For instance types with GPU accelerators, specify gpu .

                • For instance types with FPGA accelerators, specify fpga .

                • For instance types with inference accelerators, specify inference .

                Default: Any accelerator type

                • (string) --

              • AcceleratorCount (dict) --

                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

                • Min (integer) --

                  The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

              • AcceleratorManufacturers (list) --

                Indicates whether instance types must have accelerators by specific manufacturers.

                • For instance types with NVIDIA devices, specify nvidia .

                • For instance types with AMD devices, specify amd .

                • For instance types with Amazon Web Services devices, specify amazon-web-services .

                • For instance types with Xilinx devices, specify xilinx .

                Default: Any manufacturer

                • (string) --

              • AcceleratorNames (list) --

                The accelerators that must be on the instance type.

                • For instance types with NVIDIA A100 GPUs, specify a100 .

                • For instance types with NVIDIA V100 GPUs, specify v100 .

                • For instance types with NVIDIA K80 GPUs, specify k80 .

                • For instance types with NVIDIA T4 GPUs, specify t4 .

                • 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 Xilinx VU9P FPGAs, specify vu9p .

                Default: Any accelerator

                • (string) --

              • AcceleratorTotalMemoryMiB (dict) --

                The minimum and maximum amount of total accelerator memory, in MiB.

                Default: No minimum or maximum limits

                • Min (integer) --

                  The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

        • Lifecycle (string) --

          Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

        • ErrorCode (string) --

          The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .

        • ErrorMessage (string) --

          The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .

    • Instances (list) --

      Information about the instances that were launched by the fleet. Supported only for fleets of type instant .

      • (dict) --

        Describes the instances that were launched by the fleet.

        • LaunchTemplateAndOverrides (dict) --

          The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

          • LaunchTemplateSpecification (dict) --

            The launch template.

            • LaunchTemplateId (string) --

              The ID of the launch template. If you specify the template ID, you can't specify the template name.

            • LaunchTemplateName (string) --

              The name of the launch template. If you specify the template name, you can't specify the template ID.

            • Version (string) --

              The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

              If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

              If the value is $Default , Amazon EC2 uses the default version of the launch template.

          • Overrides (dict) --

            Any parameters that you specify override the same parameters in the launch template.

            • InstanceType (string) --

              The instance type.

              Note

              If you specify InstanceTypes , you can't specify InstanceRequirements .

            • MaxPrice (string) --

              The maximum price per unit hour that you are willing to pay for a Spot Instance.

            • SubnetId (string) --

              The ID of the subnet in which to launch the instances.

            • AvailabilityZone (string) --

              The Availability Zone in which to launch the instances.

            • WeightedCapacity (float) --

              The number of units provided by the specified instance type.

            • Priority (float) --

              The priority for the launch template override. The highest priority is launched first.

              If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

              If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

              Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

            • Placement (dict) --

              The location where the instance launched, if applicable.

              • GroupName (string) --

                The name of the placement group that the instance is in.

            • InstanceRequirements (dict) --

              The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

              Note

              If you specify InstanceRequirements , you can't specify InstanceTypes .

              • VCpuCount (dict) --

                The minimum and maximum number of vCPUs.

                • Min (integer) --

                  The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                • Max (integer) --

                  The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

              • MemoryMiB (dict) --

                The minimum and maximum amount of memory, in MiB.

                • Min (integer) --

                  The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

              • CpuManufacturers (list) --

                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 .

                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

                • (string) --

              • MemoryGiBPerVCpu (dict) --

                The minimum and maximum amount of memory per vCPU, in GiB.

                Default: No minimum or maximum limits

                • Min (float) --

                  The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                • Max (float) --

                  The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

              • ExcludedInstanceTypes (list) --

                The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                Default: No excluded instance types

                • (string) --

              • InstanceGenerations (list) --

                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

                • (string) --

              • SpotMaxPricePercentageOverLowestPrice (integer) --

                The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                Default: 100

              • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                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 cheapest 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 .

                Default: 20

              • BareMetal (string) --

                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

              • BurstablePerformance (string) --

                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

              • RequireHibernateSupport (boolean) --

                Indicates whether instance types must support hibernation for On-Demand Instances.

                This parameter is not supported for GetSpotPlacementScores .

                Default: false

              • NetworkInterfaceCount (dict) --

                The minimum and maximum number of network interfaces.

                Default: No minimum or maximum limits

                • Min (integer) --

                  The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

              • LocalStorage (string) --

                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

              • LocalStorageTypes (list) --

                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 (SDD) storage, specify sdd .

                Default: hdd and sdd

                • (string) --

              • TotalLocalStorageGB (dict) --

                The minimum and maximum amount of total local storage, in GB.

                Default: No minimum or maximum limits

                • Min (float) --

                  The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                • Max (float) --

                  The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

              • BaselineEbsBandwidthMbps (dict) --

                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

                • Min (integer) --

                  The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

              • AcceleratorTypes (list) --

                The accelerator types that must be on the instance type.

                • For instance types with GPU accelerators, specify gpu .

                • For instance types with FPGA accelerators, specify fpga .

                • For instance types with inference accelerators, specify inference .

                Default: Any accelerator type

                • (string) --

              • AcceleratorCount (dict) --

                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

                • Min (integer) --

                  The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

              • AcceleratorManufacturers (list) --

                Indicates whether instance types must have accelerators by specific manufacturers.

                • For instance types with NVIDIA devices, specify nvidia .

                • For instance types with AMD devices, specify amd .

                • For instance types with Amazon Web Services devices, specify amazon-web-services .

                • For instance types with Xilinx devices, specify xilinx .

                Default: Any manufacturer

                • (string) --

              • AcceleratorNames (list) --

                The accelerators that must be on the instance type.

                • For instance types with NVIDIA A100 GPUs, specify a100 .

                • For instance types with NVIDIA V100 GPUs, specify v100 .

                • For instance types with NVIDIA K80 GPUs, specify k80 .

                • For instance types with NVIDIA T4 GPUs, specify t4 .

                • 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 Xilinx VU9P FPGAs, specify vu9p .

                Default: Any accelerator

                • (string) --

              • AcceleratorTotalMemoryMiB (dict) --

                The minimum and maximum amount of total accelerator memory, in MiB.

                Default: No minimum or maximum limits

                • Min (integer) --

                  The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                • Max (integer) --

                  The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

        • Lifecycle (string) --

          Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

        • InstanceIds (list) --

          The IDs of the instances.

          • (string) --

        • InstanceType (string) --

          The instance type.

        • Platform (string) --

          The value is Windows for Windows instances. Otherwise, the value is blank.

CreateLaunchTemplate (updated) Link ¶
Changes (request)
{'LaunchTemplateData': {'InstanceType': {'dl1.24xlarge'}}}

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances , you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_launch_template(
    DryRun=True|False,
    ClientToken='string',
    LaunchTemplateName='string',
    VersionDescription='string',
    LaunchTemplateData={
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                    'Throughput': 123
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociateCarrierIpAddress': True|False,
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'InterfaceType': 'string',
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string',
                'NetworkCardIndex': 123,
                'Ipv4Prefixes': [
                    {
                        'Ipv4Prefix': 'string'
                    },
                ],
                'Ipv4PrefixCount': 123,
                'Ipv6Prefixes': [
                    {
                        'Ipv6Prefix': 'string'
                    },
                ],
                'Ipv6PrefixCount': 123
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string',
            'PartitionNumber': 123
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'ElasticInferenceAccelerators': [
            {
                'Type': 'string',
                'Count': 123
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        },
        'CpuOptions': {
            'CoreCount': 123,
            'ThreadsPerCore': 123
        },
        'CapacityReservationSpecification': {
            'CapacityReservationPreference': 'open'|'none',
            'CapacityReservationTarget': {
                'CapacityReservationId': 'string',
                'CapacityReservationResourceGroupArn': 'string'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': True|False
        },
        'MetadataOptions': {
            'HttpTokens': 'optional'|'required',
            'HttpPutResponseHopLimit': 123,
            'HttpEndpoint': 'disabled'|'enabled',
            'HttpProtocolIpv6': 'disabled'|'enabled'
        },
        'EnclaveOptions': {
            'Enabled': True|False
        },
        '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',
            ],
            'AcceleratorTotalMemoryMiB': {
                'Min': 123,
                'Max': 123
            }
        }
    },
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)
type DryRun

boolean

param DryRun

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 .

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

Constraint: Maximum 128 ASCII characters.

type LaunchTemplateName

string

param LaunchTemplateName

[REQUIRED]

A name for the launch template.

type VersionDescription

string

param VersionDescription

A description for the first version of the launch template.

type LaunchTemplateData

dict

param LaunchTemplateData

[REQUIRED]

The information for the launch template.

  • KernelId (string) --

    The ID of the kernel.

    Warning

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .

  • EbsOptimized (boolean) --

    Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

  • IamInstanceProfile (dict) --

    The name or Amazon Resource Name (ARN) of an IAM instance profile.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the instance profile.

    • Name (string) --

      The name of the instance profile.

  • BlockDeviceMappings (list) --

    The block device mapping.

    • (dict) --

      Describes a block device mapping.

      • DeviceName (string) --

        The device name (for example, /dev/sdh or xvdh).

      • VirtualName (string) --

        The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

      • Ebs (dict) --

        Parameters used to automatically set up EBS volumes when the instance is launched.

        • Encrypted (boolean) --

          Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

        • DeleteOnTermination (boolean) --

          Indicates whether the EBS volume is deleted on instance termination.

        • Iops (integer) --

          The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

          The following are the supported values for each volume type:

          • gp3 : 3,000-16,000 IOPS

          • io1 : 100-64,000 IOPS

          • io2 : 100-64,000 IOPS

          For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

          This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

        • KmsKeyId (string) --

          The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

        • SnapshotId (string) --

          The ID of the snapshot.

        • VolumeSize (integer) --

          The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

          • gp2 and gp3 : 1-16,384

          • io1 and io2 : 4-16,384

          • st1 and sc1 : 125-16,384

          • standard : 1-1,024

        • VolumeType (string) --

          The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .

        • Throughput (integer) --

          The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

          Valid Range: Minimum value of 125. Maximum value of 1000.

      • NoDevice (string) --

        To omit the device from the block device mapping, specify an empty string.

  • NetworkInterfaces (list) --

    One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

    • (dict) --

      The parameters for a network interface.

      • AssociateCarrierIpAddress (boolean) --

        Associates a Carrier IP address with eth0 for a new network interface.

        Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .

      • AssociatePublicIpAddress (boolean) --

        Associates a public IPv4 address with eth0 for a new network interface.

      • DeleteOnTermination (boolean) --

        Indicates whether the network interface is deleted when the instance is terminated.

      • Description (string) --

        A description for the network interface.

      • DeviceIndex (integer) --

        The device index for the network interface attachment.

      • Groups (list) --

        The IDs of one or more security groups.

        • (string) --

      • InterfaceType (string) --

        The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

        If you are not creating an EFA, specify interface or omit this parameter.

        Valid values: interface | efa

      • Ipv6AddressCount (integer) --

        The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

      • Ipv6Addresses (list) --

        One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

        • (dict) --

          Describes an IPv6 address.

          • Ipv6Address (string) --

            The IPv6 address.

      • NetworkInterfaceId (string) --

        The ID of the network interface.

      • PrivateIpAddress (string) --

        The primary private IPv4 address of the network interface.

      • PrivateIpAddresses (list) --

        One or more private IPv4 addresses.

        • (dict) --

          Describes a secondary private IPv4 address for a network interface.

          • Primary (boolean) --

            Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

          • PrivateIpAddress (string) --

            The private IPv4 addresses.

      • SecondaryPrivateIpAddressCount (integer) --

        The number of secondary private IPv4 addresses to assign to a network interface.

      • SubnetId (string) --

        The ID of the subnet for the network interface.

      • NetworkCardIndex (integer) --

        The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

      • Ipv4Prefixes (list) --

        One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

      • Ipv4PrefixCount (integer) --

        The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

      • Ipv6Prefixes (list) --

        One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

        • (dict) --

          Describes the IPv4 prefix option for a network interface.

          • Ipv6Prefix (string) --

            The IPv6 prefix.

      • Ipv6PrefixCount (integer) --

        The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

  • ImageId (string) --

    The ID of the AMI.

  • InstanceType (string) --

    The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .

    If you specify InstanceTypes , you can't specify InstanceRequirements .

  • KeyName (string) --

    The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .

    Warning

    If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

  • Monitoring (dict) --

    The monitoring for the instance.

    • Enabled (boolean) --

      Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

  • Placement (dict) --

    The placement for the instance.

    • AvailabilityZone (string) --

      The Availability Zone for the instance.

    • Affinity (string) --

      The affinity setting for an instance on a Dedicated Host.

    • GroupName (string) --

      The name of the placement group for the instance.

    • HostId (string) --

      The ID of the Dedicated Host for the instance.

    • Tenancy (string) --

      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

    • SpreadDomain (string) --

      Reserved for future use.

    • HostResourceGroupArn (string) --

      The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

    • PartitionNumber (integer) --

      The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .

  • RamDiskId (string) --

    The ID of the RAM disk.

    Warning

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .

  • DisableApiTermination (boolean) --

    If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.

  • InstanceInitiatedShutdownBehavior (string) --

    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

    Default: stop

  • UserData (string) --

    The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

    If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format . For more information, see Amazon EC2 user data in launch templates in the Batch User Guide .

  • TagSpecifications (list) --

    The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .

    • (dict) --

      The tags specification for the launch template.

      • ResourceType (string) --

        The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume . To tag a resource after it has been created, see CreateTags .

      • Tags (list) --

        The tags to apply to the resource.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

  • ElasticGpuSpecifications (list) --

    An elastic GPU to associate with the instance.

    • (dict) --

      A specification for an Elastic Graphics accelerator.

      • Type (string) -- [REQUIRED]

        The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .

  • ElasticInferenceAccelerators (list) --

    The elastic inference accelerator for the instance.

    • (dict) --

      Describes an elastic inference accelerator.

      • Type (string) -- [REQUIRED]

        The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

      • Count (integer) --

        The number of elastic inference accelerators to attach to the instance.

        Default: 1

  • SecurityGroupIds (list) --

    One or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a security group ID and security name in the same request.

    • (string) --

  • SecurityGroups (list) --

    [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

    • (string) --

  • InstanceMarketOptions (dict) --

    The market (purchasing) option for the instances.

    • MarketType (string) --

      The market type.

    • SpotOptions (dict) --

      The options for Spot Instances.

      • MaxPrice (string) --

        The maximum hourly price you're willing to pay for the Spot Instances.

      • SpotInstanceType (string) --

        The Spot Instance request type.

      • BlockDurationMinutes (integer) --

        The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

      • ValidUntil (datetime) --

        The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

      • InstanceInterruptionBehavior (string) --

        The behavior when a Spot Instance is interrupted. The default is terminate .

  • CreditSpecification (dict) --

    The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.

    • CpuCredits (string) -- [REQUIRED]

      The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .

  • CpuOptions (dict) --

    The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .

    • CoreCount (integer) --

      The number of CPU cores for the instance.

    • ThreadsPerCore (integer) --

      The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

  • CapacityReservationSpecification (dict) --

    The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

    • CapacityReservationPreference (string) --

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

    • CapacityReservationTarget (dict) --

      Information about the target Capacity Reservation or Capacity Reservation group.

      • CapacityReservationId (string) --

        The ID of the Capacity Reservation in which to run the instance.

      • CapacityReservationResourceGroupArn (string) --

        The ARN of the Capacity Reservation resource group in which to run the instance.

  • LicenseSpecifications (list) --

    The license configurations.

    • (dict) --

      Describes a license configuration.

      • LicenseConfigurationArn (string) --

        The Amazon Resource Name (ARN) of the license configuration.

  • HibernationOptions (dict) --

    Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide .

    • Configured (boolean) --

      If you set this parameter to true , the instance is enabled for hibernation.

      Default: false

  • MetadataOptions (dict) --

    The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide .

    • HttpTokens (string) --

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

      If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

    • HttpPutResponseHopLimit (integer) --

      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Default: 1

      Possible values: Integers from 1 to 64

    • HttpEndpoint (string) --

      This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .

      Note

      If you specify a value of disabled , you will not be able to access your instance metadata.

    • HttpProtocolIpv6 (string) --

      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

  • EnclaveOptions (dict) --

    Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide .

    You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

    • Enabled (boolean) --

      To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true .

  • InstanceRequirements (dict) --

    The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

    If you specify InstanceRequirements , you can't specify InstanceTypes .

    • VCpuCount (dict) -- [REQUIRED]

      The minimum and maximum number of vCPUs.

      • Min (integer) -- [REQUIRED]

        The minimum number of vCPUs. To specify no minimum limit, specify 0 .

      • Max (integer) --

        The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

    • MemoryMiB (dict) -- [REQUIRED]

      The minimum and maximum amount of memory, in MiB.

      • Min (integer) -- [REQUIRED]

        The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .

      • Max (integer) --

        The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.

    • CpuManufacturers (list) --

      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 .

      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

      • (string) --

    • MemoryGiBPerVCpu (dict) --

      The minimum and maximum amount of memory per vCPU, in GiB.

      Default: No minimum or maximum limits

      • Min (float) --

        The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.

      • Max (float) --

        The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.

    • ExcludedInstanceTypes (list) --

      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 (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

      Default: No excluded instance types

      • (string) --

    • InstanceGenerations (list) --

      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

      • (string) --

    • SpotMaxPricePercentageOverLowestPrice (integer) --

      The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest 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 .

      Default: 100

    • OnDemandMaxPricePercentageOverLowestPrice (integer) --

      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 cheapest 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 .

      Default: 20

    • BareMetal (string) --

      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

    • BurstablePerformance (string) --

      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

    • RequireHibernateSupport (boolean) --

      Indicates whether instance types must support hibernation for On-Demand Instances.

      This parameter is not supported for GetSpotPlacementScores .

      Default: false

    • NetworkInterfaceCount (dict) --

      The minimum and maximum number of network interfaces.

      Default: No minimum or maximum limits

      • Min (integer) --

        The minimum number of network interfaces. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum number of network interfaces. To specify no maximum limit, omit this parameter.

    • LocalStorage (string) --

      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

    • LocalStorageTypes (list) --

      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 (SDD) storage, specify sdd .

      Default: hdd and sdd

      • (string) --

    • TotalLocalStorageGB (dict) --

      The minimum and maximum amount of total local storage, in GB.

      Default: No minimum or maximum limits

      • Min (float) --

        The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.

      • Max (float) --

        The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.

    • BaselineEbsBandwidthMbps (dict) --

      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

      • Min (integer) --

        The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.

    • AcceleratorTypes (list) --

      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

      • (string) --

    • AcceleratorCount (dict) --

      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

      • Min (integer) --

        The minimum number of accelerators. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .

    • AcceleratorManufacturers (list) --

      Indicates whether instance types must have accelerators by specific manufacturers.

      • For instance types with NVIDIA devices, specify nvidia .

      • For instance types with AMD devices, specify amd .

      • For instance types with Amazon Web Services devices, specify amazon-web-services .

      • For instance types with Xilinx devices, specify xilinx .

      Default: Any manufacturer

      • (string) --

    • AcceleratorNames (list) --

      The accelerators that must be on the instance type.

      • For instance types with NVIDIA A100 GPUs, specify a100 .

      • For instance types with NVIDIA V100 GPUs, specify v100 .

      • For instance types with NVIDIA K80 GPUs, specify k80 .

      • For instance types with NVIDIA T4 GPUs, specify t4 .

      • 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 Xilinx VU9P FPGAs, specify vu9p .

      Default: Any accelerator

      • (string) --

    • AcceleratorTotalMemoryMiB (dict) --

      The minimum and maximum amount of total accelerator memory, in MiB.

      Default: No minimum or maximum limits

      • Min (integer) --

        The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

type TagSpecifications

list

param TagSpecifications

The tags to apply to the launch template during creation.

  • (dict) --

    The tags to apply to a resource when the resource is being created.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

      • (dict) --

        Describes a tag.

        • Key (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

        • Value (string) --

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplate': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersionNumber': 123,
        'LatestVersionNumber': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'Warning': {
        'Errors': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • LaunchTemplate (dict) --

      Information about the launch template.

      • LaunchTemplateId (string) --

        The ID of the launch template.

      • LaunchTemplateName (string) --

        The name of the launch template.

      • CreateTime (datetime) --

        The time launch template was created.

      • CreatedBy (string) --

        The principal that created the launch template.

      • DefaultVersionNumber (integer) --

        The version number of the default version of the launch template.

      • LatestVersionNumber (integer) --

        The version number of the latest version of the launch template.

      • Tags (list) --

        The tags for the launch template.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • Warning (dict) --

      If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

      • Errors (list) --

        The error codes and error messages.

        • (dict) --

          The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.

          • Code (string) --

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes .

          • Message (string) --

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes .

CreateLaunchTemplateVersion (updated) Link ¶
Changes (request, response)
Request
{'LaunchTemplateData': {'InstanceType': {'dl1.24xlarge'}}}
Response
{'LaunchTemplateVersion': {'LaunchTemplateData': {'InstanceType': {'dl1.24xlarge'}}}}

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versions in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_launch_template_version(
    DryRun=True|False,
    ClientToken='string',
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    SourceVersion='string',
    VersionDescription='string',
    LaunchTemplateData={
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                    'Throughput': 123
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociateCarrierIpAddress': True|False,
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'InterfaceType': 'string',
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string',
                'NetworkCardIndex': 123,
                'Ipv4Prefixes': [
                    {
                        'Ipv4Prefix': 'string'
                    },
                ],
                'Ipv4PrefixCount': 123,
                'Ipv6Prefixes': [
                    {
                        'Ipv6Prefix': 'string'
                    },
                ],
                'Ipv6PrefixCount': 123
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string',
            'PartitionNumber': 123
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'ElasticInferenceAccelerators': [
            {
                'Type': 'string',
                'Count': 123
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        },
        'CpuOptions': {
            'CoreCount': 123,
            'ThreadsPerCore': 123
        },
        'CapacityReservationSpecification': {
            'CapacityReservationPreference': 'open'|'none',
            'CapacityReservationTarget': {
                'CapacityReservationId': 'string',
                'CapacityReservationResourceGroupArn': 'string'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': True|False
        },
        'MetadataOptions': {
            'HttpTokens': 'optional'|'required',
            'HttpPutResponseHopLimit': 123,
            'HttpEndpoint': 'disabled'|'enabled',
            'HttpProtocolIpv6': 'disabled'|'enabled'
        },
        'EnclaveOptions': {
            'Enabled': True|False
        },
        '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',
            ],
            'AcceleratorTotalMemoryMiB': {
                'Min': 123,
                'Max': 123
            }
        }
    }
)
type DryRun

boolean

param DryRun

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 .

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

Constraint: Maximum 128 ASCII characters.

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

type SourceVersion

string

param SourceVersion

The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData . Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.

type VersionDescription

string

param VersionDescription

A description for the version of the launch template.

type LaunchTemplateData

dict

param LaunchTemplateData

[REQUIRED]

The information for the launch template.

  • KernelId (string) --

    The ID of the kernel.

    Warning

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .

  • EbsOptimized (boolean) --

    Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

  • IamInstanceProfile (dict) --

    The name or Amazon Resource Name (ARN) of an IAM instance profile.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the instance profile.

    • Name (string) --

      The name of the instance profile.

  • BlockDeviceMappings (list) --

    The block device mapping.

    • (dict) --

      Describes a block device mapping.

      • DeviceName (string) --

        The device name (for example, /dev/sdh or xvdh).

      • VirtualName (string) --

        The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

      • Ebs (dict) --

        Parameters used to automatically set up EBS volumes when the instance is launched.

        • Encrypted (boolean) --

          Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

        • DeleteOnTermination (boolean) --

          Indicates whether the EBS volume is deleted on instance termination.

        • Iops (integer) --

          The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

          The following are the supported values for each volume type:

          • gp3 : 3,000-16,000 IOPS

          • io1 : 100-64,000 IOPS

          • io2 : 100-64,000 IOPS

          For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

          This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

        • KmsKeyId (string) --

          The ARN of the symmetric Key Management Service (KMS) CMK used for encryption.

        • SnapshotId (string) --

          The ID of the snapshot.

        • VolumeSize (integer) --

          The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

          • gp2 and gp3 : 1-16,384

          • io1 and io2 : 4-16,384

          • st1 and sc1 : 125-16,384

          • standard : 1-1,024

        • VolumeType (string) --

          The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .

        • Throughput (integer) --

          The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

          Valid Range: Minimum value of 125. Maximum value of 1000.

      • NoDevice (string) --

        To omit the device from the block device mapping, specify an empty string.

  • NetworkInterfaces (list) --

    One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

    • (dict) --

      The parameters for a network interface.

      • AssociateCarrierIpAddress (boolean) --

        Associates a Carrier IP address with eth0 for a new network interface.

        Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .

      • AssociatePublicIpAddress (boolean) --

        Associates a public IPv4 address with eth0 for a new network interface.

      • DeleteOnTermination (boolean) --

        Indicates whether the network interface is deleted when the instance is terminated.

      • Description (string) --

        A description for the network interface.

      • DeviceIndex (integer) --

        The device index for the network interface attachment.

      • Groups (list) --

        The IDs of one or more security groups.

        • (string) --

      • InterfaceType (string) --

        The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

        If you are not creating an EFA, specify interface or omit this parameter.

        Valid values: interface | efa

      • Ipv6AddressCount (integer) --

        The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

      • Ipv6Addresses (list) --

        One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

        • (dict) --

          Describes an IPv6 address.

          • Ipv6Address (string) --

            The IPv6 address.

      • NetworkInterfaceId (string) --

        The ID of the network interface.

      • PrivateIpAddress (string) --

        The primary private IPv4 address of the network interface.

      • PrivateIpAddresses (list) --

        One or more private IPv4 addresses.

        • (dict) --

          Describes a secondary private IPv4 address for a network interface.

          • Primary (boolean) --

            Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

          • PrivateIpAddress (string) --

            The private IPv4 addresses.

      • SecondaryPrivateIpAddressCount (integer) --

        The number of secondary private IPv4 addresses to assign to a network interface.

      • SubnetId (string) --

        The ID of the subnet for the network interface.

      • NetworkCardIndex (integer) --

        The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

      • Ipv4Prefixes (list) --

        One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

      • Ipv4PrefixCount (integer) --

        The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

      • Ipv6Prefixes (list) --

        One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

        • (dict) --

          Describes the IPv4 prefix option for a network interface.

          • Ipv6Prefix (string) --

            The IPv6 prefix.

      • Ipv6PrefixCount (integer) --

        The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

  • ImageId (string) --

    The ID of the AMI.

  • InstanceType (string) --

    The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .

    If you specify InstanceTypes , you can't specify InstanceRequirements .

  • KeyName (string) --

    The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .

    Warning

    If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

  • Monitoring (dict) --

    The monitoring for the instance.

    • Enabled (boolean) --

      Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

  • Placement (dict) --

    The placement for the instance.

    • AvailabilityZone (string) --

      The Availability Zone for the instance.

    • Affinity (string) --

      The affinity setting for an instance on a Dedicated Host.

    • GroupName (string) --

      The name of the placement group for the instance.

    • HostId (string) --

      The ID of the Dedicated Host for the instance.

    • Tenancy (string) --

      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

    • SpreadDomain (string) --

      Reserved for future use.

    • HostResourceGroupArn (string) --

      The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

    • PartitionNumber (integer) --

      The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .

  • RamDiskId (string) --

    The ID of the RAM disk.

    Warning

    We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .

  • DisableApiTermination (boolean) --

    If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.

  • InstanceInitiatedShutdownBehavior (string) --

    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

    Default: stop

  • UserData (string) --

    The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

    If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format . For more information, see Amazon EC2 user data in launch templates in the Batch User Guide .

  • TagSpecifications (list) --

    The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .

    • (dict) --

      The tags specification for the launch template.

      • ResourceType (string) --

        The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume . To tag a resource after it has been created, see CreateTags .

      • Tags (list) --

        The tags to apply to the resource.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

  • ElasticGpuSpecifications (list) --

    An elastic GPU to associate with the instance.

    • (dict) --

      A specification for an Elastic Graphics accelerator.

      • Type (string) -- [REQUIRED]

        The type of Elastic Graphics accelerator. For more information about the values to specify for Type , see Elastic Graphics Basics , specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances .

  • ElasticInferenceAccelerators (list) --

    The elastic inference accelerator for the instance.

    • (dict) --

      Describes an elastic inference accelerator.

      • Type (string) -- [REQUIRED]

        The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

      • Count (integer) --

        The number of elastic inference accelerators to attach to the instance.

        Default: 1

  • SecurityGroupIds (list) --

    One or more security group IDs. You can create a security group using CreateSecurityGroup . You cannot specify both a security group ID and security name in the same request.

    • (string) --

  • SecurityGroups (list) --

    [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

    • (string) --

  • InstanceMarketOptions (dict) --

    The market (purchasing) option for the instances.

    • MarketType (string) --

      The market type.

    • SpotOptions (dict) --

      The options for Spot Instances.

      • MaxPrice (string) --

        The maximum hourly price you're willing to pay for the Spot Instances.

      • SpotInstanceType (string) --

        The Spot Instance request type.

      • BlockDurationMinutes (integer) --

        The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

      • ValidUntil (datetime) --

        The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

      • InstanceInterruptionBehavior (string) --

        The behavior when a Spot Instance is interrupted. The default is terminate .

  • CreditSpecification (dict) --

    The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances only.

    • CpuCredits (string) -- [REQUIRED]

      The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .

  • CpuOptions (dict) --

    The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide .

    • CoreCount (integer) --

      The number of CPU cores for the instance.

    • ThreadsPerCore (integer) --

      The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

  • CapacityReservationSpecification (dict) --

    The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open , which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

    • CapacityReservationPreference (string) --

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

    • CapacityReservationTarget (dict) --

      Information about the target Capacity Reservation or Capacity Reservation group.

      • CapacityReservationId (string) --

        The ID of the Capacity Reservation in which to run the instance.

      • CapacityReservationResourceGroupArn (string) --

        The ARN of the Capacity Reservation resource group in which to run the instance.

  • LicenseSpecifications (list) --

    The license configurations.

    • (dict) --

      Describes a license configuration.

      • LicenseConfigurationArn (string) --

        The Amazon Resource Name (ARN) of the license configuration.

  • HibernationOptions (dict) --

    Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide .

    • Configured (boolean) --

      If you set this parameter to true , the instance is enabled for hibernation.

      Default: false

  • MetadataOptions (dict) --

    The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide .

    • HttpTokens (string) --

      The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

      If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

      If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

    • HttpPutResponseHopLimit (integer) --

      The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

      Default: 1

      Possible values: Integers from 1 to 64

    • HttpEndpoint (string) --

      This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .

      Note

      If you specify a value of disabled , you will not be able to access your instance metadata.

    • HttpProtocolIpv6 (string) --

      Enables or disables the IPv6 endpoint for the instance metadata service.

      Default: disabled

  • EnclaveOptions (dict) --

    Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide .

    You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

    • Enabled (boolean) --

      To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true .

  • InstanceRequirements (dict) --

    The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

    If you specify InstanceRequirements , you can't specify InstanceTypes .

    • VCpuCount (dict) -- [REQUIRED]

      The minimum and maximum number of vCPUs.

      • Min (integer) -- [REQUIRED]

        The minimum number of vCPUs. To specify no minimum limit, specify 0 .

      • Max (integer) --

        The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

    • MemoryMiB (dict) -- [REQUIRED]

      The minimum and maximum amount of memory, in MiB.

      • Min (integer) -- [REQUIRED]

        The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .

      • Max (integer) --

        The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.

    • CpuManufacturers (list) --

      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 .

      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

      • (string) --

    • MemoryGiBPerVCpu (dict) --

      The minimum and maximum amount of memory per vCPU, in GiB.

      Default: No minimum or maximum limits

      • Min (float) --

        The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.

      • Max (float) --

        The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.

    • ExcludedInstanceTypes (list) --

      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 (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

      Default: No excluded instance types

      • (string) --

    • InstanceGenerations (list) --

      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

      • (string) --

    • SpotMaxPricePercentageOverLowestPrice (integer) --

      The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest 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 .

      Default: 100

    • OnDemandMaxPricePercentageOverLowestPrice (integer) --

      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 cheapest 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 .

      Default: 20

    • BareMetal (string) --

      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

    • BurstablePerformance (string) --

      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

    • RequireHibernateSupport (boolean) --

      Indicates whether instance types must support hibernation for On-Demand Instances.

      This parameter is not supported for GetSpotPlacementScores .

      Default: false

    • NetworkInterfaceCount (dict) --

      The minimum and maximum number of network interfaces.

      Default: No minimum or maximum limits

      • Min (integer) --

        The minimum number of network interfaces. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum number of network interfaces. To specify no maximum limit, omit this parameter.

    • LocalStorage (string) --

      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

    • LocalStorageTypes (list) --

      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 (SDD) storage, specify sdd .

      Default: hdd and sdd

      • (string) --

    • TotalLocalStorageGB (dict) --

      The minimum and maximum amount of total local storage, in GB.

      Default: No minimum or maximum limits

      • Min (float) --

        The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.

      • Max (float) --

        The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.

    • BaselineEbsBandwidthMbps (dict) --

      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

      • Min (integer) --

        The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.

    • AcceleratorTypes (list) --

      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

      • (string) --

    • AcceleratorCount (dict) --

      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

      • Min (integer) --

        The minimum number of accelerators. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .

    • AcceleratorManufacturers (list) --

      Indicates whether instance types must have accelerators by specific manufacturers.

      • For instance types with NVIDIA devices, specify nvidia .

      • For instance types with AMD devices, specify amd .

      • For instance types with Amazon Web Services devices, specify amazon-web-services .

      • For instance types with Xilinx devices, specify xilinx .

      Default: Any manufacturer

      • (string) --

    • AcceleratorNames (list) --

      The accelerators that must be on the instance type.

      • For instance types with NVIDIA A100 GPUs, specify a100 .

      • For instance types with NVIDIA V100 GPUs, specify v100 .

      • For instance types with NVIDIA K80 GPUs, specify k80 .

      • For instance types with NVIDIA T4 GPUs, specify t4 .

      • 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 Xilinx VU9P FPGAs, specify vu9p .

      Default: Any accelerator

      • (string) --

    • AcceleratorTotalMemoryMiB (dict) --

      The minimum and maximum amount of total accelerator memory, in MiB.

      Default: No minimum or maximum limits

      • Min (integer) --

        The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

      • Max (integer) --

        The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateVersion': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'VersionNumber': 123,
        'VersionDescription': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersion': True|False,
        'LaunchTemplateData': {
            'KernelId': 'string',
            'EbsOptimized': True|False,
            'IamInstanceProfile': {
                'Arn': 'string',
                'Name': 'string'
            },
            'BlockDeviceMappings': [
                {
                    'DeviceName': 'string',
                    'VirtualName': 'string',
                    'Ebs': {
                        'Encrypted': True|False,
                        'DeleteOnTermination': True|False,
                        'Iops': 123,
                        'KmsKeyId': 'string',
                        'SnapshotId': 'string',
                        'VolumeSize': 123,
                        'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                        'Throughput': 123
                    },
                    'NoDevice': 'string'
                },
            ],
            'NetworkInterfaces': [
                {
                    'AssociateCarrierIpAddress': True|False,
                    'AssociatePublicIpAddress': True|False,
                    'DeleteOnTermination': True|False,
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Groups': [
                        'string',
                    ],
                    'InterfaceType': 'string',
                    'Ipv6AddressCount': 123,
                    'Ipv6Addresses': [
                        {
                            'Ipv6Address': 'string'
                        },
                    ],
                    'NetworkInterfaceId': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddresses': [
                        {
                            'Primary': True|False,
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SecondaryPrivateIpAddressCount': 123,
                    'SubnetId': 'string',
                    'NetworkCardIndex': 123,
                    'Ipv4Prefixes': [
                        {
                            'Ipv4Prefix': 'string'
                        },
                    ],
                    'Ipv4PrefixCount': 123,
                    'Ipv6Prefixes': [
                        {
                            'Ipv6Prefix': 'string'
                        },
                    ],
                    'Ipv6PrefixCount': 123
                },
            ],
            'ImageId': 'string',
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'KeyName': 'string',
            'Monitoring': {
                'Enabled': True|False
            },
            'Placement': {
                'AvailabilityZone': 'string',
                'Affinity': 'string',
                'GroupName': 'string',
                'HostId': 'string',
                'Tenancy': 'default'|'dedicated'|'host',
                'SpreadDomain': 'string',
                'HostResourceGroupArn': 'string',
                'PartitionNumber': 123
            },
            'RamDiskId': 'string',
            'DisableApiTermination': True|False,
            'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
            'UserData': 'string',
            'TagSpecifications': [
                {
                    'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'ElasticGpuSpecifications': [
                {
                    'Type': 'string'
                },
            ],
            'ElasticInferenceAccelerators': [
                {
                    'Type': 'string',
                    'Count': 123
                },
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'SecurityGroups': [
                'string',
            ],
            'InstanceMarketOptions': {
                'MarketType': 'spot',
                'SpotOptions': {
                    'MaxPrice': 'string',
                    'SpotInstanceType': 'one-time'|'persistent',
                    'BlockDurationMinutes': 123,
                    'ValidUntil': datetime(2015, 1, 1),
                    'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
                }
            },
            'CreditSpecification': {
                'CpuCredits': 'string'
            },
            'CpuOptions': {
                'CoreCount': 123,
                'ThreadsPerCore': 123
            },
            'CapacityReservationSpecification': {
                'CapacityReservationPreference': 'open'|'none',
                'CapacityReservationTarget': {
                    'CapacityReservationId': 'string',
                    'CapacityReservationResourceGroupArn': 'string'
                }
            },
            'LicenseSpecifications': [
                {
                    'LicenseConfigurationArn': 'string'
                },
            ],
            'HibernationOptions': {
                'Configured': True|False
            },
            'MetadataOptions': {
                'State': 'pending'|'applied',
                'HttpTokens': 'optional'|'required',
                'HttpPutResponseHopLimit': 123,
                'HttpEndpoint': 'disabled'|'enabled',
                'HttpProtocolIpv6': 'disabled'|'enabled'
            },
            'EnclaveOptions': {
                'Enabled': True|False
            },
            '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',
                ],
                'AcceleratorTotalMemoryMiB': {
                    'Min': 123,
                    'Max': 123
                }
            }
        }
    },
    'Warning': {
        'Errors': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • LaunchTemplateVersion (dict) --

      Information about the launch template version.

      • LaunchTemplateId (string) --

        The ID of the launch template.

      • LaunchTemplateName (string) --

        The name of the launch template.

      • VersionNumber (integer) --

        The version number.

      • VersionDescription (string) --

        The description for the version.

      • CreateTime (datetime) --

        The time the version was created.

      • CreatedBy (string) --

        The principal that created the version.

      • DefaultVersion (boolean) --

        Indicates whether the version is the default version.

      • LaunchTemplateData (dict) --

        Information about the launch template.

        • KernelId (string) --

          The ID of the kernel, if applicable.

        • EbsOptimized (boolean) --

          Indicates whether the instance is optimized for Amazon EBS I/O.

        • IamInstanceProfile (dict) --

          The IAM instance profile.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the instance profile.

          • Name (string) --

            The name of the instance profile.

        • BlockDeviceMappings (list) --

          The block device mappings.

          • (dict) --

            Describes a block device mapping.

            • DeviceName (string) --

              The device name.

            • VirtualName (string) --

              The virtual device name (ephemeralN).

            • Ebs (dict) --

              Information about the block device for an EBS volume.

              • Encrypted (boolean) --

                Indicates whether the EBS volume is encrypted.

              • DeleteOnTermination (boolean) --

                Indicates whether the EBS volume is deleted on instance termination.

              • Iops (integer) --

                The number of I/O operations per second (IOPS) that the volume supports.

              • KmsKeyId (string) --

                The ARN of the Key Management Service (KMS) CMK used for encryption.

              • SnapshotId (string) --

                The ID of the snapshot.

              • VolumeSize (integer) --

                The size of the volume, in GiB.

              • VolumeType (string) --

                The volume type.

              • Throughput (integer) --

                The throughput that the volume supports, in MiB/s.

            • NoDevice (string) --

              To omit the device from the block device mapping, specify an empty string.

        • NetworkInterfaces (list) --

          The network interfaces.

          • (dict) --

            Describes a network interface.

            • AssociateCarrierIpAddress (boolean) --

              Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

              Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .

            • AssociatePublicIpAddress (boolean) --

              Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

            • DeleteOnTermination (boolean) --

              Indicates whether the network interface is deleted when the instance is terminated.

            • Description (string) --

              A description for the network interface.

            • DeviceIndex (integer) --

              The device index for the network interface attachment.

            • Groups (list) --

              The IDs of one or more security groups.

              • (string) --

            • InterfaceType (string) --

              The type of network interface.

            • Ipv6AddressCount (integer) --

              The number of IPv6 addresses for the network interface.

            • Ipv6Addresses (list) --

              The IPv6 addresses for the network interface.

              • (dict) --

                Describes an IPv6 address.

                • Ipv6Address (string) --

                  The IPv6 address.

            • NetworkInterfaceId (string) --

              The ID of the network interface.

            • PrivateIpAddress (string) --

              The primary private IPv4 address of the network interface.

            • PrivateIpAddresses (list) --

              One or more private IPv4 addresses.

              • (dict) --

                Describes a secondary private IPv4 address for a network interface.

                • Primary (boolean) --

                  Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

                • PrivateIpAddress (string) --

                  The private IPv4 addresses.

            • SecondaryPrivateIpAddressCount (integer) --

              The number of secondary private IPv4 addresses for the network interface.

            • SubnetId (string) --

              The ID of the subnet for the network interface.

            • NetworkCardIndex (integer) --

              The index of the network card.

            • Ipv4Prefixes (list) --

              One or more IPv4 prefixes assigned to the network interface.

              • (dict) --

                Information about the IPv4 delegated prefixes assigned to a network interface.

                • Ipv4Prefix (string) --

                  One or more IPv4 delegated prefixes assigned to the network interface.

            • Ipv4PrefixCount (integer) --

              The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.

            • Ipv6Prefixes (list) --

              One or more IPv6 prefixes assigned to the network interface.

              • (dict) --

                Information about the IPv6 delegated prefixes assigned to a network interface.

                • Ipv6Prefix (string) --

                  One or more IPv6 delegated prefixes assigned to the network interface.

            • Ipv6PrefixCount (integer) --

              The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.

        • ImageId (string) --

          The ID of the AMI that was used to launch the instance.

        • InstanceType (string) --

          The instance type.

        • KeyName (string) --

          The name of the key pair.

        • Monitoring (dict) --

          The monitoring for the instance.

          • Enabled (boolean) --

            Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

        • Placement (dict) --

          The placement of the instance.

          • AvailabilityZone (string) --

            The Availability Zone of the instance.

          • Affinity (string) --

            The affinity setting for the instance on the Dedicated Host.

          • GroupName (string) --

            The name of the placement group for the instance.

          • HostId (string) --

            The ID of the Dedicated Host for the instance.

          • Tenancy (string) --

            The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

          • SpreadDomain (string) --

            Reserved for future use.

          • HostResourceGroupArn (string) --

            The ARN of the host resource group in which to launch the instances.

          • PartitionNumber (integer) --

            The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .

        • RamDiskId (string) --

          The ID of the RAM disk, if applicable.

        • DisableApiTermination (boolean) --

          If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

        • InstanceInitiatedShutdownBehavior (string) --

          Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

        • UserData (string) --

          The user data for the instance.

        • TagSpecifications (list) --

          The tags.

          • (dict) --

            The tag specification for the launch template.

            • ResourceType (string) --

              The type of resource.

            • Tags (list) --

              The tags for the resource.

              • (dict) --

                Describes a tag.

                • Key (string) --

                  The key of the tag.

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

                • Value (string) --

                  The value of the tag.

                  Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

        • ElasticGpuSpecifications (list) --

          The elastic GPU specification.

          • (dict) --

            Describes an elastic GPU.

            • Type (string) --

              The elastic GPU type.

        • ElasticInferenceAccelerators (list) --

          The elastic inference accelerator for the instance.

          • (dict) --

            Describes an elastic inference accelerator.

            • Type (string) --

              The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

            • Count (integer) --

              The number of elastic inference accelerators to attach to the instance.

              Default: 1

        • SecurityGroupIds (list) --

          The security group IDs.

          • (string) --

        • SecurityGroups (list) --

          The security group names.

          • (string) --

        • InstanceMarketOptions (dict) --

          The market (purchasing) option for the instances.

          • MarketType (string) --

            The market type.

          • SpotOptions (dict) --

            The options for Spot Instances.

            • MaxPrice (string) --

              The maximum hourly price you're willing to pay for the Spot Instances.

            • SpotInstanceType (string) --

              The Spot Instance request type.

            • BlockDurationMinutes (integer) --

              The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

            • ValidUntil (datetime) --

              The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

            • InstanceInterruptionBehavior (string) --

              The behavior when a Spot Instance is interrupted.

        • CreditSpecification (dict) --

          The credit option for CPU usage of the instance.

          • CpuCredits (string) --

            The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .

        • CpuOptions (dict) --

          The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide .

          • CoreCount (integer) --

            The number of CPU cores for the instance.

          • ThreadsPerCore (integer) --

            The number of threads per CPU core.

        • CapacityReservationSpecification (dict) --

          Information about the Capacity Reservation targeting option.

          • CapacityReservationPreference (string) --

            Indicates the instance's Capacity Reservation preferences. Possible preferences include:

            • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

            • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

          • CapacityReservationTarget (dict) --

            Information about the target Capacity Reservation or Capacity Reservation group.

            • CapacityReservationId (string) --

              The ID of the targeted Capacity Reservation.

            • CapacityReservationResourceGroupArn (string) --

              The ARN of the targeted Capacity Reservation group.

        • LicenseSpecifications (list) --

          The license configurations.

          • (dict) --

            Describes a license configuration.

            • LicenseConfigurationArn (string) --

              The Amazon Resource Name (ARN) of the license configuration.

        • HibernationOptions (dict) --

          Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide .

          • Configured (boolean) --

            If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

        • MetadataOptions (dict) --

          The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide .

          • State (string) --

            The state of the metadata option changes.

            pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

            applied - The metadata options have been successfully applied on the instance.

          • HttpTokens (string) --

            The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

            If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

            If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

          • HttpPutResponseHopLimit (integer) --

            The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

            Default: 1

            Possible values: Integers from 1 to 64

          • HttpEndpoint (string) --

            This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .

            Note

            If you specify a value of disabled , you will not be able to access your instance metadata.

          • HttpProtocolIpv6 (string) --

            Enables or disables the IPv6 endpoint for the instance metadata service.

            Default: disabled

        • EnclaveOptions (dict) --

          Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

          • Enabled (boolean) --

            If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

        • InstanceRequirements (dict) --

          The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

          If you specify InstanceRequirements , you can't specify InstanceTypes .

          • VCpuCount (dict) --

            The minimum and maximum number of vCPUs.

            • Min (integer) --

              The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

            • Max (integer) --

              The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

          • MemoryMiB (dict) --

            The minimum and maximum amount of memory, in MiB.

            • Min (integer) --

              The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

            • Max (integer) --

              The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

          • CpuManufacturers (list) --

            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 .

            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

            • (string) --

          • MemoryGiBPerVCpu (dict) --

            The minimum and maximum amount of memory per vCPU, in GiB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

            • Max (float) --

              The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

          • ExcludedInstanceTypes (list) --

            The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

            Default: No excluded instance types

            • (string) --

          • InstanceGenerations (list) --

            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

            • (string) --

          • SpotMaxPricePercentageOverLowestPrice (integer) --

            The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

            Default: 100

          • OnDemandMaxPricePercentageOverLowestPrice (integer) --

            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 cheapest 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 .

            Default: 20

          • BareMetal (string) --

            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

          • BurstablePerformance (string) --

            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

          • RequireHibernateSupport (boolean) --

            Indicates whether instance types must support hibernation for On-Demand Instances.

            This parameter is not supported for GetSpotPlacementScores .

            Default: false

          • NetworkInterfaceCount (dict) --

            The minimum and maximum number of network interfaces.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

            • Max (integer) --

              The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

          • LocalStorage (string) --

            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

          • LocalStorageTypes (list) --

            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 (SDD) storage, specify sdd .

            Default: hdd and sdd

            • (string) --

          • TotalLocalStorageGB (dict) --

            The minimum and maximum amount of total local storage, in GB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

            • Max (float) --

              The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

          • BaselineEbsBandwidthMbps (dict) --

            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

            • Min (integer) --

              The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

            • Max (integer) --

              The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

          • AcceleratorTypes (list) --

            The accelerator types that must be on the instance type.

            • For instance types with GPU accelerators, specify gpu .

            • For instance types with FPGA accelerators, specify fpga .

            • For instance types with inference accelerators, specify inference .

            Default: Any accelerator type

            • (string) --

          • AcceleratorCount (dict) --

            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

            • Min (integer) --

              The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

            • Max (integer) --

              The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

          • AcceleratorManufacturers (list) --

            Indicates whether instance types must have accelerators by specific manufacturers.

            • For instance types with NVIDIA devices, specify nvidia .

            • For instance types with AMD devices, specify amd .

            • For instance types with Amazon Web Services devices, specify amazon-web-services .

            • For instance types with Xilinx devices, specify xilinx .

            Default: Any manufacturer

            • (string) --

          • AcceleratorNames (list) --

            The accelerators that must be on the instance type.

            • For instance types with NVIDIA A100 GPUs, specify a100 .

            • For instance types with NVIDIA V100 GPUs, specify v100 .

            • For instance types with NVIDIA K80 GPUs, specify k80 .

            • For instance types with NVIDIA T4 GPUs, specify t4 .

            • 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 Xilinx VU9P FPGAs, specify vu9p .

            Default: Any accelerator

            • (string) --

          • AcceleratorTotalMemoryMiB (dict) --

            The minimum and maximum amount of total accelerator memory, in MiB.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

            • Max (integer) --

              The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

    • Warning (dict) --

      If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.

      • Errors (list) --

        The error codes and error messages.

        • (dict) --

          The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.

          • Code (string) --

            The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes .

          • Message (string) --

            The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes .

CreateNetworkInterface (updated) Link ¶
Changes (response)
{'NetworkInterface': {'DenyAllIgwTraffic': 'boolean'}}

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_network_interface(
    Description='string',
    DryRun=True|False,
    Groups=[
        'string',
    ],
    Ipv6AddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string'
        },
    ],
    PrivateIpAddress='string',
    PrivateIpAddresses=[
        {
            'Primary': True|False,
            'PrivateIpAddress': 'string'
        },
    ],
    SecondaryPrivateIpAddressCount=123,
    Ipv4Prefixes=[
        {
            'Ipv4Prefix': 'string'
        },
    ],
    Ipv4PrefixCount=123,
    Ipv6Prefixes=[
        {
            'Ipv6Prefix': 'string'
        },
    ],
    Ipv6PrefixCount=123,
    InterfaceType='efa'|'branch'|'trunk',
    SubnetId='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string'
)
type Description

string

param Description

A description for the network interface.

type DryRun

boolean

param DryRun

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 .

type Groups

list

param Groups

The IDs of one or more security groups.

  • (string) --

type Ipv6AddressCount

integer

param Ipv6AddressCount

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true , you can specify 0 to override this setting.

type Ipv6Addresses

list

param Ipv6Addresses

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

  • (dict) --

    Describes an IPv6 address.

    • Ipv6Address (string) --

      The IPv6 address.

type PrivateIpAddress

string

param PrivateIpAddress

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

type PrivateIpAddresses

list

param PrivateIpAddresses

One or more private IPv4 addresses.

  • (dict) --

    Describes a secondary private IPv4 address for a network interface.

    • Primary (boolean) --

      Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

    • PrivateIpAddress (string) --

      The private IPv4 addresses.

type SecondaryPrivateIpAddressCount

integer

param SecondaryPrivateIpAddressCount

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .

type Ipv4Prefixes

list

param Ipv4Prefixes

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

type Ipv4PrefixCount

integer

param Ipv4PrefixCount

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

type Ipv6Prefixes

list

param Ipv6Prefixes

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

  • (dict) --

    Describes the IPv4 prefix option for a network interface.

    • Ipv6Prefix (string) --

      The IPv6 prefix.

type Ipv6PrefixCount

integer

param Ipv6PrefixCount

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

type InterfaceType

string

param InterfaceType

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide . To create a trunk network interface, specify efa . For more information, see Network interface trunking in the Amazon Elastic Compute Cloud User Guide .

type SubnetId

string

param SubnetId

[REQUIRED]

The ID of the subnet to associate with the network interface.

type TagSpecifications

list

param TagSpecifications

The tags to apply to the new network interface.

  • (dict) --

    The tags to apply to a resource when the resource is being created.

    • ResourceType (string) --

      The type of resource to tag on creation.

    • Tags (list) --

      The tags to apply to the resource.

      • (dict) --

        Describes a tag.

        • Key (string) --

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

        • Value (string) --

          The value of the tag.

          Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'NetworkInterface': {
        'Association': {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'IpOwnerId': 'string',
            'PublicDnsName': 'string',
            'PublicIp': 'string',
            'CustomerOwnedIp': 'string',
            'CarrierIp': 'string'
        },
        'Attachment': {
            'AttachTime': datetime(2015, 1, 1),
            'AttachmentId': 'string',
            'DeleteOnTermination': True|False,
            'DeviceIndex': 123,
            'NetworkCardIndex': 123,
            'InstanceId': 'string',
            'InstanceOwnerId': 'string',
            'Status': 'attaching'|'attached'|'detaching'|'detached'
        },
        'AvailabilityZone': 'string',
        'Description': 'string',
        'Groups': [
            {
                'GroupName': 'string',
                'GroupId': 'string'
            },
        ],
        'InterfaceType': 'interface'|'natGateway'|'efa'|'trunk',
        'Ipv6Addresses': [
            {
                'Ipv6Address': 'string'
            },
        ],
        'MacAddress': 'string',
        'NetworkInterfaceId': 'string',
        'OutpostArn': 'string',
        'OwnerId': 'string',
        'PrivateDnsName': 'string',
        'PrivateIpAddress': 'string',
        'PrivateIpAddresses': [
            {
                'Association': {
                    'AllocationId': 'string',
                    'AssociationId': 'string',
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'CustomerOwnedIp': 'string',
                    'CarrierIp': 'string'
                },
                'Primary': True|False,
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string'
            },
        ],
        'Ipv4Prefixes': [
            {
                'Ipv4Prefix': 'string'
            },
        ],
        'Ipv6Prefixes': [
            {
                'Ipv6Prefix': 'string'
            },
        ],
        'RequesterId': 'string',
        'RequesterManaged': True|False,
        'SourceDestCheck': True|False,
        'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
        'SubnetId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'VpcId': 'string',
        'DenyAllIgwTraffic': True|False
    },
    'ClientToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of CreateNetworkInterface.

    • NetworkInterface (dict) --

      Information about the network interface.

      • Association (dict) --

        The association information for an Elastic IP address (IPv4) associated with the network interface.

        • AllocationId (string) --

          The allocation ID.

        • AssociationId (string) --

          The association ID.

        • IpOwnerId (string) --

          The ID of the Elastic IP address owner.

        • PublicDnsName (string) --

          The public DNS name.

        • PublicIp (string) --

          The address of the Elastic IP address bound to the network interface.

        • CustomerOwnedIp (string) --

          The customer-owned IP address associated with the network interface.

        • CarrierIp (string) --

          The carrier IP address associated with the network interface.

          This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

      • Attachment (dict) --

        The network interface attachment.

        • AttachTime (datetime) --

          The timestamp indicating when the attachment initiated.

        • AttachmentId (string) --

          The ID of the network interface attachment.

        • DeleteOnTermination (boolean) --

          Indicates whether the network interface is deleted when the instance is terminated.

        • DeviceIndex (integer) --

          The device index of the network interface attachment on the instance.

        • NetworkCardIndex (integer) --

          The index of the network card.

        • InstanceId (string) --

          The ID of the instance.

        • InstanceOwnerId (string) --

          The Amazon Web Services account ID of the owner of the instance.

        • Status (string) --

          The attachment state.

      • AvailabilityZone (string) --

        The Availability Zone.

      • Description (string) --

        A description.

      • Groups (list) --

        Any security groups for the network interface.

        • (dict) --

          Describes a security group.

          • GroupName (string) --

            The name of the security group.

          • GroupId (string) --

            The ID of the security group.

      • InterfaceType (string) --

        The type of network interface.

      • Ipv6Addresses (list) --

        The IPv6 addresses associated with the network interface.

        • (dict) --

          Describes an IPv6 address associated with a network interface.

          • Ipv6Address (string) --

            The IPv6 address.

      • MacAddress (string) --

        The MAC address.

      • NetworkInterfaceId (string) --

        The ID of the network interface.

      • OutpostArn (string) --

        The Amazon Resource Name (ARN) of the Outpost.

      • OwnerId (string) --

        The Amazon Web Services account ID of the owner of the network interface.

      • PrivateDnsName (string) --

        The private DNS name.

      • PrivateIpAddress (string) --

        The IPv4 address of the network interface within the subnet.

      • PrivateIpAddresses (list) --

        The private IPv4 addresses associated with the network interface.

        • (dict) --

          Describes the private IPv4 address of a network interface.

          • Association (dict) --

            The association information for an Elastic IP address (IPv4) associated with the network interface.

            • AllocationId (string) --

              The allocation ID.

            • AssociationId (string) --

              The association ID.

            • IpOwnerId (string) --

              The ID of the Elastic IP address owner.

            • PublicDnsName (string) --

              The public DNS name.

            • PublicIp (string) --

              The address of the Elastic IP address bound to the network interface.

            • CustomerOwnedIp (string) --

              The customer-owned IP address associated with the network interface.

            • CarrierIp (string) --

              The carrier IP address associated with the network interface.

              This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

          • Primary (boolean) --

            Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

          • PrivateDnsName (string) --

            The private DNS name.

          • PrivateIpAddress (string) --

            The private IPv4 address.

      • Ipv4Prefixes (list) --

        The IPv4 prefixes that are assigned to the network interface.

      • Ipv6Prefixes (list) --

        The IPv6 prefixes that are assigned to the network interface.

        • (dict) --

          Describes the IPv6 prefix.

          • Ipv6Prefix (string) --

            The IPv6 prefix.

      • RequesterId (string) --

        The alias or Amazon Web Services account ID of the principal or service that created the network interface.

      • RequesterManaged (boolean) --

        Indicates whether the network interface is being managed by Amazon Web Services.

      • SourceDestCheck (boolean) --

        Indicates whether source/destination checking is enabled.

      • Status (string) --

        The status of the network interface.

      • SubnetId (string) --

        The ID of the subnet.

      • TagSet (list) --

        Any tags assigned to the network interface.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

      • VpcId (string) --

        The ID of the VPC.

      • DenyAllIgwTraffic (boolean) --

        Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true , inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.

    • ClientToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeCapacityReservationFleets (updated) Link ¶
Changes (response)
{'CapacityReservationFleets': {'InstanceTypeSpecifications': {'InstanceType': {'dl1.24xlarge'}}}}

Describes one or more Capacity Reservation Fleets.

See also: AWS API Documentation

Request Syntax

client.describe_capacity_reservation_fleets(
    CapacityReservationFleetIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
type CapacityReservationFleetIds

list

param CapacityReservationFleetIds

The IDs of the Capacity Reservation Fleets to describe.

  • (string) --

type NextToken

string

param NextToken

The token to use to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

type Filters

list

param Filters

One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed ).

  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

  • tenancy - The tenancy of the Fleet (default | dedicated ).

  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'CapacityReservationFleets': [
        {
            'CapacityReservationFleetId': 'string',
            'CapacityReservationFleetArn': 'string',
            'State': 'submitted'|'modifying'|'active'|'partially_fulfilled'|'expiring'|'expired'|'cancelling'|'cancelled'|'failed',
            'TotalTargetCapacity': 123,
            'TotalFulfilledCapacity': 123.0,
            'Tenancy': 'default',
            'EndDate': datetime(2015, 1, 1),
            'CreateTime': datetime(2015, 1, 1),
            'InstanceMatchCriteria': 'open',
            'AllocationStrategy': 'string',
            'InstanceTypeSpecifications': [
                {
                    'CapacityReservationId': 'string',
                    'AvailabilityZoneId': 'string',
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
                    'AvailabilityZone': 'string',
                    'TotalInstanceCount': 123,
                    'FulfilledCapacity': 123.0,
                    'EbsOptimized': True|False,
                    'CreateDate': datetime(2015, 1, 1),
                    'Weight': 123.0,
                    'Priority': 123
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • CapacityReservationFleets (list) --

      Information about the Capacity Reservation Fleets.

      • (dict) --

        Information about a Capacity Reservation Fleet.

        • CapacityReservationFleetId (string) --

          The ID of the Capacity Reservation Fleet.

        • CapacityReservationFleetArn (string) --

          The ARN of the Capacity Reservation Fleet.

        • State (string) --

          The state of the Capacity Reservation Fleet. Possible states include:

          • submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

          • modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

          • active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

          • partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

          • expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

          • expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.

          • cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

          • cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.

          • failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

        • TotalTargetCapacity (integer) --

          The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.

        • TotalFulfilledCapacity (float) --

          The capacity units that have been fulfilled.

        • Tenancy (string) --

          The tenancy of the Capacity Reservation Fleet. Tenancies include:

          • default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

          • dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

        • EndDate (datetime) --

          The date and time at which the Capacity Reservation Fleet expires.

        • CreateTime (datetime) --

          The date and time at which the Capacity Reservation Fleet was created.

        • InstanceMatchCriteria (string) --

          Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

          Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

        • AllocationStrategy (string) --

          The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.

        • InstanceTypeSpecifications (list) --

          Information about the instance types for which to reserve the capacity.

          • (dict) --

            Information about a Capacity Reservation in a Capacity Reservation Fleet.

            • CapacityReservationId (string) --

              The ID of the Capacity Reservation.

            • AvailabilityZoneId (string) --

              The ID of the Availability Zone in which the Capacity Reservation reserves capacity.

            • InstanceType (string) --

              The instance type for which the Capacity Reservation reserves capacity.

            • InstancePlatform (string) --

              The type of operating system for which the Capacity Reservation reserves capacity.

            • AvailabilityZone (string) --

              The Availability Zone in which the Capacity Reservation reserves capacity.

            • TotalInstanceCount (integer) --

              The total number of instances for which the Capacity Reservation reserves capacity.

            • FulfilledCapacity (float) --

              The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.

            • EbsOptimized (boolean) --

              Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.

            • CreateDate (datetime) --

              The date and time at which the Capacity Reservation was created.

            • Weight (float) --

              The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the Amazon EC2 User Guide.

            • Priority (integer) --

              The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the Amazon EC2 User Guide.

        • Tags (list) --

          The tags assigned to the Capacity Reservation Fleet.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeFleets (updated) Link ¶
Changes (response)
{'Fleets': {'Errors': {'LaunchTemplateAndOverrides': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}},
            'Instances': {'InstanceType': {'dl1.24xlarge'},
                          'LaunchTemplateAndOverrides': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}},
            'LaunchTemplateConfigs': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}}}

Describes the specified EC2 Fleets or all of your EC2 Fleets.

For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_fleets(
    DryRun=True|False,
    MaxResults=123,
    NextToken='string',
    FleetIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
type DryRun

boolean

param DryRun

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 .

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken

string

param NextToken

The token for the next set of results.

type FleetIds

list

param FleetIds

The ID of the EC2 Fleets.

  • (string) --

type Filters

list

param Filters

The filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled ).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false ).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying ).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false ).

  • type - The type of request (instant | request | maintain ).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Fleets': [
        {
            'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
            'CreateTime': datetime(2015, 1, 1),
            'FleetId': 'string',
            'FleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying',
            'ClientToken': 'string',
            'ExcessCapacityTerminationPolicy': 'no-termination'|'termination',
            'FulfilledCapacity': 123.0,
            'FulfilledOnDemandCapacity': 123.0,
            'LaunchTemplateConfigs': [
                {
                    'LaunchTemplateSpecification': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'Overrides': [
                        {
                            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                            'MaxPrice': 'string',
                            'SubnetId': 'string',
                            'AvailabilityZone': 'string',
                            'WeightedCapacity': 123.0,
                            'Priority': 123.0,
                            'Placement': {
                                'GroupName': 'string'
                            },
                            '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',
                                ],
                                'AcceleratorTotalMemoryMiB': {
                                    'Min': 123,
                                    'Max': 123
                                }
                            }
                        },
                    ]
                },
            ],
            'TargetCapacitySpecification': {
                'TotalTargetCapacity': 123,
                'OnDemandTargetCapacity': 123,
                'SpotTargetCapacity': 123,
                'DefaultTargetCapacityType': 'spot'|'on-demand',
                'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units'
            },
            'TerminateInstancesWithExpiration': True|False,
            'Type': 'request'|'maintain'|'instant',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidUntil': datetime(2015, 1, 1),
            'ReplaceUnhealthyInstances': True|False,
            'SpotOptions': {
                'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized',
                'MaintenanceStrategies': {
                    'CapacityRebalance': {
                        'ReplacementStrategy': 'launch'
                    }
                },
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
                'InstancePoolsToUseCount': 123,
                'SingleInstanceType': True|False,
                'SingleAvailabilityZone': True|False,
                'MinTargetCapacity': 123,
                'MaxTotalPrice': 'string'
            },
            'OnDemandOptions': {
                'AllocationStrategy': 'lowest-price'|'prioritized',
                'CapacityReservationOptions': {
                    'UsageStrategy': 'use-capacity-reservations-first'
                },
                'SingleInstanceType': True|False,
                'SingleAvailabilityZone': True|False,
                'MinTargetCapacity': 123,
                'MaxTotalPrice': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Errors': [
                {
                    'LaunchTemplateAndOverrides': {
                        'LaunchTemplateSpecification': {
                            'LaunchTemplateId': 'string',
                            'LaunchTemplateName': 'string',
                            'Version': 'string'
                        },
                        'Overrides': {
                            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                            'MaxPrice': 'string',
                            'SubnetId': 'string',
                            'AvailabilityZone': 'string',
                            'WeightedCapacity': 123.0,
                            'Priority': 123.0,
                            'Placement': {
                                'GroupName': 'string'
                            },
                            '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',
                                ],
                                'AcceleratorTotalMemoryMiB': {
                                    'Min': 123,
                                    'Max': 123
                                }
                            }
                        }
                    },
                    'Lifecycle': 'spot'|'on-demand',
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'Instances': [
                {
                    'LaunchTemplateAndOverrides': {
                        'LaunchTemplateSpecification': {
                            'LaunchTemplateId': 'string',
                            'LaunchTemplateName': 'string',
                            'Version': 'string'
                        },
                        'Overrides': {
                            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                            'MaxPrice': 'string',
                            'SubnetId': 'string',
                            'AvailabilityZone': 'string',
                            'WeightedCapacity': 123.0,
                            'Priority': 123.0,
                            'Placement': {
                                'GroupName': 'string'
                            },
                            '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',
                                ],
                                'AcceleratorTotalMemoryMiB': {
                                    'Min': 123,
                                    'Max': 123
                                }
                            }
                        }
                    },
                    'Lifecycle': 'spot'|'on-demand',
                    'InstanceIds': [
                        'string',
                    ],
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'Platform': 'Windows'
                },
            ],
            'Context': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token for the next set of results.

    • Fleets (list) --

      Information about the EC2 Fleets.

      • (dict) --

        Describes an EC2 Fleet.

        • ActivityStatus (string) --

          The progress of the EC2 Fleet. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

        • CreateTime (datetime) --

          The creation date and time of the EC2 Fleet.

        • FleetId (string) --

          The ID of the EC2 Fleet.

        • FleetState (string) --

          The state of the EC2 Fleet.

        • ClientToken (string) --

          Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .

          Constraints: Maximum 64 ASCII characters

        • ExcessCapacityTerminationPolicy (string) --

          Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

        • FulfilledCapacity (float) --

          The number of units fulfilled by this request compared to the set target capacity.

        • FulfilledOnDemandCapacity (float) --

          The number of units fulfilled by this request compared to the set target On-Demand capacity.

        • LaunchTemplateConfigs (list) --

          The launch template and overrides.

          • (dict) --

            Describes a launch template and overrides.

            • LaunchTemplateSpecification (dict) --

              The launch template.

              • LaunchTemplateId (string) --

                The ID of the launch template. If you specify the template ID, you can't specify the template name.

              • LaunchTemplateName (string) --

                The name of the launch template. If you specify the template name, you can't specify the template ID.

              • Version (string) --

                The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

                If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

                If the value is $Default , Amazon EC2 uses the default version of the launch template.

            • Overrides (list) --

              Any parameters that you specify override the same parameters in the launch template.

              • (dict) --

                Describes overrides for a launch template.

                • InstanceType (string) --

                  The instance type.

                  Note

                  If you specify InstanceTypes , you can't specify InstanceRequirements .

                • MaxPrice (string) --

                  The maximum price per unit hour that you are willing to pay for a Spot Instance.

                • SubnetId (string) --

                  The ID of the subnet in which to launch the instances.

                • AvailabilityZone (string) --

                  The Availability Zone in which to launch the instances.

                • WeightedCapacity (float) --

                  The number of units provided by the specified instance type.

                • Priority (float) --

                  The priority for the launch template override. The highest priority is launched first.

                  If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

                  If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

                  Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

                • Placement (dict) --

                  The location where the instance launched, if applicable.

                  • GroupName (string) --

                    The name of the placement group that the instance is in.

                • InstanceRequirements (dict) --

                  The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

                  Note

                  If you specify InstanceRequirements , you can't specify InstanceTypes .

                  • VCpuCount (dict) --

                    The minimum and maximum number of vCPUs.

                    • Min (integer) --

                      The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                    • Max (integer) --

                      The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

                  • MemoryMiB (dict) --

                    The minimum and maximum amount of memory, in MiB.

                    • Min (integer) --

                      The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

                  • CpuManufacturers (list) --

                    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 .

                    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

                    • (string) --

                  • MemoryGiBPerVCpu (dict) --

                    The minimum and maximum amount of memory per vCPU, in GiB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

                  • ExcludedInstanceTypes (list) --

                    The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                    Default: No excluded instance types

                    • (string) --

                  • InstanceGenerations (list) --

                    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

                    • (string) --

                  • SpotMaxPricePercentageOverLowestPrice (integer) --

                    The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                    Default: 100

                  • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                    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 cheapest 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 .

                    Default: 20

                  • BareMetal (string) --

                    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

                  • BurstablePerformance (string) --

                    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

                  • RequireHibernateSupport (boolean) --

                    Indicates whether instance types must support hibernation for On-Demand Instances.

                    This parameter is not supported for GetSpotPlacementScores .

                    Default: false

                  • NetworkInterfaceCount (dict) --

                    The minimum and maximum number of network interfaces.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

                  • LocalStorage (string) --

                    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

                  • LocalStorageTypes (list) --

                    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 (SDD) storage, specify sdd .

                    Default: hdd and sdd

                    • (string) --

                  • TotalLocalStorageGB (dict) --

                    The minimum and maximum amount of total local storage, in GB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

                  • BaselineEbsBandwidthMbps (dict) --

                    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

                    • Min (integer) --

                      The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorTypes (list) --

                    The accelerator types that must be on the instance type.

                    • For instance types with GPU accelerators, specify gpu .

                    • For instance types with FPGA accelerators, specify fpga .

                    • For instance types with inference accelerators, specify inference .

                    Default: Any accelerator type

                    • (string) --

                  • AcceleratorCount (dict) --

                    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

                    • Min (integer) --

                      The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorManufacturers (list) --

                    Indicates whether instance types must have accelerators by specific manufacturers.

                    • For instance types with NVIDIA devices, specify nvidia .

                    • For instance types with AMD devices, specify amd .

                    • For instance types with Amazon Web Services devices, specify amazon-web-services .

                    • For instance types with Xilinx devices, specify xilinx .

                    Default: Any manufacturer

                    • (string) --

                  • AcceleratorNames (list) --

                    The accelerators that must be on the instance type.

                    • For instance types with NVIDIA A100 GPUs, specify a100 .

                    • For instance types with NVIDIA V100 GPUs, specify v100 .

                    • For instance types with NVIDIA K80 GPUs, specify k80 .

                    • For instance types with NVIDIA T4 GPUs, specify t4 .

                    • 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 Xilinx VU9P FPGAs, specify vu9p .

                    Default: Any accelerator

                    • (string) --

                  • AcceleratorTotalMemoryMiB (dict) --

                    The minimum and maximum amount of total accelerator memory, in MiB.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

        • TargetCapacitySpecification (dict) --

          The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

          • TotalTargetCapacity (integer) --

            The number of units to request, filled using DefaultTargetCapacityType .

          • OnDemandTargetCapacity (integer) --

            The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

          • SpotTargetCapacity (integer) --

            The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

          • DefaultTargetCapacityType (string) --

            The default TotalTargetCapacity , which is either Spot or On-Demand .

          • TargetCapacityUnitType (string) --

            The unit for the target capacity.

            Default: units (translates to number of instances)

        • TerminateInstancesWithExpiration (boolean) --

          Indicates whether running instances should be terminated when the EC2 Fleet expires.

        • Type (string) --

          The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain .

        • ValidFrom (datetime) --

          The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.

        • ValidUntil (datetime) --

          The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

        • ReplaceUnhealthyInstances (boolean) --

          Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain . For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .

        • SpotOptions (dict) --

          The configuration of Spot Instances in an EC2 Fleet.

          • AllocationStrategy (string) --

            Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

            If the allocation strategy is lowest-price , EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

            If the allocation strategy is diversified , EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

            If the allocation strategy is capacity-optimized (recommended), EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.

          • MaintenanceStrategies (dict) --

            The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.

            • CapacityRebalance (dict) --

              The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

              • ReplacementStrategy (string) --

                To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch . Only available for fleets of type maintain .

                Note

                When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.

          • InstanceInterruptionBehavior (string) --

            The behavior when a Spot Instance is interrupted. The default is terminate .

          • InstancePoolsToUseCount (integer) --

            The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price . EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

            Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

          • SingleInstanceType (boolean) --

            Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant .

          • SingleAvailabilityZone (boolean) --

            Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant .

          • MinTargetCapacity (integer) --

            The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

          • MaxTotalPrice (string) --

            The maximum amount per hour for Spot Instances that you're willing to pay.

        • OnDemandOptions (dict) --

          The allocation strategy of On-Demand Instances in an EC2 Fleet.

          • AllocationStrategy (string) --

            The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price , EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price .

          • CapacityReservationOptions (dict) --

            The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant .

            • UsageStrategy (string) --

              Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

              If you specify use-capacity-reservations-first , the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized ) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized ).

              If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

          • SingleInstanceType (boolean) --

            Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported only for fleets of type instant .

          • SingleAvailabilityZone (boolean) --

            Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant .

          • MinTargetCapacity (integer) --

            The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

          • MaxTotalPrice (string) --

            The maximum amount per hour for On-Demand Instances that you're willing to pay.

        • Tags (list) --

          The tags for an EC2 Fleet resource.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

        • Errors (list) --

          Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant .

          • (dict) --

            Describes the instances that could not be launched by the fleet.

            • LaunchTemplateAndOverrides (dict) --

              The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

              • LaunchTemplateSpecification (dict) --

                The launch template.

                • LaunchTemplateId (string) --

                  The ID of the launch template. If you specify the template ID, you can't specify the template name.

                • LaunchTemplateName (string) --

                  The name of the launch template. If you specify the template name, you can't specify the template ID.

                • Version (string) --

                  The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

                  If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

                  If the value is $Default , Amazon EC2 uses the default version of the launch template.

              • Overrides (dict) --

                Any parameters that you specify override the same parameters in the launch template.

                • InstanceType (string) --

                  The instance type.

                  Note

                  If you specify InstanceTypes , you can't specify InstanceRequirements .

                • MaxPrice (string) --

                  The maximum price per unit hour that you are willing to pay for a Spot Instance.

                • SubnetId (string) --

                  The ID of the subnet in which to launch the instances.

                • AvailabilityZone (string) --

                  The Availability Zone in which to launch the instances.

                • WeightedCapacity (float) --

                  The number of units provided by the specified instance type.

                • Priority (float) --

                  The priority for the launch template override. The highest priority is launched first.

                  If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

                  If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

                  Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

                • Placement (dict) --

                  The location where the instance launched, if applicable.

                  • GroupName (string) --

                    The name of the placement group that the instance is in.

                • InstanceRequirements (dict) --

                  The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

                  Note

                  If you specify InstanceRequirements , you can't specify InstanceTypes .

                  • VCpuCount (dict) --

                    The minimum and maximum number of vCPUs.

                    • Min (integer) --

                      The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                    • Max (integer) --

                      The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

                  • MemoryMiB (dict) --

                    The minimum and maximum amount of memory, in MiB.

                    • Min (integer) --

                      The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

                  • CpuManufacturers (list) --

                    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 .

                    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

                    • (string) --

                  • MemoryGiBPerVCpu (dict) --

                    The minimum and maximum amount of memory per vCPU, in GiB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

                  • ExcludedInstanceTypes (list) --

                    The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                    Default: No excluded instance types

                    • (string) --

                  • InstanceGenerations (list) --

                    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

                    • (string) --

                  • SpotMaxPricePercentageOverLowestPrice (integer) --

                    The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                    Default: 100

                  • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                    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 cheapest 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 .

                    Default: 20

                  • BareMetal (string) --

                    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

                  • BurstablePerformance (string) --

                    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

                  • RequireHibernateSupport (boolean) --

                    Indicates whether instance types must support hibernation for On-Demand Instances.

                    This parameter is not supported for GetSpotPlacementScores .

                    Default: false

                  • NetworkInterfaceCount (dict) --

                    The minimum and maximum number of network interfaces.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

                  • LocalStorage (string) --

                    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

                  • LocalStorageTypes (list) --

                    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 (SDD) storage, specify sdd .

                    Default: hdd and sdd

                    • (string) --

                  • TotalLocalStorageGB (dict) --

                    The minimum and maximum amount of total local storage, in GB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

                  • BaselineEbsBandwidthMbps (dict) --

                    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

                    • Min (integer) --

                      The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorTypes (list) --

                    The accelerator types that must be on the instance type.

                    • For instance types with GPU accelerators, specify gpu .

                    • For instance types with FPGA accelerators, specify fpga .

                    • For instance types with inference accelerators, specify inference .

                    Default: Any accelerator type

                    • (string) --

                  • AcceleratorCount (dict) --

                    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

                    • Min (integer) --

                      The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorManufacturers (list) --

                    Indicates whether instance types must have accelerators by specific manufacturers.

                    • For instance types with NVIDIA devices, specify nvidia .

                    • For instance types with AMD devices, specify amd .

                    • For instance types with Amazon Web Services devices, specify amazon-web-services .

                    • For instance types with Xilinx devices, specify xilinx .

                    Default: Any manufacturer

                    • (string) --

                  • AcceleratorNames (list) --

                    The accelerators that must be on the instance type.

                    • For instance types with NVIDIA A100 GPUs, specify a100 .

                    • For instance types with NVIDIA V100 GPUs, specify v100 .

                    • For instance types with NVIDIA K80 GPUs, specify k80 .

                    • For instance types with NVIDIA T4 GPUs, specify t4 .

                    • 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 Xilinx VU9P FPGAs, specify vu9p .

                    Default: Any accelerator

                    • (string) --

                  • AcceleratorTotalMemoryMiB (dict) --

                    The minimum and maximum amount of total accelerator memory, in MiB.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

            • Lifecycle (string) --

              Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

            • ErrorCode (string) --

              The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes .

            • ErrorMessage (string) --

              The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes .

        • Instances (list) --

          Information about the instances that were launched by the fleet. Valid only when Type is set to instant .

          • (dict) --

            Describes the instances that were launched by the fleet.

            • LaunchTemplateAndOverrides (dict) --

              The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.

              • LaunchTemplateSpecification (dict) --

                The launch template.

                • LaunchTemplateId (string) --

                  The ID of the launch template. If you specify the template ID, you can't specify the template name.

                • LaunchTemplateName (string) --

                  The name of the launch template. If you specify the template name, you can't specify the template ID.

                • Version (string) --

                  The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

                  If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

                  If the value is $Default , Amazon EC2 uses the default version of the launch template.

              • Overrides (dict) --

                Any parameters that you specify override the same parameters in the launch template.

                • InstanceType (string) --

                  The instance type.

                  Note

                  If you specify InstanceTypes , you can't specify InstanceRequirements .

                • MaxPrice (string) --

                  The maximum price per unit hour that you are willing to pay for a Spot Instance.

                • SubnetId (string) --

                  The ID of the subnet in which to launch the instances.

                • AvailabilityZone (string) --

                  The Availability Zone in which to launch the instances.

                • WeightedCapacity (float) --

                  The number of units provided by the specified instance type.

                • Priority (float) --

                  The priority for the launch template override. The highest priority is launched first.

                  If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

                  If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

                  Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

                • Placement (dict) --

                  The location where the instance launched, if applicable.

                  • GroupName (string) --

                    The name of the placement group that the instance is in.

                • InstanceRequirements (dict) --

                  The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

                  Note

                  If you specify InstanceRequirements , you can't specify InstanceTypes .

                  • VCpuCount (dict) --

                    The minimum and maximum number of vCPUs.

                    • Min (integer) --

                      The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                    • Max (integer) --

                      The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

                  • MemoryMiB (dict) --

                    The minimum and maximum amount of memory, in MiB.

                    • Min (integer) --

                      The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

                  • CpuManufacturers (list) --

                    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 .

                    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

                    • (string) --

                  • MemoryGiBPerVCpu (dict) --

                    The minimum and maximum amount of memory per vCPU, in GiB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

                  • ExcludedInstanceTypes (list) --

                    The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                    Default: No excluded instance types

                    • (string) --

                  • InstanceGenerations (list) --

                    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

                    • (string) --

                  • SpotMaxPricePercentageOverLowestPrice (integer) --

                    The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                    Default: 100

                  • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                    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 cheapest 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 .

                    Default: 20

                  • BareMetal (string) --

                    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

                  • BurstablePerformance (string) --

                    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

                  • RequireHibernateSupport (boolean) --

                    Indicates whether instance types must support hibernation for On-Demand Instances.

                    This parameter is not supported for GetSpotPlacementScores .

                    Default: false

                  • NetworkInterfaceCount (dict) --

                    The minimum and maximum number of network interfaces.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

                  • LocalStorage (string) --

                    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

                  • LocalStorageTypes (list) --

                    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 (SDD) storage, specify sdd .

                    Default: hdd and sdd

                    • (string) --

                  • TotalLocalStorageGB (dict) --

                    The minimum and maximum amount of total local storage, in GB.

                    Default: No minimum or maximum limits

                    • Min (float) --

                      The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                    • Max (float) --

                      The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

                  • BaselineEbsBandwidthMbps (dict) --

                    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

                    • Min (integer) --

                      The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorTypes (list) --

                    The accelerator types that must be on the instance type.

                    • For instance types with GPU accelerators, specify gpu .

                    • For instance types with FPGA accelerators, specify fpga .

                    • For instance types with inference accelerators, specify inference .

                    Default: Any accelerator type

                    • (string) --

                  • AcceleratorCount (dict) --

                    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

                    • Min (integer) --

                      The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

                  • AcceleratorManufacturers (list) --

                    Indicates whether instance types must have accelerators by specific manufacturers.

                    • For instance types with NVIDIA devices, specify nvidia .

                    • For instance types with AMD devices, specify amd .

                    • For instance types with Amazon Web Services devices, specify amazon-web-services .

                    • For instance types with Xilinx devices, specify xilinx .

                    Default: Any manufacturer

                    • (string) --

                  • AcceleratorNames (list) --

                    The accelerators that must be on the instance type.

                    • For instance types with NVIDIA A100 GPUs, specify a100 .

                    • For instance types with NVIDIA V100 GPUs, specify v100 .

                    • For instance types with NVIDIA K80 GPUs, specify k80 .

                    • For instance types with NVIDIA T4 GPUs, specify t4 .

                    • 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 Xilinx VU9P FPGAs, specify vu9p .

                    Default: Any accelerator

                    • (string) --

                  • AcceleratorTotalMemoryMiB (dict) --

                    The minimum and maximum amount of total accelerator memory, in MiB.

                    Default: No minimum or maximum limits

                    • Min (integer) --

                      The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                    • Max (integer) --

                      The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

            • Lifecycle (string) --

              Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

            • InstanceIds (list) --

              The IDs of the instances.

              • (string) --

            • InstanceType (string) --

              The instance type.

            • Platform (string) --

              The value is Windows for Windows instances. Otherwise, the value is blank.

        • Context (string) --

          Reserved.

DescribeInstanceTypeOfferings (updated) Link ¶
Changes (response)
{'InstanceTypeOfferings': {'InstanceType': {'dl1.24xlarge'}}}

Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.

See also: AWS API Documentation

Request Syntax

client.describe_instance_type_offerings(
    DryRun=True|False,
    LocationType='region'|'availability-zone'|'availability-zone-id',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type DryRun

boolean

param DryRun

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 .

type LocationType

string

param LocationType

The location type.

type Filters

list

param Filters

One or more filters. Filter names and values are case-sensitive.

  • location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2 .)

  • instance-type - The instance type. For example, c5.2xlarge .

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'InstanceTypeOfferings': [
        {
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'LocationType': 'region'|'availability-zone'|'availability-zone-id',
            'Location': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceTypeOfferings (list) --

      The instance types offered.

      • (dict) --

        The instance types offered.

        • InstanceType (string) --

          The instance type. For more information, see Instance types in the Amazon EC2 User Guide .

        • LocationType (string) --

          The location type.

        • Location (string) --

          The identifier for the location. This depends on the location type. For example, if the location type is region , the location is the Region code (for example, us-east-2 .)

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeInstanceTypes (updated) Link ¶
Changes (request, response)
Request
{'InstanceTypes': {'dl1.24xlarge'}}
Response
{'InstanceTypes': {'InstanceType': {'dl1.24xlarge'}}}

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.

See also: AWS API Documentation

Request Syntax

client.describe_instance_types(
    DryRun=True|False,
    InstanceTypes=[
        't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type DryRun

boolean

param DryRun

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 .

type InstanceTypes

list

param InstanceTypes

The instance types. For more information, see Instance types in the Amazon EC2 User Guide .

  • (string) --

type Filters

list

param Filters

One or more filters. Filter names and values are case-sensitive.

  • auto-recovery-supported - Indicates whether auto recovery is supported (true | false ).

  • bare-metal - Indicates whether it is a bare metal instance type (true | false ).

  • burstable-performance-supported - Indicates whether it is a burstable performance 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-supported - Indicates whether data is encrypted at rest (required | 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-interfaces - The maximum number of network interfaces per instance.

  • network-info.network-performance - The network performance (for example, "25 Gigabit").

  • processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64 ).

  • processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.

  • 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".

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'CurrentGeneration': True|False,
            'FreeTierEligible': True|False,
            'SupportedUsageClasses': [
                'spot'|'on-demand',
            ],
            'SupportedRootDeviceTypes': [
                'ebs'|'instance-store',
            ],
            'SupportedVirtualizationTypes': [
                'hvm'|'paravirtual',
            ],
            'BareMetal': True|False,
            'Hypervisor': 'nitro'|'xen',
            'ProcessorInfo': {
                'SupportedArchitectures': [
                    'i386'|'x86_64'|'arm64'|'x86_64_mac',
                ],
                'SustainedClockSpeedInGhz': 123.0
            },
            'VCpuInfo': {
                'DefaultVCpus': 123,
                'DefaultCores': 123,
                'DefaultThreadsPerCore': 123,
                'ValidCores': [
                    123,
                ],
                'ValidThreadsPerCore': [
                    123,
                ]
            },
            'MemoryInfo': {
                'SizeInMiB': 123
            },
            'InstanceStorageSupported': True|False,
            'InstanceStorageInfo': {
                'TotalSizeInGB': 123,
                'Disks': [
                    {
                        'SizeInGB': 123,
                        'Count': 123,
                        'Type': 'hdd'|'ssd'
                    },
                ],
                'NvmeSupport': 'unsupported'|'supported'|'required',
                'EncryptionSupport': 'unsupported'|'required'
            },
            'EbsInfo': {
                'EbsOptimizedSupport': 'unsupported'|'supported'|'default',
                'EncryptionSupport': 'unsupported'|'supported',
                'EbsOptimizedInfo': {
                    'BaselineBandwidthInMbps': 123,
                    'BaselineThroughputInMBps': 123.0,
                    'BaselineIops': 123,
                    'MaximumBandwidthInMbps': 123,
                    'MaximumThroughputInMBps': 123.0,
                    'MaximumIops': 123
                },
                'NvmeSupport': 'unsupported'|'supported'|'required'
            },
            'NetworkInfo': {
                'NetworkPerformance': 'string',
                'MaximumNetworkInterfaces': 123,
                'MaximumNetworkCards': 123,
                'DefaultNetworkCardIndex': 123,
                'NetworkCards': [
                    {
                        'NetworkCardIndex': 123,
                        'NetworkPerformance': 'string',
                        'MaximumNetworkInterfaces': 123
                    },
                ],
                'Ipv4AddressesPerInterface': 123,
                'Ipv6AddressesPerInterface': 123,
                'Ipv6Supported': True|False,
                'EnaSupport': 'unsupported'|'supported'|'required',
                'EfaSupported': True|False,
                'EfaInfo': {
                    'MaximumEfaInterfaces': 123
                },
                'EncryptionInTransitSupported': True|False
            },
            'GpuInfo': {
                'Gpus': [
                    {
                        'Name': 'string',
                        'Manufacturer': 'string',
                        'Count': 123,
                        'MemoryInfo': {
                            'SizeInMiB': 123
                        }
                    },
                ],
                'TotalGpuMemoryInMiB': 123
            },
            'FpgaInfo': {
                'Fpgas': [
                    {
                        'Name': 'string',
                        'Manufacturer': 'string',
                        'Count': 123,
                        'MemoryInfo': {
                            'SizeInMiB': 123
                        }
                    },
                ],
                'TotalFpgaMemoryInMiB': 123
            },
            'PlacementGroupInfo': {
                'SupportedStrategies': [
                    'cluster'|'partition'|'spread',
                ]
            },
            'InferenceAcceleratorInfo': {
                'Accelerators': [
                    {
                        'Count': 123,
                        'Name': 'string',
                        'Manufacturer': 'string'
                    },
                ]
            },
            'HibernationSupported': True|False,
            'BurstablePerformanceSupported': True|False,
            'DedicatedHostsSupported': True|False,
            'AutoRecoverySupported': True|False,
            'SupportedBootModes': [
                'legacy-bios'|'uefi',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InstanceTypes (list) --

      The instance type. For more information, see Instance types in the Amazon EC2 User Guide .

      • (dict) --

        Describes the instance type.

        • InstanceType (string) --

          The instance type. For more information, see Instance types in the Amazon EC2 User Guide .

        • CurrentGeneration (boolean) --

          Indicates whether the instance type is current generation.

        • FreeTierEligible (boolean) --

          Indicates whether the instance type is eligible for the free tier.

        • SupportedUsageClasses (list) --

          Indicates whether the instance type is offered for spot or On-Demand.

          • (string) --

        • SupportedRootDeviceTypes (list) --

          The supported root device types.

          • (string) --

        • SupportedVirtualizationTypes (list) --

          The supported virtualization types.

          • (string) --

        • BareMetal (boolean) --

          Indicates whether the instance is a bare metal instance type.

        • Hypervisor (string) --

          The hypervisor for the instance type.

        • ProcessorInfo (dict) --

          Describes the processor.

          • SupportedArchitectures (list) --

            The architectures supported by the instance type.

            • (string) --

          • SustainedClockSpeedInGhz (float) --

            The speed of the processor, in GHz.

        • VCpuInfo (dict) --

          Describes the vCPU configurations for the instance type.

          • DefaultVCpus (integer) --

            The default number of vCPUs for the instance type.

          • DefaultCores (integer) --

            The default number of cores for the instance type.

          • DefaultThreadsPerCore (integer) --

            The default number of threads per core for the instance type.

          • ValidCores (list) --

            The valid number of cores that can be configured for the instance type.

            • (integer) --

          • ValidThreadsPerCore (list) --

            The valid number of threads per core that can be configured for the instance type.

            • (integer) --

        • MemoryInfo (dict) --

          Describes the memory for the instance type.

          • SizeInMiB (integer) --

            The size of the memory, in MiB.

        • InstanceStorageSupported (boolean) --

          Indicates whether instance storage is supported.

        • InstanceStorageInfo (dict) --

          Describes the instance storage for the instance type.

          • TotalSizeInGB (integer) --

            The total size of the disks, in GB.

          • Disks (list) --

            Describes the disks that are available for the instance type.

            • (dict) --

              Describes a disk.

              • SizeInGB (integer) --

                The size of the disk in GB.

              • Count (integer) --

                The number of disks with this configuration.

              • Type (string) --

                The type of disk.

          • NvmeSupport (string) --

            Indicates whether non-volatile memory express (NVMe) is supported.

          • EncryptionSupport (string) --

            Indicates whether data is encrypted at rest.

        • EbsInfo (dict) --

          Describes the Amazon EBS settings for the instance type.

          • EbsOptimizedSupport (string) --

            Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide .

          • EncryptionSupport (string) --

            Indicates whether Amazon EBS encryption is supported.

          • EbsOptimizedInfo (dict) --

            Describes the optimized EBS performance for the instance type.

            • BaselineBandwidthInMbps (integer) --

              The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

            • BaselineThroughputInMBps (float) --

              The baseline throughput performance for an EBS-optimized instance type, in MB/s.

            • BaselineIops (integer) --

              The baseline input/output storage operations per seconds for an EBS-optimized instance type.

            • MaximumBandwidthInMbps (integer) --

              The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.

            • MaximumThroughputInMBps (float) --

              The maximum throughput performance for an EBS-optimized instance type, in MB/s.

            • MaximumIops (integer) --

              The maximum input/output storage operations per second for an EBS-optimized instance type.

          • NvmeSupport (string) --

            Indicates whether non-volatile memory express (NVMe) is supported.

        • NetworkInfo (dict) --

          Describes the network settings for the instance type.

          • NetworkPerformance (string) --

            The network performance.

          • MaximumNetworkInterfaces (integer) --

            The maximum number of network interfaces for the instance type.

          • MaximumNetworkCards (integer) --

            The maximum number of physical network cards that can be allocated to the instance.

          • DefaultNetworkCardIndex (integer) --

            The index of the default network card, starting at 0.

          • NetworkCards (list) --

            Describes the network cards for the instance type.

            • (dict) --

              Describes the network card support of the instance type.

              • NetworkCardIndex (integer) --

                The index of the network card.

              • NetworkPerformance (string) --

                The network performance of the network card.

              • MaximumNetworkInterfaces (integer) --

                The maximum number of network interfaces for the network card.

          • Ipv4AddressesPerInterface (integer) --

            The maximum number of IPv4 addresses per network interface.

          • Ipv6AddressesPerInterface (integer) --

            The maximum number of IPv6 addresses per network interface.

          • Ipv6Supported (boolean) --

            Indicates whether IPv6 is supported.

          • EnaSupport (string) --

            Indicates whether Elastic Network Adapter (ENA) is supported.

          • EfaSupported (boolean) --

            Indicates whether Elastic Fabric Adapter (EFA) is supported.

          • EfaInfo (dict) --

            Describes the Elastic Fabric Adapters for the instance type.

            • MaximumEfaInterfaces (integer) --

              The maximum number of Elastic Fabric Adapters for the instance type.

          • EncryptionInTransitSupported (boolean) --

            Indicates whether the instance type automatically encrypts in-transit traffic between instances.

        • GpuInfo (dict) --

          Describes the GPU accelerator settings for the instance type.

          • Gpus (list) --

            Describes the GPU accelerators for the instance type.

            • (dict) --

              Describes the GPU accelerators for the instance type.

              • Name (string) --

                The name of the GPU accelerator.

              • Manufacturer (string) --

                The manufacturer of the GPU accelerator.

              • Count (integer) --

                The number of GPUs for the instance type.

              • MemoryInfo (dict) --

                Describes the memory available to the GPU accelerator.

                • SizeInMiB (integer) --

                  The size of the memory available to the GPU accelerator, in MiB.

          • TotalGpuMemoryInMiB (integer) --

            The total size of the memory for the GPU accelerators for the instance type, in MiB.

        • FpgaInfo (dict) --

          Describes the FPGA accelerator settings for the instance type.

          • Fpgas (list) --

            Describes the FPGAs for the instance type.

            • (dict) --

              Describes the FPGA accelerator for the instance type.

              • Name (string) --

                The name of the FPGA accelerator.

              • Manufacturer (string) --

                The manufacturer of the FPGA accelerator.

              • Count (integer) --

                The count of FPGA accelerators for the instance type.

              • MemoryInfo (dict) --

                Describes the memory for the FPGA accelerator for the instance type.

                • SizeInMiB (integer) --

                  The size of the memory available to the FPGA accelerator, in MiB.

          • TotalFpgaMemoryInMiB (integer) --

            The total memory of all FPGA accelerators for the instance type.

        • PlacementGroupInfo (dict) --

          Describes the placement group settings for the instance type.

          • SupportedStrategies (list) --

            The supported placement group types.

            • (string) --

        • InferenceAcceleratorInfo (dict) --

          Describes the Inference accelerator settings for the instance type.

          • Accelerators (list) --

            Describes the Inference accelerators for the instance type.

            • (dict) --

              Describes the Inference accelerators for the instance type.

              • Count (integer) --

                The number of Inference accelerators for the instance type.

              • Name (string) --

                The name of the Inference accelerator.

              • Manufacturer (string) --

                The manufacturer of the Inference accelerator.

        • HibernationSupported (boolean) --

          Indicates whether On-Demand hibernation is supported.

        • BurstablePerformanceSupported (boolean) --

          Indicates whether the instance type is a burstable performance instance type.

        • DedicatedHostsSupported (boolean) --

          Indicates whether Dedicated Hosts are supported on the instance type.

        • AutoRecoverySupported (boolean) --

          Indicates whether auto recovery is supported.

        • SupportedBootModes (list) --

          The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide .

          • (string) --

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeInstances (updated) Link ¶
Changes (response)
{'Reservations': {'Instances': {'InstanceType': {'dl1.24xlarge'}}}}

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

See also: AWS API Documentation

Request Syntax

client.describe_instances(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    InstanceIds=[
        'string',
    ],
    DryRun=True|False,
    MaxResults=123,
    NextToken='string'
)
type Filters

list

param Filters

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host ).

  • architecture - The instance architecture (i386 | x86_64 | arm64 ).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z .

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh ).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached ).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen ). The value xen is used for both Xen and Nitro hypervisors.

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled ).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped ).

  • instance-type - The type of instance (for example, t2.micro ).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z . You can use a wildcard (* ), for example, 2021-09-29T* , which matches an entire day.

  • metadata-options.http-tokens - The metadata request authorization state (optional | required )

  • metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64 )

  • metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled )

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled ).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached ).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.

  • network-interface.status - The status of the network interface (available ) | in-use ).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The Amazon Web Services account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows .

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace ).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1 ).

  • root-device-type - The type of the root device volume (ebs | instance-store ).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

  • tenancy - The tenancy of an instance (dedicated | default | host ).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm ).

  • vpc-id - The ID of the VPC that the instance is running in.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type InstanceIds

list

param InstanceIds

The instance IDs.

Default: Describes all your instances.

  • (string) --

type DryRun

boolean

param DryRun

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 .

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

type NextToken

string

param NextToken

The token to request the next page of results.

rtype

dict

returns

Response Syntax

{
    'Reservations': [
        {
            'Groups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'Instances': [
                {
                    'AmiLaunchIndex': 123,
                    'ImageId': 'string',
                    'InstanceId': 'string',
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Monitoring': {
                        'State': 'disabled'|'disabling'|'enabled'|'pending'
                    },
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'Affinity': 'string',
                        'GroupName': 'string',
                        'PartitionNumber': 123,
                        'HostId': 'string',
                        'Tenancy': 'default'|'dedicated'|'host',
                        'SpreadDomain': 'string',
                        'HostResourceGroupArn': 'string'
                    },
                    'Platform': 'Windows',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'ProductCodes': [
                        {
                            'ProductCodeId': 'string',
                            'ProductCodeType': 'devpay'|'marketplace'
                        },
                    ],
                    'PublicDnsName': 'string',
                    'PublicIpAddress': 'string',
                    'RamdiskId': 'string',
                    'State': {
                        'Code': 123,
                        'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
                    },
                    'StateTransitionReason': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string',
                    'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac',
                    'BlockDeviceMappings': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': datetime(2015, 1, 1),
                                'DeleteOnTermination': True|False,
                                'Status': 'attaching'|'attached'|'detaching'|'detached',
                                'VolumeId': 'string'
                            }
                        },
                    ],
                    'ClientToken': 'string',
                    'EbsOptimized': True|False,
                    'EnaSupport': True|False,
                    'Hypervisor': 'ovm'|'xen',
                    'IamInstanceProfile': {
                        'Arn': 'string',
                        'Id': 'string'
                    },
                    'InstanceLifecycle': 'spot'|'scheduled',
                    'ElasticGpuAssociations': [
                        {
                            'ElasticGpuId': 'string',
                            'ElasticGpuAssociationId': 'string',
                            'ElasticGpuAssociationState': 'string',
                            'ElasticGpuAssociationTime': 'string'
                        },
                    ],
                    'ElasticInferenceAcceleratorAssociations': [
                        {
                            'ElasticInferenceAcceleratorArn': 'string',
                            'ElasticInferenceAcceleratorAssociationId': 'string',
                            'ElasticInferenceAcceleratorAssociationState': 'string',
                            'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1)
                        },
                    ],
                    'NetworkInterfaces': [
                        {
                            'Association': {
                                'CarrierIp': 'string',
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentId': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'attaching'|'attached'|'detaching'|'detached',
                                'NetworkCardIndex': 123
                            },
                            'Description': 'string',
                            'Groups': [
                                {
                                    'GroupName': 'string',
                                    'GroupId': 'string'
                                },
                            ],
                            'Ipv6Addresses': [
                                {
                                    'Ipv6Address': 'string'
                                },
                            ],
                            'MacAddress': 'string',
                            'NetworkInterfaceId': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddresses': [
                                {
                                    'Association': {
                                        'CarrierIp': 'string',
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': True|False,
                            'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
                            'SubnetId': 'string',
                            'VpcId': 'string',
                            'InterfaceType': 'string',
                            'Ipv4Prefixes': [
                                {
                                    'Ipv4Prefix': 'string'
                                },
                            ],
                            'Ipv6Prefixes': [
                                {
                                    'Ipv6Prefix': 'string'
                                },
                            ]
                        },
                    ],
                    'OutpostArn': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'ebs'|'instance-store',
                    'SecurityGroups': [
                        {
                            'GroupName': 'string',
                            'GroupId': 'string'
                        },
                    ],
                    'SourceDestCheck': True|False,
                    'SpotInstanceRequestId': 'string',
                    'SriovNetSupport': 'string',
                    'StateReason': {
                        'Code': 'string',
                        'Message': 'string'
                    },
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'VirtualizationType': 'hvm'|'paravirtual',
                    'CpuOptions': {
                        'CoreCount': 123,
                        'ThreadsPerCore': 123
                    },
                    'CapacityReservationId': 'string',
                    'CapacityReservationSpecification': {
                        'CapacityReservationPreference': 'open'|'none',
                        'CapacityReservationTarget': {
                            'CapacityReservationId': 'string',
                            'CapacityReservationResourceGroupArn': 'string'
                        }
                    },
                    'HibernationOptions': {
                        'Configured': True|False
                    },
                    'Licenses': [
                        {
                            'LicenseConfigurationArn': 'string'
                        },
                    ],
                    'MetadataOptions': {
                        'State': 'pending'|'applied',
                        'HttpTokens': 'optional'|'required',
                        'HttpPutResponseHopLimit': 123,
                        'HttpEndpoint': 'disabled'|'enabled',
                        'HttpProtocolIpv6': 'disabled'|'enabled'
                    },
                    'EnclaveOptions': {
                        'Enabled': True|False
                    },
                    'BootMode': 'legacy-bios'|'uefi',
                    'PlatformDetails': 'string',
                    'UsageOperation': 'string',
                    'UsageOperationUpdateTime': datetime(2015, 1, 1)
                },
            ],
            'OwnerId': 'string',
            'RequesterId': 'string',
            'ReservationId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Reservations (list) --

      Information about the reservations.

      • (dict) --

        Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.

        • Groups (list) --

          [EC2-Classic only] The security groups.

          • (dict) --

            Describes a security group.

            • GroupName (string) --

              The name of the security group.

            • GroupId (string) --

              The ID of the security group.

        • Instances (list) --

          The instances.

          • (dict) --

            Describes an instance.

            • AmiLaunchIndex (integer) --

              The AMI launch index, which can be used to find this instance in the launch group.

            • ImageId (string) --

              The ID of the AMI used to launch the instance.

            • InstanceId (string) --

              The ID of the instance.

            • InstanceType (string) --

              The instance type.

            • KernelId (string) --

              The kernel associated with this instance, if applicable.

            • KeyName (string) --

              The name of the key pair, if this instance was launched with an associated key pair.

            • LaunchTime (datetime) --

              The time the instance was launched.

            • Monitoring (dict) --

              The monitoring for the instance.

              • State (string) --

                Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

            • Placement (dict) --

              The location where the instance launched, if applicable.

              • AvailabilityZone (string) --

                The Availability Zone of the instance.

                If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

                This parameter is not supported by CreateFleet .

              • Affinity (string) --

                The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

                This parameter is not supported by CreateFleet .

              • GroupName (string) --

                The name of the placement group the instance is in.

              • PartitionNumber (integer) --

                The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .

                This parameter is not supported by CreateFleet .

              • HostId (string) --

                The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

                This parameter is not supported by CreateFleet .

              • Tenancy (string) --

                The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

                This parameter is not supported by CreateFleet .

                T3 instances that use the unlimited CPU credit option do not support host tenancy.

              • SpreadDomain (string) --

                Reserved for future use.

                This parameter is not supported by CreateFleet .

              • HostResourceGroupArn (string) --

                The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

                This parameter is not supported by CreateFleet .

            • Platform (string) --

              The value is Windows for Windows instances; otherwise blank.

            • PrivateDnsName (string) --

              (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

              [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

            • PrivateIpAddress (string) --

              The private IPv4 address assigned to the instance.

            • ProductCodes (list) --

              The product codes attached to this instance, if applicable.

              • (dict) --

                Describes a product code.

                • ProductCodeId (string) --

                  The product code.

                • ProductCodeType (string) --

                  The type of product code.

            • PublicDnsName (string) --

              (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

            • PublicIpAddress (string) --

              The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

              A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

            • RamdiskId (string) --

              The RAM disk associated with this instance, if applicable.

            • State (dict) --

              The current state of the instance.

              • Code (integer) --

                The state of the instance as a 16-bit unsigned integer.

                The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

                The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

                The valid values for instance-state-code will all be in the range of the low byte and they are:

                • 0 : pending

                • 16 : running

                • 32 : shutting-down

                • 48 : terminated

                • 64 : stopping

                • 80 : stopped

                You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

              • Name (string) --

                The current state of the instance.

            • StateTransitionReason (string) --

              The reason for the most recent state transition. This might be an empty string.

            • SubnetId (string) --

              [EC2-VPC] The ID of the subnet in which the instance is running.

            • VpcId (string) --

              [EC2-VPC] The ID of the VPC in which the instance is running.

            • Architecture (string) --

              The architecture of the image.

            • BlockDeviceMappings (list) --

              Any block device mapping entries for the instance.

              • (dict) --

                Describes a block device mapping.

                • DeviceName (string) --

                  The device name (for example, /dev/sdh or xvdh ).

                • Ebs (dict) --

                  Parameters used to automatically set up EBS volumes when the instance is launched.

                  • AttachTime (datetime) --

                    The time stamp when the attachment initiated.

                  • DeleteOnTermination (boolean) --

                    Indicates whether the volume is deleted on instance termination.

                  • Status (string) --

                    The attachment state.

                  • VolumeId (string) --

                    The ID of the EBS volume.

            • ClientToken (string) --

              The idempotency token you provided when you launched the instance, if applicable.

            • EbsOptimized (boolean) --

              Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

            • EnaSupport (boolean) --

              Specifies whether enhanced networking with ENA is enabled.

            • Hypervisor (string) --

              The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

            • IamInstanceProfile (dict) --

              The IAM instance profile associated with the instance, if applicable.

              • Arn (string) --

                The Amazon Resource Name (ARN) of the instance profile.

              • Id (string) --

                The ID of the instance profile.

            • InstanceLifecycle (string) --

              Indicates whether this is a Spot Instance or a Scheduled Instance.

            • ElasticGpuAssociations (list) --

              The Elastic GPU associated with the instance.

              • (dict) --

                Describes the association between an instance and an Elastic Graphics accelerator.

                • ElasticGpuId (string) --

                  The ID of the Elastic Graphics accelerator.

                • ElasticGpuAssociationId (string) --

                  The ID of the association.

                • ElasticGpuAssociationState (string) --

                  The state of the association between the instance and the Elastic Graphics accelerator.

                • ElasticGpuAssociationTime (string) --

                  The time the Elastic Graphics accelerator was associated with the instance.

            • ElasticInferenceAcceleratorAssociations (list) --

              The elastic inference accelerator associated with the instance.

              • (dict) --

                Describes the association between an instance and an elastic inference accelerator.

                • ElasticInferenceAcceleratorArn (string) --

                  The Amazon Resource Name (ARN) of the elastic inference accelerator.

                • ElasticInferenceAcceleratorAssociationId (string) --

                  The ID of the association.

                • ElasticInferenceAcceleratorAssociationState (string) --

                  The state of the elastic inference accelerator.

                • ElasticInferenceAcceleratorAssociationTime (datetime) --

                  The time at which the elastic inference accelerator is associated with an instance.

            • NetworkInterfaces (list) --

              [EC2-VPC] The network interfaces for the instance.

              • (dict) --

                Describes a network interface.

                • Association (dict) --

                  The association information for an Elastic IPv4 associated with the network interface.

                  • CarrierIp (string) --

                    The carrier IP address associated with the network interface.

                  • IpOwnerId (string) --

                    The ID of the owner of the Elastic IP address.

                  • PublicDnsName (string) --

                    The public DNS name.

                  • PublicIp (string) --

                    The public IP address or Elastic IP address bound to the network interface.

                • Attachment (dict) --

                  The network interface attachment.

                  • AttachTime (datetime) --

                    The time stamp when the attachment initiated.

                  • AttachmentId (string) --

                    The ID of the network interface attachment.

                  • DeleteOnTermination (boolean) --

                    Indicates whether the network interface is deleted when the instance is terminated.

                  • DeviceIndex (integer) --

                    The index of the device on the instance for the network interface attachment.

                  • Status (string) --

                    The attachment state.

                  • NetworkCardIndex (integer) --

                    The index of the network card.

                • Description (string) --

                  The description.

                • Groups (list) --

                  One or more security groups.

                  • (dict) --

                    Describes a security group.

                    • GroupName (string) --

                      The name of the security group.

                    • GroupId (string) --

                      The ID of the security group.

                • Ipv6Addresses (list) --

                  One or more IPv6 addresses associated with the network interface.

                  • (dict) --

                    Describes an IPv6 address.

                    • Ipv6Address (string) --

                      The IPv6 address.

                • MacAddress (string) --

                  The MAC address.

                • NetworkInterfaceId (string) --

                  The ID of the network interface.

                • OwnerId (string) --

                  The ID of the Amazon Web Services account that created the network interface.

                • PrivateDnsName (string) --

                  The private DNS name.

                • PrivateIpAddress (string) --

                  The IPv4 address of the network interface within the subnet.

                • PrivateIpAddresses (list) --

                  One or more private IPv4 addresses associated with the network interface.

                  • (dict) --

                    Describes a private IPv4 address.

                    • Association (dict) --

                      The association information for an Elastic IP address for the network interface.

                      • CarrierIp (string) --

                        The carrier IP address associated with the network interface.

                      • IpOwnerId (string) --

                        The ID of the owner of the Elastic IP address.

                      • PublicDnsName (string) --

                        The public DNS name.

                      • PublicIp (string) --

                        The public IP address or Elastic IP address bound to the network interface.

                    • Primary (boolean) --

                      Indicates whether this IPv4 address is the primary private IP address of the network interface.

                    • PrivateDnsName (string) --

                      The private IPv4 DNS name.

                    • PrivateIpAddress (string) --

                      The private IPv4 address of the network interface.

                • SourceDestCheck (boolean) --

                  Indicates whether source/destination checking is enabled.

                • Status (string) --

                  The status of the network interface.

                • SubnetId (string) --

                  The ID of the subnet.

                • VpcId (string) --

                  The ID of the VPC.

                • InterfaceType (string) --

                  Describes the type of network interface.

                  Valid values: interface | efa | trunk

                • Ipv4Prefixes (list) --

                  The IPv4 delegated prefixes that are assigned to the network interface.

                  • (dict) --

                    Information about an IPv4 prefix.

                    • Ipv4Prefix (string) --

                      One or more IPv4 prefixes assigned to the network interface.

                • Ipv6Prefixes (list) --

                  The IPv6 delegated prefixes that are assigned to the network interface.

                  • (dict) --

                    Information about an IPv6 prefix.

                    • Ipv6Prefix (string) --

                      One or more IPv6 prefixes assigned to the network interface.

            • OutpostArn (string) --

              The Amazon Resource Name (ARN) of the Outpost.

            • RootDeviceName (string) --

              The device name of the root device volume (for example, /dev/sda1 ).

            • RootDeviceType (string) --

              The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

            • SecurityGroups (list) --

              The security groups for the instance.

              • (dict) --

                Describes a security group.

                • GroupName (string) --

                  The name of the security group.

                • GroupId (string) --

                  The ID of the security group.

            • SourceDestCheck (boolean) --

              Indicates whether source/destination checking is enabled.

            • SpotInstanceRequestId (string) --

              If the request is a Spot Instance request, the ID of the request.

            • SriovNetSupport (string) --

              Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

            • StateReason (dict) --

              The reason for the most recent state transition.

              • Code (string) --

                The reason code for the state change.

              • Message (string) --

                The message for the state change.

                • Server.InsufficientInstanceCapacity : There was insufficient capacity available to satisfy the launch request.

                • Server.InternalError : An internal error caused the instance to terminate during launch.

                • Server.ScheduledStop : The instance was stopped due to a scheduled retirement.

                • Server.SpotInstanceShutdown : The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

                • Server.SpotInstanceTermination : The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

                • Client.InstanceInitiatedShutdown : The instance was shut down using the shutdown -h command from the instance.

                • Client.InstanceTerminated : The instance was terminated or rebooted during AMI creation.

                • Client.InternalError : A client error caused the instance to terminate during launch.

                • Client.InvalidSnapshot.NotFound : The specified snapshot was not found.

                • Client.UserInitiatedHibernate : Hibernation was initiated on the instance.

                • Client.UserInitiatedShutdown : The instance was shut down using the Amazon EC2 API.

                • Client.VolumeLimitExceeded : The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

            • Tags (list) --

              Any tags assigned to the instance.

              • (dict) --

                Describes a tag.

                • Key (string) --

                  The key of the tag.

                  Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

                • Value (string) --

                  The value of the tag.

                  Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

            • VirtualizationType (string) --

              The virtualization type of the instance.

            • CpuOptions (dict) --

              The CPU options for the instance.

              • CoreCount (integer) --

                The number of CPU cores for the instance.

              • ThreadsPerCore (integer) --

                The number of threads per CPU core.

            • CapacityReservationId (string) --

              The ID of the Capacity Reservation.

            • CapacityReservationSpecification (dict) --

              Information about the Capacity Reservation targeting option.

              • CapacityReservationPreference (string) --

                Describes the instance's Capacity Reservation preferences. Possible preferences include:

                • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

                • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

              • CapacityReservationTarget (dict) --

                Information about the targeted Capacity Reservation or Capacity Reservation group.

                • CapacityReservationId (string) --

                  The ID of the targeted Capacity Reservation.

                • CapacityReservationResourceGroupArn (string) --

                  The ARN of the targeted Capacity Reservation group.

            • HibernationOptions (dict) --

              Indicates whether the instance is enabled for hibernation.

              • Configured (boolean) --

                If this parameter is set to true , your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

            • Licenses (list) --

              The license configurations for the instance.

              • (dict) --

                Describes a license configuration.

                • LicenseConfigurationArn (string) --

                  The Amazon Resource Name (ARN) of the license configuration.

            • MetadataOptions (dict) --

              The metadata options for the instance.

              • State (string) --

                The state of the metadata option changes.

                pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

                applied - The metadata options have been successfully applied on the instance.

              • HttpTokens (string) --

                The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

                If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

                If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.

              • HttpPutResponseHopLimit (integer) --

                The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

                Default: 1

                Possible values: Integers from 1 to 64

              • HttpEndpoint (string) --

                Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

              • HttpProtocolIpv6 (string) --

                Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

            • EnclaveOptions (dict) --

              Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

              • Enabled (boolean) --

                If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

            • BootMode (string) --

              The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide .

            • PlatformDetails (string) --

              The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide .

            • UsageOperation (string) --

              The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide .

            • UsageOperationUpdateTime (datetime) --

              The time that the usage operation was last updated.

        • OwnerId (string) --

          The ID of the Amazon Web Services account that owns the reservation.

        • RequesterId (string) --

          The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).

        • ReservationId (string) --

          The ID of the reservation.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeLaunchTemplateVersions (updated) Link ¶
Changes (response)
{'LaunchTemplateVersions': {'LaunchTemplateData': {'InstanceType': {'dl1.24xlarge'}}}}

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.

See also: AWS API Documentation

Request Syntax

client.describe_launch_template_versions(
    DryRun=True|False,
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    Versions=[
        'string',
    ],
    MinVersion='string',
    MaxVersion='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)
type DryRun

boolean

param DryRun

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 .

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.

type Versions

list

param Versions

One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.

To describe one or more versions of a specified launch template, valid values are $Latest , $Default , and numbers.

To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest . To describe all launch templates in your account that are defined as the default version, the valid value is $Default . You can specify $Latest and $Default in the same call. You cannot specify numbers.

  • (string) --

type MinVersion

string

param MinVersion

The version number after which to describe launch template versions.

type MaxVersion

string

param MaxVersion

The version number up to which to describe launch template versions.

type NextToken

string

param NextToken

The token to request the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

type Filters

list

param Filters

One or more filters.

  • create-time - The time the launch template version was created.

  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • iam-instance-profile - The ARN of the IAM instance profile.

  • image-id - The ID of the AMI.

  • instance-type - The instance type.

  • is-default-version - A boolean that indicates whether the launch template version is the default version.

  • kernel-id - The kernel ID.

  • ram-disk-id - The RAM disk ID.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateVersions': [
        {
            'LaunchTemplateId': 'string',
            'LaunchTemplateName': 'string',
            'VersionNumber': 123,
            'VersionDescription': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'DefaultVersion': True|False,
            'LaunchTemplateData': {
                'KernelId': 'string',
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'Encrypted': True|False,
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'KmsKeyId': 'string',
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                            'Throughput': 123
                        },
                        'NoDevice': 'string'
                    },
                ],
                'NetworkInterfaces': [
                    {
                        'AssociateCarrierIpAddress': True|False,
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'InterfaceType': 'string',
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string',
                        'NetworkCardIndex': 123,
                        'Ipv4Prefixes': [
                            {
                                'Ipv4Prefix': 'string'
                            },
                        ],
                        'Ipv4PrefixCount': 123,
                        'Ipv6Prefixes': [
                            {
                                'Ipv6Prefix': 'string'
                            },
                        ],
                        'Ipv6PrefixCount': 123
                    },
                ],
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                'KeyName': 'string',
                'Monitoring': {
                    'Enabled': True|False
                },
                'Placement': {
                    'AvailabilityZone': 'string',
                    'Affinity': 'string',
                    'GroupName': 'string',
                    'HostId': 'string',
                    'Tenancy': 'default'|'dedicated'|'host',
                    'SpreadDomain': 'string',
                    'HostResourceGroupArn': 'string',
                    'PartitionNumber': 123
                },
                'RamDiskId': 'string',
                'DisableApiTermination': True|False,
                'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
                'UserData': 'string',
                'TagSpecifications': [
                    {
                        'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ],
                'ElasticGpuSpecifications': [
                    {
                        'Type': 'string'
                    },
                ],
                'ElasticInferenceAccelerators': [
                    {
                        'Type': 'string',
                        'Count': 123
                    },
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'SecurityGroups': [
                    'string',
                ],
                'InstanceMarketOptions': {
                    'MarketType': 'spot',
                    'SpotOptions': {
                        'MaxPrice': 'string',
                        'SpotInstanceType': 'one-time'|'persistent',
                        'BlockDurationMinutes': 123,
                        'ValidUntil': datetime(2015, 1, 1),
                        'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
                    }
                },
                'CreditSpecification': {
                    'CpuCredits': 'string'
                },
                'CpuOptions': {
                    'CoreCount': 123,
                    'ThreadsPerCore': 123
                },
                'CapacityReservationSpecification': {
                    'CapacityReservationPreference': 'open'|'none',
                    'CapacityReservationTarget': {
                        'CapacityReservationId': 'string',
                        'CapacityReservationResourceGroupArn': 'string'
                    }
                },
                'LicenseSpecifications': [
                    {
                        'LicenseConfigurationArn': 'string'
                    },
                ],
                'HibernationOptions': {
                    'Configured': True|False
                },
                'MetadataOptions': {
                    'State': 'pending'|'applied',
                    'HttpTokens': 'optional'|'required',
                    'HttpPutResponseHopLimit': 123,
                    'HttpEndpoint': 'disabled'|'enabled',
                    'HttpProtocolIpv6': 'disabled'|'enabled'
                },
                'EnclaveOptions': {
                    'Enabled': True|False
                },
                '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',
                    ],
                    'AcceleratorTotalMemoryMiB': {
                        'Min': 123,
                        'Max': 123
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • LaunchTemplateVersions (list) --

      Information about the launch template versions.

      • (dict) --

        Describes a launch template version.

        • LaunchTemplateId (string) --

          The ID of the launch template.

        • LaunchTemplateName (string) --

          The name of the launch template.

        • VersionNumber (integer) --

          The version number.

        • VersionDescription (string) --

          The description for the version.

        • CreateTime (datetime) --

          The time the version was created.

        • CreatedBy (string) --

          The principal that created the version.

        • DefaultVersion (boolean) --

          Indicates whether the version is the default version.

        • LaunchTemplateData (dict) --

          Information about the launch template.

          • KernelId (string) --

            The ID of the kernel, if applicable.

          • EbsOptimized (boolean) --

            Indicates whether the instance is optimized for Amazon EBS I/O.

          • IamInstanceProfile (dict) --

            The IAM instance profile.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the instance profile.

            • Name (string) --

              The name of the instance profile.

          • BlockDeviceMappings (list) --

            The block device mappings.

            • (dict) --

              Describes a block device mapping.

              • DeviceName (string) --

                The device name.

              • VirtualName (string) --

                The virtual device name (ephemeralN).

              • Ebs (dict) --

                Information about the block device for an EBS volume.

                • Encrypted (boolean) --

                  Indicates whether the EBS volume is encrypted.

                • DeleteOnTermination (boolean) --

                  Indicates whether the EBS volume is deleted on instance termination.

                • Iops (integer) --

                  The number of I/O operations per second (IOPS) that the volume supports.

                • KmsKeyId (string) --

                  The ARN of the Key Management Service (KMS) CMK used for encryption.

                • SnapshotId (string) --

                  The ID of the snapshot.

                • VolumeSize (integer) --

                  The size of the volume, in GiB.

                • VolumeType (string) --

                  The volume type.

                • Throughput (integer) --

                  The throughput that the volume supports, in MiB/s.

              • NoDevice (string) --

                To omit the device from the block device mapping, specify an empty string.

          • NetworkInterfaces (list) --

            The network interfaces.

            • (dict) --

              Describes a network interface.

              • AssociateCarrierIpAddress (boolean) --

                Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

                Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .

              • AssociatePublicIpAddress (boolean) --

                Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

              • DeleteOnTermination (boolean) --

                Indicates whether the network interface is deleted when the instance is terminated.

              • Description (string) --

                A description for the network interface.

              • DeviceIndex (integer) --

                The device index for the network interface attachment.

              • Groups (list) --

                The IDs of one or more security groups.

                • (string) --

              • InterfaceType (string) --

                The type of network interface.

              • Ipv6AddressCount (integer) --

                The number of IPv6 addresses for the network interface.

              • Ipv6Addresses (list) --

                The IPv6 addresses for the network interface.

                • (dict) --

                  Describes an IPv6 address.

                  • Ipv6Address (string) --

                    The IPv6 address.

              • NetworkInterfaceId (string) --

                The ID of the network interface.

              • PrivateIpAddress (string) --

                The primary private IPv4 address of the network interface.

              • PrivateIpAddresses (list) --

                One or more private IPv4 addresses.

                • (dict) --

                  Describes a secondary private IPv4 address for a network interface.

                  • Primary (boolean) --

                    Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

                  • PrivateIpAddress (string) --

                    The private IPv4 addresses.

              • SecondaryPrivateIpAddressCount (integer) --

                The number of secondary private IPv4 addresses for the network interface.

              • SubnetId (string) --

                The ID of the subnet for the network interface.

              • NetworkCardIndex (integer) --

                The index of the network card.

              • Ipv4Prefixes (list) --

                One or more IPv4 prefixes assigned to the network interface.

                • (dict) --

                  Information about the IPv4 delegated prefixes assigned to a network interface.

                  • Ipv4Prefix (string) --

                    One or more IPv4 delegated prefixes assigned to the network interface.

              • Ipv4PrefixCount (integer) --

                The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.

              • Ipv6Prefixes (list) --

                One or more IPv6 prefixes assigned to the network interface.

                • (dict) --

                  Information about the IPv6 delegated prefixes assigned to a network interface.

                  • Ipv6Prefix (string) --

                    One or more IPv6 delegated prefixes assigned to the network interface.

              • Ipv6PrefixCount (integer) --

                The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.

          • ImageId (string) --

            The ID of the AMI that was used to launch the instance.

          • InstanceType (string) --

            The instance type.

          • KeyName (string) --

            The name of the key pair.

          • Monitoring (dict) --

            The monitoring for the instance.

            • Enabled (boolean) --

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

          • Placement (dict) --

            The placement of the instance.

            • AvailabilityZone (string) --

              The Availability Zone of the instance.

            • Affinity (string) --

              The affinity setting for the instance on the Dedicated Host.

            • GroupName (string) --

              The name of the placement group for the instance.

            • HostId (string) --

              The ID of the Dedicated Host for the instance.

            • Tenancy (string) --

              The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

            • SpreadDomain (string) --

              Reserved for future use.

            • HostResourceGroupArn (string) --

              The ARN of the host resource group in which to launch the instances.

            • PartitionNumber (integer) --

              The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .

          • RamDiskId (string) --

            The ID of the RAM disk, if applicable.

          • DisableApiTermination (boolean) --

            If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

          • InstanceInitiatedShutdownBehavior (string) --

            Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

          • UserData (string) --

            The user data for the instance.

          • TagSpecifications (list) --

            The tags.

            • (dict) --

              The tag specification for the launch template.

              • ResourceType (string) --

                The type of resource.

              • Tags (list) --

                The tags for the resource.

                • (dict) --

                  Describes a tag.

                  • Key (string) --

                    The key of the tag.

                    Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

                  • Value (string) --

                    The value of the tag.

                    Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

          • ElasticGpuSpecifications (list) --

            The elastic GPU specification.

            • (dict) --

              Describes an elastic GPU.

              • Type (string) --

                The elastic GPU type.

          • ElasticInferenceAccelerators (list) --

            The elastic inference accelerator for the instance.

            • (dict) --

              Describes an elastic inference accelerator.

              • Type (string) --

                The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

              • Count (integer) --

                The number of elastic inference accelerators to attach to the instance.

                Default: 1

          • SecurityGroupIds (list) --

            The security group IDs.

            • (string) --

          • SecurityGroups (list) --

            The security group names.

            • (string) --

          • InstanceMarketOptions (dict) --

            The market (purchasing) option for the instances.

            • MarketType (string) --

              The market type.

            • SpotOptions (dict) --

              The options for Spot Instances.

              • MaxPrice (string) --

                The maximum hourly price you're willing to pay for the Spot Instances.

              • SpotInstanceType (string) --

                The Spot Instance request type.

              • BlockDurationMinutes (integer) --

                The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

              • ValidUntil (datetime) --

                The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

              • InstanceInterruptionBehavior (string) --

                The behavior when a Spot Instance is interrupted.

          • CreditSpecification (dict) --

            The credit option for CPU usage of the instance.

            • CpuCredits (string) --

              The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .

          • CpuOptions (dict) --

            The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide .

            • CoreCount (integer) --

              The number of CPU cores for the instance.

            • ThreadsPerCore (integer) --

              The number of threads per CPU core.

          • CapacityReservationSpecification (dict) --

            Information about the Capacity Reservation targeting option.

            • CapacityReservationPreference (string) --

              Indicates the instance's Capacity Reservation preferences. Possible preferences include:

              • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

              • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

            • CapacityReservationTarget (dict) --

              Information about the target Capacity Reservation or Capacity Reservation group.

              • CapacityReservationId (string) --

                The ID of the targeted Capacity Reservation.

              • CapacityReservationResourceGroupArn (string) --

                The ARN of the targeted Capacity Reservation group.

          • LicenseSpecifications (list) --

            The license configurations.

            • (dict) --

              Describes a license configuration.

              • LicenseConfigurationArn (string) --

                The Amazon Resource Name (ARN) of the license configuration.

          • HibernationOptions (dict) --

            Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide .

            • Configured (boolean) --

              If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

          • MetadataOptions (dict) --

            The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide .

            • State (string) --

              The state of the metadata option changes.

              pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

              applied - The metadata options have been successfully applied on the instance.

            • HttpTokens (string) --

              The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

              If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

              If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

            • HttpPutResponseHopLimit (integer) --

              The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

              Default: 1

              Possible values: Integers from 1 to 64

            • HttpEndpoint (string) --

              This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .

              Note

              If you specify a value of disabled , you will not be able to access your instance metadata.

            • HttpProtocolIpv6 (string) --

              Enables or disables the IPv6 endpoint for the instance metadata service.

              Default: disabled

          • EnclaveOptions (dict) --

            Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

            • Enabled (boolean) --

              If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

          • InstanceRequirements (dict) --

            The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

            If you specify InstanceRequirements , you can't specify InstanceTypes .

            • VCpuCount (dict) --

              The minimum and maximum number of vCPUs.

              • Min (integer) --

                The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

              • Max (integer) --

                The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

            • MemoryMiB (dict) --

              The minimum and maximum amount of memory, in MiB.

              • Min (integer) --

                The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

              • Max (integer) --

                The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

            • CpuManufacturers (list) --

              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 .

              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

              • (string) --

            • MemoryGiBPerVCpu (dict) --

              The minimum and maximum amount of memory per vCPU, in GiB.

              Default: No minimum or maximum limits

              • Min (float) --

                The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

              • Max (float) --

                The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

            • ExcludedInstanceTypes (list) --

              The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

              Default: No excluded instance types

              • (string) --

            • InstanceGenerations (list) --

              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

              • (string) --

            • SpotMaxPricePercentageOverLowestPrice (integer) --

              The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

              Default: 100

            • OnDemandMaxPricePercentageOverLowestPrice (integer) --

              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 cheapest 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 .

              Default: 20

            • BareMetal (string) --

              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

            • BurstablePerformance (string) --

              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

            • RequireHibernateSupport (boolean) --

              Indicates whether instance types must support hibernation for On-Demand Instances.

              This parameter is not supported for GetSpotPlacementScores .

              Default: false

            • NetworkInterfaceCount (dict) --

              The minimum and maximum number of network interfaces.

              Default: No minimum or maximum limits

              • Min (integer) --

                The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

              • Max (integer) --

                The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

            • LocalStorage (string) --

              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

            • LocalStorageTypes (list) --

              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 (SDD) storage, specify sdd .

              Default: hdd and sdd

              • (string) --

            • TotalLocalStorageGB (dict) --

              The minimum and maximum amount of total local storage, in GB.

              Default: No minimum or maximum limits

              • Min (float) --

                The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

              • Max (float) --

                The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

            • BaselineEbsBandwidthMbps (dict) --

              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

              • Min (integer) --

                The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

              • Max (integer) --

                The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

            • AcceleratorTypes (list) --

              The accelerator types that must be on the instance type.

              • For instance types with GPU accelerators, specify gpu .

              • For instance types with FPGA accelerators, specify fpga .

              • For instance types with inference accelerators, specify inference .

              Default: Any accelerator type

              • (string) --

            • AcceleratorCount (dict) --

              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

              • Min (integer) --

                The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

              • Max (integer) --

                The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

            • AcceleratorManufacturers (list) --

              Indicates whether instance types must have accelerators by specific manufacturers.

              • For instance types with NVIDIA devices, specify nvidia .

              • For instance types with AMD devices, specify amd .

              • For instance types with Amazon Web Services devices, specify amazon-web-services .

              • For instance types with Xilinx devices, specify xilinx .

              Default: Any manufacturer

              • (string) --

            • AcceleratorNames (list) --

              The accelerators that must be on the instance type.

              • For instance types with NVIDIA A100 GPUs, specify a100 .

              • For instance types with NVIDIA V100 GPUs, specify v100 .

              • For instance types with NVIDIA K80 GPUs, specify k80 .

              • For instance types with NVIDIA T4 GPUs, specify t4 .

              • 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 Xilinx VU9P FPGAs, specify vu9p .

              Default: Any accelerator

              • (string) --

            • AcceleratorTotalMemoryMiB (dict) --

              The minimum and maximum amount of total accelerator memory, in MiB.

              Default: No minimum or maximum limits

              • Min (integer) --

                The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

              • Max (integer) --

                The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeNetworkInterfaces (updated) Link ¶
Changes (response)
{'NetworkInterfaces': {'DenyAllIgwTraffic': 'boolean'}}

Describes one or more of your network interfaces.

See also: AWS API Documentation

Request Syntax

client.describe_network_interfaces(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    NetworkInterfaceIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
type Filters

list

param Filters

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached ).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The Amazon Web Services account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.

  • requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available ; if a network interface is attached to an instance the status is in-use .

  • subnet-id - The ID of the subnet for the network interface.

  • tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the network interface.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type DryRun

boolean

param DryRun

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 .

type NetworkInterfaceIds

list

param NetworkInterfaceIds

One or more network interface IDs.

Default: Describes all your network interfaces.

  • (string) --

type NextToken

string

param NextToken

The token to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.

rtype

dict

returns

Response Syntax

{
    'NetworkInterfaces': [
        {
            'Association': {
                'AllocationId': 'string',
                'AssociationId': 'string',
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string',
                'CustomerOwnedIp': 'string',
                'CarrierIp': 'string'
            },
            'Attachment': {
                'AttachTime': datetime(2015, 1, 1),
                'AttachmentId': 'string',
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'NetworkCardIndex': 123,
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'Status': 'attaching'|'attached'|'detaching'|'detached'
            },
            'AvailabilityZone': 'string',
            'Description': 'string',
            'Groups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'InterfaceType': 'interface'|'natGateway'|'efa'|'trunk',
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string'
                },
            ],
            'MacAddress': 'string',
            'NetworkInterfaceId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Association': {
                        'AllocationId': 'string',
                        'AssociationId': 'string',
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'CustomerOwnedIp': 'string',
                        'CarrierIp': 'string'
                    },
                    'Primary': True|False,
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string'
                },
            ],
            'Ipv4Prefixes': [
                {
                    'Ipv4Prefix': 'string'
                },
            ],
            'Ipv6Prefixes': [
                {
                    'Ipv6Prefix': 'string'
                },
            ],
            'RequesterId': 'string',
            'RequesterManaged': True|False,
            'SourceDestCheck': True|False,
            'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
            'SubnetId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string',
            'DenyAllIgwTraffic': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of DescribeNetworkInterfaces.

    • NetworkInterfaces (list) --

      Information about one or more network interfaces.

      • (dict) --

        Describes a network interface.

        • Association (dict) --

          The association information for an Elastic IP address (IPv4) associated with the network interface.

          • AllocationId (string) --

            The allocation ID.

          • AssociationId (string) --

            The association ID.

          • IpOwnerId (string) --

            The ID of the Elastic IP address owner.

          • PublicDnsName (string) --

            The public DNS name.

          • PublicIp (string) --

            The address of the Elastic IP address bound to the network interface.

          • CustomerOwnedIp (string) --

            The customer-owned IP address associated with the network interface.

          • CarrierIp (string) --

            The carrier IP address associated with the network interface.

            This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

        • Attachment (dict) --

          The network interface attachment.

          • AttachTime (datetime) --

            The timestamp indicating when the attachment initiated.

          • AttachmentId (string) --

            The ID of the network interface attachment.

          • DeleteOnTermination (boolean) --

            Indicates whether the network interface is deleted when the instance is terminated.

          • DeviceIndex (integer) --

            The device index of the network interface attachment on the instance.

          • NetworkCardIndex (integer) --

            The index of the network card.

          • InstanceId (string) --

            The ID of the instance.

          • InstanceOwnerId (string) --

            The Amazon Web Services account ID of the owner of the instance.

          • Status (string) --

            The attachment state.

        • AvailabilityZone (string) --

          The Availability Zone.

        • Description (string) --

          A description.

        • Groups (list) --

          Any security groups for the network interface.

          • (dict) --

            Describes a security group.

            • GroupName (string) --

              The name of the security group.

            • GroupId (string) --

              The ID of the security group.

        • InterfaceType (string) --

          The type of network interface.

        • Ipv6Addresses (list) --

          The IPv6 addresses associated with the network interface.

          • (dict) --

            Describes an IPv6 address associated with a network interface.

            • Ipv6Address (string) --

              The IPv6 address.

        • MacAddress (string) --

          The MAC address.

        • NetworkInterfaceId (string) --

          The ID of the network interface.

        • OutpostArn (string) --

          The Amazon Resource Name (ARN) of the Outpost.

        • OwnerId (string) --

          The Amazon Web Services account ID of the owner of the network interface.

        • PrivateDnsName (string) --

          The private DNS name.

        • PrivateIpAddress (string) --

          The IPv4 address of the network interface within the subnet.

        • PrivateIpAddresses (list) --

          The private IPv4 addresses associated with the network interface.

          • (dict) --

            Describes the private IPv4 address of a network interface.

            • Association (dict) --

              The association information for an Elastic IP address (IPv4) associated with the network interface.

              • AllocationId (string) --

                The allocation ID.

              • AssociationId (string) --

                The association ID.

              • IpOwnerId (string) --

                The ID of the Elastic IP address owner.

              • PublicDnsName (string) --

                The public DNS name.

              • PublicIp (string) --

                The address of the Elastic IP address bound to the network interface.

              • CustomerOwnedIp (string) --

                The customer-owned IP address associated with the network interface.

              • CarrierIp (string) --

                The carrier IP address associated with the network interface.

                This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

            • Primary (boolean) --

              Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

            • PrivateDnsName (string) --

              The private DNS name.

            • PrivateIpAddress (string) --

              The private IPv4 address.

        • Ipv4Prefixes (list) --

          The IPv4 prefixes that are assigned to the network interface.

        • Ipv6Prefixes (list) --

          The IPv6 prefixes that are assigned to the network interface.

          • (dict) --

            Describes the IPv6 prefix.

            • Ipv6Prefix (string) --

              The IPv6 prefix.

        • RequesterId (string) --

          The alias or Amazon Web Services account ID of the principal or service that created the network interface.

        • RequesterManaged (boolean) --

          Indicates whether the network interface is being managed by Amazon Web Services.

        • SourceDestCheck (boolean) --

          Indicates whether source/destination checking is enabled.

        • Status (string) --

          The status of the network interface.

        • SubnetId (string) --

          The ID of the subnet.

        • TagSet (list) --

          Any tags assigned to the network interface.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

        • VpcId (string) --

          The ID of the VPC.

        • DenyAllIgwTraffic (boolean) --

          Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true , inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeReservedInstances (updated) Link ¶
Changes (response)
{'ReservedInstances': {'InstanceType': {'dl1.24xlarge'}}}

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_reserved_instances(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    OfferingClass='standard'|'convertible',
    ReservedInstancesIds=[
        'string',
    ],
    DryRun=True|False,
    OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront'
)
type Filters

list

param Filters

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000 ).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone ).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC) ).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired ).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type OfferingClass

string

param OfferingClass

Describes whether the Reserved Instance is Standard or Convertible.

type ReservedInstancesIds

list

param ReservedInstancesIds

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

  • (string) --

type DryRun

boolean

param DryRun

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 .

type OfferingType

string

param OfferingType

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

rtype

dict

returns

Response Syntax

{
    'ReservedInstances': [
        {
            'AvailabilityZone': 'string',
            'Duration': 123,
            'End': datetime(2015, 1, 1),
            'FixedPrice': ...,
            'InstanceCount': 123,
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'ReservedInstancesId': 'string',
            'Start': datetime(2015, 1, 1),
            'State': 'payment-pending'|'active'|'payment-failed'|'retired'|'queued'|'queued-deleted',
            'UsagePrice': ...,
            'CurrencyCode': 'USD',
            'InstanceTenancy': 'default'|'dedicated'|'host',
            'OfferingClass': 'standard'|'convertible',
            'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
            'RecurringCharges': [
                {
                    'Amount': 123.0,
                    'Frequency': 'Hourly'
                },
            ],
            'Scope': 'Availability Zone'|'Region',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Contains the output for DescribeReservedInstances.

    • ReservedInstances (list) --

      A list of Reserved Instances.

      • (dict) --

        Describes a Reserved Instance.

        • AvailabilityZone (string) --

          The Availability Zone in which the Reserved Instance can be used.

        • Duration (integer) --

          The duration of the Reserved Instance, in seconds.

        • End (datetime) --

          The time when the Reserved Instance expires.

        • FixedPrice (float) --

          The purchase price of the Reserved Instance.

        • InstanceCount (integer) --

          The number of reservations purchased.

        • InstanceType (string) --

          The instance type on which the Reserved Instance can be used.

        • ProductDescription (string) --

          The Reserved Instance product platform description.

        • ReservedInstancesId (string) --

          The ID of the Reserved Instance.

        • Start (datetime) --

          The date and time the Reserved Instance started.

        • State (string) --

          The state of the Reserved Instance purchase.

        • UsagePrice (float) --

          The usage price of the Reserved Instance, per hour.

        • CurrencyCode (string) --

          The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD .

        • InstanceTenancy (string) --

          The tenancy of the instance.

        • OfferingClass (string) --

          The offering class of the Reserved Instance.

        • OfferingType (string) --

          The Reserved Instance offering type.

        • RecurringCharges (list) --

          The recurring charge tag assigned to the resource.

          • (dict) --

            Describes a recurring charge.

            • Amount (float) --

              The amount of the recurring charge.

            • Frequency (string) --

              The frequency of the recurring charge.

        • Scope (string) --

          The scope of the Reserved Instance.

        • Tags (list) --

          Any tags assigned to the resource.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

DescribeReservedInstancesModifications (updated) Link ¶
Changes (response)
{'ReservedInstancesModifications': {'ModificationResults': {'TargetConfiguration': {'InstanceType': {'dl1.24xlarge'}}}}}

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_reserved_instances_modifications(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ReservedInstancesModificationIds=[
        'string',
    ],
    NextToken='string'
)
type Filters

list

param Filters

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled .

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC ).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed ).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type ReservedInstancesModificationIds

list

param ReservedInstancesModificationIds

IDs for the submitted modification request.

  • (string) --

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'ReservedInstancesModifications': [
        {
            'ClientToken': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'EffectiveDate': datetime(2015, 1, 1),
            'ModificationResults': [
                {
                    'ReservedInstancesId': 'string',
                    'TargetConfiguration': {
                        'AvailabilityZone': 'string',
                        'InstanceCount': 123,
                        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                        'Platform': 'string',
                        'Scope': 'Availability Zone'|'Region'
                    }
                },
            ],
            'ReservedInstancesIds': [
                {
                    'ReservedInstancesId': 'string'
                },
            ],
            'ReservedInstancesModificationId': 'string',
            'Status': 'string',
            'StatusMessage': 'string',
            'UpdateDate': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    Contains the output of DescribeReservedInstancesModifications.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • ReservedInstancesModifications (list) --

      The Reserved Instance modification information.

      • (dict) --

        Describes a Reserved Instance modification.

        • ClientToken (string) --

          A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency .

        • CreateDate (datetime) --

          The time when the modification request was created.

        • EffectiveDate (datetime) --

          The time for the modification to become effective.

        • ModificationResults (list) --

          Contains target configurations along with their corresponding new Reserved Instance IDs.

          • (dict) --

            Describes the modification request/s.

            • ReservedInstancesId (string) --

              The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

            • TargetConfiguration (dict) --

              The target Reserved Instances configurations supplied as part of the modification request.

              • AvailabilityZone (string) --

                The Availability Zone for the modified Reserved Instances.

              • InstanceCount (integer) --

                The number of modified Reserved Instances.

                Note

                This is a required field for a request.

              • InstanceType (string) --

                The instance type for the modified Reserved Instances.

              • Platform (string) --

                The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

              • Scope (string) --

                Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

        • ReservedInstancesIds (list) --

          The IDs of one or more Reserved Instances.

          • (dict) --

            Describes the ID of a Reserved Instance.

            • ReservedInstancesId (string) --

              The ID of the Reserved Instance.

        • ReservedInstancesModificationId (string) --

          A unique ID for the Reserved Instance modification.

        • Status (string) --

          The status of the Reserved Instances modification request.

        • StatusMessage (string) --

          The reason for the status.

        • UpdateDate (datetime) --

          The time when the modification request was last updated.

DescribeReservedInstancesOfferings (updated) Link ¶
Changes (request, response)
Request
{'InstanceType': {'dl1.24xlarge'}}
Response
{'ReservedInstancesOfferings': {'InstanceType': {'dl1.24xlarge'}}}

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_reserved_instances_offerings(
    AvailabilityZone='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    IncludeMarketplace=True|False,
    InstanceType='t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
    MaxDuration=123,
    MaxInstanceCount=123,
    MinDuration=123,
    OfferingClass='standard'|'convertible',
    ProductDescription='Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
    ReservedInstancesOfferingIds=[
        'string',
    ],
    DryRun=True|False,
    InstanceTenancy='default'|'dedicated'|'host',
    MaxResults=123,
    NextToken='string',
    OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront'
)
type AvailabilityZone

string

param AvailabilityZone

The Availability Zone in which the Reserved Instance can be used.

type Filters

list

param Filters

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000 ).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC) )

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region ).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type IncludeMarketplace

boolean

param IncludeMarketplace

Include Reserved Instance Marketplace offerings in the response.

type InstanceType

string

param InstanceType

The instance type that the reservation will cover (for example, m1.small ). For more information, see Instance types in the Amazon EC2 User Guide .

type MaxDuration

integer

param MaxDuration

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

type MaxInstanceCount

integer

param MaxInstanceCount

The maximum number of instances to filter when searching for offerings.

Default: 20

type MinDuration

integer

param MinDuration

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

type OfferingClass

string

param OfferingClass

The offering class of the Reserved Instance. Can be standard or convertible .

type ProductDescription

string

param ProductDescription

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

type ReservedInstancesOfferingIds

list

param ReservedInstancesOfferingIds

One or more Reserved Instances offering IDs.

  • (string) --

type DryRun

boolean

param DryRun

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 .

type InstanceTenancy

string

param InstanceTenancy

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

type NextToken

string

param NextToken

The token to retrieve the next page of results.

type OfferingType

string

param OfferingType

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

rtype

dict

returns

Response Syntax

{
    'ReservedInstancesOfferings': [
        {
            'AvailabilityZone': 'string',
            'Duration': 123,
            'FixedPrice': ...,
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'ReservedInstancesOfferingId': 'string',
            'UsagePrice': ...,
            'CurrencyCode': 'USD',
            'InstanceTenancy': 'default'|'dedicated'|'host',
            'Marketplace': True|False,
            'OfferingClass': 'standard'|'convertible',
            'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront',
            'PricingDetails': [
                {
                    'Count': 123,
                    'Price': 123.0
                },
            ],
            'RecurringCharges': [
                {
                    'Amount': 123.0,
                    'Frequency': 'Hourly'
                },
            ],
            'Scope': 'Availability Zone'|'Region'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of DescribeReservedInstancesOfferings.

    • ReservedInstancesOfferings (list) --

      A list of Reserved Instances offerings.

      • (dict) --

        Describes a Reserved Instance offering.

        • AvailabilityZone (string) --

          The Availability Zone in which the Reserved Instance can be used.

        • Duration (integer) --

          The duration of the Reserved Instance, in seconds.

        • FixedPrice (float) --

          The purchase price of the Reserved Instance.

        • InstanceType (string) --

          The instance type on which the Reserved Instance can be used.

        • ProductDescription (string) --

          The Reserved Instance product platform description.

        • ReservedInstancesOfferingId (string) --

          The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.

        • UsagePrice (float) --

          The usage price of the Reserved Instance, per hour.

        • CurrencyCode (string) --

          The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD .

        • InstanceTenancy (string) --

          The tenancy of the instance.

        • Marketplace (boolean) --

          Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is true .

        • OfferingClass (string) --

          If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard , it is not possible to perform an exchange.

        • OfferingType (string) --

          The Reserved Instance offering type.

        • PricingDetails (list) --

          The pricing details of the Reserved Instance offering.

          • (dict) --

            Describes a Reserved Instance offering.

            • Count (integer) --

              The number of reservations available for the price.

            • Price (float) --

              The price per instance.

        • RecurringCharges (list) --

          The recurring charge tag assigned to the resource.

          • (dict) --

            Describes a recurring charge.

            • Amount (float) --

              The amount of the recurring charge.

            • Frequency (string) --

              The frequency of the recurring charge.

        • Scope (string) --

          Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeSpotFleetRequests (updated) Link ¶
Changes (response)
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'InstanceType': {'dl1.24xlarge'}},
                                                        'LaunchTemplateConfigs': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}}}}

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

See also: AWS API Documentation

Request Syntax

client.describe_spot_fleet_requests(
    DryRun=True|False,
    MaxResults=123,
    NextToken='string',
    SpotFleetRequestIds=[
        'string',
    ]
)
type DryRun

boolean

param DryRun

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 .

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken

string

param NextToken

The token for the next set of results.

type SpotFleetRequestIds

list

param SpotFleetRequestIds

The IDs of the Spot Fleet requests.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SpotFleetRequestConfigs': [
        {
            'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
            'CreateTime': datetime(2015, 1, 1),
            'SpotFleetRequestConfig': {
                'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized',
                'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized',
                'SpotMaintenanceStrategies': {
                    'CapacityRebalance': {
                        'ReplacementStrategy': 'launch'
                    }
                },
                'ClientToken': 'string',
                'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
                'FulfilledCapacity': 123.0,
                'OnDemandFulfilledCapacity': 123.0,
                'IamFleetRole': 'string',
                'LaunchSpecifications': [
                    {
                        'SecurityGroups': [
                            {
                                'GroupName': 'string',
                                'GroupId': 'string'
                            },
                        ],
                        'AddressingType': 'string',
                        'BlockDeviceMappings': [
                            {
                                'DeviceName': 'string',
                                'VirtualName': 'string',
                                'Ebs': {
                                    'DeleteOnTermination': True|False,
                                    'Iops': 123,
                                    'SnapshotId': 'string',
                                    'VolumeSize': 123,
                                    'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                                    'KmsKeyId': 'string',
                                    'Throughput': 123,
                                    'OutpostArn': 'string',
                                    'Encrypted': True|False
                                },
                                'NoDevice': 'string'
                            },
                        ],
                        'EbsOptimized': True|False,
                        'IamInstanceProfile': {
                            'Arn': 'string',
                            'Name': 'string'
                        },
                        'ImageId': 'string',
                        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                        'KernelId': 'string',
                        'KeyName': 'string',
                        'Monitoring': {
                            'Enabled': True|False
                        },
                        'NetworkInterfaces': [
                            {
                                'AssociatePublicIpAddress': True|False,
                                'DeleteOnTermination': True|False,
                                'Description': 'string',
                                'DeviceIndex': 123,
                                'Groups': [
                                    'string',
                                ],
                                'Ipv6AddressCount': 123,
                                'Ipv6Addresses': [
                                    {
                                        'Ipv6Address': 'string'
                                    },
                                ],
                                'NetworkInterfaceId': 'string',
                                'PrivateIpAddress': 'string',
                                'PrivateIpAddresses': [
                                    {
                                        'Primary': True|False,
                                        'PrivateIpAddress': 'string'
                                    },
                                ],
                                'SecondaryPrivateIpAddressCount': 123,
                                'SubnetId': 'string',
                                'AssociateCarrierIpAddress': True|False,
                                'InterfaceType': 'string',
                                'NetworkCardIndex': 123,
                                'Ipv4Prefixes': [
                                    {
                                        'Ipv4Prefix': 'string'
                                    },
                                ],
                                'Ipv4PrefixCount': 123,
                                'Ipv6Prefixes': [
                                    {
                                        'Ipv6Prefix': 'string'
                                    },
                                ],
                                'Ipv6PrefixCount': 123
                            },
                        ],
                        'Placement': {
                            'AvailabilityZone': 'string',
                            'GroupName': 'string',
                            'Tenancy': 'default'|'dedicated'|'host'
                        },
                        'RamdiskId': 'string',
                        'SpotPrice': 'string',
                        'SubnetId': 'string',
                        'UserData': 'string',
                        'WeightedCapacity': 123.0,
                        'TagSpecifications': [
                            {
                                'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                                'Tags': [
                                    {
                                        'Key': 'string',
                                        'Value': 'string'
                                    },
                                ]
                            },
                        ],
                        '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',
                            ],
                            'AcceleratorTotalMemoryMiB': {
                                'Min': 123,
                                'Max': 123
                            }
                        }
                    },
                ],
                'LaunchTemplateConfigs': [
                    {
                        'LaunchTemplateSpecification': {
                            'LaunchTemplateId': 'string',
                            'LaunchTemplateName': 'string',
                            'Version': 'string'
                        },
                        'Overrides': [
                            {
                                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                                'SpotPrice': 'string',
                                'SubnetId': 'string',
                                'AvailabilityZone': 'string',
                                'WeightedCapacity': 123.0,
                                'Priority': 123.0,
                                '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',
                                    ],
                                    'AcceleratorTotalMemoryMiB': {
                                        'Min': 123,
                                        'Max': 123
                                    }
                                }
                            },
                        ]
                    },
                ],
                'SpotPrice': 'string',
                'TargetCapacity': 123,
                'OnDemandTargetCapacity': 123,
                'OnDemandMaxTotalPrice': 'string',
                'SpotMaxTotalPrice': 'string',
                'TerminateInstancesWithExpiration': True|False,
                'Type': 'request'|'maintain'|'instant',
                'ValidFrom': datetime(2015, 1, 1),
                'ValidUntil': datetime(2015, 1, 1),
                'ReplaceUnhealthyInstances': True|False,
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
                'LoadBalancersConfig': {
                    'ClassicLoadBalancersConfig': {
                        'ClassicLoadBalancers': [
                            {
                                'Name': 'string'
                            },
                        ]
                    },
                    'TargetGroupsConfig': {
                        'TargetGroups': [
                            {
                                'Arn': 'string'
                            },
                        ]
                    }
                },
                'InstancePoolsToUseCount': 123,
                'Context': 'string',
                'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units',
                'TagSpecifications': [
                    {
                        'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ]
            },
            'SpotFleetRequestId': 'string',
            'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Contains the output of DescribeSpotFleetRequests.

    • NextToken (string) --

      The token required to retrieve the next set of results. This value is null when there are no more results to return.

    • SpotFleetRequestConfigs (list) --

      Information about the configuration of your Spot Fleet.

      • (dict) --

        Describes a Spot Fleet request.

        • ActivityStatus (string) --

          The progress of the Spot Fleet request. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.

        • CreateTime (datetime) --

          The creation date and time of the request.

        • SpotFleetRequestConfig (dict) --

          The configuration of the Spot Fleet request.

          • AllocationStrategy (string) --

            Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

            If the allocation strategy is lowestPrice , Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

            If the allocation strategy is diversified , Spot Fleet launches instances from all the Spot Instance pools that you specify.

            If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.

          • OnDemandAllocationStrategy (string) --

            The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .

          • SpotMaintenanceStrategies (dict) --

            The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

            • CapacityRebalance (dict) --

              The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

              • ReplacementStrategy (string) --

                The replacement strategy to use. Only available for fleets of type maintain . You must specify a value, otherwise you get an error.

                To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for a Spot Instance in the fleet, specify launch .

                Note

                When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.

          • ClientToken (string) --

            A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency .

          • ExcessCapacityTerminationPolicy (string) --

            Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

          • FulfilledCapacity (float) --

            The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

          • OnDemandFulfilledCapacity (float) --

            The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

          • IamFleetRole (string) --

            The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .

          • LaunchSpecifications (list) --

            The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .

            • (dict) --

              Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification ; you must use LaunchTemplateConfig .

              • SecurityGroups (list) --

                One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

                • (dict) --

                  Describes a security group.

                  • GroupName (string) --

                    The name of the security group.

                  • GroupId (string) --

                    The ID of the security group.

              • AddressingType (string) --

                Deprecated.

              • BlockDeviceMappings (list) --

                One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.

                • (dict) --

                  Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

                  • DeviceName (string) --

                    The device name (for example, /dev/sdh or xvdh ).

                  • VirtualName (string) --

                    The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

                    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

                    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

                  • Ebs (dict) --

                    Parameters used to automatically set up EBS volumes when the instance is launched.

                    • DeleteOnTermination (boolean) --

                      Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .

                    • Iops (integer) --

                      The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

                      The following are the supported values for each volume type:

                      • gp3 : 3,000-16,000 IOPS

                      • io1 : 100-64,000 IOPS

                      • io2 : 100-64,000 IOPS

                      For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

                      This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

                    • SnapshotId (string) --

                      The ID of the snapshot.

                    • VolumeSize (integer) --

                      The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

                      The following are the supported volumes sizes for each volume type:

                      • gp2 and gp3 :1-16,384

                      • io1 and io2 : 4-16,384

                      • st1 and sc1 : 125-16,384

                      • standard : 1-1,024

                    • VolumeType (string) --

                      The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.

                    • KmsKeyId (string) --

                      Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

                      This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .

                    • Throughput (integer) --

                      The throughput that the volume supports, in MiB/s.

                      This parameter is valid only for gp3 volumes.

                      Valid Range: Minimum value of 125. Maximum value of 1000.

                    • OutpostArn (string) --

                      The ARN of the Outpost on which the snapshot is stored.

                    • Encrypted (boolean) --

                      Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .

                      In no case can you remove encryption from an encrypted volume.

                      Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .

                      This parameter is not returned by .

                  • NoDevice (string) --

                    To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

              • EbsOptimized (boolean) --

                Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

                Default: false

              • IamInstanceProfile (dict) --

                The IAM instance profile.

                • Arn (string) --

                  The Amazon Resource Name (ARN) of the instance profile.

                • Name (string) --

                  The name of the instance profile.

              • ImageId (string) --

                The ID of the AMI.

              • InstanceType (string) --

                The instance type.

              • KernelId (string) --

                The ID of the kernel.

              • KeyName (string) --

                The name of the key pair.

              • Monitoring (dict) --

                Enable or disable monitoring for the instances.

                • Enabled (boolean) --

                  Enables monitoring for the instance.

                  Default: false

              • NetworkInterfaces (list) --

                One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

                Note

                SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig .

                • (dict) --

                  Describes a network interface.

                  • AssociatePublicIpAddress (boolean) --

                    Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .

                  • DeleteOnTermination (boolean) --

                    If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

                  • Description (string) --

                    The description of the network interface. Applies only if creating a network interface when launching an instance.

                  • DeviceIndex (integer) --

                    The position of the network interface in the attachment order. A primary network interface has a device index of 0.

                    If you specify a network interface when launching an instance, you must specify the device index.

                  • Groups (list) --

                    The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

                    • (string) --

                  • Ipv6AddressCount (integer) --

                    A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

                  • Ipv6Addresses (list) --

                    One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

                    • (dict) --

                      Describes an IPv6 address.

                      • Ipv6Address (string) --

                        The IPv6 address.

                  • NetworkInterfaceId (string) --

                    The ID of the network interface.

                    If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

                  • PrivateIpAddress (string) --

                    The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

                  • PrivateIpAddresses (list) --

                    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

                    • (dict) --

                      Describes a secondary private IPv4 address for a network interface.

                      • Primary (boolean) --

                        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

                      • PrivateIpAddress (string) --

                        The private IPv4 addresses.

                  • SecondaryPrivateIpAddressCount (integer) --

                    The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

                  • SubnetId (string) --

                    The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

                  • AssociateCarrierIpAddress (boolean) --

                    Indicates whether to assign a carrier IP address to the network interface.

                    You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.

                  • InterfaceType (string) --

                    The type of network interface.

                    To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

                    Valid values: interface | efa

                  • NetworkCardIndex (integer) --

                    The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

                    If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances .

                  • Ipv4Prefixes (list) --

                    One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

                  • Ipv4PrefixCount (integer) --

                    The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

                  • Ipv6Prefixes (list) --

                    One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

                    • (dict) --

                      Describes the IPv4 prefix option for a network interface.

                      • Ipv6Prefix (string) --

                        The IPv6 prefix.

                  • Ipv6PrefixCount (integer) --

                    The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

              • Placement (dict) --

                The placement information.

                • AvailabilityZone (string) --

                  The Availability Zone.

                  [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".

                • GroupName (string) --

                  The name of the placement group.

                • Tenancy (string) --

                  The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.

              • RamdiskId (string) --

                The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.

              • SpotPrice (string) --

                The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .

              • SubnetId (string) --

                The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".

              • UserData (string) --

                The Base64-encoded user data that instances use when starting up.

              • WeightedCapacity (float) --

                The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

                If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

              • TagSpecifications (list) --

                The tags to apply during creation.

                • (dict) --

                  The tags for a Spot Fleet resource.

                  • ResourceType (string) --

                    The type of resource. Currently, the only resource type that is supported is instance . To tag the Spot Fleet request on creation, use the TagSpecifications parameter in ` SpotFleetRequestConfigData https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html`__ .

                  • Tags (list) --

                    The tags.

                    • (dict) --

                      Describes a tag.

                      • Key (string) --

                        The key of the tag.

                        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

                      • Value (string) --

                        The value of the tag.

                        Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

              • InstanceRequirements (dict) --

                The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

                Note

                If you specify InstanceRequirements , you can't specify InstanceTypes .

                • VCpuCount (dict) --

                  The minimum and maximum number of vCPUs.

                  • Min (integer) --

                    The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                  • Max (integer) --

                    The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

                • MemoryMiB (dict) --

                  The minimum and maximum amount of memory, in MiB.

                  • Min (integer) --

                    The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                  • Max (integer) --

                    The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

                • CpuManufacturers (list) --

                  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 .

                  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

                  • (string) --

                • MemoryGiBPerVCpu (dict) --

                  The minimum and maximum amount of memory per vCPU, in GiB.

                  Default: No minimum or maximum limits

                  • Min (float) --

                    The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                  • Max (float) --

                    The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

                • ExcludedInstanceTypes (list) --

                  The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                  Default: No excluded instance types

                  • (string) --

                • InstanceGenerations (list) --

                  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

                  • (string) --

                • SpotMaxPricePercentageOverLowestPrice (integer) --

                  The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                  Default: 100

                • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                  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 cheapest 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 .

                  Default: 20

                • BareMetal (string) --

                  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

                • BurstablePerformance (string) --

                  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

                • RequireHibernateSupport (boolean) --

                  Indicates whether instance types must support hibernation for On-Demand Instances.

                  This parameter is not supported for GetSpotPlacementScores .

                  Default: false

                • NetworkInterfaceCount (dict) --

                  The minimum and maximum number of network interfaces.

                  Default: No minimum or maximum limits

                  • Min (integer) --

                    The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                  • Max (integer) --

                    The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

                • LocalStorage (string) --

                  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

                • LocalStorageTypes (list) --

                  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 (SDD) storage, specify sdd .

                  Default: hdd and sdd

                  • (string) --

                • TotalLocalStorageGB (dict) --

                  The minimum and maximum amount of total local storage, in GB.

                  Default: No minimum or maximum limits

                  • Min (float) --

                    The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                  • Max (float) --

                    The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

                • BaselineEbsBandwidthMbps (dict) --

                  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

                  • Min (integer) --

                    The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                  • Max (integer) --

                    The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

                • AcceleratorTypes (list) --

                  The accelerator types that must be on the instance type.

                  • For instance types with GPU accelerators, specify gpu .

                  • For instance types with FPGA accelerators, specify fpga .

                  • For instance types with inference accelerators, specify inference .

                  Default: Any accelerator type

                  • (string) --

                • AcceleratorCount (dict) --

                  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

                  • Min (integer) --

                    The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                  • Max (integer) --

                    The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

                • AcceleratorManufacturers (list) --

                  Indicates whether instance types must have accelerators by specific manufacturers.

                  • For instance types with NVIDIA devices, specify nvidia .

                  • For instance types with AMD devices, specify amd .

                  • For instance types with Amazon Web Services devices, specify amazon-web-services .

                  • For instance types with Xilinx devices, specify xilinx .

                  Default: Any manufacturer

                  • (string) --

                • AcceleratorNames (list) --

                  The accelerators that must be on the instance type.

                  • For instance types with NVIDIA A100 GPUs, specify a100 .

                  • For instance types with NVIDIA V100 GPUs, specify v100 .

                  • For instance types with NVIDIA K80 GPUs, specify k80 .

                  • For instance types with NVIDIA T4 GPUs, specify t4 .

                  • 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 Xilinx VU9P FPGAs, specify vu9p .

                  Default: Any accelerator

                  • (string) --

                • AcceleratorTotalMemoryMiB (dict) --

                  The minimum and maximum amount of total accelerator memory, in MiB.

                  Default: No minimum or maximum limits

                  • Min (integer) --

                    The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                  • Max (integer) --

                    The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

          • LaunchTemplateConfigs (list) --

            The launch template and overrides. If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications . If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs .

            • (dict) --

              Describes a launch template and overrides.

              • LaunchTemplateSpecification (dict) --

                The launch template.

                • LaunchTemplateId (string) --

                  The ID of the launch template. If you specify the template ID, you can't specify the template name.

                • LaunchTemplateName (string) --

                  The name of the launch template. If you specify the template name, you can't specify the template ID.

                • Version (string) --

                  The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

                  If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

                  If the value is $Default , Amazon EC2 uses the default version of the launch template.

              • Overrides (list) --

                Any parameters that you specify override the same parameters in the launch template.

                • (dict) --

                  Describes overrides for a launch template.

                  • InstanceType (string) --

                    The instance type.

                  • SpotPrice (string) --

                    The maximum price per unit hour that you are willing to pay for a Spot Instance.

                  • SubnetId (string) --

                    The ID of the subnet in which to launch the instances.

                  • AvailabilityZone (string) --

                    The Availability Zone in which to launch the instances.

                  • WeightedCapacity (float) --

                    The number of units provided by the specified instance type.

                  • Priority (float) --

                    The priority for the launch template override. The highest priority is launched first.

                    If OnDemandAllocationStrategy is set to prioritized , Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

                    If the Spot AllocationStrategy is set to capacityOptimizedPrioritized , Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

                    Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.

                  • InstanceRequirements (dict) --

                    The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.

                    Note

                    If you specify InstanceRequirements , you can't specify InstanceTypes .

                    • VCpuCount (dict) --

                      The minimum and maximum number of vCPUs.

                      • Min (integer) --

                        The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

                      • Max (integer) --

                        The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

                    • MemoryMiB (dict) --

                      The minimum and maximum amount of memory, in MiB.

                      • Min (integer) --

                        The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

                      • Max (integer) --

                        The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

                    • CpuManufacturers (list) --

                      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 .

                      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

                      • (string) --

                    • MemoryGiBPerVCpu (dict) --

                      The minimum and maximum amount of memory per vCPU, in GiB.

                      Default: No minimum or maximum limits

                      • Min (float) --

                        The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

                      • Max (float) --

                        The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

                    • ExcludedInstanceTypes (list) --

                      The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

                      Default: No excluded instance types

                      • (string) --

                    • InstanceGenerations (list) --

                      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

                      • (string) --

                    • SpotMaxPricePercentageOverLowestPrice (integer) --

                      The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

                      Default: 100

                    • OnDemandMaxPricePercentageOverLowestPrice (integer) --

                      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 cheapest 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 .

                      Default: 20

                    • BareMetal (string) --

                      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

                    • BurstablePerformance (string) --

                      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

                    • RequireHibernateSupport (boolean) --

                      Indicates whether instance types must support hibernation for On-Demand Instances.

                      This parameter is not supported for GetSpotPlacementScores .

                      Default: false

                    • NetworkInterfaceCount (dict) --

                      The minimum and maximum number of network interfaces.

                      Default: No minimum or maximum limits

                      • Min (integer) --

                        The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

                      • Max (integer) --

                        The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

                    • LocalStorage (string) --

                      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

                    • LocalStorageTypes (list) --

                      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 (SDD) storage, specify sdd .

                      Default: hdd and sdd

                      • (string) --

                    • TotalLocalStorageGB (dict) --

                      The minimum and maximum amount of total local storage, in GB.

                      Default: No minimum or maximum limits

                      • Min (float) --

                        The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

                      • Max (float) --

                        The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

                    • BaselineEbsBandwidthMbps (dict) --

                      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

                      • Min (integer) --

                        The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

                      • Max (integer) --

                        The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

                    • AcceleratorTypes (list) --

                      The accelerator types that must be on the instance type.

                      • For instance types with GPU accelerators, specify gpu .

                      • For instance types with FPGA accelerators, specify fpga .

                      • For instance types with inference accelerators, specify inference .

                      Default: Any accelerator type

                      • (string) --

                    • AcceleratorCount (dict) --

                      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

                      • Min (integer) --

                        The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

                      • Max (integer) --

                        The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

                    • AcceleratorManufacturers (list) --

                      Indicates whether instance types must have accelerators by specific manufacturers.

                      • For instance types with NVIDIA devices, specify nvidia .

                      • For instance types with AMD devices, specify amd .

                      • For instance types with Amazon Web Services devices, specify amazon-web-services .

                      • For instance types with Xilinx devices, specify xilinx .

                      Default: Any manufacturer

                      • (string) --

                    • AcceleratorNames (list) --

                      The accelerators that must be on the instance type.

                      • For instance types with NVIDIA A100 GPUs, specify a100 .

                      • For instance types with NVIDIA V100 GPUs, specify v100 .

                      • For instance types with NVIDIA K80 GPUs, specify k80 .

                      • For instance types with NVIDIA T4 GPUs, specify t4 .

                      • 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 Xilinx VU9P FPGAs, specify vu9p .

                      Default: Any accelerator

                      • (string) --

                    • AcceleratorTotalMemoryMiB (dict) --

                      The minimum and maximum amount of total accelerator memory, in MiB.

                      Default: No minimum or maximum limits

                      • Min (integer) --

                        The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

                      • Max (integer) --

                        The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

          • SpotPrice (string) --

            The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

          • TargetCapacity (integer) --

            The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

          • OnDemandTargetCapacity (integer) --

            The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

          • OnDemandMaxTotalPrice (string) --

            The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

          • SpotMaxTotalPrice (string) --

            The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

          • TerminateInstancesWithExpiration (boolean) --

            Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

          • Type (string) --

            The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.

          • ValidFrom (datetime) --

            The start date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). By default, Amazon EC2 starts fulfilling the request immediately.

          • ValidUntil (datetime) --

            The end date and time of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

          • ReplaceUnhealthyInstances (boolean) --

            Indicates whether Spot Fleet should replace unhealthy instances.

          • InstanceInterruptionBehavior (string) --

            The behavior when a Spot Instance is interrupted. The default is terminate .

          • LoadBalancersConfig (dict) --

            One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

            With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

            • ClassicLoadBalancersConfig (dict) --

              The Classic Load Balancers.

              • ClassicLoadBalancers (list) --

                One or more Classic Load Balancers.

                • (dict) --

                  Describes a Classic Load Balancer.

                  • Name (string) --

                    The name of the load balancer.

            • TargetGroupsConfig (dict) --

              The target groups.

              • TargetGroups (list) --

                One or more target groups.

                • (dict) --

                  Describes a load balancer target group.

                  • Arn (string) --

                    The Amazon Resource Name (ARN) of the target group.

          • InstancePoolsToUseCount (integer) --

            The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

            Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

          • Context (string) --

            Reserved.

          • TargetCapacityUnitType (string) --

            The unit for the target capacity.

            Default: units (translates to number of instances)

          • TagSpecifications (list) --

            The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the ` SpotFleetTagSpecification https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html`__ (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tagging Your Resources .

            • (dict) --

              The tags to apply to a resource when the resource is being created.

              • ResourceType (string) --

                The type of resource to tag on creation.

              • Tags (list) --

                The tags to apply to the resource.

                • (dict) --

                  Describes a tag.

                  • Key (string) --

                    The key of the tag.

                    Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

                  • Value (string) --

                    The value of the tag.

                    Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

        • SpotFleetRequestId (string) --

          The ID of the Spot Fleet request.

        • SpotFleetRequestState (string) --

          The state of the Spot Fleet request.

        • Tags (list) --

          The tags for a Spot Fleet resource.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

DescribeSpotInstanceRequests (updated) Link ¶
Changes (response)
{'SpotInstanceRequests': {'LaunchSpecification': {'InstanceType': {'dl1.24xlarge'}}}}

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled , the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot .

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

See also: AWS API Documentation

Request Syntax

client.describe_spot_instance_requests(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    SpotInstanceRequestIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
type Filters

list

param Filters

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh ).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium ).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows ).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed ). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances .

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • type - The type of Spot Instance request (one-time | persistent ).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type DryRun

boolean

param DryRun

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 .

type SpotInstanceRequestIds

list

param SpotInstanceRequestIds

One or more Spot Instance request IDs.

  • (string) --

type NextToken

string

param NextToken

The token to request the next set of results. This value is null when there are no more results to return.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

rtype

dict

returns

Response Syntax

{
    'SpotInstanceRequests': [
        {
            'ActualBlockHourlyPrice': 'string',
            'AvailabilityZoneGroup': 'string',
            'BlockDurationMinutes': 123,
            'CreateTime': datetime(2015, 1, 1),
            'Fault': {
                'Code': 'string',
                'Message': 'string'
            },
            'InstanceId': 'string',
            'LaunchGroup': 'string',
            'LaunchSpecification': {
                'UserData': 'string',
                'SecurityGroups': [
                    {
                        'GroupName': 'string',
                        'GroupId': 'string'
                    },
                ],
                'AddressingType': 'string',
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                            'KmsKeyId': 'string',
                            'Throughput': 123,
                            'OutpostArn': 'string',
                            'Encrypted': True|False
                        },
                        'NoDevice': 'string'
                    },
                ],
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                'KernelId': 'string',
                'KeyName': 'string',
                'NetworkInterfaces': [
                    {
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string',
                        'AssociateCarrierIpAddress': True|False,
                        'InterfaceType': 'string',
                        'NetworkCardIndex': 123,
                        'Ipv4Prefixes': [
                            {
                                'Ipv4Prefix': 'string'
                            },
                        ],
                        'Ipv4PrefixCount': 123,
                        'Ipv6Prefixes': [
                            {
                                'Ipv6Prefix': 'string'
                            },
                        ],
                        'Ipv6PrefixCount': 123
                    },
                ],
                'Placement': {
                    'AvailabilityZone': 'string',
                    'GroupName': 'string',
                    'Tenancy': 'default'|'dedicated'|'host'
                },
                'RamdiskId': 'string',
                'SubnetId': 'string',
                'Monitoring': {
                    'Enabled': True|False
                }
            },
            'LaunchedAvailabilityZone': 'string',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'SpotInstanceRequestId': 'string',
            'SpotPrice': 'string',
            'State': 'open'|'active'|'closed'|'cancelled'|'failed',
            'Status': {
                'Code': 'string',
                'Message': 'string',
                'UpdateTime': datetime(2015, 1, 1)
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'one-time'|'persistent',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidUntil': datetime(2015, 1, 1),
            'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of DescribeSpotInstanceRequests.

    • SpotInstanceRequests (list) --

      One or more Spot Instance requests.

      • (dict) --

        Describes a Spot Instance request.

        • ActualBlockHourlyPrice (string) --

          Deprecated.

        • AvailabilityZoneGroup (string) --

          The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

        • BlockDurationMinutes (integer) --

          Deprecated.

        • CreateTime (datetime) --

          The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).

        • Fault (dict) --

          The fault codes for the Spot Instance request, if any.

          • Code (string) --

            The reason code for the Spot Instance state change.

          • Message (string) --

            The message for the Spot Instance state change.

        • InstanceId (string) --

          The instance ID, if an instance has been launched to fulfill the Spot Instance request.

        • LaunchGroup (string) --

          The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

        • LaunchSpecification (dict) --

          Additional information for launching instances.

          • UserData (string) --

            The Base64-encoded user data for the instance.

          • SecurityGroups (list) --

            One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

            • (dict) --

              Describes a security group.

              • GroupName (string) --

                The name of the security group.

              • GroupId (string) --

                The ID of the security group.

          • AddressingType (string) --

            Deprecated.

          • BlockDeviceMappings (list) --

            One or more block device mapping entries.

            • (dict) --

              Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

              • DeviceName (string) --

                The device name (for example, /dev/sdh or xvdh ).

              • VirtualName (string) --

                The virtual device name (ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 . The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

                NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

                Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

              • Ebs (dict) --

                Parameters used to automatically set up EBS volumes when the instance is launched.

                • DeleteOnTermination (boolean) --

                  Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide .

                • Iops (integer) --

                  The number of I/O operations per second (IOPS). For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

                  The following are the supported values for each volume type:

                  • gp3 : 3,000-16,000 IOPS

                  • io1 : 100-64,000 IOPS

                  • io2 : 100-64,000 IOPS

                  For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

                  This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

                • SnapshotId (string) --

                  The ID of the snapshot.

                • VolumeSize (integer) --

                  The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

                  The following are the supported volumes sizes for each volume type:

                  • gp2 and gp3 :1-16,384

                  • io1 and io2 : 4-16,384

                  • st1 and sc1 : 125-16,384

                  • standard : 1-1,024

                • VolumeType (string) --

                  The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide . If the volume type is io1 or io2 , you must specify the IOPS that the volume supports.

                • KmsKeyId (string) --

                  Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

                  This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .

                • Throughput (integer) --

                  The throughput that the volume supports, in MiB/s.

                  This parameter is valid only for gp3 volumes.

                  Valid Range: Minimum value of 125. Maximum value of 1000.

                • OutpostArn (string) --

                  The ARN of the Outpost on which the snapshot is stored.

                • Encrypted (boolean) --

                  Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide .

                  In no case can you remove encryption from an encrypted volume.

                  Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types .

                  This parameter is not returned by .

              • NoDevice (string) --

                To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

          • EbsOptimized (boolean) --

            Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

            Default: false

          • IamInstanceProfile (dict) --

            The IAM instance profile.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the instance profile.

            • Name (string) --

              The name of the instance profile.

          • ImageId (string) --

            The ID of the AMI.

          • InstanceType (string) --

            The instance type.

          • KernelId (string) --

            The ID of the kernel.

          • KeyName (string) --

            The name of the key pair.

          • NetworkInterfaces (list) --

            One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

            • (dict) --

              Describes a network interface.

              • AssociatePublicIpAddress (boolean) --

                Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .

              • DeleteOnTermination (boolean) --

                If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

              • Description (string) --

                The description of the network interface. Applies only if creating a network interface when launching an instance.

              • DeviceIndex (integer) --

                The position of the network interface in the attachment order. A primary network interface has a device index of 0.

                If you specify a network interface when launching an instance, you must specify the device index.

              • Groups (list) --

                The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

                • (string) --

              • Ipv6AddressCount (integer) --

                A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

              • Ipv6Addresses (list) --

                One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

                • (dict) --

                  Describes an IPv6 address.

                  • Ipv6Address (string) --

                    The IPv6 address.

              • NetworkInterfaceId (string) --

                The ID of the network interface.

                If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

              • PrivateIpAddress (string) --

                The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

              • PrivateIpAddresses (list) --

                One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

                • (dict) --

                  Describes a secondary private IPv4 address for a network interface.

                  • Primary (boolean) --

                    Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

                  • PrivateIpAddress (string) --

                    The private IPv4 addresses.

              • SecondaryPrivateIpAddressCount (integer) --

                The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

              • SubnetId (string) --

                The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

              • AssociateCarrierIpAddress (boolean) --

                Indicates whether to assign a carrier IP address to the network interface.

                You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.

              • InterfaceType (string) --

                The type of network interface.

                To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide .

                Valid values: interface | efa

              • NetworkCardIndex (integer) --

                The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

                If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances .

              • Ipv4Prefixes (list) --

                One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

              • Ipv4PrefixCount (integer) --

                The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.

              • Ipv6Prefixes (list) --

                One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

                • (dict) --

                  Describes the IPv4 prefix option for a network interface.

                  • Ipv6Prefix (string) --

                    The IPv6 prefix.

              • Ipv6PrefixCount (integer) --

                The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.

          • Placement (dict) --

            The placement information for the instance.

            • AvailabilityZone (string) --

              The Availability Zone.

              [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".

            • GroupName (string) --

              The name of the placement group.

            • Tenancy (string) --

              The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.

          • RamdiskId (string) --

            The ID of the RAM disk.

          • SubnetId (string) --

            The ID of the subnet in which to launch the instance.

          • Monitoring (dict) --

            Describes the monitoring of an instance.

            • Enabled (boolean) --

              Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

        • LaunchedAvailabilityZone (string) --

          The Availability Zone in which the request is launched.

        • ProductDescription (string) --

          The product description associated with the Spot Instance.

        • SpotInstanceRequestId (string) --

          The ID of the Spot Instance request.

        • SpotPrice (string) --

          The maximum price per hour that you are willing to pay for a Spot Instance.

        • State (string) --

          The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances .

        • Status (dict) --

          The status code and status message describing the Spot Instance request.

          • Code (string) --

            The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances .

          • Message (string) --

            The description for the status code.

          • UpdateTime (datetime) --

            The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).

        • Tags (list) --

          Any tags assigned to the resource.

          • (dict) --

            Describes a tag.

            • Key (string) --

              The key of the tag.

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

            • Value (string) --

              The value of the tag.

              Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

        • Type (string) --

          The Spot Instance request type.

        • ValidFrom (datetime) --

          The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.

        • ValidUntil (datetime) --

          The end date of the request, in UTC format (YYYY -MM -DD T*HH* :MM :SS Z).

          • For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.

          • For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

        • InstanceInterruptionBehavior (string) --

          The behavior when a Spot Instance is interrupted.

    • NextToken (string) --

      The token to use to retrieve the next set of results. This value is null when there are no more results to return.

DescribeSpotPriceHistory (updated) Link ¶
Changes (request, response)
Request
{'InstanceTypes': {'dl1.24xlarge'}}
Response
{'SpotPriceHistory': {'InstanceType': {'dl1.24xlarge'}}}

Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances .

When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.

See also: AWS API Documentation

Request Syntax

client.describe_spot_price_history(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    AvailabilityZone='string',
    DryRun=True|False,
    EndTime=datetime(2015, 1, 1),
    InstanceTypes=[
        't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
    ],
    MaxResults=123,
    NextToken='string',
    ProductDescriptions=[
        'string',
    ],
    StartTime=datetime(2015, 1, 1)
)
type Filters

list

param Filters

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium ).

  • product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC) ).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

  • (dict) --

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    • Name (string) --

      The name of the filter. Filter names are case-sensitive.

    • Values (list) --

      The filter values. Filter values are case-sensitive.

      • (string) --

type AvailabilityZone

string

param AvailabilityZone

Filters the results by the specified Availability Zone.

type DryRun

boolean

param DryRun

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 .

type EndTime

datetime

param EndTime

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).

type InstanceTypes

list

param InstanceTypes

Filters the results by the specified instance types.

  • (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken

string

param NextToken

The token for the next set of results.

type ProductDescriptions

list

param ProductDescriptions

Filters the results by the specified basic product descriptions.

  • (string) --

type StartTime

datetime

param StartTime

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SpotPriceHistory': [
        {
            'AvailabilityZone': 'string',
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'SpotPrice': 'string',
            'Timestamp': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    Contains the output of DescribeSpotPriceHistory.

    • NextToken (string) --

      The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.

    • SpotPriceHistory (list) --

      The historical Spot prices.

      • (dict) --

        Describes the maximum price per hour that you are willing to pay for a Spot Instance.

        • AvailabilityZone (string) --

          The Availability Zone.

        • InstanceType (string) --

          The instance type.

        • ProductDescription (string) --

          A general description of the AMI.

        • SpotPrice (string) --

          The maximum price per hour that you are willing to pay for a Spot Instance.

        • Timestamp (datetime) --

          The date and time the request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).

GetLaunchTemplateData (updated) Link ¶
Changes (response)
{'LaunchTemplateData': {'InstanceType': {'dl1.24xlarge'}}}

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.

See also: AWS API Documentation

Request Syntax

client.get_launch_template_data(
    DryRun=True|False,
    InstanceId='string'
)
type DryRun

boolean

param DryRun

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 .

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the instance.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateData': {
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                    'Throughput': 123
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociateCarrierIpAddress': True|False,
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'InterfaceType': 'string',
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string',
                'NetworkCardIndex': 123,
                'Ipv4Prefixes': [
                    {
                        'Ipv4Prefix': 'string'
                    },
                ],
                'Ipv4PrefixCount': 123,
                'Ipv6Prefixes': [
                    {
                        'Ipv6Prefix': 'string'
                    },
                ],
                'Ipv6PrefixCount': 123
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string',
            'PartitionNumber': 123
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'ElasticInferenceAccelerators': [
            {
                'Type': 'string',
                'Count': 123
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        },
        'CpuOptions': {
            'CoreCount': 123,
            'ThreadsPerCore': 123
        },
        'CapacityReservationSpecification': {
            'CapacityReservationPreference': 'open'|'none',
            'CapacityReservationTarget': {
                'CapacityReservationId': 'string',
                'CapacityReservationResourceGroupArn': 'string'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': True|False
        },
        'MetadataOptions': {
            'State': 'pending'|'applied',
            'HttpTokens': 'optional'|'required',
            'HttpPutResponseHopLimit': 123,
            'HttpEndpoint': 'disabled'|'enabled',
            'HttpProtocolIpv6': 'disabled'|'enabled'
        },
        'EnclaveOptions': {
            'Enabled': True|False
        },
        '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',
            ],
            'AcceleratorTotalMemoryMiB': {
                'Min': 123,
                'Max': 123
            }
        }
    }
}

Response Structure

  • (dict) --

    • LaunchTemplateData (dict) --

      The instance data.

      • KernelId (string) --

        The ID of the kernel, if applicable.

      • EbsOptimized (boolean) --

        Indicates whether the instance is optimized for Amazon EBS I/O.

      • IamInstanceProfile (dict) --

        The IAM instance profile.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the instance profile.

        • Name (string) --

          The name of the instance profile.

      • BlockDeviceMappings (list) --

        The block device mappings.

        • (dict) --

          Describes a block device mapping.

          • DeviceName (string) --

            The device name.

          • VirtualName (string) --

            The virtual device name (ephemeralN).

          • Ebs (dict) --

            Information about the block device for an EBS volume.

            • Encrypted (boolean) --

              Indicates whether the EBS volume is encrypted.

            • DeleteOnTermination (boolean) --

              Indicates whether the EBS volume is deleted on instance termination.

            • Iops (integer) --

              The number of I/O operations per second (IOPS) that the volume supports.

            • KmsKeyId (string) --

              The ARN of the Key Management Service (KMS) CMK used for encryption.

            • SnapshotId (string) --

              The ID of the snapshot.

            • VolumeSize (integer) --

              The size of the volume, in GiB.

            • VolumeType (string) --

              The volume type.

            • Throughput (integer) --

              The throughput that the volume supports, in MiB/s.

          • NoDevice (string) --

            To omit the device from the block device mapping, specify an empty string.

      • NetworkInterfaces (list) --

        The network interfaces.

        • (dict) --

          Describes a network interface.

          • AssociateCarrierIpAddress (boolean) --

            Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

            Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide .

          • AssociatePublicIpAddress (boolean) --

            Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

          • DeleteOnTermination (boolean) --

            Indicates whether the network interface is deleted when the instance is terminated.

          • Description (string) --

            A description for the network interface.

          • DeviceIndex (integer) --

            The device index for the network interface attachment.

          • Groups (list) --

            The IDs of one or more security groups.

            • (string) --

          • InterfaceType (string) --

            The type of network interface.

          • Ipv6AddressCount (integer) --

            The number of IPv6 addresses for the network interface.

          • Ipv6Addresses (list) --

            The IPv6 addresses for the network interface.

            • (dict) --

              Describes an IPv6 address.

              • Ipv6Address (string) --

                The IPv6 address.

          • NetworkInterfaceId (string) --

            The ID of the network interface.

          • PrivateIpAddress (string) --

            The primary private IPv4 address of the network interface.

          • PrivateIpAddresses (list) --

            One or more private IPv4 addresses.

            • (dict) --

              Describes a secondary private IPv4 address for a network interface.

              • Primary (boolean) --

                Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

              • PrivateIpAddress (string) --

                The private IPv4 addresses.

          • SecondaryPrivateIpAddressCount (integer) --

            The number of secondary private IPv4 addresses for the network interface.

          • SubnetId (string) --

            The ID of the subnet for the network interface.

          • NetworkCardIndex (integer) --

            The index of the network card.

          • Ipv4Prefixes (list) --

            One or more IPv4 prefixes assigned to the network interface.

            • (dict) --

              Information about the IPv4 delegated prefixes assigned to a network interface.

              • Ipv4Prefix (string) --

                One or more IPv4 delegated prefixes assigned to the network interface.

          • Ipv4PrefixCount (integer) --

            The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.

          • Ipv6Prefixes (list) --

            One or more IPv6 prefixes assigned to the network interface.

            • (dict) --

              Information about the IPv6 delegated prefixes assigned to a network interface.

              • Ipv6Prefix (string) --

                One or more IPv6 delegated prefixes assigned to the network interface.

          • Ipv6PrefixCount (integer) --

            The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.

      • ImageId (string) --

        The ID of the AMI that was used to launch the instance.

      • InstanceType (string) --

        The instance type.

      • KeyName (string) --

        The name of the key pair.

      • Monitoring (dict) --

        The monitoring for the instance.

        • Enabled (boolean) --

          Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

      • Placement (dict) --

        The placement of the instance.

        • AvailabilityZone (string) --

          The Availability Zone of the instance.

        • Affinity (string) --

          The affinity setting for the instance on the Dedicated Host.

        • GroupName (string) --

          The name of the placement group for the instance.

        • HostId (string) --

          The ID of the Dedicated Host for the instance.

        • Tenancy (string) --

          The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

        • SpreadDomain (string) --

          Reserved for future use.

        • HostResourceGroupArn (string) --

          The ARN of the host resource group in which to launch the instances.

        • PartitionNumber (integer) --

          The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition .

      • RamDiskId (string) --

        The ID of the RAM disk, if applicable.

      • DisableApiTermination (boolean) --

        If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

      • InstanceInitiatedShutdownBehavior (string) --

        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

      • UserData (string) --

        The user data for the instance.

      • TagSpecifications (list) --

        The tags.

        • (dict) --

          The tag specification for the launch template.

          • ResourceType (string) --

            The type of resource.

          • Tags (list) --

            The tags for the resource.

            • (dict) --

              Describes a tag.

              • Key (string) --

                The key of the tag.

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

              • Value (string) --

                The value of the tag.

                Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

      • ElasticGpuSpecifications (list) --

        The elastic GPU specification.

        • (dict) --

          Describes an elastic GPU.

          • Type (string) --

            The elastic GPU type.

      • ElasticInferenceAccelerators (list) --

        The elastic inference accelerator for the instance.

        • (dict) --

          Describes an elastic inference accelerator.

          • Type (string) --

            The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

          • Count (integer) --

            The number of elastic inference accelerators to attach to the instance.

            Default: 1

      • SecurityGroupIds (list) --

        The security group IDs.

        • (string) --

      • SecurityGroups (list) --

        The security group names.

        • (string) --

      • InstanceMarketOptions (dict) --

        The market (purchasing) option for the instances.

        • MarketType (string) --

          The market type.

        • SpotOptions (dict) --

          The options for Spot Instances.

          • MaxPrice (string) --

            The maximum hourly price you're willing to pay for the Spot Instances.

          • SpotInstanceType (string) --

            The Spot Instance request type.

          • BlockDurationMinutes (integer) --

            The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

          • ValidUntil (datetime) --

            The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

          • InstanceInterruptionBehavior (string) --

            The behavior when a Spot Instance is interrupted.

      • CreditSpecification (dict) --

        The credit option for CPU usage of the instance.

        • CpuCredits (string) --

          The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited .

      • CpuOptions (dict) --

        The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide .

        • CoreCount (integer) --

          The number of CPU cores for the instance.

        • ThreadsPerCore (integer) --

          The number of threads per CPU core.

      • CapacityReservationSpecification (dict) --

        Information about the Capacity Reservation targeting option.

        • CapacityReservationPreference (string) --

          Indicates the instance's Capacity Reservation preferences. Possible preferences include:

          • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

          • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

        • CapacityReservationTarget (dict) --

          Information about the target Capacity Reservation or Capacity Reservation group.

          • CapacityReservationId (string) --

            The ID of the targeted Capacity Reservation.

          • CapacityReservationResourceGroupArn (string) --

            The ARN of the targeted Capacity Reservation group.

      • LicenseSpecifications (list) --

        The license configurations.

        • (dict) --

          Describes a license configuration.

          • LicenseConfigurationArn (string) --

            The Amazon Resource Name (ARN) of the license configuration.

      • HibernationOptions (dict) --

        Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide .

        • Configured (boolean) --

          If this parameter is set to true , the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

      • MetadataOptions (dict) --

        The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide .

        • State (string) --

          The state of the metadata option changes.

          pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

          applied - The metadata options have been successfully applied on the instance.

        • HttpTokens (string) --

          The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional .

          If the state is optional , you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

          If the state is required , you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

        • HttpPutResponseHopLimit (integer) --

          The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

          Default: 1

          Possible values: Integers from 1 to 64

        • HttpEndpoint (string) --

          This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled .

          Note

          If you specify a value of disabled , you will not be able to access your instance metadata.

        • HttpProtocolIpv6 (string) --

          Enables or disables the IPv6 endpoint for the instance metadata service.

          Default: disabled

      • EnclaveOptions (dict) --

        Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

        • Enabled (boolean) --

          If this parameter is set to true , the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

      • InstanceRequirements (dict) --

        The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

        If you specify InstanceRequirements , you can't specify InstanceTypes .

        • VCpuCount (dict) --

          The minimum and maximum number of vCPUs.

          • Min (integer) --

            The minimum number of vCPUs. If the value is 0 , there is no minimum limit.

          • Max (integer) --

            The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.

        • MemoryMiB (dict) --

          The minimum and maximum amount of memory, in MiB.

          • Min (integer) --

            The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.

          • Max (integer) --

            The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.

        • CpuManufacturers (list) --

          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 .

          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

          • (string) --

        • MemoryGiBPerVCpu (dict) --

          The minimum and maximum amount of memory per vCPU, in GiB.

          Default: No minimum or maximum limits

          • Min (float) --

            The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.

          • Max (float) --

            The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.

        • ExcludedInstanceTypes (list) --

          The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (* ), to exclude 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 exclude the entire C5 instance family (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

          Default: No excluded instance types

          • (string) --

        • InstanceGenerations (list) --

          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

          • (string) --

        • SpotMaxPricePercentageOverLowestPrice (integer) --

          The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest 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 .

          Default: 100

        • OnDemandMaxPricePercentageOverLowestPrice (integer) --

          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 cheapest 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 .

          Default: 20

        • BareMetal (string) --

          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

        • BurstablePerformance (string) --

          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

        • RequireHibernateSupport (boolean) --

          Indicates whether instance types must support hibernation for On-Demand Instances.

          This parameter is not supported for GetSpotPlacementScores .

          Default: false

        • NetworkInterfaceCount (dict) --

          The minimum and maximum number of network interfaces.

          Default: No minimum or maximum limits

          • Min (integer) --

            The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.

          • Max (integer) --

            The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.

        • LocalStorage (string) --

          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

        • LocalStorageTypes (list) --

          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 (SDD) storage, specify sdd .

          Default: hdd and sdd

          • (string) --

        • TotalLocalStorageGB (dict) --

          The minimum and maximum amount of total local storage, in GB.

          Default: No minimum or maximum limits

          • Min (float) --

            The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.

          • Max (float) --

            The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.

        • BaselineEbsBandwidthMbps (dict) --

          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

          • Min (integer) --

            The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.

          • Max (integer) --

            The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.

        • AcceleratorTypes (list) --

          The accelerator types that must be on the instance type.

          • For instance types with GPU accelerators, specify gpu .

          • For instance types with FPGA accelerators, specify fpga .

          • For instance types with inference accelerators, specify inference .

          Default: Any accelerator type

          • (string) --

        • AcceleratorCount (dict) --

          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

          • Min (integer) --

            The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.

          • Max (integer) --

            The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.

        • AcceleratorManufacturers (list) --

          Indicates whether instance types must have accelerators by specific manufacturers.

          • For instance types with NVIDIA devices, specify nvidia .

          • For instance types with AMD devices, specify amd .

          • For instance types with Amazon Web Services devices, specify amazon-web-services .

          • For instance types with Xilinx devices, specify xilinx .

          Default: Any manufacturer

          • (string) --

        • AcceleratorNames (list) --

          The accelerators that must be on the instance type.

          • For instance types with NVIDIA A100 GPUs, specify a100 .

          • For instance types with NVIDIA V100 GPUs, specify v100 .

          • For instance types with NVIDIA K80 GPUs, specify k80 .

          • For instance types with NVIDIA T4 GPUs, specify t4 .

          • 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 Xilinx VU9P FPGAs, specify vu9p .

          Default: Any accelerator

          • (string) --

        • AcceleratorTotalMemoryMiB (dict) --

          The minimum and maximum amount of total accelerator memory, in MiB.

          Default: No minimum or maximum limits

          • Min (integer) --

            The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.

          • Max (integer) --

            The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.

ImportInstance (updated) Link ¶
Changes (request)
{'LaunchSpecification': {'InstanceType': {'dl1.24xlarge'}}}

Creates an import instance task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.

This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest .

See also: AWS API Documentation

Request Syntax

client.import_instance(
    Description='string',
    DiskImages=[
        {
            'Description': 'string',
            'Image': {
                'Bytes': 123,
                'Format': 'VMDK'|'RAW'|'VHD',
                'ImportManifestUrl': 'string'
            },
            'Volume': {
                'Size': 123
            }
        },
    ],
    DryRun=True|False,
    LaunchSpecification={
        'AdditionalInfo': 'string',
        'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac',
        'GroupIds': [
            'string',
        ],
        'GroupNames': [
            'string',
        ],
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
        'Monitoring': True|False,
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'PartitionNumber': 123,
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string'
        },
        'PrivateIpAddress': 'string',
        'SubnetId': 'string',
        'UserData': {
            'Data': 'string'
        }
    },
    Platform='Windows'
)
type Description

string

param Description

A description for the instance being imported.

type DiskImages

list

param DiskImages

The disk image.

  • (dict) --

    Describes a disk image.

    • Description (string) --

      A description of the disk image.

    • Image (dict) --

      Information about the disk image.

      • Bytes (integer) -- [REQUIRED]

        The size of the disk image, in GiB.

      • Format (string) -- [REQUIRED]

        The disk image format.

      • ImportManifestUrl (string) -- [REQUIRED]

        A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .

        For information about the import manifest referenced by this API action, see VM Import Manifest .

    • Volume (dict) --

      Information about the volume.

      • Size (integer) -- [REQUIRED]

        The size of the volume, in GiB.

type DryRun

boolean

param DryRun

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 .

type LaunchSpecification

dict

param LaunchSpecification

The launch specification.

  • AdditionalInfo (string) --

    Reserved.

  • Architecture (string) --

    The architecture of the instance.

  • GroupIds (list) --

    The security group IDs.

    • (string) --

  • GroupNames (list) --

    The security group names.

    • (string) --

  • InstanceInitiatedShutdownBehavior (string) --

    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

  • InstanceType (string) --

    The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

  • Monitoring (boolean) --

    Indicates whether monitoring is enabled.

  • Placement (dict) --

    The placement information for the instance.

    • AvailabilityZone (string) --

      The Availability Zone of the instance.

      If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

      This parameter is not supported by CreateFleet .

    • Affinity (string) --

      The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

      This parameter is not supported by CreateFleet .

    • GroupName (string) --

      The name of the placement group the instance is in.

    • PartitionNumber (integer) --

      The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .

      This parameter is not supported by CreateFleet .

    • HostId (string) --

      The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

      This parameter is not supported by CreateFleet .

    • Tenancy (string) --

      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

      This parameter is not supported by CreateFleet .

      T3 instances that use the unlimited CPU credit option do not support host tenancy.

    • SpreadDomain (string) --

      Reserved for future use.

      This parameter is not supported by CreateFleet .

    • HostResourceGroupArn (string) --

      The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

      This parameter is not supported by CreateFleet .

  • PrivateIpAddress (string) --

    [EC2-VPC] An available IP address from the IP address range of the subnet.

  • SubnetId (string) --

    [EC2-VPC] The ID of the subnet in which to launch the instance.

  • UserData (dict) --

    The Base64-encoded user data to make available to the instance.

    • Data (string) --

      The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

type Platform

string

param Platform

[REQUIRED]

The instance operating system.

rtype

dict

returns

Response Syntax

{
    'ConversionTask': {
        'ConversionTaskId': 'string',
        'ExpirationTime': 'string',
        'ImportInstance': {
            'Description': 'string',
            'InstanceId': 'string',
            'Platform': 'Windows',
            'Volumes': [
                {
                    'AvailabilityZone': 'string',
                    'BytesConverted': 123,
                    'Description': 'string',
                    'Image': {
                        'Checksum': 'string',
                        'Format': 'VMDK'|'RAW'|'VHD',
                        'ImportManifestUrl': 'string',
                        'Size': 123
                    },
                    'Status': 'string',
                    'StatusMessage': 'string',
                    'Volume': {
                        'Id': 'string',
                        'Size': 123
                    }
                },
            ]
        },
        'ImportVolume': {
            'AvailabilityZone': 'string',
            'BytesConverted': 123,
            'Description': 'string',
            'Image': {
                'Checksum': 'string',
                'Format': 'VMDK'|'RAW'|'VHD',
                'ImportManifestUrl': 'string',
                'Size': 123
            },
            'Volume': {
                'Id': 'string',
                'Size': 123
            }
        },
        'State': 'active'|'cancelling'|'cancelled'|'completed',
        'StatusMessage': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • ConversionTask (dict) --

      Information about the conversion task.

      • ConversionTaskId (string) --

        The ID of the conversion task.

      • ExpirationTime (string) --

        The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

      • ImportInstance (dict) --

        If the task is for importing an instance, this contains information about the import instance task.

        • Description (string) --

          A description of the task.

        • InstanceId (string) --

          The ID of the instance.

        • Platform (string) --

          The instance operating system.

        • Volumes (list) --

          The volumes.

          • (dict) --

            Describes an import volume task.

            • AvailabilityZone (string) --

              The Availability Zone where the resulting instance will reside.

            • BytesConverted (integer) --

              The number of bytes converted so far.

            • Description (string) --

              A description of the task.

            • Image (dict) --

              The image.

              • Checksum (string) --

                The checksum computed for the disk image.

              • Format (string) --

                The disk image format.

              • ImportManifestUrl (string) --

                A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .

                For information about the import manifest referenced by this API action, see VM Import Manifest .

              • Size (integer) --

                The size of the disk image, in GiB.

            • Status (string) --

              The status of the import of this particular disk image.

            • StatusMessage (string) --

              The status information or errors related to the disk image.

            • Volume (dict) --

              The volume.

              • Id (string) --

                The volume identifier.

              • Size (integer) --

                The size of the volume, in GiB.

      • ImportVolume (dict) --

        If the task is for importing a volume, this contains information about the import volume task.

        • AvailabilityZone (string) --

          The Availability Zone where the resulting volume will reside.

        • BytesConverted (integer) --

          The number of bytes converted so far.

        • Description (string) --

          The description you provided when starting the import volume task.

        • Image (dict) --

          The image.

          • Checksum (string) --

            The checksum computed for the disk image.

          • Format (string) --

            The disk image format.

          • ImportManifestUrl (string) --

            A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide .

            For information about the import manifest referenced by this API action, see VM Import Manifest .

          • Size (integer) --

            The size of the disk image, in GiB.

        • Volume (dict) --

          The volume.

          • Id (string) --

            The volume identifier.

          • Size (integer) --

            The size of the volume, in GiB.

      • State (string) --

        The state of the conversion task.

      • StatusMessage (string) --

        The status message related to the conversion task.

      • Tags (list) --

        Any tags assigned to the task.

        • (dict) --

          Describes a tag.

          • Key (string) --

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

          • Value (string) --

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

ModifyFleet (updated) Link ¶
Changes (request)
{'LaunchTemplateConfigs': {'Overrides': {'InstanceType': {'dl1.24xlarge'}}}}

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain .

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price , the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified , the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized , EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price , the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized , the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified , the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

See also: AWS API Documentation

Request Syntax

client.modify_fleet(
    DryRun=True|False,
    ExcessCapacityTerminationPolicy='no-termination'|'termination',
    LaunchTemplateConfigs=[
        {
            'LaunchTemplateSpecification': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'Overrides': [
                {
                    'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r6g.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6gd.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6gd.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'mac1.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge',
                    'MaxPrice': 'string',
                    'SubnetId': 'string',
                    'AvailabilityZone': 'string',
                    'WeightedCapacity': 123.0,
                    'Priority': 123.0,
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'Affinity': 'string',
                        'GroupName': 'string',
                        'PartitionNumber': 123,
                        'HostId': 'string',
                        'Tenancy': 'default'|'dedicated'|'host',
                        'SpreadDomain': 'string',
                        'HostResourceGroupArn': 'string'
                    },
                    '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',
                        ],
                        'AcceleratorTotalMemoryMiB': {
                            'Min': 123,
                            'Max': 123
                        }
                    }
                },
            ]
        },
    ],
    FleetId='string',
    TargetCapacitySpecification={
        'TotalTargetCapacity': 123,
        'OnDemandTargetCapacity': 123,
        'SpotTargetCapacity': 123,
        'DefaultTargetCapacityType': 'spot'|'on-demand',
        'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units'
    },
    Context='string'
)
type DryRun

boolean

param DryRun

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 .

type ExcessCapacityTerminationPolicy

string

param ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

type LaunchTemplateConfigs

list

param LaunchTemplateConfigs

The launch template and overrides.

  • (dict) --

    Describes a launch template and overrides.

    • LaunchTemplateSpecification (dict) --

      The launch template to use. You must specify either the launch template ID or launch template name in the request.

      • LaunchTemplateId (string) --

        The ID of the launch template. If you specify the template ID, you can't specify the template name.

      • LaunchTemplateName (string) --

        The name of the launch template. If you specify the template name, you can't specify the template ID.

      • Version (string) --

        The launch template version number, $Latest , or $Default . You must specify a value, otherwise the request fails.

        If the value is $Latest , Amazon EC2 uses the latest version of the launch template.

        If the value is $Default , Amazon EC2 uses the default version of the launch template.

    • Overrides (list) --

      Any parameters that you specify override the same parameters in the launch template.

      For fleets of type request and maintain , a maximum of 300 items is allowed across all launch templates.

      • (dict) --

        Describes overrides for a launch template.

        • InstanceType (string) --

          The instance type.

          Note

          If you specify InstanceTypes , you can't specify InstanceRequirements .

        • MaxPrice (string) --

          The maximum price per unit hour that you are willing to pay for a Spot Instance.

        • SubnetId (string) --

          The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2 ). A request of type instant can have only one subnet ID.

        • AvailabilityZone (string) --

          The Availability Zone in which to launch the instances.

        • WeightedCapacity (float) --

          The number of units provided by the specified instance type.

        • Priority (float) --

          The priority for the launch template override. The highest priority is launched first.

          If the On-Demand AllocationStrategy is set to prioritized , EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

          If the Spot AllocationStrategy is set to capacity-optimized-prioritized , EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

          Valid values are whole numbers starting at 0 . The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.

        • Placement (dict) --

          The location where the instance launched, if applicable.

          • AvailabilityZone (string) --

            The Availability Zone of the instance.

            If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

            This parameter is not supported by CreateFleet .

          • Affinity (string) --

            The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

          • GroupName (string) --

            The name of the placement group the instance is in.

          • PartitionNumber (integer) --

            The number of the partition the instance is in. Valid only if the placement group strategy is set to partition .

            This parameter is not supported by CreateFleet .

          • HostId (string) --

            The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

          • Tenancy (string) --

            The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

            This parameter is not supported by CreateFleet .

            T3 instances that use the unlimited CPU credit option do not support host tenancy.

          • SpreadDomain (string) --

            Reserved for future use.

            This parameter is not supported by CreateFleet .

          • HostResourceGroupArn (string) --

            The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

            This parameter is not supported by CreateFleet .

        • InstanceRequirements (dict) --

          The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

          Note

          If you specify InstanceRequirements , you can't specify InstanceTypes .

          • VCpuCount (dict) -- [REQUIRED]

            The minimum and maximum number of vCPUs.

            • Min (integer) -- [REQUIRED]

              The minimum number of vCPUs. To specify no minimum limit, specify 0 .

            • Max (integer) --

              The maximum number of vCPUs. To specify no maximum limit, omit this parameter.

          • MemoryMiB (dict) -- [REQUIRED]

            The minimum and maximum amount of memory, in MiB.

            • Min (integer) -- [REQUIRED]

              The minimum amount of memory, in MiB. To specify no minimum limit, specify 0 .

            • Max (integer) --

              The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.

          • CpuManufacturers (list) --

            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 .

            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

            • (string) --

          • MemoryGiBPerVCpu (dict) --

            The minimum and maximum amount of memory per vCPU, in GiB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.

            • Max (float) --

              The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.

          • ExcludedInstanceTypes (list) --

            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 (all C5a and C5n instance types). If you specify c5a.* , Amazon EC2 excludes all the C5a instance types, but does not exclude the C5n instance types.

            Default: No excluded instance types

            • (string) --

          • InstanceGenerations (list) --

            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

            • (string) --

          • SpotMaxPricePercentageOverLowestPrice (integer) --

            The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the cheapest 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 .

            Default: 100

          • OnDemandMaxPricePercentageOverLowestPrice (integer) --

            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 cheapest 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 .

            Default: 20

          • BareMetal (string) --

            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

          • BurstablePerformance (string) --

            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

          • RequireHibernateSupport (boolean) --

            Indicates whether instance types must support hibernation for On-Demand Instances.

            This parameter is not supported for GetSpotPlacementScores .

            Default: false

          • NetworkInterfaceCount (dict) --

            The minimum and maximum number of network interfaces.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum number of network interfaces. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum number of network interfaces. To specify no maximum limit, omit this parameter.

          • LocalStorage (string) --

            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

          • LocalStorageTypes (list) --

            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 (SDD) storage, specify sdd .

            Default: hdd and sdd

            • (string) --

          • TotalLocalStorageGB (dict) --

            The minimum and maximum amount of total local storage, in GB.

            Default: No minimum or maximum limits

            • Min (float) --

              The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.

            • Max (float) --

              The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.

          • BaselineEbsBandwidthMbps (dict) --

            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

            • Min (integer) --

              The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.

          • AcceleratorTypes (list) --

            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

            • (string) --

          • AcceleratorCount (dict) --

            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

            • Min (integer) --

              The minimum number of accelerators. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0 .

          • AcceleratorManufacturers (list) --

            Indicates whether instance types must have accelerators by specific manufacturers.

            • For instance types with NVIDIA devices, specify nvidia .

            • For instance types with AMD devices, specify amd .

            • For instance types with Amazon Web Services devices, specify amazon-web-services .

            • For instance types with Xilinx devices, specify xilinx .

            Default: Any manufacturer

            • (string) --

          • AcceleratorNames (list) --

            The accelerators that must be on the instance type.

            • For instance types with NVIDIA A100 GPUs, specify a100 .

            • For instance types with NVIDIA V100 GPUs, specify v100 .

            • For instance types with NVIDIA K80 GPUs, specify k80 .

            • For instance types with NVIDIA T4 GPUs, specify t4 .

            • 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 Xilinx VU9P FPGAs, specify vu9p .

            Default: Any accelerator

            • (string) --

          • AcceleratorTotalMemoryMiB (dict) --

            The minimum and maximum amount of total accelerator memory, in MiB.

            Default: No minimum or maximum limits

            • Min (integer) --

              The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.

            • Max (integer) --

              The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.

type FleetId

string

param FleetId

[REQUIRED]

The ID of the EC2 Fleet.

type TargetCapacitySpecification

dict

param TargetCapacitySpecification

The size of the EC2 Fleet.

  • TotalTargetCapacity (integer) -- [REQUIRED]

    The number of units to request, filled using DefaultTargetCapacityType .

  • OnDemandTargetCapacity (integer) --

    The number of On-Demand units to request.

  • SpotTargetCapacity (integer) --

    The number of Spot units to request.

  • DefaultTargetCapacityType (string) --

    The default TotalTargetCapacity , which is either Spot or On-Demand .

  • TargetCapacityUnitType (string) --

    The unit for the target capacity.

    Default: units (translates to number of instances)

type Context

string

param Context

Reserved.

rtype

dict

returns

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) --

    • Return (boolean) --

      Is true if the request succeeds, and an error otherwise.

ModifyReservedInstances (updated) Link ¶
Changes (request)
{'TargetConfigurations': {'InstanceType': {'dl1.24xlarge'}}}

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.modify_reserved_instances(
    ReservedInstancesIds=[
        'string',
    ],
    ClientToken='string',
    TargetConfigurations=[
        {
            'AvailabilityZone': 'string',
            'InstanceCount': 123,
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r