AWS API Changes

2024/10/21 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes Amazon EC2 now allows you to create network interfaces with just the EFA driver and no ENA driver by specifying the network interface type as efa-only.

CreateNetworkInterface (updated)

Link ¶
Changes (request, response)
Request

{'InterfaceType': {'efa-only'}}

Response

{'NetworkInterface': {'InterfaceType': {'efa-only'}}}

Creates a network interface in the specified subnet.

The number of IP addresses you can assign to a network interface varies by instance type.

For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.create_network_interface(
    Ipv4Prefixes=[
        {
            'Ipv4Prefix': 'string'
        },
    ],
    Ipv4PrefixCount=123,
    Ipv6Prefixes=[
        {
            'Ipv6Prefix': 'string'
        },
    ],
    Ipv6PrefixCount=123,
    InterfaceType='efa'|'efa-only'|'branch'|'trunk',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string',
    EnablePrimaryIpv6=True|False,
    ConnectionTrackingSpecification={
        'TcpEstablishedTimeout': 123,
        'UdpStreamTimeout': 123,
        'UdpTimeout': 123
    },
    SubnetId='string',
    Description='string',
    PrivateIpAddress='string',
    Groups=[
        'string',
    ],
    PrivateIpAddresses=[
        {
            'Primary': True|False,
            'PrivateIpAddress': 'string'
        },
    ],
    SecondaryPrivateIpAddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string',
            'IsPrimaryIpv6': True|False
        },
    ],
    Ipv6AddressCount=123,
    DryRun=True|False
)

type Ipv4Prefixes

list

param Ipv4Prefixes

The IPv4 prefixes assigned to the network interface.

You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

(dict) --

Describes the IPv4 prefix option for a network interface.
- Ipv4Prefix (string) --
  
  The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .

type Ipv4PrefixCount

integer

param Ipv4PrefixCount

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

type Ipv6Prefixes

list

param Ipv6Prefixes

The IPv6 prefixes assigned to the network interface.

You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

(dict) --

Describes the IPv4 prefix option for a network interface.
- Ipv6Prefix (string) --
  
  The IPv6 prefix.

type Ipv6PrefixCount

integer

param Ipv6PrefixCount

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

type InterfaceType

string

param InterfaceType

The type of network interface. The default is interface .

The only supported values are interface , efa , and trunk .

type TagSpecifications

list

param TagSpecifications

The tags to apply to the new network interface.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- 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 256 Unicode characters.

type ClientToken

string

param ClientToken

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

This field is autopopulated if not provided.

type EnablePrimaryIpv6

boolean

param EnablePrimaryIpv6

If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

type ConnectionTrackingSpecification

dict

param ConnectionTrackingSpecification

A connection tracking specification for the network interface.

TcpEstablishedTimeout (integer) --

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.
UdpStreamTimeout (integer) --

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.
UdpTimeout (integer) --

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.

type SubnetId

string

param SubnetId

[REQUIRED]

The ID of the subnet to associate with the network interface.

type Description

string

param Description

A description for the network interface.

type PrivateIpAddress

string

param PrivateIpAddress

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

type Groups

list

param Groups

The IDs of one or more security groups.

(string) --

type PrivateIpAddresses

list

param PrivateIpAddresses

The private IPv4 addresses.

You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

(dict) --

Describes a secondary private IPv4 address for a network interface.
- Primary (boolean) --
  
  Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
- PrivateIpAddress (string) --
  
  The private IPv4 address.

type SecondaryPrivateIpAddressCount

integer

param SecondaryPrivateIpAddressCount

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

type Ipv6Addresses

list

param Ipv6Addresses

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

(dict) --

Describes an IPv6 address.
- Ipv6Address (string) --
  
  The IPv6 address.
- IsPrimaryIpv6 (boolean) --
  
  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.

type Ipv6AddressCount

integer

param Ipv6AddressCount

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

type DryRun

boolean

param DryRun

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

rtype

dict

returns

Response Syntax

{
    'NetworkInterface': {
        'Association': {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'IpOwnerId': 'string',
            'PublicDnsName': 'string',
            'PublicIp': 'string',
            'CustomerOwnedIp': 'string',
            'CarrierIp': 'string'
        },
        'Attachment': {
            'AttachTime': datetime(2015, 1, 1),
            'AttachmentId': 'string',
            'DeleteOnTermination': True|False,
            'DeviceIndex': 123,
            'NetworkCardIndex': 123,
            'InstanceId': 'string',
            'InstanceOwnerId': 'string',
            'Status': 'attaching'|'attached'|'detaching'|'detached',
            'EnaSrdSpecification': {
                'EnaSrdEnabled': True|False,
                'EnaSrdUdpSpecification': {
                    'EnaSrdUdpEnabled': True|False
                }
            }
        },
        'AvailabilityZone': 'string',
        'ConnectionTrackingConfiguration': {
            'TcpEstablishedTimeout': 123,
            'UdpStreamTimeout': 123,
            'UdpTimeout': 123
        },
        'Description': 'string',
        'Groups': [
            {
                'GroupId': 'string',
                'GroupName': 'string'
            },
        ],
        'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
        'Ipv6Addresses': [
            {
                'Ipv6Address': 'string',
                'IsPrimaryIpv6': True|False
            },
        ],
        'MacAddress': 'string',
        'NetworkInterfaceId': 'string',
        'OutpostArn': 'string',
        'OwnerId': 'string',
        'PrivateDnsName': 'string',
        'PrivateIpAddress': 'string',
        'PrivateIpAddresses': [
            {
                'Association': {
                    'AllocationId': 'string',
                    'AssociationId': 'string',
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'CustomerOwnedIp': 'string',
                    'CarrierIp': 'string'
                },
                'Primary': True|False,
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string'
            },
        ],
        'Ipv4Prefixes': [
            {
                'Ipv4Prefix': 'string'
            },
        ],
        'Ipv6Prefixes': [
            {
                'Ipv6Prefix': 'string'
            },
        ],
        'RequesterId': 'string',
        'RequesterManaged': True|False,
        'SourceDestCheck': True|False,
        'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
        'SubnetId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'VpcId': 'string',
        'DenyAllIgwTraffic': True|False,
        'Ipv6Native': True|False,
        'Ipv6Address': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- NetworkInterface (dict) --
  
  Information about the network interface.
  - Association (dict) --
    
    The association information for an Elastic IP address (IPv4) associated with the network interface.
    - AllocationId (string) --
      
      The allocation ID.
    - AssociationId (string) --
      
      The association ID.
    - IpOwnerId (string) --
      
      The ID of the Elastic IP address owner.
    - PublicDnsName (string) --
      
      The public DNS name.
    - PublicIp (string) --
      
      The address of the Elastic IP address bound to the network interface.
    - CustomerOwnedIp (string) --
      
      The customer-owned IP address associated with the network interface.
    - CarrierIp (string) --
      
      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.
  - Attachment (dict) --
    
    The network interface attachment.
    - AttachTime (datetime) --
      
      The timestamp indicating 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 device index of the network interface attachment on the instance.
    - NetworkCardIndex (integer) --
      
      The index of the network card.
    - InstanceId (string) --
      
      The ID of the instance.
    - InstanceOwnerId (string) --
      
      The Amazon Web Services account ID of the owner of the instance.
    - Status (string) --
      
      The attachment state.
    - EnaSrdSpecification (dict) --
      
      Configures ENA Express for the network interface that this action attaches to the instance.
      - EnaSrdEnabled (boolean) --
        
        Indicates whether ENA Express is enabled for the network interface.
      - EnaSrdUdpSpecification (dict) --
        
        Configures ENA Express for UDP network traffic.
        
        EnaSrdUdpEnabled (boolean) --
        
        Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
  - AvailabilityZone (string) --
    
    The Availability Zone.
  - ConnectionTrackingConfiguration (dict) --
    
    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 .
    - TcpEstablishedTimeout (integer) --
      
      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.
    - UdpStreamTimeout (integer) --
      
      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.
    - UdpTimeout (integer) --
      
      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.
  - Description (string) --
    
    A description.
  - Groups (list) --
    
    Any security groups for the network interface.
    - (dict) --
      
      Describes a security group.
      - GroupId (string) --
        
        The ID of the security group.
      - GroupName (string) --
        
        The name of the security group.
  - InterfaceType (string) --
    
    The type of network interface.
  - Ipv6Addresses (list) --
    
    The IPv6 addresses associated with the network interface.
    - (dict) --
      
      Describes an IPv6 address associated with a network interface.
      - Ipv6Address (string) --
        
        The IPv6 address.
      - IsPrimaryIpv6 (boolean) --
        
        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.
  - MacAddress (string) --
    
    The MAC address.
  - NetworkInterfaceId (string) --
    
    The ID of the network interface.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - OwnerId (string) --
    
    The Amazon Web Services account ID of the owner of the network interface.
  - PrivateDnsName (string) --
    
    The private DNS name.
  - PrivateIpAddress (string) --
    
    The IPv4 address of the network interface within the subnet.
  - PrivateIpAddresses (list) --
    
    The private IPv4 addresses associated with the network interface.
    - (dict) --
      
      Describes the private IPv4 address of a network interface.
      - Association (dict) --
        
        The association information for an Elastic IP address (IPv4) associated with the network interface.
        
        AllocationId (string) --
        
        The allocation ID.
        
        AssociationId (string) --
        
        The association ID.
        
        IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
        
        CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
        
        CarrierIp (string) --
        
        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.
      - Primary (boolean) --
        
        Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
      - PrivateDnsName (string) --
        
        The private DNS name.
      - PrivateIpAddress (string) --
        
        The private IPv4 address.
  - Ipv4Prefixes (list) --
    
    The IPv4 prefixes that are assigned to the network interface.
    - (dict) --
      
      Describes an IPv4 prefix.
      - Ipv4Prefix (string) --
        
        The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .
  - Ipv6Prefixes (list) --
    
    The IPv6 prefixes that are assigned to the network interface.
    - (dict) --
      
      Describes the IPv6 prefix.
      - Ipv6Prefix (string) --
        
        The IPv6 prefix.
  - RequesterId (string) --
    
    The alias or Amazon Web Services account ID of the principal or service that created the network interface.
  - RequesterManaged (boolean) --
    
    Indicates whether the network interface is being managed by Amazon Web Services.
  - SourceDestCheck (boolean) --
    
    Indicates whether source/destination checking is enabled.
  - Status (string) --
    
    The status of the network interface.
  - SubnetId (string) --
    
    The ID of the subnet.
  - TagSet (list) --
    
    Any tags assigned to the network interface.
    - (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 256 Unicode characters.
  - VpcId (string) --
    
    The ID of the VPC.
  - DenyAllIgwTraffic (boolean) --
    
    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.
  - Ipv6Native (boolean) --
    
    Indicates whether this is an IPv6 only network interface.
  - Ipv6Address (string) --
    
    The IPv6 globally unique address associated with the network interface.
- ClientToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeNetworkInterfaces (updated)

Link ¶
Changes (response)

{'NetworkInterfaces': {'InterfaceType': {'efa-only'}}}

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 .

Warning

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

See also: AWS API Documentation

Request Syntax

client.describe_network_interfaces(
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    NetworkInterfaceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type NextToken

string

param NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

type MaxResults

integer

param MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.

type DryRun

boolean

param DryRun

type NetworkInterfaceIds

list

param NetworkInterfaceIds

The network interface IDs.

Default: Describes all your network interfaces.

(string) --

type Filters

list

param Filters

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.

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

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
  - (string) --

rtype

dict

returns

Response Syntax

{
    'NetworkInterfaces': [
        {
            'Association': {
                'AllocationId': 'string',
                'AssociationId': 'string',
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string',
                'CustomerOwnedIp': 'string',
                'CarrierIp': 'string'
            },
            'Attachment': {
                'AttachTime': datetime(2015, 1, 1),
                'AttachmentId': 'string',
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'NetworkCardIndex': 123,
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'Status': 'attaching'|'attached'|'detaching'|'detached',
                'EnaSrdSpecification': {
                    'EnaSrdEnabled': True|False,
                    'EnaSrdUdpSpecification': {
                        'EnaSrdUdpEnabled': True|False
                    }
                }
            },
            'AvailabilityZone': 'string',
            'ConnectionTrackingConfiguration': {
                'TcpEstablishedTimeout': 123,
                'UdpStreamTimeout': 123,
                'UdpTimeout': 123
            },
            'Description': 'string',
            'Groups': [
                {
                    'GroupId': 'string',
                    'GroupName': 'string'
                },
            ],
            'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed',
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string',
                    'IsPrimaryIpv6': True|False
                },
            ],
            'MacAddress': 'string',
            'NetworkInterfaceId': 'string',
            'OutpostArn': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Association': {
                        'AllocationId': 'string',
                        'AssociationId': 'string',
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'CustomerOwnedIp': 'string',
                        'CarrierIp': 'string'
                    },
                    'Primary': True|False,
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string'
                },
            ],
            'Ipv4Prefixes': [
                {
                    'Ipv4Prefix': 'string'
                },
            ],
            'Ipv6Prefixes': [
                {
                    'Ipv6Prefix': 'string'
                },
            ],
            'RequesterId': 'string',
            'RequesterManaged': True|False,
            'SourceDestCheck': True|False,
            'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching',
            'SubnetId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string',
            'DenyAllIgwTraffic': True|False,
            'Ipv6Native': True|False,
            'Ipv6Address': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NetworkInterfaces (list) --
  
  Information about the network interfaces.
  - (dict) --
    
    Describes a network interface.
    - Association (dict) --
      
      The association information for an Elastic IP address (IPv4) associated with the network interface.
      - AllocationId (string) --
        
        The allocation ID.
      - AssociationId (string) --
        
        The association ID.
      - IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
      - PublicDnsName (string) --
        
        The public DNS name.
      - PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
      - CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
      - CarrierIp (string) --
        
        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.
    - Attachment (dict) --
      
      The network interface attachment.
      - AttachTime (datetime) --
        
        The timestamp indicating 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 device index of the network interface attachment on the instance.
      - NetworkCardIndex (integer) --
        
        The index of the network card.
      - InstanceId (string) --
        
        The ID of the instance.
      - InstanceOwnerId (string) --
        
        The Amazon Web Services account ID of the owner of the instance.
      - Status (string) --
        
        The attachment state.
      - EnaSrdSpecification (dict) --
        
        Configures ENA Express for the network interface that this action attaches to the instance.
        
        EnaSrdEnabled (boolean) --
        
        Indicates whether ENA Express is enabled for the network interface.
        
        EnaSrdUdpSpecification (dict) --
        
        Configures ENA Express for UDP network traffic.
        
        EnaSrdUdpEnabled (boolean) --
        
        Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.
    - AvailabilityZone (string) --
      
      The Availability Zone.
    - ConnectionTrackingConfiguration (dict) --
      
      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 .
      - TcpEstablishedTimeout (integer) --
        
        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.
      - UdpStreamTimeout (integer) --
        
        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.
      - UdpTimeout (integer) --
        
        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.
    - Description (string) --
      
      A description.
    - Groups (list) --
      
      Any security groups for the network interface.
      - (dict) --
        
        Describes a security group.
        
        GroupId (string) --
        
        The ID of the security group.
        
        GroupName (string) --
        
        The name of the security group.
    - InterfaceType (string) --
      
      The type of network interface.
    - Ipv6Addresses (list) --
      
      The IPv6 addresses associated with the network interface.
      - (dict) --
        
        Describes an IPv6 address associated with a network interface.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        IsPrimaryIpv6 (boolean) --
        
        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.
    - MacAddress (string) --
      
      The MAC address.
    - NetworkInterfaceId (string) --
      
      The ID of the network interface.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost.
    - OwnerId (string) --
      
      The Amazon Web Services account ID of the owner of the network interface.
    - PrivateDnsName (string) --
      
      The private DNS name.
    - PrivateIpAddress (string) --
      
      The IPv4 address of the network interface within the subnet.
    - PrivateIpAddresses (list) --
      
      The private IPv4 addresses associated with the network interface.
      - (dict) --
        
        Describes the private IPv4 address of a network interface.
        
        Association (dict) --
        
        The association information for an Elastic IP address (IPv4) associated with the network interface.
        
        AllocationId (string) --
        
        The allocation ID.
        
        AssociationId (string) --
        
        The association ID.
        
        IpOwnerId (string) --
        
        The ID of the Elastic IP address owner.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The address of the Elastic IP address bound to the network interface.
        
        CustomerOwnedIp (string) --
        
        The customer-owned IP address associated with the network interface.
        
        CarrierIp (string) --
        
        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.
        
        Primary (boolean) --
        
        Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
        
        PrivateDnsName (string) --
        
        The private DNS name.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address.
    - Ipv4Prefixes (list) --
      
      The IPv4 prefixes that are assigned to the network interface.
      - (dict) --
        
        Describes an IPv4 prefix.
        
        Ipv4Prefix (string) --
        
        The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide .
    - Ipv6Prefixes (list) --
      
      The IPv6 prefixes that are assigned to the network interface.
      - (dict) --
        
        Describes the IPv6 prefix.
        
        Ipv6Prefix (string) --
        
        The IPv6 prefix.
    - RequesterId (string) --
      
      The alias or Amazon Web Services account ID of the principal or service that created the network interface.
    - RequesterManaged (boolean) --
      
      Indicates whether the network interface is being managed by Amazon Web Services.
    - SourceDestCheck (boolean) --
      
      Indicates whether source/destination checking is enabled.
    - Status (string) --
      
      The status of the network interface.
    - SubnetId (string) --
      
      The ID of the subnet.
    - TagSet (list) --
      
      Any tags assigned to the network interface.
      - (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 256 Unicode characters.
    - VpcId (string) --
      
      The ID of the VPC.
    - DenyAllIgwTraffic (boolean) --
      
      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.
    - Ipv6Native (boolean) --
      
      Indicates whether this is an IPv6 only network interface.
    - Ipv6Address (string) --
      
      The IPv6 globally unique address associated with the network interface.
- NextToken (string) --
  
  The token to include in another request to get the next page of items. This value is null when there are no more items to return.