Skip to content

Update Workflow

omics_update_workflow R Documentation

Updates information about a workflow

Description

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 get_workflow API operation.

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

Usage

omics_update_workflow(id, name, description, storageType,
  storageCapacity, readmeMarkdown)

Arguments

id

[required] The workflow's ID.
name

A name for the workflow.
description

A description for the workflow.
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.
storageCapacity

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

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

Value

An empty list.

Request syntax

svc$update_workflow(
  id = "string",
  name = "string",
  description = "string",
  storageType = "STATIC"|"DYNAMIC",
  storageCapacity = 123,
  readmeMarkdown = "string"
)