Skip to content

GetEngineStatusOutput

Source code in docs_src/capo_neptunedata/types/get_engine_status_output.py
class GetEngineStatusOutput(TypedDict, closed=True):
    status: NotRequired["str"]
    """<p>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>.</p>"""
    start_time: NotRequired["str"]
    """<p>Set to the UTC time at which the current server process started.</p>"""
    db_engine_version: NotRequired["str"]
    """<p>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>.</p>"""
    role: NotRequired["str"]
    """<p>Set to <code>reader</code> if the instance is a read-replica, or to <code>writer</code> if the instance is the primary instance.</p>"""
    dfe_query_engine: NotRequired["str"]
    """<p>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>.</p>"""
    gremlin: NotRequired[
        "capo_neptunedata.types.query_language_version.QueryLanguageVersion"
    ]
    """<p>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.</p>"""
    sparql: NotRequired[
        "capo_neptunedata.types.query_language_version.QueryLanguageVersion"
    ]
    """<p>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.</p>"""
    opencypher: NotRequired[
        "capo_neptunedata.types.query_language_version.QueryLanguageVersion"
    ]
    """<p>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.</p>"""
    lab_mode: NotRequired["capo_neptunedata.types.string_valued_map.StringValuedMap"]
    """<p>Contains Lab Mode settings being used by the engine.</p>"""
    rolling_back_trx_count: NotRequired["int"]
    """<p>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.</p>"""
    rolling_back_trx_earliest_start_time: NotRequired["str"]
    """<p>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.</p>"""
    features: NotRequired[
        "capo_neptunedata.types.document_valued_map.DocumentValuedMap"
    ]
    """<p>Contains status information about the features enabled on your DB cluster.</p>"""
    settings: NotRequired["capo_neptunedata.types.string_valued_map.StringValuedMap"]
    """<p>Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (<code>clusterQueryTimeoutInMs</code>).</p>"""

db_engine_version instance-attribute

db_engine_version: NotRequired[str]

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

dfe_query_engine instance-attribute

dfe_query_engine: NotRequired[str]

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 instance-attribute

features: NotRequired[DocumentValuedMap]

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

gremlin instance-attribute

gremlin: NotRequired[QueryLanguageVersion]

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.

lab_mode instance-attribute

lab_mode: NotRequired[StringValuedMap]

Contains Lab Mode settings being used by the engine.

opencypher instance-attribute

opencypher: NotRequired[QueryLanguageVersion]

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 instance-attribute

role: NotRequired[str]

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

rolling_back_trx_count instance-attribute

rolling_back_trx_count: NotRequired[int]

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.

rolling_back_trx_earliest_start_time instance-attribute

rolling_back_trx_earliest_start_time: NotRequired[str]

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 instance-attribute

settings: NotRequired[StringValuedMap]

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

sparql instance-attribute

sparql: NotRequired[QueryLanguageVersion]

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.

start_time instance-attribute

start_time: NotRequired[str]

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

status instance-attribute

status: NotRequired[str]

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.