NetworkManager / Paginator / ListContextChanges

ListContextChanges

class NetworkManager.Paginator.ListContextChanges
paginator = client.get_paginator('list_context_changes')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the context store.

  • FromVersionId (string) –

    [REQUIRED]

    The version to return changes from. Specify a version returned by ListContexts, GetContextVersion, or the ToVersionId of a previous ListContextChanges request. If the version is no longer available, the request fails, and you must call ListContexts to get the current context entries.

  • 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

{
    'ContextChanges': [
        {
            'ChangeType': 'ADDED'|'REMOVED',
            'Context': {
                'ContextId': 'string',
                'ContextType': 'string',
                'SegmentType': 'string',
                'PublicId': 'string',
                'Region': 'string',
                'AvailabilityZone': 'string',
                'AttachmentType': 'string'
            }
        },
    ],
    'FromVersionId': 'string',
    'ToVersionId': 'string',

}

Response Structure

  • (dict) –

    • ContextChanges (list) –

      The context entries that were added or removed.

      • (dict) –

        Describes a context entry that was added to or removed from a context store.

        • ChangeType (string) –

          The type of change. The possible values are the following:

          • ADDED: The context entry was added to the context store.

          • REMOVED: The context entry was removed from the context store.

        • Context (dict) –

          The context entry that was added or removed.

          • ContextId (string) –

            The ID of the context entry.

          • ContextType (string) –

            The type of the context entry, for example SegmentId, Subnet, or Attachment.

          • SegmentType (string) –

            The type of the segment, for example SecurityGroup. Network Manager returns this value only when the context type is SegmentId.

          • PublicId (string) –

            The ID of the resource, for example a security group ID, subnet ID, or transit gateway attachment ID.

          • Region (string) –

            The Amazon Web Services Region of the resource.

          • AvailabilityZone (string) –

            The ID of the Availability Zone of the resource, for example use1-az2. Network Manager returns this value only when the context type is Subnet.

          • AttachmentType (string) –

            The type of the attachment, for example VPC. Network Manager returns this value only when the context type is Attachment.

    • FromVersionId (string) –

      The version that the changes start from.

    • ToVersionId (string) –

      The version that the changes bring the context entries up to. To get later changes, specify this value as FromVersionId in your next request. All pages of the same request return the same version.