Did this page help you? Yes No Tell us about it...

DescribeNetworkInterfaces

Description

Provides information about one or more network interfaces.

You can filter the results to return information only about network interfaces that match criteria you specify. For example, you could get information about only network interfaces launched in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). A network interface must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the network interface is in a specific Availability Zone, and its owner ID matches a specific owner ID). A network interface must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name	Description
`association.association-id`	The association ID returned when the network interface was associated with an IP address. Type: String
`association.allocation-id`	The allocation ID that AWS returned when you allocated the Elastic IP address for your network interface. Type: String
`association.ip-owner-id`	The owner of the Elastic IP address associated with the network interface. Type: String
`association.public-ip`	The address of the Elastic IP address bound to the network interface. Type: String
`attachment.attachment-id`	The ID of the interface attachment. Type: String
`attachment.instance-id`	The ID of the instance to which the network interface is attached. Type: String
`attachment.instance-owner-id`	The owner ID of the instance to which the network interface is attached. Type: String
`attachment.device-index`	The device index to which the network interface is attached. Type: Integer
`attachment.status`	The status of the attachment. Type: String Valid values: `attaching \| attached \| detaching \| detached`
`attachment.attach.time`	The time that the network interface was attached to an instance. Type: Date
`attachment.delete-on-termination`	Indicates whether or not the attachment is deleted when an instance is terminated. Type: Boolean
`availability-zone`	Availability Zone of the network interface. Type: String
`description`	The description of the network interface. Type: String
`group-id`	ID of a VPC security group associated with the network interface. Type: String
`group-name`	Name of a VPC security group associated with the network interface. Type: String
`mac-address`	The MAC address of the network interface. Type: String
`network-interface-id`	The ID of the network interface. Type: String
`owner-id`	The AWS account ID of the network interface owner. Type: String
`private-ip-address`	The private IP address of the network interface. Type: String
`private-dns-name`	The private DNS name of the network interface. Type: String
`requester-id`	ID of the entity that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling, etc.). Type: String
`requester-managed`	Indicates whether the network interface is being managed by an AWS service (e.g., AWS Management Console, Auto Scaling, etc). Type: Boolean
`source-dest-check`	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. Type: Boolean
`status`	The status of the network interface. If the network interface is not attached to an instance, the status shows `available`; if a network interface is attached to an instance the status shows `in-use`. Type: String Valid values: `available \| in-use`
`subnet-id`	The ID of the subnet that the network interface is in. Type: String
`tag-key`	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 what the tag's key is). If you want to list only resources where Purpose=X, see the `tag:key` filter later in this table. For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide. Type: String
`tag-value`	Value of a tag assigned to the resource. This filter is independent of the `tag-key` filter. Type: String
`tag:``key`	Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: `Filter.1.Name=tag:Purpose` `Filter.1.Value.1=X` Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: `Filter.1.Name=tag:Purpose` `Filter.1.Value.1=X` `Filter.1.Value.2=Y`
`vpc-id`	The ID of the VPC that the network interface is in. Type: String

Request Parameters

Name Description Required

Name	Description	Required
`NetworkInterfaceId.n`	One or more network interface IDs. Type: String Default: None	No
`Filter.n.Name`	The filter name to use. Type: string Default: None	No
`Filter.n.Value.n`	The filter value to use. Type: string Default: None	No

NetworkInterfaceId.n

One or more network interface IDs.

Type: String

Default: None

Filter.n.Name

The filter name to use.

Type: string

Default: None

Filter.n.Value.n

The filter value to use.

Type: string

Default: None

Response Elements

Name Description

Name	Description
`requestId`	The ID of the request. Type: xsd:string
`networkInterfaceSet`	Returns information about the network interfaces. Type: InstanceNetworkInterfaceSetRequestType

requestId

The ID of the request.

Type: xsd:string

networkInterfaceSet

Returns information about the network interfaces.

Type: InstanceNetworkInterfaceSetRequestType

Examples

Example Request

This example describes network interfaces.

https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaces
&AUTHPARAMS

Example Response

<DescribeNetworkInterfacesResponse xmlns='http://ec2.amazonaws.com/doc/2011-11-15/'>
    <requestId>8ac55c54-792d-415b-a14c-3dffbc0aed2e</requestId>
    <networkInterfaceSet>
        <item>
            <networkInterfaceId>eni-ffda3197</networkInterfaceId>
            <subnetId>subnet-b2a249da</subnetId>
            <vpcId>vpc-1ea24976</vpcId>
            <availabilityZone>us-east-1b</availabilityZone>
            <description/>
            <ownerId>111122223333</ownerId>
            <requesterManaged>false</requesterManaged>
            <status>available</status>
            <macAddress>06:01:92:a4:43:77</macAddress>
            <privateIpAddress>10.0.0.182</privateIpAddress>
            <sourceDestCheck>true</sourceDestCheck>
            <groupSet>
                <item>
                    <groupId>sg-050c1369</groupId>
                    <groupName>default</groupName>
                </item>
            </groupSet>
            <tagSet/>
        </item>
        <item>
            <networkInterfaceId>eni-21a04b49</networkInterfaceId>
            <subnetId>subnet-b2a249da</subnetId>
            <vpcId>vpc-1ea24976</vpcId>
            <availabilityZone>us-east-1b</availabilityZone>
            <description/>
            <ownerId>111122223333</ownerId>
            <requesterManaged>false</requesterManaged>
            <status>in-use</status>
            <macAddress>06:01:92:94:7d:52</macAddress>
            <privateIpAddress>10.0.0.4</privateIpAddress>
            <sourceDestCheck>true</sourceDestCheck>
            <groupSet>
                <item>
                    <groupId>sg-050c1369</groupId>
                    <groupName>default</groupName>
                </item>
            </groupSet>
            <attachment>
                <attachmentId>eni-attach-0720626e</attachmentId>
                <instanceId>i-9cc316fe</instanceId>
                <instanceOwnerId>111122223333</instanceOwnerId>
                <deviceIndex>0</deviceIndex>
                <status>attached</status>
                <attachTime>2011-12-20T07:48:20.000Z</attachTime>
                <deleteOnTermination>true</deleteOnTermination>
            </attachment>
            <tagSet/>
        </item>
        <item>
            <networkInterfaceId>eni-c6bb50ae</networkInterfaceId>
            <subnetId>subnet-b2a249da</subnetId>
            <vpcId>vpc-1ea24976</vpcId>
            <availabilityZone>us-east-1b</availabilityZone>
            <description/>
            <ownerId>111122223333</ownerId>
            <requesterManaged>false</requesterManaged>
            <status>in-use</status>
            <macAddress>06:01:92:a7:f4:5c</macAddress>
            <privateIpAddress>10.0.0.142</privateIpAddress>
            <sourceDestCheck>true</sourceDestCheck>
            <groupSet>
                <item>
                    <groupId>sg-050c1369</groupId>
                    <groupName>default</groupName>
                </item>
            </groupSet>
            <attachment>
                <attachmentId>eni-attach-0326646a</attachmentId>
                <instanceId>i-0ee0356c</instanceId>
                <instanceOwnerId>111122223333</instanceOwnerId>
                <deviceIndex>0</deviceIndex>
                <status>attached</status>
                <attachTime>2011-12-20T08:29:31.000Z</attachTime>
                <deleteOnTermination>true</deleteOnTermination>
            </attachment>
            <tagSet/>
        </item>
    </networkInterfaceSet>
</DescribeNetworkInterfacesResponse>

Related Operations

Document Conventions
Terms of Use

Did this page help you? Yes No Tell us about it...