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

************
get_read_set
************



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

  

  Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.

  

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


  **Request Syntax**
  ::

    response = client.get_read_set(
        id='string',
        sequenceStoreId='string',
        file='SOURCE1'|'SOURCE2'|'INDEX',
        partNumber=123
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The read set's ID.

    

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

    The read set's sequence store ID.

    

  
  :type file: string
  :param file: 

    The file to retrieve.

    

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

    The part number to retrieve.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        The read set 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.ConflictException`

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

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

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

  