:doc:`EntityResolution <../../entityresolution>` / Paginator / ListMatchingJobs

****************
ListMatchingJobs
****************



.. py:class:: EntityResolution.Paginator.ListMatchingJobs

  ::

    
    paginator = client.get_paginator('list_matching_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EntityResolution.Client.list_matching_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/ListMatchingJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workflowName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type workflowName: string
    :param workflowName: **[REQUIRED]** 

      The name of the workflow to be retrieved.

      

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

      
      ::

        {
            'jobs': [
                {
                    'jobId': 'string',
                    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'QUEUED',
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **jobs** *(list) --* 

          A list of ``JobSummary`` objects, each of which contain the ID, status, start time, and end time of a job.

          
          

          - *(dict) --* 

            An object containing the ``jobId``, ``status``, ``startTime``, and ``endTime`` of a job.

            
            

            - **jobId** *(string) --* 

              The ID of the job.

              
            

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

              The current status of the job.

              
            

            - **startTime** *(datetime) --* 

              The time at which the job was started.

              
            

            - **endTime** *(datetime) --* 

              The time at which the job has finished.

              
        
      
        

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

          A token to resume pagination.

          
    