Skip to content

Start Annotation Import Job

omics_start_annotation_import_job R Documentation

Starts an annotation import job

Description

Starts an annotation import job.

Usage

omics_start_annotation_import_job(destinationName, roleArn, items,
  versionName, formatOptions, runLeftNormalization, annotationFields)

Arguments

destinationName

[required] A destination annotation store for the job.

roleArn

[required] A service role for the job.

items

[required] Items to import.

versionName

The name of the annotation store version.

formatOptions

Formatting options for the annotation file.

runLeftNormalization

The job's left normalization setting.

annotationFields

The annotation schema generated by the parsed annotation data.

Value

A list with the following syntax:

list(
  jobId = "string"
)

Request syntax

svc$start_annotation_import_job(
  destinationName = "string",
  roleArn = "string",
  items = list(
    list(
      source = "string"
    )
  ),
  versionName = "string",
  formatOptions = list(
    tsvOptions = list(
      readOptions = list(
        sep = "string",
        encoding = "string",
        quote = "string",
        quoteAll = TRUE|FALSE,
        escape = "string",
        escapeQuotes = TRUE|FALSE,
        comment = "string",
        header = TRUE|FALSE,
        lineSep = "string"
      )
    ),
    vcfOptions = list(
      ignoreQualField = TRUE|FALSE,
      ignoreFilterField = TRUE|FALSE
    )
  ),
  runLeftNormalization = TRUE|FALSE,
  annotationFields = list(
    "string"
  )
)