2018/05/08 - Amazon Elastic Compute Cloud - 2 updated api methods
Changes Enable support for specifying CPU options during instance launch.
{'Reservations': {'Instances': {'CpuOptions': {'CoreCount': 'integer',
'ThreadsPerCore': 'integer'}}}}
Describes one or more of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
See also: AWS API Documentation
Request Syntax
client.describe_instances(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
InstanceIds=[
'string',
],
DryRun=True|False,
MaxResults=123,
NextToken='string'
)
list
One or more filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host ).
architecture - The instance architecture (i386 | x86_64 ).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z .
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh ).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached ).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen ).
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled ).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped ).
instance-type - The type of instance (for example, t2.micro ).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled ).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached ).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available ) | in-use ).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace ).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1 ).
root-device-type - The type of the root device volume (ebs | instance-store ).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag :key =*value* - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of the tag's key). If you want to list only resources where Purpose is X, see the tag :key =*value* filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
tenancy - The tenancy of an instance (dedicated | default | host ).
virtualization-type - The virtualization type of the instance (paravirtual | hvm ).
vpc-id - The ID of the VPC that the instance is running in.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. 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) --
One or more filter values. Filter values are case-sensitive.
(string) --
list
One or more instance IDs.
Default: Describes all your instances.
(string) --
boolean
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 .
integer
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.
string
The token to request the next page of results.
dict
Response Syntax
{
'Reservations': [
{
'Groups': [
{
'GroupName': 'string',
'GroupId': 'string'
},
],
'Instances': [
{
'AmiLaunchIndex': 123,
'ImageId': 'string',
'InstanceId': 'string',
'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'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'|'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'|'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.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.12xlarge'|'m5.24xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge',
'KernelId': 'string',
'KeyName': 'string',
'LaunchTime': datetime(2015, 1, 1),
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': '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',
'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'
},
],
'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'
},
],
'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
}
},
],
'OwnerId': 'string',
'RequesterId': 'string',
'ReservationId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the output of DescribeInstances.
Reservations (list) --
Zero or more reservations.
(dict) --
Describes a reservation.
Groups (list) --
[EC2-Classic only] 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.
Instances (list) --
One or more 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.
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 (for cluster compute instances).
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.
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 low byte represents the state. The high byte is an opaque internal value and should be ignored.
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
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 GPU.
ElasticGpuId (string) --
The ID of the Elastic GPU.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic GPU.
ElasticGpuAssociationTime (string) --
The time the Elastic GPU was associated with the instance.
NetworkInterfaces (list) --
[EC2-VPC] One or more 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.
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) --
One or more 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 instance capacity to satisfy the launch request.
Server.InternalError : An internal error occurred during instance launch, resulting in termination.
Server.ScheduledStop : The instance was stopped due to a scheduled retirement.
Server.SpotInstanceTermination : A Spot Instance was terminated due to an increase in the Spot price.
Client.InternalError : A client error caused the instance to terminate on launch.
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.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 limits.
Client.InvalidSnapshot.NotFound : The specified snapshot was not found.
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.
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.
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.
{'CpuOptions': {'CoreCount': 'integer', 'ThreadsPerCore': 'integer'}}
Response {'Instances': {'CpuOptions': {'CoreCount': 'integer',
'ThreadsPerCore': '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': {
'Encrypted': True|False,
'DeleteOnTermination': True|False,
'Iops': 123,
'KmsKeyId': 'string',
'SnapshotId': 'string',
'VolumeSize': 123,
'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
},
'NoDevice': 'string'
},
],
ImageId='string',
InstanceType='t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.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'|'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'|'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.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.12xlarge'|'m5.24xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge',
Ipv6AddressCount=123,
Ipv6Addresses=[
{
'Ipv6Address': 'string'
},
],
KernelId='string',
KeyName='string',
MaxCount=123,
MinCount=123,
Monitoring={
'Enabled': True|False
},
Placement={
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': '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'
},
],
PrivateIpAddress='string',
ElasticGpuSpecification=[
{
'Type': 'string'
},
],
TagSpecifications=[
{
'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'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
}
)
list
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
(dict) --
Describes a block device mapping.
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.
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.
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. This is because only blank volumes can be encrypted on creation.
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 .
Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
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) --
Identifier (key ID, key alias, ID ARN, or alias ARN) for a user-managed CMK under which the EBS volume is encrypted.
Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances , RequestSpotFleet , and RequestSpotInstances .
SnapshotId (string) --
The ID of the snapshot.
VolumeSize (integer) --
The size of the volume, in GiB.
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.
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: gp2 , io1 , st1 , sc1 , or standard .
Default: standard
NoDevice (string) --
Suppresses the specified device included in the block device mapping of the AMI.
string
The ID of the AMI, which you can get by calling DescribeImages . An AMI is required to launch an instance and must be specified here or in a launch template.
string
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .
Default: m1.small
integer
[EC2-VPC] A 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.
list
[EC2-VPC] Specify one or more 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.
(dict) --
Describes an IPv6 address.
Ipv6Address (string) --
The IPv6 address.
string
The ID of the kernel.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide .
string
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
Warning
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
integer
[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.
integer
[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.
dict
The monitoring for the instance.
Enabled (boolean) -- [REQUIRED]
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
dict
The placement for the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
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 (for cluster compute instances).
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.
string
The ID of the RAM disk.
Warning
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide .
list
One or more security group IDs. You can create a security group using CreateSecurityGroup .
Default: Amazon EC2 uses the default security group.
(string) --
list
[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
Default: Amazon EC2 uses the default security group.
(string) --
string
[EC2-VPC] The ID of the subnet to launch the instance into.
string
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.
string
Reserved.
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency .
Constraints: Maximum 64 ASCII characters
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 to false 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
boolean
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 .
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.
Default: false
dict
The IAM instance profile.
Arn (string) --
The Amazon Resource Name (ARN) of the instance profile.
Name (string) --
The name of the instance profile.
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
list
One or more network interfaces.
(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 index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide 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) -- [REQUIRED]
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 string. Applies only if creating a network interface when launching an instance.
string
[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.
list
An elastic GPU to associate with the instance.
(dict) --
A specification for an Elastic GPU.
Type (string) -- [REQUIRED]
The type of Elastic GPU.
list
The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.
(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 instance and volume .
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.
dict
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.
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. The default is the On-Demand price.
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 .
dict
The credit option for CPU usage of the instance. Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see T2 Instances in the Amazon Elastic Compute Cloud User Guide .
Default: standard
CpuCredits (string) -- [REQUIRED]
The credit option for CPU usage of a T2 instance. Valid values are standard and unlimited .
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 Intel Hyper-Threading Technology for the instance, specify a value of 1 . Otherwise, specify the default value of 2 .
dict
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'|'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'|'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'|'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.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.12xlarge'|'m5.24xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge',
'KernelId': 'string',
'KeyName': 'string',
'LaunchTime': datetime(2015, 1, 1),
'Monitoring': {
'State': 'disabled'|'disabling'|'enabled'|'pending'
},
'Placement': {
'AvailabilityZone': 'string',
'Affinity': 'string',
'GroupName': 'string',
'HostId': 'string',
'Tenancy': 'default'|'dedicated'|'host',
'SpreadDomain': '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',
'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'
},
],
'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'
},
],
'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
}
},
],
'OwnerId': 'string',
'RequesterId': 'string',
'ReservationId': 'string'
}
Response Structure
(dict) --
Describes a reservation.
Groups (list) --
[EC2-Classic only] 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.
Instances (list) --
One or more 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.
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 (for cluster compute instances).
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.
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 low byte represents the state. The high byte is an opaque internal value and should be ignored.
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
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 GPU.
ElasticGpuId (string) --
The ID of the Elastic GPU.
ElasticGpuAssociationId (string) --
The ID of the association.
ElasticGpuAssociationState (string) --
The state of the association between the instance and the Elastic GPU.
ElasticGpuAssociationTime (string) --
The time the Elastic GPU was associated with the instance.
NetworkInterfaces (list) --
[EC2-VPC] One or more 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.
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) --
One or more 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 instance capacity to satisfy the launch request.
Server.InternalError : An internal error occurred during instance launch, resulting in termination.
Server.ScheduledStop : The instance was stopped due to a scheduled retirement.
Server.SpotInstanceTermination : A Spot Instance was terminated due to an increase in the Spot price.
Client.InternalError : A client error caused the instance to terminate on launch.
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.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 limits.
Client.InvalidSnapshot.NotFound : The specified snapshot was not found.
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.
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.