NeptuneGraph / Client / restore_graph_from_snapshot

restore_graph_from_snapshot#

NeptuneGraph.Client.restore_graph_from_snapshot(**kwargs)#

Restores a graph from a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.restore_graph_from_snapshot(
    snapshotIdentifier='string',
    graphName='string',
    provisionedMemory=123,
    deletionProtection=True|False,
    tags={
        'string': 'string'
    },
    replicaCount=123,
    publicConnectivity=True|False
)
Parameters:

  • snapshotIdentifier (string) –

    [REQUIRED]

    The ID of the snapshot in question.

  • graphName (string) –

    [REQUIRED]

    A name for the new Neptune Analytics graph to be created from the snapshot.

    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.

  • provisionedMemory (integer) –

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    Min = 128

  • deletionProtection (boolean) – A value that indicates whether the graph has deletion protection enabled. The graph can’t be deleted when deletion protection is enabled.

  • tags (dict) –

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

    • (string) –

      • (string) –

  • replicaCount (integer) –

    The number of replicas in other AZs. Min =0, Max = 2, Default =1

    Warning

    Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

  • publicConnectivity (boolean) – Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. ( true to enable, or false to disable).

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED'|'IMPORTING',
    'statusReason': 'string',
    'createTime': datetime(2015, 1, 1),
    'provisionedMemory': 123,
    'endpoint': 'string',
    'publicConnectivity': True|False,
    'vectorSearchConfiguration': {
        'dimension': 123
    },
    'replicaCount': 123,
    'kmsKeyIdentifier': 'string',
    'sourceSnapshotId': 'string',
    'deletionProtection': True|False,
    'buildNumber': 'string'
}

Response Structure

  • (dict) –

    • id (string) –

      The unique identifier of the graph.

    • name (string) –

      The name of the graph.

    • arn (string) –

      The ARN associated with the graph.

    • status (string) –

      The status of the graph.

    • statusReason (string) –

      The reason that the graph has this status.

    • createTime (datetime) –

      The time at which the graph was created.

    • provisionedMemory (integer) –

      The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

    • endpoint (string) –

      The graph endpoint.

    • publicConnectivity (boolean) –

      If true, the graph has a public endpoint, otherwise not.

    • vectorSearchConfiguration (dict) –

      Specifies the number of dimensions for vector embeddings loaded into the graph. Max = 65535

      • dimension (integer) –

        The number of dimensions.

    • replicaCount (integer) –

      The number of replicas for the graph.

    • kmsKeyIdentifier (string) –

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

    • sourceSnapshotId (string) –

      The ID of the snapshot from which the graph was created, if any.

    • deletionProtection (boolean) –

      If true, deletion protection is enabled for the graph.

    • buildNumber (string) –

      The build number of the graph.

Exceptions