NeptuneData / Client / execute_gremlin_query

execute_gremlin_query#

NeptuneData.Client.execute_gremlin_query(**kwargs)#

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

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 enables one of the following IAM actions in that cluster, depending on the query:

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

See also: AWS API Documentation

Request Syntax

response = client.execute_gremlin_query(
    gremlinQuery='string',
    serializer='string'
)
Parameters:

  • gremlinQuery (string) –

    [REQUIRED]

    Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the Tinkerpop client section to determine which Gremlin releases your engine version supports).

  • serializer (string) – If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'status': {
        'message': 'string',
        'code': 123,
        'attributes': {...}|[...]|123|123.4|'string'|True|None
    },
    'result': {...}|[...]|123|123.4|'string'|True|None,
    'meta': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • requestId (string) –

      The unique identifier of the Gremlin query.

    • status (dict) –

      The status of the Gremlin query.

      • message (string) –

        The status message.

      • code (integer) –

        The HTTP response code returned fro the Gremlin query request..

      • attributes (document) –

        Attributes of the Gremlin query status.

    • result (document) –

      The Gremlin query output from the server.

    • meta (document) –

      Metadata about the Gremlin query.

Exceptions