Omics / Client / list_read_set_export_jobs
list_read_set_export_jobs#
- Omics.Client.list_read_set_export_jobs(**kwargs)#
Retrieves a list of read set export jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_read_set_export_jobs( filter={ 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1), 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES' }, maxResults=123, nextToken='string', sequenceStoreId='string' )
- Parameters:
filter (dict) –
A filter to apply to the list.
createdAfter (datetime) –
The filter’s start date.
createdBefore (datetime) –
The filter’s end date.
status (string) –
A status to filter on.
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'exportJobs': [ { 'completionTime': datetime(2015, 1, 1), 'creationTime': datetime(2015, 1, 1), 'destination': 'string', 'id': 'string', 'sequenceStoreId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
exportJobs (list) –
A list of jobs.
(dict) –
Details about a read set export job.
completionTime (datetime) –
When the job completed.
creationTime (datetime) –
When the job was created.
destination (string) –
The job’s destination in Amazon S3.
id (string) –
The job’s ID.
sequenceStoreId (string) –
The job’s sequence store ID.
status (string) –
The job’s status.
nextToken (string) –
A pagination token that’s included if more results are available.
Exceptions
Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException