Neptune dataplane engine, fast reset, and general structure APIs - Amazon Neptune
GetEngineStatusExecuteFastReset________________________QueryLanguageVersionFastResetToken
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Neptune dataplane engine, fast reset, and general structure APIs

Engine operations:

Engine operation structures:

GetEngineStatus (action)

        The Amazon CLI name for this API is: get-engine-status.

Retrieves the status of the graph database on the host.

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:GetEngineStatus IAM action in that cluster.

Request

  • No Request parameters.

Response

  • dbEngineVersion   – a String, of type: string (a UTF-8 encoded string).

    Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by Patch-.

  • dfeQueryEngine   – a String, of type: string (a UTF-8 encoded string).

    Set to enabled if the DFE engine is fully enabled, or to viaQueryHint (the default) if the DFE engine is only used with queries that have the useDFE query hint set to true.

  • features   – It is a map array of key-value pairs where:

        Each key is a a String, of type: string (a UTF-8 encoded string).

        Each value is a a Document, of type: document (a protocol-agnostic open content represented by a JSON-like data model).

    Contains status information about the features enabled on your DB cluster.

  • gremlin   – A QueryLanguageVersion object.

    Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.

  • labMode   – It is a map array of key-value pairs where:

        Each key is a a String, of type: string (a UTF-8 encoded string).

        Each value is a a String, of type: string (a UTF-8 encoded string).

    Contains Lab Mode settings being used by the engine.

  • opencypher   – A QueryLanguageVersion object.

    Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.

  • role   – a String, of type: string (a UTF-8 encoded string).

    Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.

  • rollingBackTrxCount   – an Integer, of type: integer (a signed 32-bit integer).

    If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn't appear at all.

  • rollingBackTrxEarliestStartTime   – a String, of type: string (a UTF-8 encoded string).

    Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn't appear at all.

  • settings   – It is a map array of key-value pairs where:

        Each key is a a String, of type: string (a UTF-8 encoded string).

        Each value is a a String, of type: string (a UTF-8 encoded string).

    Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (clusterQueryTimeoutInMs).

  • sparql   – A QueryLanguageVersion object.

    Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.

  • startTime   – a String, of type: string (a UTF-8 encoded string).

    Set to the UTC time at which the current server process started.

  • status   – a String, of type: string (a UTF-8 encoded string).

    Set to healthy if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to recovery.

Errors

ExecuteFastReset (action)

        The Amazon CLI name for this API is: execute-fast-reset.

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

  • action  (in the CLI: --action) –  Required: an Action, of type: string (a UTF-8 encoded string).

    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  (in the CLI: --token) –  a String, of type: string (a UTF-8 encoded string).

    The fast-reset token to initiate the reset.

Response

  • payload   – A FastResetToken object.

    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.

  • status   – Required: a String, of type: string (a UTF-8 encoded string).

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

Errors

Engine operation structures:

QueryLanguageVersion (structure)

Structure for expressing the query language version.

Fields

  • version – This is Required: a String, of type: string (a UTF-8 encoded string).

    The version of the query language.

FastResetToken (structure)

A structure containing the fast reset token used to initiate a fast reset.

Fields

  • token – This is a String, of type: string (a UTF-8 encoded string).

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