NetworkManager / Paginator / GetCoreNetworkChangeEvents

GetCoreNetworkChangeEvents

class NetworkManager.Paginator.GetCoreNetworkChangeEvents

paginator = client.get_paginator('get_core_network_change_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CoreNetworkId='string',
    PolicyVersionId=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CoreNetworkId (string) –

  [REQUIRED]

  The ID of a core network.

• PolicyVersionId (integer) –

  [REQUIRED]

  The ID of the policy version.

• 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

{
    'CoreNetworkChangeEvents': [
        {
            'Type': 'CORE_NETWORK_SEGMENT'|'NETWORK_FUNCTION_GROUP'|'CORE_NETWORK_EDGE'|'ATTACHMENT_MAPPING'|'ATTACHMENT_ROUTE_PROPAGATION'|'ATTACHMENT_ROUTE_STATIC'|'ROUTING_POLICY'|'ROUTING_POLICY_SEGMENT_ASSOCIATION'|'ROUTING_POLICY_EDGE_ASSOCIATION'|'ROUTING_POLICY_ATTACHMENT_ASSOCIATION'|'CORE_NETWORK_CONFIGURATION'|'SEGMENTS_CONFIGURATION'|'SEGMENT_ACTIONS_CONFIGURATION'|'ATTACHMENT_POLICIES_CONFIGURATION',
            'Action': 'ADD'|'MODIFY'|'REMOVE',
            'IdentifierPath': 'string',
            'EventTime': datetime(2015, 1, 1),
            'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED',
            'Values': {
                'EdgeLocation': 'string',
                'PeerEdgeLocation': 'string',
                'RoutingPolicyDirection': 'inbound'|'outbound',
                'SegmentName': 'string',
                'NetworkFunctionGroupName': 'string',
                'AttachmentId': 'string',
                'Cidr': 'string',
                'RoutingPolicyAssociationDetails': [
                    {
                        'RoutingPolicyNames': [
                            'string',
                        ],
                        'SharedSegments': [
                            'string',
                        ]
                    },
                ]
            }
        },
    ],

}

Response Structure

• (dict) –

  • CoreNetworkChangeEvents (list) –

    The response to GetCoreNetworkChangeEventsRequest.

    • (dict) –

      Describes a core network change event. This can be a change to a segment, attachment, route, etc.

      • Type (string) –

        Describes the type of change event.

      • Action (string) –

        The action taken for the change event.

      • IdentifierPath (string) –

        Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

      • EventTime (datetime) –

        The timestamp for an event change in status.

      • Status (string) –

        The status of the core network change event.

      • Values (dict) –

        Details of the change event.

        • EdgeLocation (string) –

          The edge location for the core network change event.

        • PeerEdgeLocation (string) –

          The edge location of the peer in a core network change event.

        • RoutingPolicyDirection (string) –

          The routing policy direction (inbound/outbound) in a core network change event.

        • SegmentName (string) –

          The segment name if the change event is associated with a segment.

        • NetworkFunctionGroupName (string) –

          The changed network function group name.

        • AttachmentId (string) –

          The ID of the attachment if the change event is associated with an attachment.

        • Cidr (string) –

          For a STATIC_ROUTE event, this is the IP address.

        • RoutingPolicyAssociationDetails (list) –

          The names of the routing policies and other association details in the core network change values.

          • (dict) –

            Information about a routing policy association.

            • RoutingPolicyNames (list) –

              The names of the routing policies in the association.

              • (string) –

            • SharedSegments (list) –

              The names of the segments that are shared with each other in the association.

              • (string) –