Skip to content

UpdateWorkflowVersionRequest

Source code in docs_src/capo_omics/types/update_workflow_version_request.py
class UpdateWorkflowVersionRequest(TypedDict, closed=True):
    workflow_id: "capo_omics.types.workflow_id.WorkflowId"
    """<p>The workflow's ID. The <code>workflowId</code> is not the UUID.</p>"""
    version_name: "capo_omics.types.workflow_version_name.WorkflowVersionName"
    """<p>The name of the workflow version.</p>"""
    description: NotRequired[
        "capo_omics.types.workflow_version_description.WorkflowVersionDescription"
    ]
    """<p>Description of the workflow version.</p>"""
    storage_type: NotRequired["capo_omics.types.storage_type.StorageType"]
    """<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: NotRequired["int"]
    """<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: NotRequired["capo_omics.types.readme_markdown.ReadmeMarkdown"]
    """<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>"""

description instance-attribute

description: NotRequired[WorkflowVersionDescription]

Description of the workflow version.

readme_markdown instance-attribute

readme_markdown: NotRequired[ReadmeMarkdown]

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

storage_capacity instance-attribute

storage_capacity: NotRequired[int]

The default static storage capacity (in gibibytes) for runs that use this workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

storage_type instance-attribute

storage_type: NotRequired[StorageType]

The default storage type for runs that use this workflow version. The storageType can be overridden at run time. DYNAMIC 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 Run storage types in the in the Amazon Web Services HealthOmics User Guide .

version_name instance-attribute

version_name: WorkflowVersionName

The name of the workflow version.

workflow_id instance-attribute

workflow_id: WorkflowId

The workflow's ID. The workflowId is not the UUID.