NetworkManager / Paginator / ListCoreNetworkPolicyVersions

ListCoreNetworkPolicyVersions

class NetworkManager.Paginator.ListCoreNetworkPolicyVersions

paginator = client.get_paginator('list_core_network_policy_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CoreNetworkId (string) –

  [REQUIRED]

  The ID of a core network.

• 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

{
    'CoreNetworkPolicyVersions': [
        {
            'CoreNetworkId': 'string',
            'PolicyVersionId': 123,
            'Alias': 'LIVE'|'LATEST',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ChangeSetState': 'PENDING_GENERATION'|'FAILED_GENERATION'|'READY_TO_EXECUTE'|'EXECUTING'|'EXECUTION_SUCCEEDED'|'OUT_OF_DATE'
        },
    ],

}

Response Structure

• (dict) –

  • CoreNetworkPolicyVersions (list) –

    Describes core network policy versions.

    • (dict) –

      Describes a core network policy version.

      • CoreNetworkId (string) –

        The ID of a core network.

      • PolicyVersionId (integer) –

        The ID of the policy version.

      • Alias (string) –

        Whether a core network policy is the current policy or the most recently submitted policy.

      • Description (string) –

        The description of a core network policy version.

      • CreatedAt (datetime) –

        The timestamp when a core network policy version was created.

      • ChangeSetState (string) –

        The status of the policy version change set.