Skip to content

Get Annotation Store Version

omics_get_annotation_store_version R Documentation

Retrieves the metadata for an annotation store version

Description

Retrieves the metadata for an annotation store version.

Usage

omics_get_annotation_store_version(name, versionName)

Arguments

name

[required] The name given to an annotation store version to distinguish it from others.

versionName

[required] The name given to an annotation store version to distinguish it from others.

Value

A list with the following syntax:

list(
  storeId = "string",
  id = "string",
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED",
  versionArn = "string",
  name = "string",
  versionName = "string",
  description = "string",
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  updateTime = as.POSIXct(
    "2015-01-01"
  ),
  tags = list(
    "string"
  ),
  versionOptions = list(
    tsvVersionOptions = list(
      annotationType = "GENERIC"|"CHR_POS"|"CHR_POS_REF_ALT"|"CHR_START_END_ONE_BASE"|"CHR_START_END_REF_ALT_ONE_BASE"|"CHR_START_END_ZERO_BASE"|"CHR_START_END_REF_ALT_ZERO_BASE",
      formatToHeader = list(
        "string"
      ),
      schema = list(
        list(
          "LONG"|"INT"|"STRING"|"FLOAT"|"DOUBLE"|"BOOLEAN"
        )
      )
    )
  ),
  statusMessage = "string",
  versionSizeBytes = 123
)

Request syntax

svc$get_annotation_store_version(
  name = "string",
  versionName = "string"
)