Skip to content

cancel_query async

cancel_query(
    graph_identifier: GraphIdentifier,
    query_id: str,
    *,
    config_overrides: Optional[AsyncNeptuneGraphClientConfig] = None,
) -> None

Cancels a specified query.

Parameters:

  • graph_identifier (GraphIdentifier) –

    The unique identifier of the Neptune Analytics graph.

  • query_id (str) –

    The unique identifier of the query to cancel.

Raises:

Source code in docs_src/capo_neptune_graph/_services/async_neptune_graph.py
async def cancel_query(
    self,
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier",
    query_id: str,
    *,
    config_overrides: Optional[AsyncNeptuneGraphClientConfig] = None,
) -> None:
    """<p>Cancels a specified query.</p>

    Args:
        graph_identifier: <p>The unique identifier of the Neptune Analytics graph.</p>
        query_id: <p>The unique identifier of the query to cancel.</p>

    Raises:
        capo_neptune_graph.errors.access_denied_exception.AccessDeniedException: <p>Raised in case of an authentication or authorization failure.</p>
        capo_neptune_graph.errors.internal_server_exception.InternalServerException: <p>A failure occurred on the server.</p>
        capo_neptune_graph.errors.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource could not be located.</p>
        capo_neptune_graph.errors.throttling_exception.ThrottlingException: <p>The exception was interrupted by throttling.</p>
        capo_neptune_graph.errors.validation_exception.ValidationException: <p>A resource could not be validated.</p>
        capo_neptune_graph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_neptune_graph.types.cancel_query_input.CancelQueryInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_neptune_graph._operations.amazon_neptune_graph.cancel_query

        (
            output,
            http_response,
        ) = await capo_neptune_graph._operations.amazon_neptune_graph.cancel_query.async_cancel_query(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelQuery")
    )
    input_: capo_neptune_graph.types.cancel_query_input.CancelQueryInput = {
        "graph_identifier": graph_identifier,
        "query_id": query_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output