Omics / Paginator / ListAnnotationImportJobs
ListAnnotationImportJobs#
- class Omics.Paginator.ListAnnotationImportJobs#
paginator = client.get_paginator('list_annotation_import_jobs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Omics.Client.list_annotation_import_jobs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'storeName': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
ids (list) –
IDs of annotation import jobs to retrieve.
(string) –
filter (dict) –
A filter to apply to the list.
status (string) –
A status to filter on.
storeName (string) –
A store name to filter on.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'annotationImportJobs': [ { 'id': 'string', 'destinationName': 'string', 'versionName': 'string', 'roleArn': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1), 'completionTime': datetime(2015, 1, 1), 'runLeftNormalization': True|False, 'annotationFields': { 'string': 'string' } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
annotationImportJobs (list) –
A list of jobs.
(dict) –
An annotation import job.
id (string) –
The job’s ID.
destinationName (string) –
The job’s destination annotation store.
versionName (string) –
The name of the annotation store version.
roleArn (string) –
The job’s service role ARN.
status (string) –
The job’s status.
creationTime (datetime) –
When the job was created.
updateTime (datetime) –
When the job was updated.
completionTime (datetime) –
When the job completed.
runLeftNormalization (boolean) –
The job’s left normalization setting.
annotationFields (dict) –
The annotation schema generated by the parsed annotation data.
(string) –
(string) –
NextToken (string) –
A token to resume pagination.