AWS API Changes

2018/09/12 - Amazon Elastic Compute Cloud - 1 updated api methods

Changes Pagination Support for DescribeNetworkInterfaces API

DescribeNetworkInterfaces (updated)

Link ¶
Changes (request, response)
Request

{'MaxResults': 'integer', 'NextToken': 'string'}

Response

{'NextToken': 'string'}

Describes one or more of your network interfaces.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

One or more filters.

addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address 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.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your 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.attachment-id - The ID of the interface attachment.
attachment.attach.time - The time that the network interface was attached to an instance.
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.nat-gateway-id - The ID of the NAT gateway 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.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-desk-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. The filters supported by a describe operation are documented with the describe operation. For example:
- DescribeAvailabilityZones
- DescribeImages
- DescribeInstances
- DescribeKeyPairs
- DescribeSecurityGroups
- DescribeSnapshots
- DescribeSubnets
- DescribeTags
- DescribeVolumes
- DescribeVpcs
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

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 .

type NetworkInterfaceIds

list

param NetworkInterfaceIds

One or more network interface IDs.

Default: Describes all your network interfaces.

(string) --

type NextToken

string

param NextToken

The token to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

rtype

dict

returns

Response Syntax

{
    'NetworkInterfaces': [
        {
            'Association': {
                'AllocationId': 'string',
                'AssociationId': 'string',
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string'
            },
            'Attachment': {
                'AttachTime': datetime(2015, 1, 1),
                'AttachmentId': 'string',
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'Status': 'attaching'|'attached'|'detaching'|'detached'
            },
            'AvailabilityZone': 'string',
            'Description': 'string',
            'Groups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'InterfaceType': 'interface'|'natGateway',
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string'
                },
            ],
            'MacAddress': 'string',
            'NetworkInterfaceId': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Association': {
                        'AllocationId': 'string',
                        'AssociationId': 'string',
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string'
                    },
                    'Primary': True|False,
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Contains the output of DescribeNetworkInterfaces.
- NetworkInterfaces (list) --
  
  Information about one or more 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.
    - 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.
      - InstanceId (string) --
        
        The ID of the instance.
      - InstanceOwnerId (string) --
        
        The AWS account ID of the owner of the instance.
      - Status (string) --
        
        The attachment state.
    - AvailabilityZone (string) --
      
      The Availability Zone.
    - Description (string) --
      
      A description.
    - Groups (list) --
      
      Any security groups for the network interface.
      - (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
    - InterfaceType (string) --
      
      The type of 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.
    - MacAddress (string) --
      
      The MAC address.
    - NetworkInterfaceId (string) --
      
      The ID of the network interface.
    - OwnerId (string) --
      
      The AWS 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.
        
        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.
    - RequesterId (string) --
      
      The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
    - RequesterManaged (boolean) --
      
      Indicates whether the network interface is being managed by AWS.
    - SourceDestCheck (boolean) --
      
      Indicates whether traffic to or from the instance is validated.
    - 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 255 Unicode characters.
    - VpcId (string) --
      
      The ID of the VPC.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.