ResetGraph - NeptuneAnalyticsAPI
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

ResetGraph

Empties the data from a specified Neptune Analytics graph.

Request Syntax

PUT /graphs/graphIdentifier HTTP/1.1
Content-type: application/json

{
   "skipSnapshot": boolean
}

URI Request Parameters

The request uses the following URI parameters.

graphIdentifier

ID of the graph to reset.

Pattern: g-[a-z0-9]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

skipSnapshot

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.

Type: Boolean

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "buildNumber": "string",
   "createTime": number,
   "deletionProtection": boolean,
   "endpoint": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "provisionedMemory": number,
   "publicConnectivity": boolean,
   "replicaCount": number,
   "sourceSnapshotId": "string",
   "status": "string",
   "statusReason": "string",
   "vectorSearchConfiguration": { 
      "dimension": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN associated with the graph.

Type: String

buildNumber

The build number of the graph.

Type: String

createTime

The time at which the graph was created.

Type: Timestamp

deletionProtection

If true, deletion protection is enabled for the graph.

Type: Boolean

endpoint

The graph endpoint.

Type: String

id

The unique identifier of the graph.

Type: String

Pattern: g-[a-z0-9]{10}

kmsKeyIdentifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

name

The name of the graph.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: (?!g-)[a-z][a-z0-9]*(-[a-z0-9]+)*

provisionedMemory

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

Type: Integer

Valid Range: Minimum value of 16. Maximum value of 24576.

publicConnectivity

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

Type: Boolean

replicaCount

The number of replicas for the graph.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2.

sourceSnapshotId

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

Type: String

Pattern: gs-[a-z0-9]{10}

status

The status of the graph.

Type: String

Valid Values: CREATING | AVAILABLE | DELETING | RESETTING | UPDATING | SNAPSHOTTING | FAILED | IMPORTING

statusReason

The reason that the graph has this status.

Type: String

vectorSearchConfiguration

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

Type: VectorSearchConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Raised when a conflict is encountered.

HTTP Status Code: 409

InternalServerException

A failure occurred on the server.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be located.

HTTP Status Code: 404

ThrottlingException

The exception was interrupted by throttling.

HTTP Status Code: 429

ValidationException

A resource could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: