Omics / Client / start_read_set_activation_job

start_read_set_activation_job

Omics.Client.start_read_set_activation_job(**kwargs)

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

See also: AWS API Documentation

Request Syntax

response = client.start_read_set_activation_job(
    clientToken='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.

• sequenceStoreId (string) –

  [REQUIRED]

  The read set’s sequence store ID.

• sources (list) –

  [REQUIRED]

  The job’s source files.

  • (dict) –

    A source for a read set activation job.

    • readSetId (string) – [REQUIRED]

      The source’s read set ID.

Return type:

dict

Returns:

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    '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.

  • 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