Skip to content

aws.ec2.describe_instances

Example SQL Queries

SELECT * FROM
aws.ec2.describe_instances;

Description

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Table Definition

Column NameColumn Data Type
dry_run Input Column

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
filters Input Column

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64 | arm64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-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.

  • boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).

  • capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.

  • capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).

  • capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.

  • capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.

  • client-token - The idempotency token you provided when you launched the instance.

  • current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).

  • dns-name - The public DNS name of the instance.

  • ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.

  • enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.

  • iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.

  • 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, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • ipv6-address - The IPv6 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.

  • maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).

  • metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)

  • metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).

  • metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).

  • metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)

  • metadata-options.http-tokens - The metadata request authorization state (optional | required)

  • metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)

  • metadata-options.state - The state of the metadata option changes (pending | applied).

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.association.allocation-id - The allocation ID.

  • network-interface.addresses.association.association-id - The association ID.

  • network-interface.addresses.association.carrier-ip - The carrier IP address.

  • network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.addresses.association.public-dns-name - The public DNS name.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.private-dns-name - The private DNS name.

  • network-interface.addresses.private-ip-address - The private IPv4 address 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.association.carrier-ip - The customer-owned IP address.

  • network-interface.association.customer-owned-ip - The customer-owned IP address.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.public-dns-name - The public DNS name.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • 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.network-card-index - The index of the network card.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.

  • 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.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

  • network-interface.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.

  • network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.

  • network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to 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.outpost-arn - The ARN of the Outpost.

  • 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.private-ip-address - The private IPv4 address.

  • network-interface.public-dns-name - The public DNS name.

  • network-interface.requester-id - The requester ID for the network interface.

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

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.tag-key - The key of a tag assigned to the network interface.

  • network-interface.tag-value - The value of a tag assigned to the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The Amazon Web Services account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows.

  • platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.

  • private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

  • private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).

  • private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).

  • usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).

  • usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

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

filters[].values[]
instance_ids Input Column

The instance IDs.

Default: Describes all your instances.

VARCHAR[]
Show child fields
instance_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
groups

Not supported.

STRUCT(
"group_name" VARCHAR,
"group_id" VARCHAR
)[]
Show child fields
groups[]
Show child fields
groups[].group_id

The ID of the security group.

groups[].group_name

The name of the security group.

instances

The instances.

STRUCT(
"ami_launch_index" BIGINT,
"image_id" VARCHAR,
"instance_id" VARCHAR,
"instance_type" VARCHAR,
"kernel_id" VARCHAR,
"key_name" VARCHAR,
"launch_time" TIMESTAMP_S,
"monitoring" STRUCT(
"state" VARCHAR
),
"placement" STRUCT(
"availability_zone" VARCHAR,
"affinity" VARCHAR,
"group_name" VARCHAR,
"partition_number" BIGINT,
"host_id" VARCHAR,
"tenancy" VARCHAR,
"spread_domain" VARCHAR,
"host_resource_group_arn" VARCHAR,
"group_id" VARCHAR
),
"platform" VARCHAR,
"private_dns_name" VARCHAR,
"private_ip_address" VARCHAR,
"product_codes" STRUCT(
"product_code_id" VARCHAR,
"product_code_type" VARCHAR
)[],
"public_dns_name" VARCHAR,
"public_ip_address" VARCHAR,
"ramdisk_id" VARCHAR,
"state" STRUCT(
"code" BIGINT,
"name" VARCHAR
),
"state_transition_reason" VARCHAR,
"subnet_id" VARCHAR,
"vpc_id" VARCHAR,
"architecture" VARCHAR,
"block_device_mappings" STRUCT(
"device_name" VARCHAR,
"ebs" STRUCT(
"attach_time" TIMESTAMP_S,
"delete_on_termination" BOOLEAN,
"status" VARCHAR,
"volume_id" VARCHAR,
"associated_resource" VARCHAR,
"volume_owner_id" VARCHAR
)
)[],
"client_token" VARCHAR,
"ebs_optimized" BOOLEAN,
"ena_support" BOOLEAN,
"hypervisor" VARCHAR,
"iam_instance_profile" STRUCT(
"arn" VARCHAR,
"id" VARCHAR
),
"instance_lifecycle" VARCHAR,
"elastic_gpu_associations" STRUCT(
"elastic_gpu_id" VARCHAR,
"elastic_gpu_association_id" VARCHAR,
"elastic_gpu_association_state" VARCHAR,
"elastic_gpu_association_time" VARCHAR
)[],
"elastic_inference_accelerator_associations" STRUCT(
"elastic_inference_accelerator_arn" VARCHAR,
"elastic_inference_accelerator_association_id" VARCHAR,
"elastic_inference_accelerator_association_state" VARCHAR,
"elastic_inference_accelerator_association_time" TIMESTAMP_S
)[],
"network_interfaces" STRUCT(
"association" STRUCT(
"carrier_ip" VARCHAR,
"customer_owned_ip" VARCHAR,
"ip_owner_id" VARCHAR,
"public_dns_name" VARCHAR,
"public_ip" VARCHAR
),
"attachment" STRUCT(
"attach_time" TIMESTAMP_S,
"attachment_id" VARCHAR,
"delete_on_termination" BOOLEAN,
"device_index" BIGINT,
"status" VARCHAR,
"network_card_index" BIGINT,
"ena_srd_specification" STRUCT(
"ena_srd_enabled" BOOLEAN,
"ena_srd_udp_specification" STRUCT(
"ena_srd_udp_enabled" BOOLEAN
)
)
),
"description" VARCHAR,
"groups" STRUCT(
"group_name" VARCHAR,
"group_id" VARCHAR
)[],
"ipv6_addresses" STRUCT(
"ipv6_address" VARCHAR,
"is_primary_ipv6" BOOLEAN
)[],
"mac_address" VARCHAR,
"network_interface_id" VARCHAR,
"owner_id" VARCHAR,
"private_dns_name" VARCHAR,
"private_ip_address" VARCHAR,
"private_ip_addresses" STRUCT(
"association" STRUCT(
"carrier_ip" VARCHAR,
"customer_owned_ip" VARCHAR,
"ip_owner_id" VARCHAR,
"public_dns_name" VARCHAR,
"public_ip" VARCHAR
),
"primary" BOOLEAN,
"private_dns_name" VARCHAR,
"private_ip_address" VARCHAR
)[],
"source_dest_check" BOOLEAN,
"status" VARCHAR,
"subnet_id" VARCHAR,
"vpc_id" VARCHAR,
"interface_type" VARCHAR,
"ipv4_prefixes" STRUCT(
"ipv4_prefix" VARCHAR
)[],
"ipv6_prefixes" STRUCT(
"ipv6_prefix" VARCHAR
)[],
"connection_tracking_configuration" STRUCT(
"tcp_established_timeout" BIGINT,
"udp_stream_timeout" BIGINT,
"udp_timeout" BIGINT
)
)[],
"outpost_arn" VARCHAR,
"root_device_name" VARCHAR,
"root_device_type" VARCHAR,
"security_groups" STRUCT(
"group_name" VARCHAR,
"group_id" VARCHAR
)[],
"source_dest_check" BOOLEAN,
"spot_instance_request_id" VARCHAR,
"sriov_net_support" VARCHAR,
"state_reason" STRUCT(
"code" VARCHAR,
"message" VARCHAR
),
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"virtualization_type" VARCHAR,
"cpu_options" STRUCT(
"core_count" BIGINT,
"threads_per_core" BIGINT,
"amd_sev_snp" VARCHAR
),
"capacity_reservation_id" VARCHAR,
"capacity_reservation_specification" STRUCT(
"capacity_reservation_preference" VARCHAR,
"capacity_reservation_target" STRUCT(
"capacity_reservation_id" VARCHAR,
"capacity_reservation_resource_group_arn" VARCHAR
)
),
"hibernation_options" STRUCT(
"configured" BOOLEAN
),
"licenses" STRUCT(
"license_configuration_arn" VARCHAR
)[],
"metadata_options" STRUCT(
"state" VARCHAR,
"http_tokens" VARCHAR,
"http_put_response_hop_limit" BIGINT,
"http_endpoint" VARCHAR,
"http_protocol_ipv6" VARCHAR,
"instance_metadata_tags" VARCHAR
),
"enclave_options" STRUCT(
"enabled" BOOLEAN
),
"boot_mode" VARCHAR,
"platform_details" VARCHAR,
"usage_operation" VARCHAR,
"usage_operation_update_time" TIMESTAMP_S,
"private_dns_name_options" STRUCT(
"hostname_type" VARCHAR,
"enable_resource_name_dns_a_record" BOOLEAN,
"enable_resource_name_dns_aaaa_record" BOOLEAN
),
"ipv6_address" VARCHAR,
"tpm_support" VARCHAR,
"maintenance_options" STRUCT(
"auto_recovery" VARCHAR
),
"current_instance_boot_mode" VARCHAR
)[]
Show child fields
instances[]
Show child fields
instances[].ami_launch_index

The AMI launch index, which can be used to find this instance in the launch group.

instances[].architecture

The architecture of the image.

instances[].block_device_mappings[]
Show child fields
instances[].block_device_mappings[].device_name

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

instances[].block_device_mappings[].ebs

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

Show child fields
instances[].block_device_mappings[].ebs.associated_resource

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

instances[].block_device_mappings[].ebs.attach_time

The time stamp when the attachment initiated.

instances[].block_device_mappings[].ebs.delete_on_termination

Indicates whether the volume is deleted on instance termination.

instances[].block_device_mappings[].ebs.status

The attachment state.

instances[].block_device_mappings[].ebs.volume_id

The ID of the EBS volume.

instances[].block_device_mappings[].ebs.volume_owner_id

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

This parameter is returned only for volumes that are attached to Fargate tasks.

instances[].boot_mode

The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

instances[].capacity_reservation_id

The ID of the Capacity Reservation.

instances[].capacity_reservation_specification

Information about the Capacity Reservation targeting option.

Show child fields
instances[].capacity_reservation_specification.capacity_reservation_preference

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.

instances[].capacity_reservation_specification.capacity_reservation_target

Information about the targeted Capacity Reservation or Capacity Reservation group.

Show child fields
instances[].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_id

The ID of the targeted Capacity Reservation.

instances[].capacity_reservation_specification.capacity_reservation_target.capacity_reservation_resource_group_arn

The ARN of the targeted Capacity Reservation group.

instances[].client_token

The idempotency token you provided when you launched the instance, if applicable.

instances[].cpu_options

The CPU options for the instance.

Show child fields
instances[].cpu_options.amd_sev_snp

Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.

instances[].cpu_options.core_count

The number of CPU cores for the instance.

instances[].cpu_options.threads_per_core

The number of threads per CPU core.

instances[].current_instance_boot_mode

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

instances[].ebs_optimized

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.

instances[].elastic_gpu_associations[]
Show child fields
instances[].elastic_gpu_associations[].elastic_gpu_association_id

The ID of the association.

instances[].elastic_gpu_associations[].elastic_gpu_association_state

The state of the association between the instance and the Elastic Graphics accelerator.

instances[].elastic_gpu_associations[].elastic_gpu_association_time

The time the Elastic Graphics accelerator was associated with the instance.

instances[].elastic_gpu_associations[].elastic_gpu_id

The ID of the Elastic Graphics accelerator.

instances[].elastic_inference_accelerator_associations[]
Show child fields
instances[].elastic_inference_accelerator_associations[].elastic_inference_accelerator_arn

The Amazon Resource Name (ARN) of the elastic inference accelerator.

instances[].elastic_inference_accelerator_associations[].elastic_inference_accelerator_association_id

The ID of the association.

instances[].elastic_inference_accelerator_associations[].elastic_inference_accelerator_association_state

The state of the elastic inference accelerator.

instances[].elastic_inference_accelerator_associations[].elastic_inference_accelerator_association_time

The time at which the elastic inference accelerator is associated with an instance.

instances[].ena_support

Specifies whether enhanced networking with ENA is enabled.

instances[].enclave_options

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

Show child fields
instances[].enclave_options.enabled

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

instances[].hibernation_options

Indicates whether the instance is enabled for hibernation.

Show child fields
instances[].hibernation_options.configured

If true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

instances[].hypervisor

The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

instances[].iam_instance_profile

The IAM instance profile associated with the instance, if applicable.

Show child fields
instances[].iam_instance_profile.arn

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

instances[].iam_instance_profile.id

The ID of the instance profile.

instances[].image_id

The ID of the AMI used to launch the instance.

instances[].instance_id

The ID of the instance.

instances[].instance_lifecycle

Indicates whether this is a Spot Instance or a Scheduled Instance.

instances[].instance_type

The instance type.

instances[].ipv6_address

The IPv6 address assigned to the instance.

instances[].kernel_id

The kernel associated with this instance, if applicable.

instances[].key_name

The name of the key pair, if this instance was launched with an associated key pair.

instances[].launch_time

The time the instance was launched.

instances[].licenses[]
Show child fields
instances[].licenses[].license_configuration_arn

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

instances[].maintenance_options

Provides information on the recovery and maintenance options of your instance.

Show child fields
instances[].maintenance_options.auto_recovery

Provides information on the current automatic recovery behavior of your instance.

instances[].metadata_options

The metadata options for the instance.

Show child fields
instances[].metadata_options.http_endpoint

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

instances[].metadata_options.http_protocol_ipv6

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Default: disabled

instances[].metadata_options.http_put_response_hop_limit

The maximum number of hops that the metadata token can travel.

Possible values: Integers from 1 to 64

instances[].metadata_options.http_tokens

Indicates whether IMDSv2 is required.

  • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

  • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

instances[].metadata_options.instance_metadata_tags

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

instances[].metadata_options.state

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.

instances[].monitoring

The monitoring for the instance.

Show child fields
instances[].monitoring.state

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

instances[].network_interfaces[]
Show child fields
instances[].network_interfaces[].association

The association information for an Elastic IPv4 associated with the network interface.

Show child fields
instances[].network_interfaces[].association.carrier_ip

The carrier IP address associated with the network interface.

instances[].network_interfaces[].association.customer_owned_ip

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

instances[].network_interfaces[].association.ip_owner_id

The ID of the owner of the Elastic IP address.

instances[].network_interfaces[].association.public_dns_name

The public DNS name.

instances[].network_interfaces[].association.public_ip

The public IP address or Elastic IP address bound to the network interface.

instances[].network_interfaces[].attachment

The network interface attachment.

Show child fields
instances[].network_interfaces[].attachment.attach_time

The time stamp when the attachment initiated.

instances[].network_interfaces[].attachment.attachment_id

The ID of the network interface attachment.

instances[].network_interfaces[].attachment.delete_on_termination

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

instances[].network_interfaces[].attachment.device_index

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

instances[].network_interfaces[].attachment.ena_srd_specification

Contains the ENA Express settings for the network interface that's attached to the instance.

Show child fields
instances[].network_interfaces[].attachment.ena_srd_specification.ena_srd_enabled

Indicates whether ENA Express is enabled for the network interface.

instances[].network_interfaces[].attachment.ena_srd_specification.ena_srd_udp_specification

Configures ENA Express for UDP network traffic.

Show child fields
instances[].network_interfaces[].attachment.ena_srd_specification.ena_srd_udp_specification.ena_srd_udp_enabled

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.

instances[].network_interfaces[].attachment.network_card_index

The index of the network card.

instances[].network_interfaces[].attachment.status

The attachment state.

instances[].network_interfaces[].connection_tracking_configuration

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.

Show child fields
instances[].network_interfaces[].connection_tracking_configuration.tcp_established_timeout

Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.

instances[].network_interfaces[].connection_tracking_configuration.udp_stream_timeout

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.

instances[].network_interfaces[].connection_tracking_configuration.udp_timeout

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

instances[].network_interfaces[].description

The description.

instances[].network_interfaces[].groups[]
Show child fields
instances[].network_interfaces[].groups[].group_id

The ID of the security group.

instances[].network_interfaces[].groups[].group_name

The name of the security group.

instances[].network_interfaces[].interface_type

The type of network interface.

Valid values: interface | efa | trunk

instances[].network_interfaces[].ipv4_prefixes[]
Show child fields
instances[].network_interfaces[].ipv4_prefixes[].ipv4_prefix

One or more IPv4 prefixes assigned to the network interface.

instances[].network_interfaces[].ipv6_addresses[]
Show child fields
instances[].network_interfaces[].ipv6_addresses[].ipv6_address

The IPv6 address.

instances[].network_interfaces[].ipv6_addresses[].is_primary_ipv6

Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.

instances[].network_interfaces[].ipv6_prefixes[]
Show child fields
instances[].network_interfaces[].ipv6_prefixes[].ipv6_prefix

One or more IPv6 prefixes assigned to the network interface.

instances[].network_interfaces[].mac_address

The MAC address.

instances[].network_interfaces[].network_interface_id

The ID of the network interface.

instances[].network_interfaces[].owner_id

The ID of the Amazon Web Services account that created the network interface.

instances[].network_interfaces[].private_dns_name

The private DNS name.

instances[].network_interfaces[].private_ip_address

The IPv4 address of the network interface within the subnet.

instances[].network_interfaces[].private_ip_addresses[]
Show child fields
instances[].network_interfaces[].private_ip_addresses[].association

The association information for an Elastic IP address for the network interface.

Show child fields
instances[].network_interfaces[].private_ip_addresses[].association.carrier_ip

The carrier IP address associated with the network interface.

instances[].network_interfaces[].private_ip_addresses[].association.customer_owned_ip

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

instances[].network_interfaces[].private_ip_addresses[].association.ip_owner_id

The ID of the owner of the Elastic IP address.

instances[].network_interfaces[].private_ip_addresses[].association.public_dns_name

The public DNS name.

instances[].network_interfaces[].private_ip_addresses[].association.public_ip

The public IP address or Elastic IP address bound to the network interface.

instances[].network_interfaces[].private_ip_addresses[].primary

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

instances[].network_interfaces[].private_ip_addresses[].private_dns_name

The private IPv4 DNS name.

instances[].network_interfaces[].private_ip_addresses[].private_ip_address

The private IPv4 address of the network interface.

instances[].network_interfaces[].source_dest_check

Indicates whether source/destination checking is enabled.

instances[].network_interfaces[].status

The status of the network interface.

instances[].network_interfaces[].subnet_id

The ID of the subnet.

instances[].network_interfaces[].vpc_id

The ID of the VPC.

instances[].outpost_arn

The Amazon Resource Name (ARN) of the Outpost.

instances[].placement

The location where the instance launched, if applicable.

Show child fields
instances[].placement.affinity

The affinity setting for the instance on the Dedicated Host.

This parameter is not supported for CreateFleet or ImportInstance.

instances[].placement.availability_zone

The Availability Zone of the instance.

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

This parameter is not supported for CreateFleet.

instances[].placement.group_id

The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.

instances[].placement.group_name

The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

instances[].placement.host_id

The ID of the Dedicated Host on which the instance resides.

This parameter is not supported for CreateFleet or ImportInstance.

instances[].placement.host_resource_group_arn

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

If you specify this parameter, either omit the Tenancy parameter or set it to host.

This parameter is not supported for CreateFleet.

instances[].placement.partition_number

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

This parameter is not supported for CreateFleet.

instances[].placement.spread_domain

Reserved for future use.

instances[].placement.tenancy

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

instances[].platform

The platform. This value is windows for Windows instances; otherwise, it is empty.

instances[].platform_details

The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

instances[].private_dns_name

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

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.

instances[].private_dns_name_options

The options for the instance hostname.

Show child fields
instances[].private_dns_name_options.enable_resource_name_dns_a_record

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

instances[].private_dns_name_options.enable_resource_name_dns_aaaa_record

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

instances[].private_dns_name_options.hostname_type

The type of hostname to assign to an instance.

instances[].private_ip_address

The private IPv4 address assigned to the instance.

instances[].product_codes[]
Show child fields
instances[].product_codes[].product_code_id

The product code.

instances[].product_codes[].product_code_type

The type of product code.

instances[].public_dns_name

[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.

instances[].public_ip_address

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

instances[].ramdisk_id

The RAM disk associated with this instance, if applicable.

instances[].root_device_name

The device name of the root device volume (for example, /dev/sda1).

instances[].root_device_type

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

instances[].security_groups[]
Show child fields
instances[].security_groups[].group_id

The ID of the security group.

instances[].security_groups[].group_name

The name of the security group.

instances[].source_dest_check

Indicates whether source/destination checking is enabled.

instances[].spot_instance_request_id

If the request is a Spot Instance request, the ID of the request.

instances[].sriov_net_support

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

instances[].state

The current state of the instance.

Show child fields
instances[].state.code

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.

instances[].state.name

The current state of the instance.

instances[].state_reason

The reason for the most recent state transition.

Show child fields
instances[].state_reason.code

The reason code for the state change.

instances[].state_reason.message

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 from the operating system of 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.

instances[].state_transition_reason

The reason for the most recent state transition. This might be an empty string.

instances[].subnet_id

The ID of the subnet in which the instance is running.

instances[].tags[]
Show child fields
instances[].tags[].key

The key of the tag.

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

instances[].tags[].value

The value of the tag.

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

instances[].tpm_support

If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

instances[].usage_operation

The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

instances[].usage_operation_update_time

The time that the usage operation was last updated.

instances[].virtualization_type

The virtualization type of the instance.

instances[].vpc_id

The ID of the VPC in which the instance is running.

owner_id

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

VARCHAR
requester_id

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

VARCHAR
reservation_id

The ID of the reservation.

VARCHAR