Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443187284.6 KB

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.

get/status

Response

Success

statusstring

Set to <code>healthy</code> 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 <code>recovery</code>.

startTimestring

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

dbEngineVersionstring

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 <code>Patch-</code>.

rolestring

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

dfeQueryEnginestring

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

labModeobject

Contains Lab Mode settings being used by the engine.

rollingBackTrxCountinteger

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.

rollingBackTrxEarliestStartTimestring

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.

featuresobject

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

settingsobject

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