:doc:`Omics <../../omics>` / Paginator / ListReadSetImportJobs

*********************
ListReadSetImportJobs
*********************



.. py:class:: Omics.Paginator.ListReadSetImportJobs

  ::

    
    paginator = client.get_paginator('list_read_set_import_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Omics.Client.list_read_set_import_jobs`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          sequenceStoreId='string',
          filter={
              'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLING'|'CANCELLED'|'FAILED'|'COMPLETED'|'COMPLETED_WITH_FAILURES',
              'createdAfter': datetime(2015, 1, 1),
              'createdBefore': datetime(2015, 1, 1)
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type sequenceStoreId: string
    :param sequenceStoreId: **[REQUIRED]** 

      The jobs' sequence store ID.

      

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

        

      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

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

      

      - *(dict) --* 
        

        - **importJobs** *(list) --* 

          A list of jobs.

          
          

          - *(dict) --* 

            An import read set job.

            
            

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

              The job's ID.

              
            

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

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

              
            

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

              When the job completed.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    