update_workflow_version ¶

def update_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,
    description: Optional[
        "capo_omics.types.workflow_version_description.WorkflowVersionDescription"
    ] = None,
    storage_type: Optional["capo_omics.types.storage_type.StorageType"] = None,
    storage_capacity: Optional[int] = None,
    readme_markdown: Optional[
        "capo_omics.types.readme_markdown.ReadmeMarkdown"
    ] = None,
) -> None:
    """<p>Updates information about the workflow version. 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. The <code>workflowId</code> is not the UUID.</p>
        version_name: <p>The name of the workflow version.</p>
        description: <p>Description of the workflow version.</p>
        storage_type: <p>The default storage type for runs that use this workflow version. The <code>storageType</code> can be overridden at run time. <code>DYNAMIC</code> storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the <i>in the <i>Amazon Web Services HealthOmics User Guide</i> </i>.</p>
        storage_capacity: <p>The default static storage capacity (in gibibytes) for runs that use this workflow version. The <code>storageCapacity</code> can be overwritten at run time. The storage capacity is not required for runs with a <code>DYNAMIC</code> storage type.</p>
        readme_markdown: <p>The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.</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.update_workflow_version_request.UpdateWorkflowVersionRequest]",
    ) -> OperationResponse[None]:
        import capo_omics._operations.omics.update_workflow_version

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkflowVersion")
    )
    input_: capo_omics.types.update_workflow_version_request.UpdateWorkflowVersionRequest = {
        "workflow_id": workflow_id,
        "version_name": version_name,
    }
    if description is not None:
        input_["description"] = description
    if storage_type is not None:
        input_["storage_type"] = storage_type
    if storage_capacity is not None:
        input_["storage_capacity"] = storage_capacity
    if readme_markdown is not None:
        input_["readme_markdown"] = readme_markdown

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