Omics / Client / start_read_set_import_job

start_read_set_import_job¶

Omics.Client.start_read_set_import_job(**kwargs)¶

Imports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.

Request Syntax

response = client.start_read_set_import_job(
    sequenceStoreId='string',
    roleArn='string',
    clientToken='string',
    sources=[
        {
            'sourceFiles': {
                'source1': 'string',
                'source2': 'string'
            },
            'sourceFileType': 'FASTQ'|'BAM'|'CRAM'|'UBAM',
            'subjectId': 'string',
            'sampleId': 'string',
            'generatedFrom': 'string',
            'referenceArn': 'string',
            'name': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
)

Parameters:

sequenceStoreId (string) –
[REQUIRED]

The read set’s sequence store ID.
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 source for a read set import job.
  - sourceFiles (dict) – [REQUIRED]
    
    The source files’ location in Amazon S3.
    - source1 (string) – [REQUIRED]
      
      The location of the first file in Amazon S3.
    - source2 (string) –
      
      The location of the second file in Amazon S3.
  - sourceFileType (string) – [REQUIRED]
    
    The source’s file type.
  - subjectId (string) – [REQUIRED]
    
    The source’s subject ID.
  - sampleId (string) – [REQUIRED]
    
    The source’s sample ID.
  - generatedFrom (string) –
    
    Where the source originated.
  - referenceArn (string) –
    
    The source’s reference ARN.
  - name (string) –
    
    The source’s name.
  - description (string) –
    
    The source’s description.
  - tags (dict) –
    
    The source’s tags.
    - (string) –
      - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'sequenceStoreId': 'string',
    'roleArn': '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.
- roleArn (string) –
  
  The job’s service role ARN.
- 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