delete_run ¶

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

Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED, FAILED, or CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.

To verify that the workflow is deleted:

Use ListRuns to confirm the workflow no longer appears in the list.
Use GetRun to verify the workflow cannot be found.

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 delete_run(
    self,
    id: "capo_omics.types.run_id.RunId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> None:
    """<p>Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a <code>COMPLETED</code>, <code>FAILED</code>, or <code>CANCELLED</code> stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.</p> <p>To verify that the workflow is deleted:</p> <ul> <li> <p>Use <code>ListRuns</code> to confirm the workflow no longer appears in the list.</p> </li> <li> <p>Use <code>GetRun</code> to verify the workflow cannot be found.</p> </li> </ul>

    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.delete_run_request.DeleteRunRequest]",
    ) -> OperationResponse[None]:
        import capo_omics._operations.omics.delete_run

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRun")
    )
    input_: capo_omics.types.delete_run_request.DeleteRunRequest = {"id": id}

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