---
title: "POST /import/annotation"
method: POST
path: "/import/annotation"
---

# POST /import/annotation

`POST /import/annotation`

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](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html).

Starts an annotation import job.

## Request body

- object
  - `destinationName` string, required — A destination annotation store for the job.
  - `roleArn` string, required — A service role for the job.
  - `items` AnnotationImportItemSource[], required — Items to import.
    - `source` string, required — The source file's location in Amazon S3.
  - `versionName` string — The name of the annotation store version.
  - `formatOptions` object — Formatting options for a file.
    - `tsvOptions` object — Options for a TSV file.
      - `readOptions` object — The file's read options.
        - `sep` string — The file's field separator.
        - `encoding` string — The file's encoding.
        - `quote` string — The file's quote character.
        - `quoteAll` boolean — Whether all values need to be quoted, or just those that contain quotes.
        - `escape` string — A character for escaping quotes in the file.
        - `escapeQuotes` boolean — Whether quotes need to be escaped in the file.
        - `comment` string — The file's comment character.
        - `header` boolean — Whether the file has a header row.
        - `lineSep` string — A line separator for the file.
    - `vcfOptions` object — Options for a VCF file.
      - `ignoreQualField` boolean — The file's ignore qual field setting.
      - `ignoreFilterField` boolean — The file's ignore filter field setting.
  - `runLeftNormalization` boolean — The job's left normalization setting.
  - `annotationFields` object — The annotation schema generated by the parsed annotation data.

## Response `200`

Success

- StartAnnotationImportResponse
  - `jobId` string, required — The job's ID.

## Other responses

- `480` — InternalServerException
- `481` — ServiceQuotaExceededException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — ResourceNotFoundException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/omics.md) · [All operations](https://skmtc.net/aws/apis/omics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/omics/versions/e9df1bcc0813/schema)