Skip to content

Get Annotation Store

omics_get_annotation_store R Documentation

Gets information about an annotation store

Description

Gets information about an annotation store.

Usage

omics_get_annotation_store(name)

Arguments

name

[required] The store's name.

Value

A list with the following syntax:

list(
  id = "string",
  reference = list(
    referenceArn = "string"
  ),
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED",
  storeArn = "string",
  name = "string",
  description = "string",
  sseConfig = list(
    type = "KMS",
    keyArn = "string"
  ),
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  updateTime = as.POSIXct(
    "2015-01-01"
  ),
  tags = list(
    "string"
  ),
  storeOptions = list(
    tsvStoreOptions = 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"
        )
      )
    )
  ),
  storeFormat = "GFF"|"TSV"|"VCF",
  statusMessage = "string",
  storeSizeBytes = 123,
  numVersions = 123
)

Request syntax

svc$get_annotation_store(
  name = "string"
)