Skip to content

UpdateWorkflowRequest

Source code in docs_src/capo_omics/types/update_workflow_request.py
class UpdateWorkflowRequest(TypedDict, closed=True):
    id: "capo_omics.types.workflow_id.WorkflowId"
    """<p>The workflow's ID.</p>"""
    name: NotRequired["capo_omics.types.workflow_name.WorkflowName"]
    """<p>A name for the workflow.</p>"""
    description: NotRequired[
        "capo_omics.types.workflow_description.WorkflowDescription"
    ]
    """<p>A description for the workflow.</p>"""
    storage_type: NotRequired["capo_omics.types.storage_type.StorageType"]
    """<p>The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see <a href="https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html">Running workflows</a> in the <i>Amazon Web Services HealthOmics User Guide</i>. </p>"""
    storage_capacity: NotRequired["int"]
    """<p>The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. </p>"""
    readme_markdown: NotRequired["capo_omics.types.readme_markdown.ReadmeMarkdown"]
    """<p>The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.</p>"""

description instance-attribute

description: NotRequired[WorkflowDescription]

A description for the workflow.

id instance-attribute

The workflow's ID.

name instance-attribute

name: NotRequired[WorkflowName]

A name for the workflow.

readme_markdown instance-attribute

readme_markdown: NotRequired[ReadmeMarkdown]

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

storage_capacity instance-attribute

storage_capacity: NotRequired[int]

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

storage_type instance-attribute

storage_type: NotRequired[StorageType]

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.