NetworkManager / Client / list_context_changes

list_context_changes

NetworkManager.Client.list_context_changes(**kwargs)

Returns the context entries that were added to or removed from a context store after the specified version. The context store must be in the AVAILABLE state.

See also: AWS API Documentation

Request Syntax

response = client.list_context_changes(
    ContextStoreId='string',
    FromVersionId='string',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next page of results.

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',
    'NextToken': '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.

    • NextToken (string) –

      The token for the next page of results.

Exceptions

  • NetworkManager.Client.exceptions.ValidationException

  • NetworkManager.Client.exceptions.AccessDeniedException

  • NetworkManager.Client.exceptions.ResourceNotFoundException

  • NetworkManager.Client.exceptions.ThrottlingException

  • NetworkManager.Client.exceptions.InternalServerException