ListReadSetImportJobs
Retrieves a list of read set import jobs.
Request Syntax
POST /sequencestore/sequenceStoreId
/importjobs?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
Content-type: application/json
{
"filter": {
"createdAfter": "string
",
"createdBefore": "string
",
"status": "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of jobs to return in one page of results.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
Specify the pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 6144.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+
- sequenceStoreId
-
The jobs' 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.
- filter
-
A filter to apply to the list.
Type: ImportReadSetFilter object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"importJobs": [
{
"completionTime": "string",
"creationTime": "string",
"id": "string",
"roleArn": "string",
"sequenceStoreId": "string",
"status": "string"
}
],
"nextToken": "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.
- importJobs
-
A list of jobs.
Type: Array of ImportReadSetJobItem objects
- nextToken
-
A pagination token that's included if more results are available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
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: