Amazon Entity Resolution

Amazon Entity Resolution Entity Resolution Idmappingworkflows API

The Entity Resolution Idmappingworkflows API from Amazon Entity Resolution — 2 operation(s) for entity resolution idmappingworkflows.

Documentation GitHub OpenAPI

Business capability

Master Data Management BC-610.20

Operations 5

POST /idmappingworkflows Create Id Mapping Workflow #

GET /idmappingworkflows List Id Mapping Workflows #

DELETE /idmappingworkflows/{workflowName} Delete Id Mapping Workflow #

GET /idmappingworkflows/{workflowName} Get Id Mapping Workflow #

PUT /idmappingworkflows/{workflowName} Update Id Mapping Workflow #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/amazon-entity-resolution/openapi/amazon-entity-resolution-idmappingworkflows-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-idmappingworkflows-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

openapi: 3.2.0
info:
  title: AWS EntityResolution Idmappingworkflows API
  version: '2018-05-10'
  description: Generated from AWS's published Smithy model for AWS EntityResolution. 5 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: Idmappingworkflows
paths:
  /idmappingworkflows:
    post:
      operationId: CreateIdMappingWorkflow
      summary: Create Id Mapping Workflow
      description: Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API. Incremental processing is not supported for ID mapping workflows.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateIdMappingWorkflowOutput'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIdMappingWorkflowInput'
      tags:
      - Idmappingworkflows
    get:
      operationId: ListIdMappingWorkflows
      summary: List Id Mapping Workflows
      description: Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdMappingWorkflowsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '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/ListIdMappingWorkflowsInput'
      tags:
      - Idmappingworkflows
  /idmappingworkflows/{workflowName}:
    delete:
      operationId: DeleteIdMappingWorkflow
      summary: Delete Id Mapping Workflow
      description: Deletes the IdMappingWorkflow with a given name. This operation returns a ResourceNotFoundException if a workflow with the given name does not exist.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteIdMappingWorkflowOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/DeleteIdMappingWorkflowInput'
      tags:
      - Idmappingworkflows
    get:
      operationId: GetIdMappingWorkflow
      summary: Get Id Mapping Workflow
      description: Returns the IdMappingWorkflow with a given name, if it exists.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdMappingWorkflowOutput'
        '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/GetIdMappingWorkflowInput'
      tags:
      - Idmappingworkflows
    put:
      operationId: UpdateIdMappingWorkflow
      summary: Update Id Mapping Workflow
      description: Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed. Incremental processing is not supported for ID mapping workflows.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIdMappingWorkflowOutput'
        '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/UpdateIdMappingWorkflowInput'
      tags:
      - Idmappingworkflows
components:
  schemas:
    IdMappingWorkflowOutputSource:
      type: object
      properties:
        KMSArn:
          type: string
          description: Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.
        outputS3Path:
          type: string
          description: The S3 path to which Entity Resolution will write the output table.
      required:
      - 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.
    IdMappingTechniques:
      type: object
      properties:
        idMappingType:
          type: string
          enum:
          - PROVIDER
          - RULE_BASED
          description: The type of ID mapping.
        ruleBasedProperties:
          $ref: '#/components/schemas/IdMappingRuleBasedProperties'
        providerProperties:
          $ref: '#/components/schemas/ProviderProperties'
      required:
      - idMappingType
    DeleteIdMappingWorkflowInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow to be deleted.
      required:
      - workflowName
    CreateIdMappingWorkflowOutput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        workflowArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.
        description:
          type: string
          description: A description of the workflow.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowOutputSource'
          description: A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.
        idMappingTechniques:
          $ref: '#/components/schemas/IdMappingTechniques'
        incrementalRunConfig:
          $ref: '#/components/schemas/IdMappingIncrementalRunConfig'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
      required:
      - workflowName
      - workflowArn
      - inputSourceConfig
      - idMappingTechniques
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    IntermediateSourceConfiguration:
      type: object
      properties:
        intermediateS3Path:
          type: string
          description: 'The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET'
      required:
      - intermediateS3Path
    CreateIdMappingWorkflowInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.
        description:
          type: string
          description: A description of the workflow.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowOutputSource'
          description: A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.
        idMappingTechniques:
          $ref: '#/components/schemas/IdMappingTechniques'
        incrementalRunConfig:
          $ref: '#/components/schemas/IdMappingIncrementalRunConfig'
        roleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - workflowName
      - inputSourceConfig
      - idMappingTechniques
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    GetIdMappingWorkflowOutput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        workflowArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .
        description:
          type: string
          description: A description of the workflow.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowOutputSource'
          description: A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.
        idMappingTechniques:
          $ref: '#/components/schemas/IdMappingTechniques'
        createdAt:
          type: string
          description: The timestamp of when the workflow was created.
        updatedAt:
          type: string
          description: The timestamp of when the workflow was last updated.
        incrementalRunConfig:
          $ref: '#/components/schemas/IdMappingIncrementalRunConfig'
        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.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - workflowName
      - workflowArn
      - inputSourceConfig
      - idMappingTechniques
      - createdAt
      - updatedAt
    ListIdMappingWorkflowsOutput:
      type: object
      properties:
        workflowSummaries:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowSummary'
          description: A list of IdMappingWorkflowSummary 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
    IdMappingWorkflowInputSource:
      type: object
      properties:
        inputSourceARN:
          type: string
          description: An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.
        schemaName:
          type: string
          description: The name of the schema to be retrieved.
        type:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: 'The type of ID namespace. There are two types: SOURCE and TARGET. The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId which all sourceIds will resolve to.'
      required:
      - inputSourceARN
    ProviderProperties:
      type: object
      properties:
        providerServiceArn:
          type: string
          description: The ARN of the provider service.
        providerConfiguration:
          type: object
          description: The required configuration fields to use with the provider service.
        intermediateSourceConfiguration:
          $ref: '#/components/schemas/IntermediateSourceConfiguration'
      required:
      - providerServiceArn
    ConflictException:
      type: object
      properties:
        message:
          type: string
    IdMappingRuleBasedProperties:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules that can be used for ID mapping.
        ruleDefinitionType:
          type: string
          enum:
          - SOURCE
          - TARGET
          description: The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.
        attributeMatchingModel:
          type: string
          enum:
          - ONE_TO_ONE
          - MANY_TO_MANY
          description: The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel. If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B. If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B,
        recordMatchingModel:
          type: string
          enum:
          - ONE_SOURCE_TO_ONE_TARGET
          - MANY_SOURCE_TO_ONE_TARGET
          description: The type of matching record that is allowed to be used in an ID mapping workflow. If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target. If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.
      required:
      - ruleDefinitionType
      - attributeMatchingModel
      - recordMatchingModel
    UpdateIdMappingWorkflowInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        description:
          type: string
          description: A description of the workflow.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowOutputSource'
          description: A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.
        idMappingTechniques:
          $ref: '#/components/schemas/IdMappingTechniques'
        incrementalRunConfig:
          $ref: '#/components/schemas/IdMappingIncrementalRunConfig'
        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.
      required:
      - workflowName
      - inputSourceConfig
      - idMappingTechniques
    IdMappingIncrementalRunConfig:
      type: object
      properties:
        incrementalRunType:
          type: string
          enum:
          - ON_DEMAND
          description: 'The incremental run type for an ID mapping workflow. It takes only one value: ON_DEMAND. This setting runs the ID mapping workflow when it''s manually triggered through the StartIdMappingJob API.'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    Rule:
      type: object
      properties:
        ruleName:
          type: string
          description: A name for the matching rule.
        matchingKeys:
          type: array
          items:
            type: string
          description: A list of MatchingKeys. The MatchingKeys must have been defined in the SchemaMapping. Two records are considered to match according to this rule if all of the MatchingKeys match.
      required:
      - ruleName
      - matchingKeys
    IdMappingWorkflowSummary:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        workflowArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow.
        createdAt:
          type: string
          description: The timestamp of when the workflow was created.
        updatedAt:
          type: string
          description: The timestamp of when the workflow was last updated.
      required:
      - workflowName
      - workflowArn
      - createdAt
      - updatedAt
    DeleteIdMappingWorkflowOutput:
      type: object
      properties:
        message:
          type: string
          description: A successful operation message.
      required:
      - message
    UpdateIdMappingWorkflowOutput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        workflowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.
        description:
          type: string
          description: A description of the workflow.
        inputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowInputSource'
          description: A list of InputSource objects, which have the fields InputSourceARN and SchemaName.
        outputSourceConfig:
          type: array
          items:
            $ref: '#/components/schemas/IdMappingWorkflowOutputSource'
          description: A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.
        idMappingTechniques:
          $ref: '#/components/schemas/IdMappingTechniques'
        incrementalRunConfig:
          $ref: '#/components/schemas/IdMappingIncrementalRunConfig'
        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.
      required:
      - workflowName
      - workflowArn
      - inputSourceConfig
      - idMappingTechniques
    GetIdMappingWorkflowInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
      required:
      - workflowName
    ListIdMappingWorkflowsInput:
      type: object
      properties:
        nextToken:
          type: string
          description: The pagination token from the previous API call.
        maxResults:
          type: integer
          description: The maximum number of objects returned per page.
  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)