Amazon Elastic Compute Cloud

Modifies the options for instance hostnames for the specified instance.

See also: AWS API Documentation

Request Syntax

client.modify_private_dns_name_options(
    DryRun=True|False,
    InstanceId='string',
    PrivateDnsHostnameType='ip-name'|'resource-name',
    EnableResourceNameDnsARecord=True|False,
    EnableResourceNameDnsAAAARecord=True|False
)

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

The ID of the instance.

type PrivateDnsHostnameType

string

param PrivateDnsHostnameType

The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

type EnableResourceNameDnsARecord

boolean

param EnableResourceNameDnsARecord

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

type EnableResourceNameDnsAAAARecord

boolean

param EnableResourceNameDnsAAAARecord

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

rtype

dict

returns

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) --

  • Return (boolean) --

    Returns true if the request succeeds; otherwise, it returns an error.

{'Ipv6Native': 'boolean'}

{'Subnet': {'Ipv6Native': 'boolean',
            'PrivateDnsNameOptionsOnLaunch': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                              'EnableResourceNameDnsARecord': 'boolean',
                                              'HostnameType': 'ip-name | '
                                                              'resource-name'}}}

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_default_subnet(
    AvailabilityZone='string',
    DryRun=True|False,
    Ipv6Native=True|False
)

type AvailabilityZone

string

param AvailabilityZone

[REQUIRED]

The Availability Zone in which to create the default subnet.

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 Ipv6Native

boolean

param Ipv6Native

Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.

rtype

dict

returns

Response Syntax

{
    'Subnet': {
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'AvailableIpAddressCount': 123,
        'CidrBlock': 'string',
        'DefaultForAz': True|False,
        'MapPublicIpOnLaunch': True|False,
        'MapCustomerOwnedIpOnLaunch': True|False,
        'CustomerOwnedIpv4Pool': 'string',
        'State': 'pending'|'available',
        'SubnetId': 'string',
        'VpcId': 'string',
        'OwnerId': 'string',
        'AssignIpv6AddressOnCreation': True|False,
        'Ipv6CidrBlockAssociationSet': [
            {
                'AssociationId': 'string',
                'Ipv6CidrBlock': 'string',
                'Ipv6CidrBlockState': {
                    'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                    'StatusMessage': 'string'
                }
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string',
        'OutpostArn': 'string',
        'EnableDns64': True|False,
        'Ipv6Native': True|False,
        'PrivateDnsNameOptionsOnLaunch': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        }
    }
}

Response Structure

• (dict) --

  • Subnet (dict) --

    Information about the subnet.

    • AvailabilityZone (string) --

      The Availability Zone of the subnet.

    • AvailabilityZoneId (string) --

      The AZ ID of the subnet.

    • AvailableIpAddressCount (integer) --

      The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

    • CidrBlock (string) --

      The IPv4 CIDR block assigned to the subnet.

    • DefaultForAz (boolean) --

      Indicates whether this is the default subnet for the Availability Zone.

    • MapPublicIpOnLaunch (boolean) --

      Indicates whether instances launched in this subnet receive a public IPv4 address.

    • MapCustomerOwnedIpOnLaunch (boolean) --

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.

    • CustomerOwnedIpv4Pool (string) --

      The customer-owned IPv4 address pool associated with the subnet.

    • State (string) --

      The current state of the subnet.

    • SubnetId (string) --

      The ID of the subnet.

    • VpcId (string) --

      The ID of the VPC the subnet is in.

    • OwnerId (string) --

      The ID of the Amazon Web Services account that owns the subnet.

    • AssignIpv6AddressOnCreation (boolean) --

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.

    • Ipv6CidrBlockAssociationSet (list) --

      Information about the IPv6 CIDR blocks associated with the subnet.

      • (dict) --

        Describes an association between a subnet and an IPv6 CIDR block.

        • AssociationId (string) --

          The ID of the association.

        • Ipv6CidrBlock (string) --

          The IPv6 CIDR block.

        • Ipv6CidrBlockState (dict) --

          The state of the CIDR block.

          • State (string) --

            The state of a CIDR block.

          • StatusMessage (string) --

            A message about the status of the CIDR block, if applicable.

    • Tags (list) --

      Any tags assigned to the subnet.

      • (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.

    • SubnetArn (string) --

      The Amazon Resource Name (ARN) of the subnet.

    • OutpostArn (string) --

      The Amazon Resource Name (ARN) of the Outpost.

    • EnableDns64 (boolean) --

      Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

    • Ipv6Native (boolean) --

      Indicates whether this is an IPv6 only subnet.

    • PrivateDnsNameOptionsOnLaunch (dict) --

      The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

      • HostnameType (string) --

        The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

      • EnableResourceNameDnsARecord (boolean) --

        Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

      • EnableResourceNameDnsAAAARecord (boolean) --

        Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.

{'LaunchTemplateData': {'PrivateDnsNameOptions': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                                  'EnableResourceNameDnsARecord': 'boolean',
                                                  'HostnameType': 'ip-name | '
                                                                  'resource-name'}}}

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'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'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'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge',
        '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
            }
        },
        'PrivateDnsNameOptions': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': 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'
                },
            ]
        },
    ]
)

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.

      • (dict) --

        Describes the IPv4 prefix option for a network interface.

        • Ipv4Prefix (string) --

          The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

    • 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, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

    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.

• PrivateDnsNameOptions (dict) --

  The options for the instance hostname. The default values are inherited from the subnet.

  • HostnameType (string) --

    The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

  • EnableResourceNameDnsARecord (boolean) --

    Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • EnableResourceNameDnsAAAARecord (boolean) --

    Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

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.

{'LaunchTemplateData': {'PrivateDnsNameOptions': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                                  'EnableResourceNameDnsARecord': 'boolean',
                                                  'HostnameType': 'ip-name | '
                                                                  'resource-name'}}}

{'LaunchTemplateVersion': {'LaunchTemplateData': {'PrivateDnsNameOptions': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                                                            'EnableResourceNameDnsARecord': 'boolean',
                                                                            'HostnameType': 'ip-name '
                                                                                            '| '
                                                                                            'resource-name'}}}}

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'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'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'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge',
        '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
            }
        },
        'PrivateDnsNameOptions': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        }
    }
)

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.

      • (dict) --

        Describes the IPv4 prefix option for a network interface.

        • Ipv4Prefix (string) --

          The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

    • 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, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

    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.

• PrivateDnsNameOptions (dict) --

  The options for the instance hostname. The default values are inherited from the subnet.

  • HostnameType (string) --

    The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

  • EnableResourceNameDnsARecord (boolean) --

    Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • EnableResourceNameDnsAAAARecord (boolean) --

    Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

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'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'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'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge',
            '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
                }
            },
            'PrivateDnsNameOptions': {
                'HostnameType': 'ip-name'|'resource-name',
                'EnableResourceNameDnsARecord': True|False,
                'EnableResourceNameDnsAAAARecord': True|False
            }
        }
    },
    '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, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

          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.

      • PrivateDnsNameOptions (dict) --

        The options for the instance hostname.

        • HostnameType (string) --

          The type of hostname to assign to an instance.

        • EnableResourceNameDnsARecord (boolean) --

          Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

        • EnableResourceNameDnsAAAARecord (boolean) --

          Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

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

{'NetworkInterface': {'Ipv6Address': 'string', 'Ipv6Native': '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.

• (dict) --

  Describes the IPv4 prefix option for a network interface.

  • Ipv4Prefix (string) --

    The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

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,
        'Ipv6Native': True|False,
        'Ipv6Address': 'string'
    },
    '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.

      • (dict) --

        Describes an IPv4 prefix.

        • Ipv4Prefix (string) --

          The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

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

    • Ipv6Native (boolean) --

      Indicates whether this is an IPv6 only network interface.

    • Ipv6Address (string) --

      The IPv6 globally unique address associated with the network interface.

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

{'Ipv6Native': 'boolean'}

{'Subnet': {'Ipv6Native': 'boolean',
            'PrivateDnsNameOptionsOnLaunch': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                              'EnableResourceNameDnsARecord': 'boolean',
                                              'HostnameType': 'ip-name | '
                                                              'resource-name'}}}

Creates a subnet in a specified VPC.

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_subnet(
    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'
                },
            ]
        },
    ],
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    CidrBlock='string',
    Ipv6CidrBlock='string',
    OutpostArn='string',
    VpcId='string',
    DryRun=True|False,
    Ipv6Native=True|False
)

type TagSpecifications

list

param TagSpecifications

The tags to assign to the subnet.

• (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 AvailabilityZone

string

param AvailabilityZone

The Availability Zone or Local Zone for the subnet.

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a . For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide .

To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

type AvailabilityZoneId

string

param AvailabilityZoneId

The AZ ID or the Local Zone ID of the subnet.

type CidrBlock

string

param CidrBlock

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24 . We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

This parameter is not supported for an IPv6 only subnet.

type Ipv6CidrBlock

string

param Ipv6CidrBlock

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

This parameter is required for an IPv6 only subnet.

type OutpostArn

string

param OutpostArn

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

type VpcId

string

param VpcId

[REQUIRED]

The ID of the VPC.

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 Ipv6Native

boolean

param Ipv6Native

Indicates whether to create an IPv6 only subnet.

rtype

dict

returns

Response Syntax

{
    'Subnet': {
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'AvailableIpAddressCount': 123,
        'CidrBlock': 'string',
        'DefaultForAz': True|False,
        'MapPublicIpOnLaunch': True|False,
        'MapCustomerOwnedIpOnLaunch': True|False,
        'CustomerOwnedIpv4Pool': 'string',
        'State': 'pending'|'available',
        'SubnetId': 'string',
        'VpcId': 'string',
        'OwnerId': 'string',
        'AssignIpv6AddressOnCreation': True|False,
        'Ipv6CidrBlockAssociationSet': [
            {
                'AssociationId': 'string',
                'Ipv6CidrBlock': 'string',
                'Ipv6CidrBlockState': {
                    'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed',
                    'StatusMessage': 'string'
                }
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string',
        'OutpostArn': 'string',
        'EnableDns64': True|False,
        'Ipv6Native': True|False,
        'PrivateDnsNameOptionsOnLaunch': {
            'HostnameType': 'ip-name'|'resource-name',
            'EnableResourceNameDnsARecord': True|False,
            'EnableResourceNameDnsAAAARecord': True|False
        }
    }
}

Response Structure

• (dict) --

  • Subnet (dict) --

    Information about the subnet.

    • AvailabilityZone (string) --

      The Availability Zone of the subnet.

    • AvailabilityZoneId (string) --

      The AZ ID of the subnet.

    • AvailableIpAddressCount (integer) --

      The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

    • CidrBlock (string) --

      The IPv4 CIDR block assigned to the subnet.

    • DefaultForAz (boolean) --

      Indicates whether this is the default subnet for the Availability Zone.

    • MapPublicIpOnLaunch (boolean) --

      Indicates whether instances launched in this subnet receive a public IPv4 address.

    • MapCustomerOwnedIpOnLaunch (boolean) --

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives a customer-owned IPv4 address.

    • CustomerOwnedIpv4Pool (string) --

      The customer-owned IPv4 address pool associated with the subnet.

    • State (string) --

      The current state of the subnet.

    • SubnetId (string) --

      The ID of the subnet.

    • VpcId (string) --

      The ID of the VPC the subnet is in.

    • OwnerId (string) --

      The ID of the Amazon Web Services account that owns the subnet.

    • AssignIpv6AddressOnCreation (boolean) --

      Indicates whether a network interface created in this subnet (including a network interface created by RunInstances ) receives an IPv6 address.

    • Ipv6CidrBlockAssociationSet (list) --

      Information about the IPv6 CIDR blocks associated with the subnet.

      • (dict) --

        Describes an association between a subnet and an IPv6 CIDR block.

        • AssociationId (string) --

          The ID of the association.

        • Ipv6CidrBlock (string) --

          The IPv6 CIDR block.

        • Ipv6CidrBlockState (dict) --

          The state of the CIDR block.

          • State (string) --

            The state of a CIDR block.

          • StatusMessage (string) --

            A message about the status of the CIDR block, if applicable.

    • Tags (list) --

      Any tags assigned to the subnet.

      • (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.

    • SubnetArn (string) --

      The Amazon Resource Name (ARN) of the subnet.

    • OutpostArn (string) --

      The Amazon Resource Name (ARN) of the Outpost.

    • EnableDns64 (boolean) --

      Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

    • Ipv6Native (boolean) --

      Indicates whether this is an IPv6 only subnet.

    • PrivateDnsNameOptionsOnLaunch (dict) --

      The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

      • HostnameType (string) --

        The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.

      • EnableResourceNameDnsARecord (boolean) --

        Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

      • EnableResourceNameDnsAAAARecord (boolean) --

        Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.

{'Reservations': {'Instances': {'Ipv6Address': 'string',
                                'PrivateDnsNameOptions': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                                          'EnableResourceNameDnsARecord': 'boolean',
                                                          'HostnameType': 'ip-name '
                                                                          '| '
                                                                          'resource-name'}}}}

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'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'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'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge',
                    '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',
                                'CustomerOwnedIp': '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',
                                        'CustomerOwnedIp': '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),
                    'PrivateDnsNameOptions': {
                        'HostnameType': 'ip-name'|'resource-name',
                        'EnableResourceNameDnsARecord': True|False,
                        'EnableResourceNameDnsAAAARecord': True|False
                    },
                    'Ipv6Address': 'string'
                },
            ],
            '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 that 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.

                • CustomerOwnedIp (string) --

                  The customer-owned 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.

                    • CustomerOwnedIp (string) --

                      The customer-owned 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.

          • PrivateDnsNameOptions (dict) --

            The options for the instance hostname.

            • HostnameType (string) --

              The type of hostname to assign to an instance.

            • EnableResourceNameDnsARecord (boolean) --

              Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

            • EnableResourceNameDnsAAAARecord (boolean) --

              Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

          • Ipv6Address (string) --

            The IPv6 address assigned to the instance.

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

{'LaunchTemplateVersions': {'LaunchTemplateData': {'PrivateDnsNameOptions': {'EnableResourceNameDnsAAAARecord': 'boolean',
                                                                             'EnableResourceNameDnsARecord': 'boolean',
                                                                             'HostnameType': 'ip-name '
                                                                                             '| '
                                                                                             'resource-name'}}}}

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'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'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'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge',
                '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
                    }
                },
                'PrivateDnsNameOptions': {
                    'HostnameType': 'ip-name'|'resource-name',
                    'EnableResourceNameDnsARecord': True|False,
                    'EnableResourceNameDnsAAAARecord': True|False
                }
            }
        },
    ],
    '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, which includes all C5a and C5n instance types. If you specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

            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.

        • PrivateDnsNameOptions (dict) --

          The options for the instance hostname.

          • HostnameType (string) --

            The type of hostname to assign to an instance.

          • EnableResourceNameDnsARecord (boolean) --

            Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

          • EnableResourceNameDnsAAAARecord (boolean) --

            Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

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

{'NetworkInterfaces': {'Ipv6Address': 'string', 'Ipv6Native': '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,
            'Ipv6Native': True|False,
            'Ipv6Address': 'string'
        },
    ],
    '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.

        • (dict) --

          Describes an IPv4 prefix.

          • Ipv4Prefix (string) --

            The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide .

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

      • Ipv6Native (boolean) --

        Indicates whether this is an IPv6 only network interface.

      • Ipv6Address (string) --

        The IPv6 globally unique address associated with the network interface.

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