NetworkManager / Paginator / ListCoreNetworkRoutingInformation

ListCoreNetworkRoutingInformation

class NetworkManager.Paginator.ListCoreNetworkRoutingInformation

paginator = client.get_paginator('list_core_network_routing_information')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkManager.Client.list_core_network_routing_information().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    SegmentName='string',
    EdgeLocation='string',
    NextHopFilters={
        'string': [
            'string',
        ]
    },
    ExactPrefixMatches=[
        'string',
    ],
    LongestPrefixMatches=[
        'string',
    ],
    SubnetOfMatches=[
        'string',
    ],
    SupernetOfMatches=[
        'string',
    ],
    LocalPreferenceMatches=[
        'string',
    ],
    ExactAsPathMatches=[
        'string',
    ],
    MedMatches=[
        'string',
    ],
    CommunityMatches=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CoreNetworkId (string) –

  [REQUIRED]

  The ID of the core network to retrieve routing information for.

• SegmentName (string) –

  [REQUIRED]

  The name of the segment to filter routing information by.

• EdgeLocation (string) –

  [REQUIRED]

  The edge location to filter routing information by.

• NextHopFilters (dict) –

  Filters to apply based on next hop information. Each filter value must exactly match the corresponding next hop value. Values for the same filter are joined with OR, and different filters are joined with AND. The following filters are supported:

  • core-network-attachment-id: The ID of the core network attachment for the next hop, for example attachment-0123456789abcdef0.

  • segment-name: The name of the segment for the next hop.

  • edge-location: The edge location for the next hop, for example us-east-1.

  • resource-id: The ID of the resource for the next hop.

  • resource-type: The type of resource for the next hop. The possible values are vpc, vpn, connect-peer, direct-connect-gateway, transit-gateway-route-table, attachment, and blackhole.

  • ip-address: The IP address of the next hop. For a Site-to-Site VPN next hop, this is the outside IP address of the AWS side of the VPN tunnel. For a Connect peer next hop, this is the core network BGP address of the Connect peer. The value must be a single IPv4 or IPv6 address.

  You can specify up to 10 filter values in total across NextHopFilters and the other match parameters in the request. Each filter value can be up to 256 characters.

  • (string) –

    • (list) –

      • (string) –

• ExactPrefixMatches (list) –

  Exact prefix values to match when filtering routing information.

  • (string) –

• LongestPrefixMatches (list) –

  Filters routing information based on the longest prefix that matches each provided IP address.

  • (string) –

• SubnetOfMatches (list) –

  Prefix values to filter routing information whose prefix is a subnet of the prefixes provided.

  • (string) –

• SupernetOfMatches (list) –

  Prefix values to filter routing information whose prefix is a supernet of the prefixes provided.

  • (string) –

• LocalPreferenceMatches (list) –

  Local preference values to match when filtering routing information.

  • (string) –

• ExactAsPathMatches (list) –

  Exact AS path values to match when filtering routing information.

  • (string) –

• MedMatches (list) –

  Multi-Exit Discriminator (MED) values to match when filtering routing information.

  • (string) –

• CommunityMatches (list) –

  BGP community values to match when filtering routing information.

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

{
    'CoreNetworkRoutingInformation': [
        {
            'Prefix': 'string',
            'NextHop': {
                'IpAddress': 'string',
                'CoreNetworkAttachmentId': 'string',
                'ResourceId': 'string',
                'ResourceType': 'string',
                'SegmentName': 'string',
                'EdgeLocation': 'string'
            },
            'LocalPreference': 'string',
            'Med': 'string',
            'AsPath': [
                'string',
            ],
            'Communities': [
                'string',
            ]
        },
    ],

}

Response Structure

• (dict) –

  • CoreNetworkRoutingInformation (list) –

    The list of routing information for the core network.

    • (dict) –

      Routing information for a core network, including route details and BGP attributes.

      • Prefix (string) –

        The IP prefix for the route.

      • NextHop (dict) –

        The next hop information for the route.

        • IpAddress (string) –

          The IP address of the next hop.

        • CoreNetworkAttachmentId (string) –

          The ID of the core network attachment for the next hop.

        • ResourceId (string) –

          The ID of the resource for the next hop.

        • ResourceType (string) –

          The type of resource for the next hop.

        • SegmentName (string) –

          The name of the segment for the next hop.

        • EdgeLocation (string) –

          The edge location for the next hop.

      • LocalPreference (string) –

        The BGP local preference value for the route.

      • Med (string) –

        The BGP Multi-Exit Discriminator (MED) value for the route.

      • AsPath (list) –

        The BGP AS path for the route.

        • (string) –

      • Communities (list) –

        The BGP community values for the route.

        • (string) –