Omics / Client / get_reference_import_job

get_reference_import_job#

Omics.Client.get_reference_import_job(**kwargs)#

Gets information about a reference import job.

See also: AWS API Documentation

Request Syntax

response = client.get_reference_import_job(
    id='string',
    referenceStoreId='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The job’s ID.

  • referenceStoreId (string) –

    [REQUIRED]

    The job’s reference store ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'referenceStoreId': 'string',
    'roleArn': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
    'statusMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'completionTime': datetime(2015, 1, 1),
    'sources': [
        {
            'sourceFile': 'string',
            'status': 'NOT_STARTED'|'IN_PROGRESS'|'FINISHED'|'FAILED',
            'statusMessage': 'string',
            'name': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'referenceId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • id (string) –

      The job’s ID.

    • referenceStoreId (string) –

      The job’s reference store ID.

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

    • completionTime (datetime) –

      When the job completed.

    • sources (list) –

      The job’s source files.

      • (dict) –

        An genome reference source.

        • sourceFile (string) –

          The source file’s location in Amazon S3.

        • status (string) –

          The source’s status.

        • statusMessage (string) –

          The source’s status message.

        • name (string) –

          The source’s name.

        • description (string) –

          The source’s description.

        • tags (dict) –

          The source’s tags.

          • (string) –

            • (string) –

        • referenceId (string) –

          The source’s reference ID.

Exceptions