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(
    clientToken='string',
    destination='string',
    roleArn='string',
    sequenceStoreId='string',
    sources=[
        {
            'readSetId': 'string'
        },
    ]
)

Parameters

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

  [REQUIRED]

  A location for exported files in Amazon S3.

• roleArn (string) --

  [REQUIRED]

  A service role for the job.

• sequenceStoreId (string) --

  [REQUIRED]

  The read set's sequence store ID.

• 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

{
    'creationTime': datetime(2015, 1, 1),
    'destination': 'string',
    'id': 'string',
    'sequenceStoreId': 'string',
    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES'
}

Response Structure

• (dict) --

  • creationTime (datetime) --

    When the job was created.

  • destination (string) --

    The job's output location.

  • id (string) --

    The job's ID.

  • sequenceStoreId (string) --

    The read set's sequence store ID.

  • status (string) --

    The job's status.

Exceptions

• Omics.Client.exceptions.InternalServerException
• Omics.Client.exceptions.ServiceQuotaExceededException
• Omics.Client.exceptions.ThrottlingException
• Omics.Client.exceptions.ValidationException
• Omics.Client.exceptions.ResourceNotFoundException
• Omics.Client.exceptions.AccessDeniedException
• Omics.Client.exceptions.RequestTimeoutException