AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginExecuteFastReset and EndExecuteFastReset.

Namespace: Amazon.Neptunedata
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<ExecuteFastResetResponse> ExecuteFastResetAsync(
         ExecuteFastResetRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Neptunedata.Model.ExecuteFastResetRequest

Container for the necessary parameters to execute the ExecuteFastReset service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ExecuteFastReset service method, as returned by Neptunedata.

Exceptions

ExceptionCondition
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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also