EntityResolution / Client / list_id_mapping_jobs

list_id_mapping_jobs#

EntityResolution.Client.list_id_mapping_jobs(**kwargs)#

Lists all ID mapping jobs for a given workflow.

See also: AWS API Documentation

Request Syntax

response = client.list_id_mapping_jobs(
    maxResults=123,
    nextToken='string',
    workflowName='string'
)
Parameters:

  • maxResults (integer) – The maximum number of objects returned per page.

  • nextToken (string) – The pagination token from the previous API call.

  • workflowName (string) –

    [REQUIRED]

    The name of the workflow to be retrieved.

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.

      • (dict) –

        An object containing the JobId, Status, StartTime, and EndTime 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) –

      The pagination token from the previous API call.

Exceptions

  • EntityResolution.Client.exceptions.ThrottlingException

  • EntityResolution.Client.exceptions.InternalServerException

  • EntityResolution.Client.exceptions.ResourceNotFoundException

  • EntityResolution.Client.exceptions.AccessDeniedException

  • EntityResolution.Client.exceptions.ValidationException