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

*************
get_reference
*************



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

  

  Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.

   

  For more information, see `Creating a HealthOmics reference store <https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html>`__ in the *Amazon Web Services HealthOmics User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.get_reference(
        id='string',
        referenceStoreId='string',
        range='string',
        partNumber=123,
        file='SOURCE'|'INDEX'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The reference's ID.

    

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

    The reference's store ID.

    

  
  :type range: string
  :param range: 

    The range to retrieve.

    

  
  :type partNumber: integer
  :param partNumber: **[REQUIRED]** 

    The part number to retrieve.

    

  
  :type file: string
  :param file: 

    The file to retrieve.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'payload': StreamingBody()
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **payload** (:class:`.StreamingBody`) -- 

        The reference file payload.

        
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

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

  
  *   :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`

  