Omics / Client / list_read_set_import_jobs
list_read_set_import_jobs#
- Omics.Client.list_read_set_import_jobs(**kwargs)#
Retrieves a list of read set import jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_read_set_import_jobs( maxResults=123, nextToken='string', sequenceStoreId='string', filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) } )
- Parameters:
maxResults (integer) – The maximum number of jobs to return in one page of results.
nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
sequenceStoreId (string) –
[REQUIRED]
The jobs’ sequence store ID.
filter (dict) –
A filter to apply to the list.
status (string) –
A status to filter on.
createdAfter (datetime) –
The filter’s start date.
createdBefore (datetime) –
The filter’s end date.
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'importJobs': [ { 'id': 'string', 'sequenceStoreId': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) –
nextToken (string) –
A pagination token that’s included if more results are available.
importJobs (list) –
A list of jobs.
(dict) –
An import read set job.
id (string) –
The job’s ID.
sequenceStoreId (string) –
The job’s sequence store ID.
roleArn (string) –
The job’s service role ARN.
status (string) –
The job’s status.
creationTime (datetime) –
When the job was created.
completionTime (datetime) –
When the job completed.
Exceptions