ServiceResource / Collection / network_interfaces

network_interfaces#

EC2.ServiceResource.network_interfaces#

A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all NetworkInterface resources in the collection.

See also: AWS API Documentation

Request Syntax

network_interface_iterator = ec2.network_interfaces.all()

Return type:: list(ec2.NetworkInterface)
Returns:: A list of NetworkInterface resources

filter(**kwargs)#

Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method. A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

network_interface_iterator = ec2.network_interfaces.filter(
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    NetworkInterfaceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – 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.
DryRun (boolean) – 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.
NetworkInterfaceIds (list) –
The network interface IDs.

Default: Describes all your network interfaces.
- (string) –
Filters (list) –
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 | efa-only | 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.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - 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) –

Return type:

list(ec2.NetworkInterface)

Returns:

A list of NetworkInterface resources

limit(**kwargs)#

Creates an iterable up to a specified amount of NetworkInterface resources in the collection.

See also: AWS API Documentation

Request Syntax

network_interface_iterator = ec2.network_interfaces.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(ec2.NetworkInterface)
Returns:: A list of NetworkInterface resources

page_size(**kwargs)#

Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

network_interface_iterator = ec2.network_interfaces.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(ec2.NetworkInterface)
Returns:: A list of NetworkInterface resources