Skip to content

aws.ec2.describe_network_interfaces

Example SQL Queries

SELECT * FROM
aws.ec2.describe_network_interfaces;

Description

Describes one or more of your network interfaces.

If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, private-dns-name, subnet-id, or vpc-id.

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

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

One or more filters.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

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

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

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

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

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

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

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

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

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

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

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

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

  • interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).

  • mac-address - The MAC address of the network interface.

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

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

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • private-ip-address - The private IPv4 address or addresses of the network interface.

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

  • requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

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

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

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

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

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

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

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[]
network_interface_ids Input Column

The network interface IDs.

Default: Describes all your network interfaces.

VARCHAR[]
Show child fields
network_interface_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
association

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

STRUCT(
"allocation_id" VARCHAR,
"association_id" VARCHAR,
"ip_owner_id" VARCHAR,
"public_dns_name" VARCHAR,
"public_ip" VARCHAR,
"customer_owned_ip" VARCHAR,
"carrier_ip" VARCHAR
)
Show child fields
association.allocation_id

The allocation ID.

association.association_id

The association ID.

association.carrier_ip

The carrier IP address associated with the network interface.

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

association.customer_owned_ip

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

association.ip_owner_id

The ID of the Elastic IP address owner.

association.public_dns_name

The public DNS name.

association.public_ip

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

attachment

The network interface attachment.

STRUCT(
"attach_time" TIMESTAMP_S,
"attachment_id" VARCHAR,
"delete_on_termination" BOOLEAN,
"device_index" BIGINT,
"network_card_index" BIGINT,
"instance_id" VARCHAR,
"instance_owner_id" VARCHAR,
"status" VARCHAR,
"ena_srd_specification" STRUCT(
"ena_srd_enabled" BOOLEAN,
"ena_srd_udp_specification" STRUCT(
"ena_srd_udp_enabled" BOOLEAN
)
)
)
Show child fields
attachment.attach_time

The timestamp indicating when the attachment initiated.

attachment.attachment_id

The ID of the network interface attachment.

attachment.delete_on_termination

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

attachment.device_index

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

attachment.ena_srd_specification

Configures ENA Express for the network interface that this action attaches to the instance.

Show child fields
attachment.ena_srd_specification.ena_srd_enabled

Indicates whether ENA Express is enabled for the network interface.

attachment.ena_srd_specification.ena_srd_udp_specification

Configures ENA Express for UDP network traffic.

Show child fields
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.

attachment.instance_id

The ID of the instance.

attachment.instance_owner_id

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

attachment.network_card_index

The index of the network card.

attachment.status

The attachment state.

availability_zone

The Availability Zone.

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

STRUCT(
"tcp_established_timeout" BIGINT,
"udp_stream_timeout" BIGINT,
"udp_timeout" BIGINT
)
Show child fields
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.

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.

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.

deny_all_igw_traffic

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

BOOLEAN
description

A description.

VARCHAR
groups

Any security groups for the network interface.

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.

interface_type

The type of network interface.

VARCHAR
ipv4_prefixes

The IPv4 prefixes that are assigned to the network interface.

STRUCT(
"ipv4_prefix" VARCHAR
)[]
Show child fields
ipv4_prefixes[]
Show child fields
ipv4_prefixes[].ipv4_prefix

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

ipv6_address

The IPv6 globally unique address associated with the network interface.

VARCHAR
ipv6_addresses

The IPv6 addresses associated with the network interface.

STRUCT(
"ipv6_address" VARCHAR,
"is_primary_ipv6" BOOLEAN
)[]
Show child fields
ipv6_addresses[]
Show child fields
ipv6_addresses[].ipv6_address

The IPv6 address.

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

ipv6_native

Indicates whether this is an IPv6 only network interface.

BOOLEAN
ipv6_prefixes

The IPv6 prefixes that are assigned to the network interface.

STRUCT(
"ipv6_prefix" VARCHAR
)[]
Show child fields
ipv6_prefixes[]
Show child fields
ipv6_prefixes[].ipv6_prefix

The IPv6 prefix.

mac_address

The MAC address.

VARCHAR
network_interface_id

The ID of the network interface.

VARCHAR
outpost_arn

The Amazon Resource Name (ARN) of the Outpost.

VARCHAR
owner_id

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

VARCHAR
private_dns_name

The private DNS name.

VARCHAR
private_ip_address

The IPv4 address of the network interface within the subnet.

VARCHAR
private_ip_addresses

The private IPv4 addresses associated with the network interface.

STRUCT(
"association" STRUCT(
"allocation_id" VARCHAR,
"association_id" VARCHAR,
"ip_owner_id" VARCHAR,
"public_dns_name" VARCHAR,
"public_ip" VARCHAR,
"customer_owned_ip" VARCHAR,
"carrier_ip" VARCHAR
),
"primary" BOOLEAN,
"private_dns_name" VARCHAR,
"private_ip_address" VARCHAR
)[]
Show child fields
private_ip_addresses[]
Show child fields
private_ip_addresses[].association

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

Show child fields
private_ip_addresses[].association.allocation_id

The allocation ID.

private_ip_addresses[].association.association_id

The association ID.

private_ip_addresses[].association.carrier_ip

The carrier IP address associated with the network interface.

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

private_ip_addresses[].association.customer_owned_ip

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

private_ip_addresses[].association.ip_owner_id

The ID of the Elastic IP address owner.

private_ip_addresses[].association.public_dns_name

The public DNS name.

private_ip_addresses[].association.public_ip

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

private_ip_addresses[].primary

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

private_ip_addresses[].private_dns_name

The private DNS name.

private_ip_addresses[].private_ip_address

The private IPv4 address.

requester_id

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

VARCHAR
requester_managed

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

BOOLEAN
source_dest_check

Indicates whether source/destination checking is enabled.

BOOLEAN
status

The status of the network interface.

VARCHAR
subnet_id

The ID of the subnet.

VARCHAR
tag_set

Any tags assigned to the network interface.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tag_set[]
Show child fields
tag_set[].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:.

tag_set[].value

The value of the tag.

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

vpc_id

The ID of the VPC.

VARCHAR