:doc:`EntityResolution <../../entityresolution>` / Client / list_matching_jobs

******************
list_matching_jobs
******************



.. py:method:: EntityResolution.Client.list_matching_jobs(**kwargs)

  

  Lists all jobs for a given workflow.

  

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


  **Request Syntax**
  ::

    response = client.list_matching_jobs(
        workflowName='string',
        nextToken='string',
        maxResults=123
    )
    
  :type workflowName: string
  :param workflowName: **[REQUIRED]** 

    The name of the workflow to be retrieved.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token from the previous API call.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of objects returned per page.

    

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

        The pagination token from the previous API call.

        
  
  **Exceptions**
  
  *   :py:class:`EntityResolution.Client.exceptions.ThrottlingException`

  
  *   :py:class:`EntityResolution.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`EntityResolution.Client.exceptions.ValidationException`

  