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

*************************
list_read_set_export_jobs
*************************



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

  

  Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the ``StartReadSetExportJob`` API operation.

  

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


  **Request Syntax**
  ::

    response = client.list_read_set_export_jobs(
        sequenceStoreId='string',
        maxResults=123,
        nextToken='string',
        filter={
            'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
            'createdAfter': datetime(2015, 1, 1),
            'createdBefore': datetime(2015, 1, 1)
        }
    )
    
  :type sequenceStoreId: string
  :param sequenceStoreId: **[REQUIRED]** 

    The jobs' sequence store ID.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of jobs to return in one page of results.

    

  
  :type nextToken: string
  :param nextToken: 

    Specify the pagination token from a previous request to retrieve the next page of results.

    

  
  :type filter: dict
  :param filter: 

    A filter to apply to the list.

    

  
    - **status** *(string) --* 

      A status to filter on.

      

    
    - **createdAfter** *(datetime) --* 

      The filter's start date.

      

    
    - **createdBefore** *(datetime) --* 

      The filter's end date.

      

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

    
    ::

      {
          'nextToken': 'string',
          'exportJobs': [
              {
                  'id': 'string',
                  'sequenceStoreId': 'string',
                  'destination': 'string',
                  'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
                  'creationTime': datetime(2015, 1, 1),
                  'completionTime': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        A pagination token that's included if more results are available.

        
      

      - **exportJobs** *(list) --* 

        A list of jobs.

        
        

        - *(dict) --* 

          Details about a read set export job.

          
          

          - **id** *(string) --* 

            The job's ID.

            
          

          - **sequenceStoreId** *(string) --* 

            The job's sequence store ID.

            
          

          - **destination** *(string) --* 

            The job's destination in Amazon S3.

            
          

          - **status** *(string) --* 

            The job's status.

            
          

          - **creationTime** *(datetime) --* 

            When the job was created.

            
          

          - **completionTime** *(datetime) --* 

            When the job completed.

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

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

  