NeptuneGraph / Client / get_graph_snapshot

get_graph_snapshot#

NeptuneGraph.Client.get_graph_snapshot(**kwargs)#

Retrieves a specified graph snapshot.

See also: AWS API Documentation

Request Syntax

response = client.get_graph_snapshot(
    snapshotIdentifier='string'
)
Parameters:

snapshotIdentifier (string) –

[REQUIRED]

The ID of the snapshot to retrieve.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.

Exceptions

  • NeptuneGraph.Client.exceptions.ThrottlingException

  • NeptuneGraph.Client.exceptions.ValidationException

  • NeptuneGraph.Client.exceptions.InternalServerException

  • NeptuneGraph.Client.exceptions.ResourceNotFoundException