Skip to content

Create Annotation Store

omics_create_annotation_store R Documentation

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers

Description

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change.

Creates an annotation store.

Usage

omics_create_annotation_store(reference, name, description, tags,
  versionName, sseConfig, storeFormat, storeOptions)

Arguments

reference

The genome reference for the store's annotations.

name

A name for the store.

description

A description for the store.

tags

Tags for the store.

versionName

The name given to an annotation store version to distinguish it from other versions.

sseConfig

Server-side encryption (SSE) settings for the store.

storeFormat

[required] The annotation file format of the store.

storeOptions

File parsing options for the annotation store.

Value

A list with the following syntax:

list(
  id = "string",
  reference = list(
    referenceArn = "string"
  ),
  storeFormat = "GFF"|"TSV"|"VCF",
  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"
        )
      )
    )
  ),
  status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED",
  name = "string",
  versionName = "string",
  creationTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_annotation_store(
  reference = list(
    referenceArn = "string"
  ),
  name = "string",
  description = "string",
  tags = list(
    "string"
  ),
  versionName = "string",
  sseConfig = list(
    type = "KMS",
    keyArn = "string"
  ),
  storeFormat = "GFF"|"TSV"|"VCF",
  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"
        )
      )
    )
  )
)