Skip to content

Retrieves a list of existing workflows

Description

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

Usage

omics_list_workflows(type, name, startingToken, maxResults)

Arguments

  • type

    Filter the list by workflow type.

  • name

    Filter the list by workflow name.

  • startingToken

    Specify the pagination token from a previous request to retrieve the next page of results.

  • maxResults

    The maximum number of workflows to return in one page of results.

Value

A list with the following syntax:

list(
  items = list(
    list(
      arn = "string",
      id = "string",
      name = "string",
      status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETED"|"FAILED"|"INACTIVE",
      type = "PRIVATE"|"READY2RUN",
      digest = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      metadata = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_workflows(
  type = "PRIVATE"|"READY2RUN",
  name = "string",
  startingToken = "string",
  maxResults = 123
)