:doc:`Omics <../../omics>` / Client / start_read_set_import_job

*************************
start_read_set_import_job
*************************



.. py:method:: 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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartReadSetImportJob>`_  


  **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'
                }
            },
        ]
    )
    
  :type sequenceStoreId: string
  :param sequenceStoreId: **[REQUIRED]** 

    The read set's sequence store ID.

    

  
  :type roleArn: string
  :param roleArn: **[REQUIRED]** 

    A service role for the job.

    

  
  :type clientToken: string
  :param clientToken: 

    To ensure that jobs don't run multiple times, specify a unique token for each job.

    

  
  :type sources: list
  :param sources: **[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) --* 

          
    
  
    

  
  :rtype: 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**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Omics.Client.exceptions.RequestTimeoutException`

  