GetAnnotationStore - HealthOmics API Reference

GetAnnotationStore

Gets information about an annotation store.

Request Syntax

GET /annotationStore/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The store's name.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "creationTime": "string", "description": "string", "id": "string", "name": "string", "numVersions": number, "reference": { ... }, "sseConfig": { "keyArn": "string", "type": "string" }, "status": "string", "statusMessage": "string", "storeArn": "string", "storeFormat": "string", "storeOptions": { ... }, "storeSizeBytes": number, "tags": { "string" : "string" }, "updateTime": "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

description

The store's description.

Type: String

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

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

numVersions

An integer indicating how many versions of an annotation store exist.

Type: Integer

reference

The store's genome reference.

Type: ReferenceItem object

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

sseConfig

The store's server-side encryption (SSE) settings.

Type: SseConfig object

status

The store's status.

Type: String

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

statusMessage

A status message.

Type: String

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

storeArn

The store's ARN.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)

storeFormat

The store's annotation file format.

Type: String

Valid Values: GFF | TSV | VCF

storeOptions

The store's parsing options.

Type: StoreOptions object

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

storeSizeBytes

The store's size in bytes.

Type: Long

tags

The store's tags.

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.

updateTime

When the store was updated.

Type: Timestamp

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

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: