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

*********************
ListVariantImportJobs
*********************



.. py:class:: Omics.Paginator.ListVariantImportJobs

  ::

    
    paginator = client.get_paginator('list_variant_import_jobs')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ids=[
              'string',
          ],
          filter={
              'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
              'storeName': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ids: list
    :param ids: 

      A list of job IDs.

      

    
      - *(string) --* 

      
  
    :type filter: dict
    :param filter: 

      A filter to apply to the list.

      

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

        A status to filter on.

        

      
      - **storeName** *(string) --* 

        A store name to filter on.

        

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

      
      ::

        {
            'variantImportJobs': [
                {
                    'id': 'string',
                    'destinationName': 'string',
                    'roleArn': 'string',
                    'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED'|'COMPLETED_WITH_FAILURES',
                    'creationTime': datetime(2015, 1, 1),
                    'updateTime': datetime(2015, 1, 1),
                    'completionTime': datetime(2015, 1, 1),
                    'runLeftNormalization': True|False,
                    'annotationFields': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **variantImportJobs** *(list) --* 

          A list of jobs.

          
          

          - *(dict) --* 

            A variant import job.

            
            

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

              The job's ID.

              
            

            - **destinationName** *(string) --* 

              The job's destination variant store.

              
            

            - **roleArn** *(string) --* 

              The job's service role ARN.

              
            

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

              The job's status.

              
            

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

              When the job was created.

              
            

            - **updateTime** *(datetime) --* 

              When the job was updated.

              
            

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

              When the job completed.

              
            

            - **runLeftNormalization** *(boolean) --* 

              The job's left normalization setting.

              
            

            - **annotationFields** *(dict) --* 

              The annotation schema generated by the parsed annotation data.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    