Amazon Elastic Compute Cloud

{'LaunchTemplateData': {'ElasticInferenceAccelerators': {'Count': 'integer'}}}

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.

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'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                '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'
            },
        ],
        '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
                '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'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': True|False
        }
    },
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
            '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.

• 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 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) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

      • KmsKeyId (string) --

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

      • SnapshotId (string) --

        The ID of the snapshot.

      • VolumeSize (integer) --

        The size of the volume, in GiB.

        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

      • VolumeType (string) --

        The volume type.

    • NoDevice (string) --

      Suppresses the specified device included in the block device mapping of the AMI.

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

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

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

• KeyName (string) --

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

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

• RamDiskId (string) --

  The ID of the RAM disk.

• 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 Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).

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

• 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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 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 or T3 instances only.

  • CpuCredits (string) -- [REQUIRED]

    The credit option for CPU usage of a T2 or T3 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.

    • CapacityReservationId (string) --

      The ID of the Capacity Reservation.

• 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

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. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | fpga-image | instance | launch-template | snapshot | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | 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.

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'
            },
        ]
    }
}

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.

{'LaunchTemplateData': {'ElasticInferenceAccelerators': {'Count': 'integer'}}}

{'LaunchTemplateVersion': {'LaunchTemplateData': {'ElasticInferenceAccelerators': {'Count': 'integer'}}}}

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.

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'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                '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'
            },
        ],
        '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
                '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'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': 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.

• 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 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) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

      • KmsKeyId (string) --

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

      • SnapshotId (string) --

        The ID of the snapshot.

      • VolumeSize (integer) --

        The size of the volume, in GiB.

        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

      • VolumeType (string) --

        The volume type.

    • NoDevice (string) --

      Suppresses the specified device included in the block device mapping of the AMI.

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

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

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

• KeyName (string) --

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

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

• RamDiskId (string) --

  The ID of the RAM disk.

• 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 Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).

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

• 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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 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 or T3 instances only.

  • CpuCredits (string) -- [REQUIRED]

    The credit option for CPU usage of a T2 or T3 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.

    • CapacityReservationId (string) --

      The ID of the Capacity Reservation.

• 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

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'|'gp2'|'sc1'|'st1'
                    },
                    'NoDevice': 'string'
                },
            ],
            'NetworkInterfaces': [
                {
                    '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'
                },
            ],
            '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
            'KeyName': 'string',
            'Monitoring': {
                'Enabled': True|False
            },
            'Placement': {
                'AvailabilityZone': 'string',
                'Affinity': 'string',
                'GroupName': 'string',
                'HostId': 'string',
                'Tenancy': 'default'|'dedicated'|'host',
                'SpreadDomain': 'string',
                'HostResourceGroupArn': 'string'
            },
            'RamDiskId': 'string',
            'DisableApiTermination': True|False,
            'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
            'UserData': 'string',
            'TagSpecifications': [
                {
                    'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
                    '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'
                }
            },
            'LicenseSpecifications': [
                {
                    'LicenseConfigurationArn': 'string'
                },
            ],
            'HibernationOptions': {
                'Configured': True|False
            }
        }
    }
}

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 AWS Key Management Service (AWS 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.

          • NoDevice (string) --

            Suppresses the specified device included in the block device mapping of the AMI.

      • NetworkInterfaces (list) --

        The network interfaces.

        • (dict) --

          Describes a network interface.

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

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

      • 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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 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 or T3 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.

          • CapacityReservationId (string) --

            The ID of the Capacity Reservation.

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

{'LaunchTemplateVersions': {'LaunchTemplateData': {'ElasticInferenceAccelerators': {'Count': 'integer'}}}}

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.

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. 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 Versions:

list

param Versions:

One or more versions of the launch template.

• (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. The filters supported by a describe operation are documented with the describe operation. For example:

  • DescribeAvailabilityZones

  • DescribeImages

  • DescribeInstances

  • DescribeKeyPairs

  • DescribeSecurityGroups

  • DescribeSnapshots

  • DescribeSubnets

  • DescribeTags

  • DescribeVolumes

  • DescribeVpcs

  • 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'|'gp2'|'sc1'|'st1'
                        },
                        'NoDevice': 'string'
                    },
                ],
                'NetworkInterfaces': [
                    {
                        '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'
                    },
                ],
                '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
                'KeyName': 'string',
                'Monitoring': {
                    'Enabled': True|False
                },
                'Placement': {
                    'AvailabilityZone': 'string',
                    'Affinity': 'string',
                    'GroupName': 'string',
                    'HostId': 'string',
                    'Tenancy': 'default'|'dedicated'|'host',
                    'SpreadDomain': 'string',
                    'HostResourceGroupArn': 'string'
                },
                'RamDiskId': 'string',
                'DisableApiTermination': True|False,
                'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
                'UserData': 'string',
                'TagSpecifications': [
                    {
                        'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
                        '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'
                    }
                },
                'LicenseSpecifications': [
                    {
                        'LicenseConfigurationArn': 'string'
                    },
                ],
                'HibernationOptions': {
                    'Configured': 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 AWS Key Management Service (AWS 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.

            • NoDevice (string) --

              Suppresses the specified device included in the block device mapping of the AMI.

        • NetworkInterfaces (list) --

          The network interfaces.

          • (dict) --

            Describes a network interface.

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

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

        • 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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 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 or T3 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.

            • CapacityReservationId (string) --

              The ID of the Capacity Reservation.

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

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

{'LaunchTemplateData': {'ElasticInferenceAccelerators': {'Count': 'integer'}}}

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

See also: AWS API Documentation

Request Syntax

client.get_launch_template_data(
    DryRun=True|False,
    InstanceId='string'
)

type DryRun:

boolean

param DryRun:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The ID of the instance.

rtype:

dict

returns:

Response Syntax

{
    'LaunchTemplateData': {
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                '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'
            },
        ],
        '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string',
            'HostResourceGroupArn': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
                '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'
            }
        },
        'LicenseSpecifications': [
            {
                'LicenseConfigurationArn': 'string'
            },
        ],
        'HibernationOptions': {
            'Configured': True|False
        }
    }
}

Response Structure

• (dict) --

  • LaunchTemplateData (dict) --

    The instance data.

    • KernelId (string) --

      The ID of the kernel, if applicable.

    • EbsOptimized (boolean) --

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

    • IamInstanceProfile (dict) --

      The IAM instance profile.

      • Arn (string) --

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

      • Name (string) --

        The name of the instance profile.

    • BlockDeviceMappings (list) --

      The block device mappings.

      • (dict) --

        Describes a block device mapping.

        • DeviceName (string) --

          The device name.

        • VirtualName (string) --

          The virtual device name (ephemeralN).

        • Ebs (dict) --

          Information about the block device for an EBS volume.

          • Encrypted (boolean) --

            Indicates whether the EBS volume is encrypted.

          • DeleteOnTermination (boolean) --

            Indicates whether the EBS volume is deleted on instance termination.

          • Iops (integer) --

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

          • KmsKeyId (string) --

            The ARN of the AWS Key Management Service (AWS 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.

        • NoDevice (string) --

          Suppresses the specified device included in the block device mapping of the AMI.

    • NetworkInterfaces (list) --

      The network interfaces.

      • (dict) --

        Describes a network interface.

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

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

    • 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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 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 or T3 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.

        • CapacityReservationId (string) --

          The ID of the Capacity Reservation.

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

{'ElasticInferenceAccelerators': {'Count': 'integer'}}

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

• [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

• [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

• Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.

• [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

• Not all instance types support IPv6 addresses. For more information, see Instance Types.

• If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.

• If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

client.run_instances(
    BlockDeviceMappings=[
        {
            'DeviceName': 'string',
            'VirtualName': 'string',
            'Ebs': {
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1',
                'Encrypted': True|False,
                'KmsKeyId': 'string'
            },
            'NoDevice': 'string'
        },
    ],
    ImageId='string',
    InstanceType='t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
    Ipv6AddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string'
        },
    ],
    KernelId='string',
    KeyName='string',
    MaxCount=123,
    MinCount=123,
    Monitoring={
        'Enabled': True|False
    },
    Placement={
        'AvailabilityZone': 'string',
        'Affinity': 'string',
        'GroupName': 'string',
        'PartitionNumber': 123,
        'HostId': 'string',
        'Tenancy': 'default'|'dedicated'|'host',
        'SpreadDomain': 'string',
        'HostResourceGroupArn': 'string'
    },
    RamdiskId='string',
    SecurityGroupIds=[
        'string',
    ],
    SecurityGroups=[
        'string',
    ],
    SubnetId='string',
    UserData='string',
    AdditionalInfo='string',
    ClientToken='string',
    DisableApiTermination=True|False,
    DryRun=True|False,
    EbsOptimized=True|False,
    IamInstanceProfile={
        'Arn': 'string',
        'Name': 'string'
    },
    InstanceInitiatedShutdownBehavior='stop'|'terminate',
    NetworkInterfaces=[
        {
            'AssociatePublicIpAddress': True|False,
            'DeleteOnTermination': True|False,
            'Description': 'string',
            'DeviceIndex': 123,
            'Groups': [
                'string',
            ],
            'Ipv6AddressCount': 123,
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string'
                },
            ],
            'NetworkInterfaceId': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Primary': True|False,
                    'PrivateIpAddress': 'string'
                },
            ],
            'SecondaryPrivateIpAddressCount': 123,
            'SubnetId': 'string',
            'InterfaceType': 'string'
        },
    ],
    PrivateIpAddress='string',
    ElasticGpuSpecification=[
        {
            'Type': 'string'
        },
    ],
    ElasticInferenceAccelerators=[
        {
            'Type': 'string',
            'Count': 123
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': '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'
        }
    },
    HibernationOptions={
        'Configured': True|False
    },
    LicenseSpecifications=[
        {
            'LicenseConfigurationArn': 'string'
        },
    ],
    MetadataOptions={
        'HttpTokens': 'optional'|'required',
        'HttpPutResponseHopLimit': 123,
        'HttpEndpoint': 'disabled'|'enabled'
    }
)

type BlockDeviceMappings:

list

param BlockDeviceMappings:

The block device mapping entries.

• (dict) --

  Describes a block device mapping.

  • DeviceName (string) --

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

  • VirtualName (string) --

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

    NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

  • Ebs (dict) --

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

    • DeleteOnTermination (boolean) --

      Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.

    • Iops (integer) --

      The number of I/O operations per second (IOPS) that the volume supports. For io1 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. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

      Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

    • SnapshotId (string) --

      The ID of the snapshot.

    • VolumeSize (integer) --

      The size of the volume, in GiB.

      Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

      Constraints: 1-16384 for General Purpose SSD ( gp2), 4-16384 for Provisioned IOPS SSD ( io1), 500-16384 for Throughput Optimized HDD ( st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic ( standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

    • VolumeType (string) --

      The volume type. If you set the type to io1, you must also specify the IOPS that the volume supports.

      Default: gp2

    • Encrypted (boolean) --

      Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

      In no case can you remove encryption from an encrypted volume.

      Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

    • KmsKeyId (string) --

      Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

      This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

  • NoDevice (string) --

    Suppresses the specified device included in the block device mapping of the AMI.

type ImageId:

string

param ImageId:

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

type InstanceType:

string

param InstanceType:

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

Default: m1.small

type Ipv6AddressCount:

integer

param Ipv6AddressCount:

[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

type Ipv6Addresses:

list

param Ipv6Addresses:

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

• (dict) --

  Describes an IPv6 address.

  • Ipv6Address (string) --

    The IPv6 address.

type KernelId:

string

param KernelId:

The ID of the kernel.

type KeyName:

string

param KeyName:

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

type MaxCount:

integer

param MaxCount:

[REQUIRED]

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

type MinCount:

integer

param MinCount:

[REQUIRED]

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

type Monitoring:

dict

param Monitoring:

Specifies whether detailed monitoring is enabled for the instance.

• Enabled (boolean) -- [REQUIRED]

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

type Placement:

dict

param Placement:

The placement for the instance.

• AvailabilityZone (string) --

  The Availability Zone of the instance.

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

• Affinity (string) --

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

• GroupName (string) --

  The name of the placement group the instance is in.

• PartitionNumber (integer) --

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

• HostId (string) --

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

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

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

type RamdiskId:

string

param RamdiskId:

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.

type SecurityGroupIds:

list

param SecurityGroupIds:

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

• (string) --

type SecurityGroups:

list

param SecurityGroups:

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.

• (string) --

type SubnetId:

string

param SubnetId:

[EC2-VPC] The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface.

type UserData:

string

param UserData:

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

type AdditionalInfo:

string

param AdditionalInfo:

Reserved.

type ClientToken:

string

param ClientToken:

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

Constraints: Maximum 64 ASCII characters

type DisableApiTermination:

boolean

param DisableApiTermination:

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.

Default: 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 EbsOptimized:

boolean

param EbsOptimized:

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.

Default: false

type IamInstanceProfile:

dict

param IamInstanceProfile:

The IAM instance profile.

• Arn (string) --

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

• Name (string) --

  The name of the instance profile.

type InstanceInitiatedShutdownBehavior:

string

param InstanceInitiatedShutdownBehavior:

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

Default: stop

type NetworkInterfaces:

list

param NetworkInterfaces:

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

• (dict) --

  Describes a network interface.

  • AssociatePublicIpAddress (boolean) --

    Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

  • DeleteOnTermination (boolean) --

    If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

  • Description (string) --

    The description of the network interface. Applies only if creating a network interface when launching an instance.

  • DeviceIndex (integer) --

    The position of the network interface in the attachment order. A primary network interface has a device index of 0.

    If you specify a network interface when launching an instance, you must specify the device index.

  • Groups (list) --

    The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

    • (string) --

  • Ipv6AddressCount (integer) --

    A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

  • Ipv6Addresses (list) --

    One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

    • (dict) --

      Describes an IPv6 address.

      • Ipv6Address (string) --

        The IPv6 address.

  • NetworkInterfaceId (string) --

    The ID of the network interface.

  • PrivateIpAddress (string) --

    The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

  • PrivateIpAddresses (list) --

    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

    • (dict) --

      Describes a secondary private IPv4 address for a network interface.

      • Primary (boolean) --

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

      • PrivateIpAddress (string) --

        The private IPv4 addresses.

  • SecondaryPrivateIpAddressCount (integer) --

    The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

  • SubnetId (string) --

    The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

  • 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

type PrivateIpAddress:

string

param PrivateIpAddress:

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

type ElasticGpuSpecification:

list

param ElasticGpuSpecification:

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

• (dict) --

  A specification for an Elastic Graphics accelerator.

  • Type (string) -- [REQUIRED]

    The type of Elastic Graphics accelerator.

type ElasticInferenceAccelerators:

list

param ElasticInferenceAccelerators:

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

• (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 of given type to be attached to the instance. Only positive values allowed. If not specified defaults to 1.

type TagSpecifications:

list

param TagSpecifications:

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 to apply to a resource when the resource is being created.

  • ResourceType (string) --

    The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | fpga-image | instance | launch-template | snapshot | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | 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.

type LaunchTemplate:

dict

param LaunchTemplate:

The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

• LaunchTemplateId (string) --

  The ID of the launch template.

• LaunchTemplateName (string) --

  The name of the launch template.

• Version (string) --

  The version number of the launch template.

  Default: The default version for the launch template.

type InstanceMarketOptions:

dict

param InstanceMarketOptions:

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

• 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. The default is the On-Demand price.

  • SpotInstanceType (string) --

    The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

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

type CreditSpecification:

dict

param CreditSpecification:

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

• CpuCredits (string) -- [REQUIRED]

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

type CpuOptions:

dict

param CpuOptions:

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.

type CapacityReservationSpecification:

dict

param CapacityReservationSpecification:

Information about 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 as an On-Demand Instance.

• CapacityReservationTarget (dict) --

  Information about the target Capacity Reservation.

  • CapacityReservationId (string) --

    The ID of the Capacity Reservation.

type HibernationOptions:

dict

param HibernationOptions:

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

• Configured (boolean) --

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

  Default: false

type LicenseSpecifications:

list

param LicenseSpecifications:

The license configurations.

• (dict) --

  Describes a license configuration.

  • LicenseConfigurationArn (string) --

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

type MetadataOptions:

dict

param MetadataOptions:

The metadata options for the instance. For more information, see Instance Metadata and User Data.

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

rtype:

dict

returns:

Response Syntax

{
    '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'|'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'|'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'|'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'|'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'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'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'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'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'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge',
            'KernelId': 'string',
            'KeyName': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Monitoring': {
                'State': 'disabled'|'disabling'|'enabled'|'pending'
            },
            'Placement': {
                'AvailabilityZone': 'string',
                'Affinity': 'string',
                'GroupName': 'string',
                'PartitionNumber': 123,
                'HostId': 'string',
                'Tenancy': 'default'|'dedicated'|'host',
                'SpreadDomain': 'string',
                'HostResourceGroupArn': 'string'
            },
            'Platform': 'Windows',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'ProductCodes': [
                {
                    'ProductCodeId': 'string',
                    'ProductCodeType': 'devpay'|'marketplace'
                },
            ],
            'PublicDnsName': 'string',
            'PublicIpAddress': 'string',
            'RamdiskId': 'string',
            'State': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            },
            'StateTransitionReason': 'string',
            'SubnetId': 'string',
            'VpcId': 'string',
            'Architecture': 'i386'|'x86_64'|'arm64',
            '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': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentId': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'attaching'|'attached'|'detaching'|'detached'
                    },
                    'Description': 'string',
                    'Groups': [
                        {
                            'GroupName': 'string',
                            'GroupId': 'string'
                        },
                    ],
                    'Ipv6Addresses': [
                        {
                            'Ipv6Address': 'string'
                        },
                    ],
                    'MacAddress': 'string',
                    'NetworkInterfaceId': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddresses': [
                        {
                            'Association': {
                                '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'
                },
            ],
            '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'
                }
            },
            'HibernationOptions': {
                'Configured': True|False
            },
            'Licenses': [
                {
                    'LicenseConfigurationArn': 'string'
                },
            ],
            'MetadataOptions': {
                'State': 'pending'|'applied',
                'HttpTokens': 'optional'|'required',
                'HttpPutResponseHopLimit': 123,
                'HttpEndpoint': 'disabled'|'enabled'
            }
        },
    ],
    'OwnerId': 'string',
    'RequesterId': 'string',
    'ReservationId': 'string'
}

Response Structure

• (dict) --

  Describes a reservation.

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

        • Affinity (string) --

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

        • GroupName (string) --

          The name of the placement group the instance is in.

        • PartitionNumber (integer) --

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

        • HostId (string) --

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

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

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

      • 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 assigned to the instance, if applicable.

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

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

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

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

                • 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 to validate network traffic to or from this network interface.

          • 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

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

        Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. 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 NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

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

          • CapacityReservationId (string) --

            The ID of the Capacity Reservation.

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

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

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

  • OwnerId (string) --

    The ID of the AWS account that owns the reservation.

  • RequesterId (string) --

    The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

  • ReservationId (string) --

    The ID of the reservation.