Omics / Client / get_annotation_import_job

get_annotation_import_job#

Omics.Client.get_annotation_import_job(**kwargs)#

Gets information about an annotation import job.

See also: AWS API Documentation

Request Syntax

response = client.get_annotation_import_job(
    jobId='string'
)
Parameters:

jobId (string) –

[REQUIRED]

The job’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'destinationName': 'string',
    'versionName': 'string',
    'roleArn': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
    'statusMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'completionTime': datetime(2015, 1, 1),
    'items': [
        {
            'source': 'string',
            'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES'
        },
    ],
    'runLeftNormalization': True|False,
    'formatOptions': {
        'tsvOptions': {
            'readOptions': {
                'sep': 'string',
                'encoding': 'string',
                'quote': 'string',
                'quoteAll': True|False,
                'escape': 'string',
                'escapeQuotes': True|False,
                'comment': 'string',
                'header': True|False,
                'lineSep': 'string'
            }
        },
        'vcfOptions': {
            'ignoreQualField': True|False,
            'ignoreFilterField': True|False
        }
    },
    'annotationFields': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • 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.

    • statusMessage (string) –

      The job’s status message.

    • creationTime (datetime) –

      When the job was created.

    • updateTime (datetime) –

      When the job was updated.

    • completionTime (datetime) –

      When the job completed.

    • items (list) –

      The job’s imported items.

      • (dict) –

        Details about an imported annotation item.

        • source (string) –

          The source file’s location in Amazon S3.

        • jobStatus (string) –

          The item’s job status.

    • runLeftNormalization (boolean) –

      The job’s left normalization setting.

    • formatOptions (dict) –

      Formatting options for a file.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: tsvOptions, vcfOptions. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • tsvOptions (dict) –

        Options for a TSV file.

        • readOptions (dict) –

          The file’s read options.

          • sep (string) –

            The file’s field separator.

          • encoding (string) –

            The file’s encoding.

          • quote (string) –

            The file’s quote character.

          • quoteAll (boolean) –

            Whether all values need to be quoted, or just those that contain quotes.

          • escape (string) –

            A character for escaping quotes in the file.

          • escapeQuotes (boolean) –

            Whether quotes need to be escaped in the file.

          • comment (string) –

            The file’s comment character.

          • header (boolean) –

            Whether the file has a header row.

          • lineSep (string) –

            A line separator for the file.

      • vcfOptions (dict) –

        Options for a VCF file.

        • ignoreQualField (boolean) –

          The file’s ignore qual field setting.

        • ignoreFilterField (boolean) –

          The file’s ignore filter field setting.

    • annotationFields (dict) –

      The annotation schema generated by the parsed annotation data.

      • (string) –

        • (string) –

Exceptions