Skip to content

cancel_job

cancel_job(
    job_arn: JobArn, *, config_overrides: Optional[BraketClientConfig] = None
) -> CancelJobResponse

Cancels an Amazon Braket hybrid job.

Parameters:

  • job_arn (JobArn) –

    The ARN of the Amazon Braket hybrid job to cancel.

Raises:

Source code in docs_src/capo_braket/_services/braket.py
def cancel_job(
    self,
    job_arn: "capo_braket.types.job_arn.JobArn",
    *,
    config_overrides: Optional[BraketClientConfig] = None,
) -> "capo_braket.types.cancel_job_response.CancelJobResponse":
    """<p>Cancels an Amazon Braket hybrid job.</p>

    Args:
        job_arn: <p>The ARN of the Amazon Braket hybrid job to cancel.</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_job_request.CancelJobRequest]",
    ) -> OperationResponse[
        "capo_braket.types.cancel_job_response.CancelJobResponse"
    ]:
        import capo_braket._operations.braket.cancel_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelJob")
    )
    input_: capo_braket.types.cancel_job_request.CancelJobRequest = {
        "job_arn": job_arn
    }

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