NeptuneData / Client / execute_open_cypher_explain_query
execute_open_cypher_explain_query#
- NeptuneData.Client.execute_open_cypher_explain_query(**kwargs)#
Executes an openCypher
explain
request. See The openCypher explain feature for more information.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:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).
See also: AWS API Documentation
Request Syntax
response = client.execute_open_cypher_explain_query( openCypherQuery='string', parameters='string', explainMode='static'|'dynamic'|'details' )
- Parameters:
openCypherQuery (string) –
[REQUIRED]
The openCypher query string.
parameters (string) – The openCypher query parameters.
explainMode (string) –
[REQUIRED]
The openCypher
explain
mode. Can be one of:static
,dynamic
, ordetails
.
- Return type:
dict
- Returns:
Response Syntax
{ 'results': StreamingBody() }
Response Structure
(dict) –
results (
StreamingBody
) –A text blob containing the openCypher
explain
results.
Exceptions
NeptuneData.Client.exceptions.QueryTooLargeException
NeptuneData.Client.exceptions.InvalidNumericDataException
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