StartReadSetImportJob
Starts a read set import job.
Request Syntax
POST /sequencestore/sequenceStoreId
/importjob HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"roleArn": "string
",
"sources": [
{
"description": "string
",
"generatedFrom": "string
",
"name": "string
",
"referenceArn": "string
",
"sampleId": "string
",
"sourceFiles": {
"source1": "string
",
"source2": "string
"
},
"sourceFileType": "string
",
"subjectId": "string
",
"tags": {
"string
" : "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
- roleArn
-
A service role for the job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*
Required: Yes
- sources
-
The job's source files.
Type: Array of StartReadSetImportJobSourceItem objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"id": "string",
"roleArn": "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]+
- roleArn
-
The job's service role ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*
- 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
Valid Values:
SUBMITTED | IN_PROGRESS | CANCELLING | CANCELLED | FAILED | COMPLETED | COMPLETED_WITH_FAILURES
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: