NeptuneData / Client / execute_gremlin_profile_query

execute_gremlin_profile_query#

NeptuneData.Client.execute_gremlin_profile_query(**kwargs)#

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.

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

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_profile_query(
    gremlinQuery='string',
    results=True|False,
    chop=123,
    serializer='string',
    indexOps=True|False
)
Parameters:

  • gremlinQuery (string) –

    [REQUIRED]

    The Gremlin query string to profile.

  • results (boolean) – If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

  • chop (integer) – If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

  • serializer (string) – If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

  • indexOps (boolean) – If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

Return type:

dict

Returns:

Response Syntax

{
    'output': StreamingBody()
}

Response Structure

Exceptions

  • NeptuneData.Client.exceptions.QueryTooLargeException

  • NeptuneData.Client.exceptions.BadRequestException

  • NeptuneData.Client.exceptions.QueryLimitExceededException

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.QueryLimitException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.CancelledByUserException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.FailureByQueryException

  • NeptuneData.Client.exceptions.MemoryLimitExceededException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.MalformedQueryException

  • NeptuneData.Client.exceptions.ParsingException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.TimeLimitExceededException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.ConcurrentModificationException

  • NeptuneData.Client.exceptions.MissingParameterException