Skip to content

Retrieves the metadata of one or more reference genomes in a reference store

Description

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Usage

omics_list_references(referenceStoreId, maxResults, nextToken, filter)

Arguments

  • referenceStoreId

    [required] The references' reference store ID.

  • maxResults

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

  • nextToken

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

  • filter

    A filter to apply to the list.

Value

A list with the following syntax:

list(
  nextToken = "string",
  references = list(
    list(
      id = "string",
      arn = "string",
      referenceStoreId = "string",
      md5 = "string",
      status = "ACTIVE"|"DELETING"|"DELETED",
      name = "string",
      description = "string",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      updateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_references(
  referenceStoreId = "string",
  maxResults = 123,
  nextToken = "string",
  filter = list(
    name = "string",
    md5 = "string",
    createdAfter = as.POSIXct(
      "2015-01-01"
    ),
    createdBefore = as.POSIXct(
      "2015-01-01"
    )
  )
)