---
title: "POST /idmappingworkflows/{workflowName}/jobs"
method: POST
path: "/idmappingworkflows/{workflowName}/jobs"
---

# POST /idmappingworkflows/{workflowName}/jobs

`POST /idmappingworkflows/{workflowName}/jobs`

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

## Path parameters

- `workflowName` string, required

## Request body

- object
  - `outputSourceConfig` IdMappingJobOutputSource[] — A list of <code>OutputSource</code> objects.
    - `roleArn` string, required — The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
    - `outputS3Path` string, required — The S3 path to which Entity Resolution will write the output table.
    - `KMSArn` string — Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
  - `jobType` 'BATCH' | 'INCREMENTAL' | 'DELETE_ONLY' — <p> The job type for the ID mapping job.</p> <p>If the <code>jobType</code> value is set to <code>INCREMENTAL</code>, only new or changed data is processed since the last job run. This is the default value if the <code>CreateIdMappingWorkflow</code> API is configured with an <code>incrementalRunConfig</code>.</p> <p>If the <code>jobType</code> value is set to <code>BATCH</code>, all data is processed from the input source, regardless of previous job runs. This is the default value if the <code>CreateIdMappingWorkflow</code> API isn't configured with an <code>incrementalRunConfig</code>.</p> <p>If the <code>jobType</code> value is set to <code>DELETE_ONLY</code>, only deletion requests from <code>BatchDeleteUniqueIds</code> are processed.</p>

## Response `200`

Success

- StartIdMappingJobOutput
  - `jobId` string, required — The ID of the job.
  - `outputSourceConfig` IdMappingJobOutputSource[] — A list of <code>OutputSource</code> objects.
    - `roleArn` string, required — The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf as part of workflow execution.
    - `outputS3Path` string, required — The S3 path to which Entity Resolution will write the output table.
    - `KMSArn` string — Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
  - `jobType` 'BATCH' | 'INCREMENTAL' | 'DELETE_ONLY' — <p> The job type for the started ID mapping job.</p> <p>A value of <code>INCREMENTAL</code> 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 <code>incrementalRunConfig</code>.</p> <p>A value of <code>BATCH</code> 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 <code>incrementalRunConfig</code>.</p> <p>A value of <code>DELETE_ONLY</code> indicates that only deletion requests from <code>BatchDeleteUniqueIds</code> were processed.</p>

## Other responses

- `480` — ThrottlingException
- `481` — InternalServerException
- `482` — ResourceNotFoundException
- `483` — AccessDeniedException
- `484` — ExceedsLimitException
- `485` — ConflictException
- `486` — ValidationException

---

[API](https://skmtc.net/aws/apis/entityresolution.md) · [All operations](https://skmtc.net/aws/apis/entityresolution/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/entityresolution/versions/480b85498767/schema)