Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

Creates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats (BAM and CRAM), a sequence store can only use one reference genome. For unaligned formats (FASTQ and uBAM), a reference genome is not required. You can create multiple sequence stores per region per account.

The following are optional parameters you can specify for your sequence store:

  • Use s3AccessConfig to configure your sequence store with S3 access logs (recommended).

  • Use sseConfig to define your own KMS key for encryption.

  • Use eTagAlgorithmFamily to define which algorithm to use for the HealthOmics eTag on objects.

  • Use fallbackLocation to define a backup location for storing files that have failed a direct upload.

  • Use propagatedSetLevelTags to configure tags that propagate to all objects in your store.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

post/sequencestore

Request body

namestring required

A name for the store.

descriptionstring

A description for the store.

tagsobject

Tags for the store. You can configure up to 50 tags.

clientTokenstring

An idempotency token used to dedupe retry requests so that duplicate runs are not created.

fallbackLocationstring

An S3 location that is used to store files that have failed a direct upload. You can add or change the <code>fallbackLocation</code> after creating a sequence store. This is not required if you are uploading files from a different S3 bucket.

eTagAlgorithmFamily'MD5up' | 'SHA256up' | 'SHA512up'

The ETag algorithm family to use for ingested read sets. The default value is MD5up. For more information on ETags, see <a href="https://docs.aws.amazon.com/omics/latest/dev/etags-and-provenance.html">ETags and data provenance</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.

propagatedSetLevelTagsTagKey[]

The tags keys to propagate to the S3 objects associated with read sets in the sequence store. These tags can be used as input to add metadata to your read sets.

Response

Success

idstring required

The store's ID.

arnstring required

The store's ARN.

namestring

The store's name.

descriptionstring

The store's description.

creationTimestring date-time required

When the store was created.

fallbackLocationstring

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

eTagAlgorithmFamily'MD5up' | 'SHA256up' | 'SHA512up'

The algorithm family of the ETag.

status'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'FAILED'

The status of the sequence store.

statusMessagestring

The status message of the sequence store.

propagatedSetLevelTagsTagKey[]

The tags keys to propagate to the S3 objects associated with read sets in the sequence store.