Amazon Entity Resolution

Amazon Entity Resolution Entity Resolution Jobs API

The Entity Resolution Jobs API from Amazon Entity Resolution — 4 operation(s) for entity resolution jobs.

GitHub OpenAPI
Business capability
Master Data Management BC-610.20

Operations 3

GET /idmappingworkflows/{workflowName}/jobs/{jobId} Get Id Mapping Job #
GET /idmappingworkflows/{workflowName}/jobs List Id Mapping Jobs #
POST /idmappingworkflows/{workflowName}/jobs Start Id Mapping Job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-entity-resolution/openapi/amazon-entity-resolution-jobs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-entity-resolution:amazon-entity-resolution-jobs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-entity-resolution-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS EntityResolution Jobs API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS EntityResolution. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://entityresolution.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Jobs
paths:
  /idmappingworkflows/{workflowName}/jobs/{jobId}:
    get:
      operationId: GetIdMappingJob
      summary: Get Id Mapping Job
      description: Returns the status, metrics, and errors (if there are any) that are associated with a job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdMappingJobOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIdMappingJobInput'
      tags:
      - Jobs
  /idmappingworkflows/{workflowName}/jobs:
    get:
      operationId: ListIdMappingJobs
      summary: List Id Mapping Jobs
      description: Lists all ID mapping jobs for a given workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdMappingJobsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListIdMappingJobsInput'
      tags:
      - Jobs
    post:
      operationId: StartIdMappingJob
      summary: Start Id Mapping Job
      description: Starts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartIdMappingJobOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '402':
          description: ExceedsLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceedsLimitException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartIdMappingJobInput'
      tags:
      - Jobs
components:
  schemas:
    ErrorDetails:
      type: object
      properties:
        errorMessage:
          type: string
          description: The error message from the job, if there is one.
    IdMappingJobOutputSource:
      type: object
      properties:
        roleArn:
          type: string
          description: 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:
          type: string
          description: The S3 path to which Entity Resolution will write the output table.
        KMSArn:
          type: string
          description: Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
      required:
      - roleArn
      - outputS3Path
    ExceedsLimitException:
      type: object
      properties:
        message:
          type: string
        quotaName:
          type: string
          description: The name of the quota that has been breached.
        quotaValue:
          type: integer
          description: The current quota value for the customers.
    StartIdMappingJobInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the ID mapping job to be retrieved.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingJobOutputSource'
          description: A list of OutputSource objects.
        jobType:
          type: string
          enum:
          - BATCH
          - INCREMENTAL
          - DELETE_ONLY
          description: 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.
      required:
      - workflowName
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    IdMappingJobMetrics:
      type: object
      properties:
        inputRecords:
          type: integer
          description: The total number of records that were input for processing.
        totalRecordsProcessed:
          type: integer
          description: The total number of records that were processed.
        recordsNotProcessed:
          type: integer
          description: The total number of records that did not get processed.
        deleteRecordsProcessed:
          type: integer
          description: The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.
        totalMappedRecords:
          type: integer
          description: The total number of records that were mapped.
        totalMappedSourceRecords:
          type: integer
          description: The total number of mapped source records.
        totalMappedTargetRecords:
          type: integer
          description: The total number of distinct mapped target records.
        uniqueRecordsLoaded:
          type: integer
          description: The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.
        newMappedRecords:
          type: integer
          description: The number of new mapped records.
        newMappedSourceRecords:
          type: integer
          description: The number of new source records mapped.
        newMappedTargetRecords:
          type: integer
          description: The number of new mapped target records.
        newUniqueRecordsLoaded:
          type: integer
          description: The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.
        mappedRecordsRemoved:
          type: integer
          description: The number of mapped records removed.
        mappedSourceRecordsRemoved:
          type: integer
          description: The number of source records removed due to ID mapping.
        mappedTargetRecordsRemoved:
          type: integer
          description: The number of mapped target records removed.
    GetIdMappingJobInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        jobId:
          type: string
          description: The ID of the job.
      required:
      - workflowName
      - jobId
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ListIdMappingJobsInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow to be retrieved.
        nextToken:
          type: string
          description: The pagination token from the previous API call.
        maxResults:
          type: integer
          description: The maximum number of objects returned per page.
      required:
      - workflowName
    ConflictException:
      type: object
      properties:
        message:
          type: string
    GetIdMappingJobOutput:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the job.
        status:
          type: string
          enum:
          - RUNNING
          - SUCCEEDED
          - FAILED
          - QUEUED
          description: The current status of the job.
        startTime:
          type: string
          description: The time at which the job was started.
        endTime:
          type: string
          description: The time at which the job has finished.
        metrics:
          $ref: '#/components/schemas/IdMappingJobMetrics'
        errorDetails:
          $ref: '#/components/schemas/ErrorDetails'
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingJobOutputSource'
          description: A list of OutputSource objects.
        jobType:
          type: string
          enum:
          - BATCH
          - INCREMENTAL
          - DELETE_ONLY
          description: The job type of the 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.
      required:
      - jobId
      - status
      - startTime
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    JobSummary:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the job.
        status:
          type: string
          enum:
          - RUNNING
          - SUCCEEDED
          - FAILED
          - QUEUED
          description: The current status of the job.
        startTime:
          type: string
          description: The time at which the job was started.
        endTime:
          type: string
          description: The time at which the job has finished.
      required:
      - jobId
      - status
      - startTime
    ListIdMappingJobsOutput:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/JobSummary'
          description: A list of JobSummary objects.
        nextToken:
          type: string
          description: The pagination token from the previous API call.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    StartIdMappingJobOutput:
      type: object
      properties:
        jobId:
          type: string
          description: The ID of the job.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingJobOutputSource'
          description: A list of OutputSource objects.
        jobType:
          type: string
          enum:
          - BATCH
          - INCREMENTAL
          - DELETE_ONLY
          description: 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.
      required:
      - jobId
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: entityresolution
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/entityresolution/service/2018-05-10/entityresolution-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)