cancel_statement ¶

def cancel_statement(
    self,
    id: "capo_redshift_data.types.uuid.UUID",
    *,
    config_overrides: Optional[RedshiftDataClientConfig] = None,
) -> "capo_redshift_data.types.cancel_statement_response.CancelStatementResponse":
    """<p>Cancels a running query. To be canceled, a query must be running. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>

    Args:
        id: <p>The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by <code>BatchExecuteStatment</code>, <code>ExecuteStatment</code>, and <code>ListStatements</code>. </p>

    Raises:
        capo_redshift_data.errors.database_connection_exception.DatabaseConnectionException: <p>Connection to a database failed.</p>
        capo_redshift_data.errors.internal_server_exception.InternalServerException: <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
        capo_redshift_data.errors.query_timeout_exception.QueryTimeoutException: <p>The Amazon Redshift Data API operation failed due to timeout.</p>
        capo_redshift_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>The Amazon Redshift Data API operation failed due to a missing resource. </p>
        capo_redshift_data.errors.validation_exception.ValidationException: <p>The Amazon Redshift Data API operation failed due to invalid input. </p>
        capo_redshift_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_data.types.cancel_statement_request.CancelStatementRequest]",
    ) -> OperationResponse[
        "capo_redshift_data.types.cancel_statement_response.CancelStatementResponse"
    ]:
        import capo_redshift_data._operations.redshift_data.cancel_statement

        output, http_response = (
            capo_redshift_data._operations.redshift_data.cancel_statement.cancel_statement(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelStatement")
    )
    input_: capo_redshift_data.types.cancel_statement_request.CancelStatementRequest = {
        "id": id
    }

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