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 and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation.

To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.

Request Syntax

response = client.start_read_set_activation_job(
    sequenceStoreId='string',
    clientToken='string',
    sources=[
        {
            'readSetId': 'string'
        },
    ]
)

Parameters:

sequenceStoreId (string) –
[REQUIRED]

The read set’s sequence store ID.
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 source for a read set activation job.
  - readSetId (string) – [REQUIRED]
    
    The source’s read set ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'sequenceStoreId': '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.
- status (string) –
  
  The job’s status.
- creationTime (datetime) –
  
  When the job was created.

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