Omics / Client / get_variant_import_job

get_variant_import_job#

Omics.Client.get_variant_import_job(**kwargs)#

Gets information about a variant import job.

See also: AWS API Documentation

Request Syntax

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

jobId (string) –

[REQUIRED]

The job’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'destinationName': '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',
            'statusMessage': 'string'
        },
    ],
    'runLeftNormalization': True|False,
    'annotationFields': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • id (string) –

      The job’s ID.

    • destinationName (string) –

      The job’s destination variant store.

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

      • (dict) –

        Details about an imported variant item.

        • source (string) –

          The source file’s location in Amazon S3.

        • jobStatus (string) –

          The item’s job status.

        • statusMessage (string) –

          A message that provides additional context about a job

    • runLeftNormalization (boolean) –

      The job’s left normalization setting.

    • annotationFields (dict) –

      The annotation schema generated by the parsed annotation data.

      • (string) –

        • (string) –

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException