Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateAnnotationStore

Important

AWS HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS HealthOmics variant store and annotation store availability change.

Creates an annotation store.

Request Syntax


POST /annotationStore HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "reference": { ... },
   "sseConfig": { 
      "keyArn": "string",
      "type": "string"
   },
   "storeFormat": "string",
   "storeOptions": { ... },
   "tags": { 
      "string" : "string" 
   },
   "versionName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

A description for the store.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

name

A name for the store.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ([a-z]){1}([a-z0-9_]){2,254}

Required: No

reference

The genome reference for the store's annotations.

Type: ReferenceItem object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

sseConfig

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

Type: SseConfig object

Required: No

storeFormat

The annotation file format of the store.

Type: String

Valid Values: GFF | TSV | VCF

Required: Yes

storeOptions

File parsing options for the annotation store.

Type: StoreOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

tags

Tags for the store.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

versionName

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ([a-z]){1}([a-z0-9_]){2,254}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "name": "string",
   "reference": { ... },
   "status": "string",
   "storeFormat": "string",
   "storeOptions": { ... },
   "versionName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

creationTime

When the store was created.

Type: Timestamp

id

The store's ID.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

name

The store's name.

Type: String

reference

The store's genome reference. Required for all stores except TSV format with generic annotations.

Type: ReferenceItem object

Note: This object is a Union. Only one member of this object can be specified or returned.

status

The store's status.

Type: String

Valid Values: CREATING | UPDATING | DELETING | ACTIVE | FAILED

storeFormat

The annotation file format of the store.

Type: String

Valid Values: GFF | TSV | VCF

storeOptions

The store's file parsing options.

Type: StoreOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

versionName

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ([a-z]){1}([a-z0-9_]){2,254}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400