NeptuneGraph / Client / list_queries

list_queries#

NeptuneGraph.Client.list_queries(**kwargs)#

Lists active openCypher queries.

See also: AWS API Documentation

Request Syntax

response = client.list_queries(
    graphIdentifier='string',
    maxResults=123,
    state='ALL'|'RUNNING'|'WAITING'|'CANCELLING'
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The unique identifier of the Neptune Analytics graph.

  • maxResults (integer) –

    [REQUIRED]

    The maximum number of results to be fetched by the API.

  • state (string) – Filtered list of queries based on state.

Return type:

dict

Returns:

Response Syntax

{
    'queries': [
        {
            'id': 'string',
            'queryString': 'string',
            'waited': 123,
            'elapsed': 123,
            'state': 'RUNNING'|'WAITING'|'CANCELLING'
        },
    ]
}

Response Structure

  • (dict) –

    • queries (list) –

      A list of current openCypher queries.

      • (dict) –

        Details of the query listed.

        • id (string) –

          A string representation of the id of the query.

        • queryString (string) –

          The actual query text. The queryString may be truncated if the actual query string is too long.

        • waited (integer) –

          The amount of time, in milliseconds, the query has waited in the queue before being picked up by a worker thread.

        • elapsed (integer) –

          The running time of the query, in milliseconds.

        • state (string) –

          State of the query.

Exceptions