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',
        ]
    },
    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.

  • (string) –

    • (list) –

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