v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the <code>ListTagsForResource</code> API operation.

get/sequencestore/{sequenceStoreId}/readset/{id}/metadata

Path parameters

idstring required

The read set's ID.

sequenceStoreIdstring required

The read set's sequence store ID.

Response

Success

idstring required

The read set's ID.

arnstring required

The read set's ARN.

sequenceStoreIdstring required

The read set's sequence store ID.

subjectIdstring

The read set's subject ID.

sampleIdstring

The read set's sample ID.

status'ARCHIVED' | 'ACTIVATING' | 'ACTIVE' | 'DELETING' | 'DELETED' | 'PROCESSING_UPLOAD' | 'UPLOAD_FAILED' required

The read set's status.

namestring

The read set's name.

descriptionstring

The read set's description.

fileType'FASTQ' | 'BAM' | 'CRAM' | 'UBAM' required

The read set's file type.

creationTimestring date-time required

When the read set was created.

referenceArnstring

The read set's genome reference ARN.

statusMessagestring

The status message for a read set. It provides more detail as to why the read set has a status.

creationType'IMPORT' | 'UPLOAD'

The creation type of the read set.

creationJobIdstring

The read set's creation job ID.