Skip to content

cancel_quantum_task 

cancel_quantum_task(
    quantum_task_arn: QuantumTaskArn,
    client_token: String64,
    *,
    config_overrides: Optional[BraketClientConfig] = None,
) -> CancelQuantumTaskResponse

Cancels the specified task.

Parameters:

  • quantum_task_arn (QuantumTaskArn) –

    The ARN of the quantum task to cancel.

  • client_token (String64) –

    The client token associated with the cancellation request.

Raises:

Source code in docs_src/capo_braket/_services/braket.py 
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
def cancel_quantum_task(
    self,
    quantum_task_arn: "capo_braket.types.quantum_task_arn.QuantumTaskArn",
    client_token: "capo_braket.types.string64.String64",
    *,
    config_overrides: Optional[BraketClientConfig] = None,
) -> "capo_braket.types.cancel_quantum_task_response.CancelQuantumTaskResponse":
    """<p>Cancels the specified task.</p>

    Args:
        quantum_task_arn: <p>The ARN of the quantum task to cancel.</p>
        client_token: <p>The client token associated with the cancellation request.</p>

    Raises:
        capo_braket.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_braket.errors.conflict_exception.ConflictException: <p>An error occurred due to a conflict.</p>
        capo_braket.errors.internal_service_exception.InternalServiceException: <p>The request failed because of an unknown error.</p>
        capo_braket.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_braket.errors.throttling_exception.ThrottlingException: <p>The API throttling rate limit is exceeded.</p>
        capo_braket.errors.validation_exception.ValidationException: <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
        capo_braket.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_braket.types.cancel_quantum_task_request.CancelQuantumTaskRequest]",
    ) -> OperationResponse[
        "capo_braket.types.cancel_quantum_task_response.CancelQuantumTaskResponse"
    ]:
        import capo_braket._operations.braket.cancel_quantum_task

        output, http_response = (
            capo_braket._operations.braket.cancel_quantum_task.cancel_quantum_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelQuantumTask")
    )
    input_: capo_braket.types.cancel_quantum_task_request.CancelQuantumTaskRequest = {
        "quantum_task_arn": quantum_task_arn,
        "client_token": client_token,
    }

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