Omics / Client / update_workflow_version

update_workflow_version

Omics.Client.update_workflow_version(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_workflow_version(
    workflowId='string',
    versionName='string',
    description='string',
    storageType='STATIC'|'DYNAMIC',
    storageCapacity=123,
    readmeMarkdown='string'
)
Parameters:

  • workflowId (string) –

    [REQUIRED]

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

  • versionName (string) –

    [REQUIRED]

    The name of the workflow version.

  • description (string) – Description of the workflow version.

  • storageType (string) – 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 .

  • storageCapacity (integer) – 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.

  • readmeMarkdown (string) – The markdown content for the workflow version’s README file. This provides documentation and usage information for users of this specific workflow version.

Returns:

None

Exceptions