CreateMultipartReadSetUpload - HealthOmics API Reference
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

CreateMultipartReadSetUpload

Begins a multipart read set upload.

Request Syntax

POST /sequencestore/sequenceStoreId/upload HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "generatedFrom": "string",
   "name": "string",
   "referenceArn": "string",
   "sampleId": "string",
   "sourceFileType": "string",
   "subjectId": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

sequenceStoreId

The sequence store ID for the store that is the destination of the multipart uploads.

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

Pattern: [0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

An idempotency token that can be used to avoid triggering multiple multipart uploads.

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}]+

Required: No

description

The description of the read set.

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}]+

Required: No

generatedFrom

Where the source originated.

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}]+

Required: No

name

The name of the read set.

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}]+

Required: Yes

referenceArn

The ARN of the reference.

Type: String

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

Pattern: arn:.+

Required: No

sampleId

The source'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}]+

Required: Yes

sourceFileType

The type of file being uploaded.

Type: String

Valid Values: FASTQ | BAM | CRAM | UBAM

Required: Yes

subjectId

The source'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}]+

Required: Yes

tags

Any tags to add to the read set.

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.

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "description": "string",
   "generatedFrom": "string",
   "name": "string",
   "referenceArn": "string",
   "sampleId": "string",
   "sequenceStoreId": "string",
   "sourceFileType": "string",
   "subjectId": "string",
   "tags": { 
      "string" : "string" 
   },
   "uploadId": "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

The creation time of the multipart upload.

Type: Timestamp

description

The description of the read set.

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}]+

generatedFrom

The source of the read set.

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}]+

name

The name of the read set.

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 source's reference ARN.

Type: String

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

Pattern: arn:.+

sampleId

The source'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}]+

sequenceStoreId

The sequence store ID for the store that the read set will be created in.

Type: String

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

Pattern: [0-9]+

sourceFileType

The file type of the read set source.

Type: String

Valid Values: FASTQ | BAM | CRAM | UBAM

subjectId

The source'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}]+

tags

The tags to add to the read set.

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.

uploadId

The ID for the initiated multipart upload.

Type: String

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

Pattern: [0-9]+

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

NotSupportedOperationException

The operation is not supported by Amazon Omics, or the API does not exist.

HTTP Status Code: 405

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

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: