NeptuneGraph / Paginator / ListGraphSnapshots

ListGraphSnapshots

class NeptuneGraph.Paginator.ListGraphSnapshots

paginator = client.get_paginator('list_graph_snapshots')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NeptuneGraph.Client.list_graph_snapshots().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• graphIdentifier (string) – The unique identifier of the Neptune Analytics graph.

• 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

{
    'graphSnapshots': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'sourceGraphId': 'string',
            'snapshotCreateTime': datetime(2015, 1, 1),
            'status': 'CREATING'|'AVAILABLE'|'DELETING'|'FAILED',
            'kmsKeyIdentifier': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • graphSnapshots (list) –

    The requested list of snapshots.

    • (dict) –

      Details about a graph snapshot.

      • id (string) –

        The unique identifier of the graph snapshot.

      • name (string) –

        The snapshot name. For example: my-snapshot-1.

        The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

      • arn (string) –

        The ARN of the graph snapshot.

      • sourceGraphId (string) –

        The graph identifier for the graph for which a snapshot is to be created.

      • snapshotCreateTime (datetime) –

        The time when the snapshot was created.

      • status (string) –

        The status of the graph snapshot.

      • kmsKeyIdentifier (string) –

        The ID of the KMS key used to encrypt and decrypt the snapshot.

  • NextToken (string) –

    A token to resume pagination.