ExecuteFastReset - Neptune Data API
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.

Neptune fast reset is a two-step process. First you call ExecuteFastReset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon Neptune DB cluster using the fast reset API.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ResetDatabase IAM action in that cluster.

Request Syntax

POST /system HTTP/1.1 Content-type: application/json { "action": "string", "token": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The fast reset action. One of the following values:

  • initiateDatabaseReset   –   This action generates a unique token needed to actually perform the fast reset.

  • performDatabaseReset   –   This action uses the token generated by the initiateDatabaseReset action to actually perform the fast reset.

Type: String

Valid Values: initiateDatabaseReset | performDatabaseReset

Required: Yes


The fast-reset token to initiate the reset.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "payload": { "token": "string" }, "status": "string" }

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.


The payload is only returned by the initiateDatabaseReset action, and contains the unique token to use with the performDatabaseReset action to make the reset occur.

Type: FastResetToken object


The status is only returned for the performDatabaseReset action, and indicates whether or not the fast reset rquest is accepted.

Type: String


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


Raised in case of an authentication or authorization failure.

HTTP Status Code: 403


Raised when a request timed out in the client.

HTTP Status Code: 408


Raised when a value in a request field did not satisfy required constraints.

HTTP Status Code: 400


Raised when an argument in a request is not supported.

HTTP Status Code: 400


Raised when an argument in a request has an invalid value.

HTTP Status Code: 400


Raised when a parameter value is not valid.

HTTP Status Code: 400


Raised when the HTTP method used by a request is not supported by the endpoint being used.

HTTP Status Code: 405


Raised when a required parameter is missing.

HTTP Status Code: 400


Raised when a precondition for processing a request is not satisfied.

HTTP Status Code: 400


Raised when a request attempts to write to a read-only resource.

HTTP Status Code: 400


Raised when the server shuts down while processing a request.

HTTP Status Code: 500


Raised when the number of requests being processed exceeds the limit.

HTTP Status Code: 429


Raised when a request attempts to initiate an operation that is not supported.

HTTP Status Code: 400

See Also

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