get_open_cypher_query_status ¶

get_open_cypher_query_status(
    query_id: str, *, config_overrides: Optional[neptunedataClientConfig] = None
) -> GetOpenCypherQueryStatusOutput

Retrieves the status of a specified openCypher query.

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:GetQueryStatus 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).

Parameters:

query_id (str) –

The unique ID of the openCypher query for which to retrieve the query status.

Raises:

AccessDeniedException –

Raised in case of an authentication or authorization failure.
BadRequestException –

Raised when a request is submitted that cannot be processed.
ClientTimeoutException –

Raised when a request timed out in the client.
ConcurrentModificationException –

Raised when a request attempts to modify data that is concurrently being modified by another process.
ConstraintViolationException –

Raised when a value in a request field did not satisfy required constraints.
FailureByQueryException –

Raised when a request fails.
IllegalArgumentException –

Raised when an argument in a request is not supported.
InvalidArgumentException –

Raised when an argument in a request has an invalid value.
InvalidNumericDataException –

Raised when invalid numerical data is encountered when servicing a request.
InvalidParameterException –

Raised when a parameter value is not valid.
MissingParameterException –

Raised when a required parameter is missing.
ParsingException –

Raised when a parsing issue is encountered.
PreconditionsFailedException –

Raised when a precondition for processing a request is not satisfied.
ReadOnlyViolationException –

Raised when a request attempts to write to a read-only resource.
TimeLimitExceededException –

Raised when the an operation exceeds the time limit allowed for it.
TooManyRequestsException –

Raised when the number of requests being processed exceeds the limit.
UnsupportedOperationException –

Raised when a request attempts to initiate an operation that is not supported.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_neptunedata/_services/neptunedata.py

def get_open_cypher_query_status(
    self,
    query_id: str,
    *,
    config_overrides: Optional[neptunedataClientConfig] = None,
) -> "capo_neptunedata.types.get_open_cypher_query_status_output.GetOpenCypherQueryStatusOutput":
    """<p>Retrieves the status of a specified openCypher query.</p> <p>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 <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getquerystatus">neptune-db:GetQueryStatus</a> IAM action in that cluster.</p> <p>Note that the <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys">neptune-db:QueryLanguage:OpenCypher</a> IAM condition key can be used in the policy document to restrict the use of openCypher queries (see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html">Condition keys available in Neptune IAM data-access policy statements</a>).</p>

    Args:
        query_id: <p>The unique ID of the openCypher query for which to retrieve the query status.</p>

    Raises:
        capo_neptunedata.errors.access_denied_exception.AccessDeniedException: <p>Raised in case of an authentication or authorization failure.</p>
        capo_neptunedata.errors.bad_request_exception.BadRequestException: <p>Raised when a request is submitted that cannot be processed.</p>
        capo_neptunedata.errors.client_timeout_exception.ClientTimeoutException: <p>Raised when a request timed out in the client.</p>
        capo_neptunedata.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Raised when a request attempts to modify data that is concurrently being modified by another process.</p>
        capo_neptunedata.errors.constraint_violation_exception.ConstraintViolationException: <p>Raised when a value in a request field did not satisfy required constraints.</p>
        capo_neptunedata.errors.failure_by_query_exception.FailureByQueryException: <p>Raised when a request fails.</p>
        capo_neptunedata.errors.illegal_argument_exception.IllegalArgumentException: <p>Raised when an argument in a request is not supported.</p>
        capo_neptunedata.errors.invalid_argument_exception.InvalidArgumentException: <p>Raised when an argument in a request has an invalid value.</p>
        capo_neptunedata.errors.invalid_numeric_data_exception.InvalidNumericDataException: <p>Raised when invalid numerical data is encountered when servicing a request.</p>
        capo_neptunedata.errors.invalid_parameter_exception.InvalidParameterException: <p>Raised when a parameter value is not valid.</p>
        capo_neptunedata.errors.missing_parameter_exception.MissingParameterException: <p>Raised when a required parameter is missing.</p>
        capo_neptunedata.errors.parsing_exception.ParsingException: <p>Raised when a parsing issue is encountered.</p>
        capo_neptunedata.errors.preconditions_failed_exception.PreconditionsFailedException: <p>Raised when a precondition for processing a request is not satisfied.</p>
        capo_neptunedata.errors.read_only_violation_exception.ReadOnlyViolationException: <p>Raised when a request attempts to write to a read-only resource.</p>
        capo_neptunedata.errors.time_limit_exceeded_exception.TimeLimitExceededException: <p>Raised when the an operation exceeds the time limit allowed for it.</p>
        capo_neptunedata.errors.too_many_requests_exception.TooManyRequestsException: <p>Raised when the number of requests being processed exceeds the limit.</p>
        capo_neptunedata.errors.unsupported_operation_exception.UnsupportedOperationException: <p>Raised when a request attempts to initiate an operation that is not supported.</p>
        capo_neptunedata.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptunedata.types.get_open_cypher_query_status_input.GetOpenCypherQueryStatusInput]",
    ) -> OperationResponse[
        "capo_neptunedata.types.get_open_cypher_query_status_output.GetOpenCypherQueryStatusOutput"
    ]:
        import capo_neptunedata._operations.amazon_neptune_dataplane.get_open_cypher_query_status

        output, http_response = (
            capo_neptunedata._operations.amazon_neptune_dataplane.get_open_cypher_query_status.get_open_cypher_query_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetOpenCypherQueryStatus")
    )
    input_: capo_neptunedata.types.get_open_cypher_query_status_input.GetOpenCypherQueryStatusInput = {
        "query_id": query_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output