Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartReadSetActivationJob

Activates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation.

To learn more, see Activating read sets in the AWS HealthOmics User Guide.

Request Syntax


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

{
   "clientToken": "string",
   "sources": [ 
      { 
         "readSetId": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

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 accepts the following data in JSON format.

clientToken

To ensure that jobs don't run multiple times, specify a unique token for each job.

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

sources

The job's source files.

Type: Array of StartReadSetActivationJobSourceItem objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "id": "string",
   "sequenceStoreId": "string",
   "status": "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

When the job was created.

Type: Timestamp

id

The job's ID.

Type: String

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

Pattern: [0-9]+

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 job's status.

Type: String

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

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