delete_workflow_version ¶

delete_workflow_version(
    workflow_id: WorkflowId,
    version_name: WorkflowVersionName,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> None

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Parameters:

workflow_id (WorkflowId) –

The workflow's ID.
version_name (WorkflowVersionName) –

The workflow version name.

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_workflow_version(
    self,
    workflow_id: "capo_omics.types.workflow_id.WorkflowId",
    version_name: "capo_omics.types.workflow_version_name.WorkflowVersionName",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
) -> None:
    """<p>Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        workflow_id: <p>The workflow's ID.</p>
        version_name: <p>The workflow version name.</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_workflow_version_request.DeleteWorkflowVersionRequest]",
    ) -> OperationResponse[None]:
        import capo_omics._operations.omics.delete_workflow_version

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkflowVersion")
    )
    input_: capo_omics.types.delete_workflow_version_request.DeleteWorkflowVersionRequest = {
        "workflow_id": workflow_id,
        "version_name": version_name,
    }

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