Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ExecuteFastReset

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.

action

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

token

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.

payload

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

status

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

Type: String

Errors

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

AccessDeniedException

Raised in case of an authentication or authorization failure.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 403

ClientTimeoutException

Raised when a request timed out in the client.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 408

ConstraintViolationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

IllegalArgumentException

Raised when an argument in a request is not supported.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

InvalidArgumentException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

InvalidParameterException

Raised when a parameter value is not valid.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request that includes an invalid parameter.

HTTP Status Code: 400

MethodNotAllowedException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 405

MissingParameterException

Raised when a required parameter is missing.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in which the parameter is missing.

HTTP Status Code: 400

PreconditionsFailedException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400

ReadOnlyViolationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in which the parameter is missing.

HTTP Status Code: 400

ServerShutdownException

Raised when the server shuts down while processing a request.

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 500

TooManyRequestsException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request that could not be processed for this reason.

HTTP Status Code: 429

UnsupportedOperationException

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

code: The HTTP status code returned with the exception.
detailedMessage: A detailed message describing the problem.
requestId: The ID of the request in question.

HTTP Status Code: 400