EntityResolution / Paginator / ListMatchingJobs
ListMatchingJobs#
- class EntityResolution.Paginator.ListMatchingJobs#
paginator = client.get_paginator('list_matching_jobs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
EntityResolution.Client.list_matching_jobs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( workflowName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
workflowName (string) –
[REQUIRED]
The name of the workflow to be retrieved.
PaginationConfig (dict) –
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'jobs': [ { 'endTime': datetime(2015, 1, 1), 'jobId': 'string', 'startTime': datetime(2015, 1, 1), 'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'QUEUED' }, ], '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
, andEndTime
of a job.endTime (datetime) –
The time at which the job has finished.
jobId (string) –
The ID of the job.
startTime (datetime) –
The time at which the job was started.
status (string) –
The current status of the job.
NextToken (string) –
A token to resume pagination.