Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartIdMappingJob

Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.

Request Syntax


POST /idmappingworkflows/workflowName/jobs HTTP/1.1
Content-type: application/json

{
   "jobType": "string",
   "outputSourceConfig": [ 
      { 
         "KMSArn": "string",
         "outputS3Path": "string",
         "roleArn": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

workflowName

The name of the ID mapping job 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 accepts the following data in JSON format.

jobType

The job type for the ID mapping job.

If the jobType value is set to INCREMENTAL, only new or changed data is processed since the last job run. This is the default value if the CreateIdMappingWorkflow API is configured with an incrementalRunConfig.

If the jobType value is set to BATCH, all data is processed from the input source, regardless of previous job runs. This is the default value if the CreateIdMappingWorkflow API isn't configured with an incrementalRunConfig.

If the jobType value is set to DELETE_ONLY, only deletion requests from BatchDeleteUniqueIds are processed.

Type: String

Valid Values: BATCH | INCREMENTAL | DELETE_ONLY

Required: No

outputSourceConfig

A list of OutputSource objects.

Type: Array of IdMappingJobOutputSource objects

Array Members: Fixed number of 1 item.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobId": "string",
   "jobType": "string",
   "outputSourceConfig": [ 
      { 
         "KMSArn": "string",
         "outputS3Path": "string",
         "roleArn": "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.

jobId

The ID of the job.

Type: String

Pattern: [a-f0-9]{32}

jobType

The job type for the started ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig.

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig.

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

Type: String

Valid Values: BATCH | INCREMENTAL | DELETE_ONLY

outputSourceConfig

A list of OutputSource objects.

Type: Array of IdMappingJobOutputSource objects

Array Members: Fixed number of 1 item.

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

ConflictException

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.

HTTP Status Code: 400

ExceedsLimitException

The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. The error message describes the limit exceeded.

quotaName: The name of the quota that has been breached.
quotaValue: The current quota value for the customers.

HTTP Status Code: 402

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't 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