GetSequenceStore - HealthOmics API Reference

GetSequenceStore

Gets information about a sequence store.

Request Syntax

GET /sequencestore/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The store's ID.

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationTime": "string", "description": "string", "eTagAlgorithmFamily": "string", "fallbackLocation": "string", "id": "string", "name": "string", "s3Access": { "s3AccessPointArn": "string", "s3Uri": "string" }, "sseConfig": { "keyArn": "string", "type": "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.

arn

The store's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: arn:.+

creationTime

When the store was created.

Type: Timestamp

description

The store's description.

Type: String

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

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

eTagAlgorithmFamily

The algorithm family of the ETag.

Type: String

Valid Values: MD5up | SHA256up | SHA512up

fallbackLocation

An S3 location that is used to store files that have failed a direct upload.

Type: String

Pattern: s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?

id

The store's ID.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

name

The store's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

s3Access

The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.

Type: SequenceStoreS3Access object

sseConfig

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

Type: SseConfig object

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

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

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: