Skip to content

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

Description

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 execute_fast_reset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling execute_fast_reset 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.

Usage

neptunedata_execute_fast_reset(action, token)

Arguments

  • action

    [required] 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.

  • token

    The fast-reset token to initiate the reset.

Value

A list with the following syntax:

list(
  status = "string",
  payload = list(
    token = "string"
  )
)

Request syntax

svc$execute_fast_reset(
  action = "initiateDatabaseReset"|"performDatabaseReset",
  token = "string"
)