NetworkFirewall / Paginator / ListVpcEndpointAssociations

ListVpcEndpointAssociations

class NetworkFirewall.Paginator.ListVpcEndpointAssociations
paginator = client.get_paginator('list_vpc_endpoint_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFirewall.Client.list_vpc_endpoint_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FirewallArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • FirewallArn (string) –

    The Amazon Resource Name (ARN) of the firewall.

    If you don’t specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.

  • 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

{
    'VpcEndpointAssociations': [
        {
            'VpcEndpointAssociationArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • VpcEndpointAssociations (list) –

      The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn’t specify a firewall, this is all VPC endpoint associations that you have defined.

      Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

      • (dict) –

        High-level information about a VPC endpoint association, returned by ListVpcEndpointAssociations. You can use the information provided in the metadata to retrieve and manage a VPC endpoint association.

        • VpcEndpointAssociationArn (string) –

          The Amazon Resource Name (ARN) of a VPC endpoint association.