NeptuneGraph / Client / delete_graph
delete_graph#
- NeptuneGraph.Client.delete_graph(**kwargs)#
Deletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
See also: AWS API Documentation
Request Syntax
response = client.delete_graph( graphIdentifier='string', skipSnapshot=True|False )
- Parameters:
graphIdentifier (string) –
[REQUIRED]
The unique identifier of the Neptune Analytics graph.
skipSnapshot (boolean) –
[REQUIRED]
Determines whether a final graph snapshot is created before the graph is deleted. If
true
is specified, no graph snapshot is created. Iffalse
is specified, a graph snapshot is created before the graph is deleted.
- Return type:
dict
- Returns:
Response Syntax
{ 'id': 'string', 'name': 'string', 'arn': 'string', 'status': 'CREATING'|'AVAILABLE'|'DELETING'|'RESETTING'|'UPDATING'|'SNAPSHOTTING'|'FAILED', '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 for the status of the graph.
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 the graph was recovered from a snapshot.
deletionProtection (boolean) –
If
true
, deletion protection was enabled for the graph.buildNumber (string) –
The build number associated with the graph.
Exceptions
NeptuneGraph.Client.exceptions.ThrottlingException
NeptuneGraph.Client.exceptions.ValidationException
NeptuneGraph.Client.exceptions.ConflictException
NeptuneGraph.Client.exceptions.InternalServerException
NeptuneGraph.Client.exceptions.ResourceNotFoundException