NeptuneData / Client / execute_fast_reset

execute_fast_reset#

NeptuneData.Client.execute_fast_reset(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.execute_fast_reset(
    action='initiateDatabaseReset'|'performDatabaseReset',
    token='string'
)
Parameters:

  • action (string) –

    [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 (string) – The fast-reset token to initiate the reset.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'payload': {
        'token': 'string'
    }
}

Response Structure

  • (dict) –

    • status (string) –

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

    • payload (dict) –

      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.

      • token (string) –

        A UUID generated by the database in the initiateDatabaseReset action, and then consumed by the performDatabaseReset to reset the database.

Exceptions

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.AccessDeniedException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.ServerShutdownException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.MethodNotAllowedException

  • NeptuneData.Client.exceptions.ReadOnlyViolationException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.MissingParameterException