NeptuneGraph / Client / reset_graph

reset_graph#

NeptuneGraph.Client.reset_graph(**kwargs)#

Empties the data from a specified Neptune Analytics graph.

See also: AWS API Documentation

Request Syntax

response = client.reset_graph(
    graphIdentifier='string',
    skipSnapshot=True|False
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    ID of the graph to reset.

  • skipSnapshot (boolean) –

    [REQUIRED]

    Determines whether a final graph snapshot is created before the graph data is deleted. If set to true, no graph snapshot is created. If set to false, a graph snapshot is created before the data is deleted.

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