ListIdMappingJobs - AWS Entity Resolution

ListIdMappingJobs

Lists all ID mapping jobs for a given workflow.

Request Syntax

GET /idmappingworkflows/workflowName/jobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of objects returned per page.

Valid Range: Minimum value of 1. Maximum value of 25.

nextToken

The pagination token from the previous API call.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z_0-9-=+/]*$

workflowName

The name of the workflow to be retrieved.

Pattern: ^[a-zA-Z_0-9-=+/]*$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "jobs": [ { "endTime": number, "jobId": "string", "startTime": number, "status": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobs

A list of JobSummary objects.

Type: Array of JobSummary objects

nextToken

The pagination token from the previous API call.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[a-zA-Z_0-9-=+/]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the AWS Entity Resolution service.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by AWS Entity Resolution.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: