Omics / Client / update_workflow

update_workflow¶

Omics.Client.update_workflow(**kwargs)¶

Updates information about a workflow.

You can update the following workflow information:

Name
Description
Default storage type
Default storage capacity (with workflow ID)

This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the GetWorkflow API operation.

For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

Request Syntax

response = client.update_workflow(
    id='string',
    name='string',
    description='string',
    storageType='STATIC'|'DYNAMIC',
    storageCapacity=123,
    readmeMarkdown='string'
)

Parameters:

id (string) –
[REQUIRED]

The workflow’s ID.
name (string) – A name for the workflow.
description (string) – A description for the workflow.
storageType (string) – 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.
storageCapacity (integer) – The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
readmeMarkdown (string) – The markdown content for the workflow’s README file. This provides documentation and usage information for users of the workflow.

Returns:

None

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException