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

**************************
start_reference_import_job
**************************



.. py:method:: Omics.Client.start_reference_import_job(**kwargs)

  

  Imports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the ``GetReferenceImportJob`` API operation.

  

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


  **Request Syntax**
  ::

    response = client.start_reference_import_job(
        referenceStoreId='string',
        roleArn='string',
        clientToken='string',
        sources=[
            {
                'sourceFile': 'string',
                'name': 'string',
                'description': 'string',
                'tags': {
                    'string': 'string'
                }
            },
        ]
    )
    
  :type referenceStoreId: string
  :param referenceStoreId: **[REQUIRED]** 

    The job's reference 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 reference import job.

      

    
      - **sourceFile** *(string) --* **[REQUIRED]** 

        The source file's location in Amazon S3.

        

      
      - **name** *(string) --* **[REQUIRED]** 

        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',
          'referenceStoreId': '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.

        
      

      - **referenceStoreId** *(string) --* 

        The job's reference 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`

  