Amazon Entity Resolution Schemas API

The Schemas API from Amazon Entity Resolution — 2 operation(s) for schemas.

GitHub OpenAPI

Operations 5

POST /schemas Create Schema Mapping #
GET /schemas List Schema Mappings #
DELETE /schemas/{schemaName} Delete Schema Mapping #
GET /schemas/{schemaName} Get Schema Mapping #
PUT /schemas/{schemaName} Update Schema Mapping #

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-schemas-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.

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

OpenAPI Specification

amazon-entity-resolution-schemas-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS EntityResolution Schemas 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: []
paths:
  /schemas:
    post:
      operationId: CreateSchemaMapping
      summary: Create Schema Mapping
      description: Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping
        also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and
        which columns to match on.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSchemaMappingOutput'
        '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/CreateSchemaMappingInput'
      tags:
      - Schemas
    get:
      operationId: ListSchemaMappings
      summary: List Schema Mappings
      description: Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSchemaMappingsOutput'
        '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/ListSchemaMappingsInput'
      tags:
      - Schemas
  /schemas/{schemaName}:
    delete:
      operationId: DeleteSchemaMapping
      summary: Delete Schema Mapping
      description: Deletes the SchemaMapping with a given name. This operation returns a ResourceNotFoundException if a schema
        with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references
        the SchemaMapping in the workflow's InputSourceConfig.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSchemaMappingOutput'
        '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/DeleteSchemaMappingInput'
      tags:
      - Schemas
    get:
      operationId: GetSchemaMapping
      summary: Get Schema Mapping
      description: Returns the SchemaMapping of a given name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchemaMappingOutput'
        '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/GetSchemaMappingInput'
      tags:
      - Schemas
    put:
      operationId: UpdateSchemaMapping
      summary: Update Schema Mapping
      description: Updates a schema mapping. A schema is immutable if it is being used by a workflow. Therefore, you can't
        update a schema mapping if it's associated with a workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSchemaMappingOutput'
        '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/UpdateSchemaMappingInput'
      tags:
      - Schemas
components:
  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
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateSchemaMappingInput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema. There can't be multiple SchemaMappings with the same name.
        description:
          type: string
          description: A description of the schema.
        mappedInputFields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInputAttribute'
          description: A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and
            contains column name plus additional information that Entity Resolution uses for matching.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
      required:
      - schemaName
      - mappedInputFields
    CreateSchemaMappingOutput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
        description:
          type: string
          description: A description of the schema.
        mappedInputFields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInputAttribute'
          description: A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and
            contains column name plus additional information that Entity Resolution uses for matching.
      required:
      - schemaName
      - schemaArn
      - description
      - mappedInputFields
    DeleteSchemaMappingInput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema to delete.
      required:
      - schemaName
    DeleteSchemaMappingOutput:
      type: object
      properties:
        message:
          type: string
          description: A successful operation message.
      required:
      - message
    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.
    GetSchemaMappingInput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema to be retrieved.
      required:
      - schemaName
    GetSchemaMappingOutput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
        description:
          type: string
          description: A description of the schema.
        mappedInputFields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInputAttribute'
          description: A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and
            contains column name plus additional information Entity Resolution uses for matching.
        createdAt:
          type: string
          description: The timestamp of when the SchemaMapping was created.
        updatedAt:
          type: string
          description: The timestamp of when the SchemaMapping was last updated.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags used to organize, track, or control access for this resource.
        hasWorkflows:
          type: boolean
          description: Specifies whether the schema mapping has been applied to a workflow.
      required:
      - schemaName
      - schemaArn
      - mappedInputFields
      - createdAt
      - updatedAt
      - hasWorkflows
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListSchemaMappingsInput:
      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.
    ListSchemaMappingsOutput:
      type: object
      properties:
        schemaList:
          type: array
          items:
            $ref: '#/components/schemas/SchemaMappingSummary'
          description: A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt,
            UpdatedAt.
        nextToken:
          type: string
          description: The pagination token from the previous API call.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    SchemaInputAttribute:
      type: object
      properties:
        fieldName:
          type: string
          description: A string containing the field name.
        type:
          type: string
          enum:
          - NAME
          - NAME_FIRST
          - NAME_MIDDLE
          - NAME_LAST
          - ADDRESS
          - ADDRESS_STREET1
          - ADDRESS_STREET2
          - ADDRESS_STREET3
          - ADDRESS_CITY
          - ADDRESS_STATE
          - ADDRESS_COUNTRY
          - ADDRESS_POSTALCODE
          - PHONE
          - PHONE_NUMBER
          - PHONE_COUNTRYCODE
          - EMAIL_ADDRESS
          - UNIQUE_ID
          - DATE
          - STRING
          - PROVIDER_ID
          - IPV4
          - IPV6
          - MAID
          description: 'The type of the attribute, selected from a list of values. LiveRamp supports: NAME | NAME_FIRST |
            NAME_MIDDLE | NAME_LAST | ADDRESS | ADDRESS_STREET1 | ADDRESS_STREET2 | ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE
            | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | PROVIDER_ID TransUnion
            supports: NAME | NAME_FIRST | NAME_LAST | ADDRESS | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE
            | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | IPV4 | IPV6 | MAID Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS
            | UNIQUE_ID Normalization is o'
        groupName:
          type: string
          description: A string that instructs Entity Resolution to combine several columns into a unified column with the
            identical attribute type. For example, when working with columns such as NAME_FIRST, NAME_MIDDLE, and NAME_LAST,
            assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.
        matchKey:
          type: string
          description: A key that allows grouping of multiple input attributes into a unified matching group. For example,
            consider a scenario where the source table contains various addresses, such as business_address and shipping_address.
            By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields
            to create a consolidated matching group. If no matchKey is specified for a column, it won't be utilized for matching
            purposes but will still be included in the output table.
        subType:
          type: string
          description: The subtype of the attribute, selected from a list of values.
        hashed:
          type: boolean
          description: Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column
            values are hashed. If the value is set to FALSE, the column values are cleartext.
      required:
      - fieldName
      - type
    SchemaMappingSummary:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
        createdAt:
          type: string
          description: The timestamp of when the SchemaMapping was created.
        updatedAt:
          type: string
          description: The timestamp of when the SchemaMapping was last updated.
        hasWorkflows:
          type: boolean
          description: Specifies whether the schema mapping has been applied to a workflow.
      required:
      - schemaName
      - schemaArn
      - createdAt
      - updatedAt
      - hasWorkflows
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    UpdateSchemaMappingInput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema. There can't be multiple SchemaMappings with the same name.
        description:
          type: string
          description: A description of the schema.
        mappedInputFields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInputAttribute'
          description: A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and
            contains column name plus additional information that Entity Resolution uses for matching.
      required:
      - schemaName
      - mappedInputFields
    UpdateSchemaMappingOutput:
      type: object
      properties:
        schemaName:
          type: string
          description: The name of the schema.
        schemaArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
        description:
          type: string
          description: A description of the schema.
        mappedInputFields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaInputAttribute'
          description: A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and
            contains column name plus additional information that Entity Resolution uses for matching.
      required:
      - schemaName
      - schemaArn
      - mappedInputFields
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)