execute_fast_reset ¶

execute_fast_reset(
    action: Action,
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
    token: Optional[str] = None,
) -> ExecuteFastResetOutput

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.

Parameters:

action (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.
token (Optional[str], default: None ) –

The fast-reset token to initiate the reset.

Raises:

AccessDeniedException –

Raised in case of an authentication or authorization failure.
ClientTimeoutException –

Raised when a request timed out in the client.
ConstraintViolationException –

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

Raised when an argument in a request is not supported.
InvalidArgumentException –

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

Raised when a parameter value is not valid.
MethodNotAllowedException –

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

Raised when a required parameter is missing.
PreconditionsFailedException –

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

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

Raised when the server shuts down while processing a request.
TooManyRequestsException –

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

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

The service returned an error code this client does not model.

Source code in docs_src/capo_neptunedata/_services/neptunedata.py

def execute_fast_reset(
    self,
    action: "capo_neptunedata.types.action.Action",
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
    token: Optional[str] = None,
) -> "capo_neptunedata.types.execute_fast_reset_output.ExecuteFastResetOutput":
    """<p>The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.</p> <p>Neptune fast reset is a two-step process. First you call <code>ExecuteFastReset</code> with <code>action</code> set to <code>initiateDatabaseReset</code>. This returns a UUID token which you then include when calling <code>ExecuteFastReset</code> again with <code>action</code> set to <code>performDatabaseReset</code>. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-fast-reset.html">Empty an Amazon Neptune DB cluster using the fast reset API</a>.</p> <p>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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#resetdatabase">neptune-db:ResetDatabase</a> IAM action in that cluster.</p>

    Args:
        action: <p>The fast reset action. One of the following values:</p> <ul> <li> <p> <b> <code>initiateDatabaseReset</code> </b> - This action generates a unique token needed to actually perform the fast reset.</p> </li> <li> <p> <b> <code>performDatabaseReset</code> </b> - This action uses the token generated by the <code>initiateDatabaseReset</code> action to actually perform the fast reset.</p> <p/> </li> </ul>
        token: <p>The fast-reset token to initiate the reset.</p>

    Raises:
        capo_neptunedata.errors.access_denied_exception.AccessDeniedException: <p>Raised in case of an authentication or authorization failure.</p>
        capo_neptunedata.errors.client_timeout_exception.ClientTimeoutException: <p>Raised when a request timed out in the client.</p>
        capo_neptunedata.errors.constraint_violation_exception.ConstraintViolationException: <p>Raised when a value in a request field did not satisfy required constraints.</p>
        capo_neptunedata.errors.illegal_argument_exception.IllegalArgumentException: <p>Raised when an argument in a request is not supported.</p>
        capo_neptunedata.errors.invalid_argument_exception.InvalidArgumentException: <p>Raised when an argument in a request has an invalid value.</p>
        capo_neptunedata.errors.invalid_parameter_exception.InvalidParameterException: <p>Raised when a parameter value is not valid.</p>
        capo_neptunedata.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Raised when the HTTP method used by a request is not supported by the endpoint being used.</p>
        capo_neptunedata.errors.missing_parameter_exception.MissingParameterException: <p>Raised when a required parameter is missing.</p>
        capo_neptunedata.errors.preconditions_failed_exception.PreconditionsFailedException: <p>Raised when a precondition for processing a request is not satisfied.</p>
        capo_neptunedata.errors.read_only_violation_exception.ReadOnlyViolationException: <p>Raised when a request attempts to write to a read-only resource.</p>
        capo_neptunedata.errors.server_shutdown_exception.ServerShutdownException: <p>Raised when the server shuts down while processing a request.</p>
        capo_neptunedata.errors.too_many_requests_exception.TooManyRequestsException: <p>Raised when the number of requests being processed exceeds the limit.</p>
        capo_neptunedata.errors.unsupported_operation_exception.UnsupportedOperationException: <p>Raised when a request attempts to initiate an operation that is not supported.</p>
        capo_neptunedata.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptunedata.types.execute_fast_reset_input.ExecuteFastResetInput]",
    ) -> OperationResponse[
        "capo_neptunedata.types.execute_fast_reset_output.ExecuteFastResetOutput"
    ]:
        import capo_neptunedata._operations.amazon_neptune_dataplane.execute_fast_reset

        output, http_response = (
            capo_neptunedata._operations.amazon_neptune_dataplane.execute_fast_reset.execute_fast_reset(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExecuteFastReset")
    )
    input_: capo_neptunedata.types.execute_fast_reset_input.ExecuteFastResetInput = {
        "action": action
    }
    if token is not None:
        input_["token"] = token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output