Omics / Client / list_annotation_import_jobs

list_annotation_import_jobs

Omics.Client.list_annotation_import_jobs(**kwargs)

Retrieves a list of annotation import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_annotation_import_jobs(
    maxResults=123,
    ids=[
        'string',
    ],
    nextToken='string',
    filter={
        'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
        'storeName': 'string'
    }
)

Parameters:

• maxResults (integer) – The maximum number of jobs to return in one page of results.

• ids (list) –

  IDs of annotation import jobs to retrieve.

  • (string) –

• nextToken (string) – Specifies the pagination token from a previous request to retrieve the next page of results.

• filter (dict) –

  A filter to apply to the list.

  • status (string) –

    A status to filter on.

  • storeName (string) –

    A store name to filter on.

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) –

    Specifies the pagination token from a previous request to retrieve the next page of results.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException