GetReadSetMetadata
Gets details about a read set.
Request Syntax
GET /sequencestore/sequenceStoreId/readset/id/metadata HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The read set's ID.
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+Required: Yes
- sequenceStoreId
-
The read set's sequence store 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",
"creationJobId": "string",
"creationTime": "string",
"creationType": "string",
"description": "string",
"etag": {
"algorithm": "string",
"source1": "string",
"source2": "string"
},
"files": {
"index": {
"contentLength": number,
"partSize": number,
"s3Access": {
"s3Uri": "string"
},
"totalParts": number
},
"source1": {
"contentLength": number,
"partSize": number,
"s3Access": {
"s3Uri": "string"
},
"totalParts": number
},
"source2": {
"contentLength": number,
"partSize": number,
"s3Access": {
"s3Uri": "string"
},
"totalParts": number
}
},
"fileType": "string",
"id": "string",
"name": "string",
"referenceArn": "string",
"sampleId": "string",
"sequenceInformation": {
"alignment": "string",
"generatedFrom": "string",
"totalBaseCount": number,
"totalReadCount": number
},
"sequenceStoreId": "string",
"status": "string",
"statusMessage": "string",
"subjectId": "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 read set's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
arn:.+ - creationJobId
-
The read set's creation job ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
[a-zA-Z0-9]+ - creationTime
-
When the read set was created.
Type: Timestamp
- creationType
-
The creation type of the read set.
Type: String
Valid Values:
IMPORT | UPLOAD - description
-
The read set'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}]+ - etag
-
The entity tag (ETag) is a hash of the object meant to represent its semantic content.
Type: ETag object
- files
-
The read set's files.
Type: ReadSetFiles object
- fileType
-
The read set's file type.
Type: String
Valid Values:
FASTQ | BAM | CRAM | UBAM - id
-
The read set's ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+ - name
-
The read set'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}]+ - referenceArn
-
The read set's genome reference ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
arn:.+ - sampleId
-
The read set's sample ID.
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}]+ - sequenceInformation
-
The read set's sequence information.
Type: SequenceInformation object
- sequenceStoreId
-
The read set's sequence store ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+ - status
-
The read set's status.
Type: String
Valid Values:
ARCHIVED | ACTIVATING | ACTIVE | DELETING | DELETED | PROCESSING_UPLOAD | UPLOAD_FAILED - statusMessage
-
The status message for a read set. It provides more detail as to why the read set has a status.
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}]+ - subjectId
-
The read set's subject ID.
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}]+
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:
