openapi: 3.0.0
info:
  version: '2018-05-10'
  x-release: v4
  title: AWS EntityResolution Matchingworkflows Schemas API
  description: <p>Welcome to the <i>AWS Entity Resolution API Reference</i>.</p> <p>AWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities that enable developers and analysts at advertising and marketing companies to build an accurate and complete view of their consumers.</p> <p> With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, such as name, email address, and phone number. This holds true even when these records have incomplete or conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a customer relationship management (CRM) system, which includes account information like first name, last name, postal address, phone number, and email address, with a source record from a marketing system containing campaign information, such as username and email address.</p> <p>To learn more about AWS Entity Resolution concepts, procedures, and best practices, see the <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">AWS Entity Resolution User Guide</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: entityresolution
  x-aws-signingName: entityresolution
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/entityresolution-2018-05-10.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://entityresolution.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWSEntityResolution multi-region endpoint
- url: https://entityresolution.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWSEntityResolution multi-region endpoint
- url: http://entityresolution.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWSEntityResolution endpoint for China (Beijing) and China (Ningxia)
- url: https://entityresolution.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWSEntityResolution endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Schemas
paths:
  /schemas:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateSchemaMapping
      description: Creates a schema mapping, which defines the schema of the input customer records table. The <code>SchemaMapping</code> 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'
              examples:
                CreateSchemaMapping200Example:
                  summary: Default CreateSchemaMapping 200 response
                  x-microcks-default: true
                  value:
                    description: Example description
                    mappedInputFields: example
                    schemaArn: arn:aws:service:us-east-1:123456789012:resource/example
                    schemaName: example-name
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                CreateSchemaMapping480Example:
                  summary: Default CreateSchemaMapping 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateSchemaMapping481Example:
                  summary: Default CreateSchemaMapping 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                CreateSchemaMapping482Example:
                  summary: Default CreateSchemaMapping 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ExceedsLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceedsLimitException'
              examples:
                CreateSchemaMapping483Example:
                  summary: Default CreateSchemaMapping 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateSchemaMapping484Example:
                  summary: Default CreateSchemaMapping 484 response
                  x-microcks-default: true
                  value: {}
        '485':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                CreateSchemaMapping485Example:
                  summary: Default CreateSchemaMapping 485 response
                  x-microcks-default: true
                  value: {}
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - schemaName
              properties:
                description:
                  description: A description of the schema.
                  type: string
                  minLength: 0
                  maxLength: 255
                mappedInputFields:
                  description: A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
                  type: array
                  items:
                    $ref: '#/components/schemas/SchemaInputAttribute'
                  minItems: 2
                  maxItems: 25
                schemaName:
                  description: The name of the schema. There cannot be multiple <code>SchemaMappings</code> with the same name.
                  type: string
                  pattern: ^[a-zA-Z_0-9-]*$
                  minLength: 0
                  maxLength: 255
                tags:
                  description: The tags used to organize, track, or control access for this resource.
                  type: object
                  minProperties: 0
                  maxProperties: 200
                  additionalProperties:
                    $ref: '#/components/schemas/TagValue'
            examples:
              CreateSchemaMappingRequestExample:
                summary: Default CreateSchemaMapping request
                x-microcks-default: true
                value:
                  description: Example description
                  mappedInputFields: []
                  schemaName: example-name
                  tags: {}
      summary: Amazon Entity Resolution CreateSchemaMapping
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schemas
    get:
      operationId: ListSchemaMappings
      description: Returns a list of all the <code>SchemaMappings</code> that have been created for an AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSchemaMappingsOutput'
              examples:
                ListSchemaMappings200Example:
                  summary: Default ListSchemaMappings 200 response
                  x-microcks-default: true
                  value:
                    nextToken: example
                    schemaList: example
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                ListSchemaMappings480Example:
                  summary: Default ListSchemaMappings 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListSchemaMappings481Example:
                  summary: Default ListSchemaMappings 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                ListSchemaMappings482Example:
                  summary: Default ListSchemaMappings 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                ListSchemaMappings483Example:
                  summary: Default ListSchemaMappings 483 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: maxResults
        in: query
        required: false
        description: The maximum number of objects returned per page.
        schema:
          type: integer
          maximum: 25
      - name: nextToken
        in: query
        required: false
        description: The pagination token from the previous <code>ListSchemaMappings</code> API call.
        schema:
          type: string
          pattern: ^[a-zA-Z_0-9-=+/]*$
          minLength: 1
          maxLength: 1024
      summary: Amazon Entity Resolution ListSchemaMappings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schemas
  /schemas/{schemaName}:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    delete:
      operationId: DeleteSchemaMapping
      description: Deletes the <code>SchemaMapping</code> with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a <code>DataIntegrationWorkflow</code> object that references the <code>SchemaMapping</code> in the workflow's <code>InputSourceConfig</code>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSchemaMappingOutput'
              examples:
                DeleteSchemaMapping200Example:
                  summary: Default DeleteSchemaMapping 200 response
                  x-microcks-default: true
                  value:
                    message: example
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                DeleteSchemaMapping480Example:
                  summary: Default DeleteSchemaMapping 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DeleteSchemaMapping481Example:
                  summary: Default DeleteSchemaMapping 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                DeleteSchemaMapping482Example:
                  summary: Default DeleteSchemaMapping 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                DeleteSchemaMapping483Example:
                  summary: Default DeleteSchemaMapping 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                DeleteSchemaMapping484Example:
                  summary: Default DeleteSchemaMapping 484 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: schemaName
        in: path
        required: true
        description: The name of the schema to delete.
        schema:
          type: string
          pattern: ^[a-zA-Z_0-9-]*$
          minLength: 0
          maxLength: 255
      summary: Amazon Entity Resolution DeleteSchemaMapping
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schemas
    get:
      operationId: GetSchemaMapping
      description: Returns the SchemaMapping of a given name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchemaMappingOutput'
              examples:
                GetSchemaMapping200Example:
                  summary: Default GetSchemaMapping 200 response
                  x-microcks-default: true
                  value:
                    createdAt: example
                    description: Example description
                    mappedInputFields: example
                    schemaArn: arn:aws:service:us-east-1:123456789012:resource/example
                    schemaName: example-name
        '480':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
              examples:
                GetSchemaMapping480Example:
                  summary: Default GetSchemaMapping 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                GetSchemaMapping481Example:
                  summary: Default GetSchemaMapping 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                GetSchemaMapping482Example:
                  summary: Default GetSchemaMapping 482 response
                  x-microcks-default: true
                  value: {}
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                GetSchemaMapping483Example:
                  summary: Default GetSchemaMapping 483 response
                  x-microcks-default: true
                  value: {}
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
              examples:
                GetSchemaMapping484Example:
                  summary: Default GetSchemaMapping 484 response
                  x-microcks-default: true
                  value: {}
      parameters:
      - name: schemaName
        in: path
        required: true
        description: The name of the schema to be retrieved.
        schema:
          type: string
          pattern: ^[a-zA-Z_0-9-]*$
          minLength: 0
          maxLength: 255
      summary: Amazon Entity Resolution GetSchemaMapping
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Schemas
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    SchemaInputAttribute:
      type: object
      required:
      - fieldName
      - type
      properties:
        fieldName:
          allOf:
          - $ref: '#/components/schemas/AttributeName'
          - description: A string containing the field name.
        groupName:
          allOf:
          - $ref: '#/components/schemas/AttributeName'
          - description: Instruct Entity Resolution to combine several columns into a unified column with the identical attribute type. For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common <code>GroupName</code> will prompt Entity Resolution to concatenate them into a single value.
        matchKey:
          allOf:
          - $ref: '#/components/schemas/AttributeName'
          - description: A key that allows grouping of multiple input attributes into a unified matching group. For example, let's consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning the <code>MatchKey</code> <i>Address</i>' to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group. If no <code>MatchKey</code> is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.
        type:
          allOf:
          - $ref: '#/components/schemas/SchemaAttributeType'
          - description: The type of the attribute, selected from a list of values.
      description: An object containing <code>FieldField</code>, <code>Type</code>, <code>GroupName</code>, and <code>MatchKey</code>.
    AccessDeniedException: {}
    ExceedsLimitException: {}
    ThrottlingException: {}
    ConflictException: {}
    Timestamp:
      type: string
      format: date-time
    TagMap:
      type: object
      minProperties: 0
      maxProperties: 200
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    SchemaMappingSummary:
      type: object
      required:
      - createdAt
      - schemaArn
      - schemaName
      - updatedAt
      properties:
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The timestamp of when the <code>SchemaMapping</code> was created.
        schemaArn:
          allOf:
          - $ref: '#/components/schemas/SchemaMappingArn'
          - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>SchemaMapping</code>.
        schemaName:
          allOf:
          - $ref: '#/components/schemas/EntityName'
          - description: The name of the schema.
        updatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The timestamp of when the <code>SchemaMapping</code> was last updated.
      description: An object containing <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, and<code>UpdatedAt</code>.
    SchemaMappingArn:
      type: string
      pattern: ^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(schemamapping/.*)$
    String:
      type: string
    NextToken:
      type: string
      pattern: ^[a-zA-Z_0-9-=+/]*$
      minLength: 1
      maxLength: 1024
    InternalServerException: {}
    SchemaMappingList:
      type: array
      items:
        $ref: '#/components/schemas/SchemaMappingSummary'
    AttributeName:
      type: string
      pattern: ^[a-zA-Z_0-9- \t]*$
      minLength: 0
      maxLength: 255
    GetSchemaMappingOutput:
      type: object
      required:
      - createdAt
      - mappedInputFields
      - schemaArn
      - schemaName
      - updatedAt
      properties:
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The timestamp of when the <code>SchemaMapping</code> was created.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description of the schema.
        mappedInputFields:
          allOf:
          - $ref: '#/components/schemas/SchemaInputAttributes'
          - description: A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.
        schemaArn:
          allOf:
          - $ref: '#/components/schemas/SchemaMappingArn'
          - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
        schemaName:
          allOf:
          - $ref: '#/components/schemas/EntityName'
          - description: The name of the schema.
        tags:
          allOf:
          - $ref: '#/components/schemas/TagMap'
          - description: The tags used to organize, track, or control access for this resource.
        updatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The timestamp of when the <code>SchemaMapping</code> was last updated.
    ListSchemaMappingsOutput:
      type: object
      properties:
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The pagination token from the previous <code>ListDomains</code> API call.
        schemaList:
          allOf:
          - $ref: '#/components/schemas/SchemaMappingList'
          - description: A list of <code>SchemaMappingSummary</code> objects, each of which contain the fields <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.
    Description:
      type: string
      minLength: 0
      maxLength: 255
    ResourceNotFoundException: {}
    SchemaInputAttributes:
      type: array
      items:
        $ref: '#/components/schemas/SchemaInputAttribute'
      minItems: 2
      maxItems: 25
    DeleteSchemaMappingOutput:
      type: object
      required:
      - message
      properties:
        message:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A successful operation message.
    EntityName:
      type: string
      pattern: ^[a-zA-Z_0-9-]*$
      minLength: 0
      maxLength: 255
    ValidationException: {}
    SchemaAttributeType:
      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
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    CreateSchemaMappingOutput:
      type: object
      required:
      - description
      - mappedInputFields
      - schemaArn
      - schemaName
      properties:
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description of the schema.
        mappedInputFields:
          allOf:
          - $ref: '#/components/schemas/SchemaInputAttributes'
          - description: A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
        schemaArn:
          allOf:
          - $ref: '#/components/schemas/SchemaMappingArn'
          - description: The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>SchemaMapping</code>.
        schemaName:
          allOf:
          - $ref: '#/components/schemas/EntityName'
          - description: The name of the schema.
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/entityresolution/
x-hasEquivalentPaths: true