Omics / Client / get_read_set_export_job

get_read_set_export_job

Omics.Client.get_read_set_export_job(**kwargs)

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

See also: AWS API Documentation

Request Syntax

response = client.get_read_set_export_job(
    sequenceStoreId='string',
    id='string'
)
Parameters:

  • sequenceStoreId (string) –

    [REQUIRED]

    The job’s sequence store ID.

  • id (string) –

    [REQUIRED]

    The job’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'sequenceStoreId': 'string',
    'destination': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
    'statusMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'completionTime': datetime(2015, 1, 1),
    'readSets': [
        {
            'id': 'string',
            'status': 'NOT_STARTED'|'IN_PROGRESS'|'FINISHED'|'FAILED',
            'statusMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • id (string) –

      The job’s ID.

    • sequenceStoreId (string) –

      The job’s sequence store ID.

    • destination (string) –

      The job’s destination in Amazon S3.

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

    • readSets (list) –

      The job’s read sets.

      • (dict) –

        Details about a read set.

        • id (string) –

          The set’s ID.

        • status (string) –

          The set’s status.

        • statusMessage (string) –

          The set’s status message.

Exceptions