Omics / Client / start_read_set_export_job

start_read_set_export_job#

Omics.Client.start_read_set_export_job(**kwargs)#

Exports a read set to Amazon S3.

See also: AWS API Documentation

Request Syntax

response = client.start_read_set_export_job(
    sequenceStoreId='string',
    destination='string',
    roleArn='string',
    clientToken='string',
    sources=[
        {
            'readSetId': 'string'
        },
    ]
)
Parameters:

  • sequenceStoreId (string) –

    [REQUIRED]

    The read set’s sequence store ID.

  • destination (string) –

    [REQUIRED]

    A location for exported files in Amazon S3.

  • roleArn (string) –

    [REQUIRED]

    A service role for the job.

  • clientToken (string) – To ensure that jobs don’t run multiple times, specify a unique token for each job.

  • sources (list) –

    [REQUIRED]

    The job’s source files.

    • (dict) –

      A read set.

      • readSetId (string) – [REQUIRED]

        The set’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',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • id (string) –

      The job’s ID.

    • sequenceStoreId (string) –

      The read set’s sequence store ID.

    • destination (string) –

      The job’s output location.

    • status (string) –

      The job’s status.

    • creationTime (datetime) –

      When the job was created.

Exceptions