cancel_run ¶

cancel_run(id: RunId, *, config_overrides: Optional[OmicsClientConfig] = None) -> None

Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns API operation to check that it is no longer listed.

Parameters:

id (RunId) –

The run's ID.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request cannot be applied to the target resource in its current state.
InternalServerException –

An unexpected error occurred. Try the request again.
RequestTimeoutException –

The request timed out.
ResourceNotFoundException –

The target resource was not found in the current Region.
ServiceQuotaExceededException –

The request exceeds a service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_omics/_services/omics.py

def cancel_run(
    self,
    id: "capo_omics.types.run_id.RunId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> None:
    """<p>Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the <code>ListRuns</code> API operation to check that it is no longer listed.</p>

    Args:
        id: <p>The run's ID.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.cancel_run_request.CancelRunRequest]",
    ) -> OperationResponse[None]:
        import capo_omics._operations.omics.cancel_run

        output, http_response = capo_omics._operations.omics.cancel_run.cancel_run(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelRun")
    )
    input_: capo_omics.types.cancel_run_request.CancelRunRequest = {"id": id}

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