NeptuneGraph / Client / create_graph_snapshot

create_graph_snapshot#

NeptuneGraph.Client.create_graph_snapshot(**kwargs)#

Creates a snapshot of the specific graph.

See also: AWS API Documentation

Request Syntax

response = client.create_graph_snapshot(
    graphIdentifier='string',
    snapshotName='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The unique identifier of the Neptune Analytics graph.

  • snapshotName (string) –

    [REQUIRED]

    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.

  • tags (dict) –

    Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

    • (string) –

      • (string) –

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 ID of the snapshot created.

    • name (string) –

      The name of the snapshot created.

    • arn (string) –

      The ARN of the snapshot created.

    • sourceGraphId (string) –

      The Id of the Neptune Analytics graph from which the snapshot is created.

    • snapshotCreateTime (datetime) –

      The snapshot creation time

    • status (string) –

      The current state of the snapshot.

    • kmsKeyIdentifier (string) –

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

Exceptions