DescribeNetworkInterfacePermissions¶

class EC2.Paginator.DescribeNetworkInterfacePermissions¶

paginator = client.get_paginator('describe_network_interface_permissions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EC2.Client.describe_network_interface_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    NetworkInterfacePermissionIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

NetworkInterfacePermissionIds (list) --
The network interface permission IDs.
- (string) --
Filters (list) --
One or more filters.
- network-interface-permission.network-interface-permission-id - The ID of the permission.
- network-interface-permission.network-interface-id - The ID of the network interface.
- network-interface-permission.aws-account-id - The Amazon Web Services account ID.
- network-interface-permission.aws-service - The Amazon Web Service.
- network-interface-permission.permission - The type of permission ( INSTANCE-ATTACH | EIP-ASSOCIATE ).
- (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) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'NetworkInterfacePermissions': [
        {
            'NetworkInterfacePermissionId': 'string',
            'NetworkInterfaceId': 'string',
            'AwsAccountId': 'string',
            'AwsService': 'string',
            'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE',
            'PermissionState': {
                'State': 'pending'|'granted'|'revoking'|'revoked',
                'StatusMessage': 'string'
            }
        },
    ],

}

Response Structure

(dict) --

Contains the output for DescribeNetworkInterfacePermissions.
- NetworkInterfacePermissions (list) --
  
  The network interface permissions.
  - (dict) --
    
    Describes a permission for a network interface.
    - NetworkInterfacePermissionId (string) --
      
      The ID of the network interface permission.
    - NetworkInterfaceId (string) --
      
      The ID of the network interface.
    - AwsAccountId (string) --
      
      The Amazon Web Services account ID.
    - AwsService (string) --
      
      The Amazon Web Service.
    - Permission (string) --
      
      The type of permission.
    - PermissionState (dict) --
      
      Information about the state of the permission.
      - State (string) --
        
        The state of the permission.
      - StatusMessage (string) --
        
        A status message, if applicable.

Table Of Contents

DescribeNetworkInterfacePermissions¶