Amazon Entity Resolution Entity Resolution Operations API

openapi: 3.2.0
info:
  title: AWS EntityResolution Operations 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: Operations
paths:
  /matchingworkflows/{workflowName}/uniqueids:
    delete:
      operationId: BatchDeleteUniqueId
      summary: Batch Delete Unique Id
      description: Deletes multiple unique IDs in a matching workflow.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDeleteUniqueIdOutput'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDeleteUniqueIdInput'
      tags:
      - Operations
  /matchingworkflows/{workflowName}/generateMatches:
    post:
      operationId: GenerateMatchId
      summary: Generate Match Id
      description: Generates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3. The processing type (processingType) you choose affects both the accuracy and response time of the operation. Additional charges apply for each API call, whether made through the Entity Resolution console or directly via the API. The rule-based matching workflow must exist and be active before calling this operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateMatchIdOutput'
        '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/GenerateMatchIdInput'
      tags:
      - Operations
  /providerservices/{providerName}/{providerServiceName}:
    get:
      operationId: GetProviderService
      summary: Get Provider Service
      description: Returns the ProviderService of a given name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProviderServiceOutput'
        '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/GetProviderServiceInput'
      tags:
      - Operations
  /providerservices:
    get:
      operationId: ListProviderServices
      summary: List Provider Services
      description: Returns a list of all the ProviderServices that are available in this Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProviderServicesOutput'
        '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/ListProviderServicesInput'
      tags:
      - Operations
components:
  schemas:
    BatchDeleteUniqueIdInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the workflow.
        inputSource:
          type: string
          description: The input source for the batch delete unique ID operation.
        uniqueIds:
          type: array
          items:
            type: string
          description: The unique IDs to delete.
      required:
      - workflowName
      - uniqueIds
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    BatchDeleteUniqueIdOutput:
      type: object
      properties:
        status:
          type: string
          enum:
          - COMPLETED
          - ACCEPTED
          description: The status of the batch delete unique ID operation.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/DeleteUniqueIdError'
          description: The errors from deleting multiple unique IDs.
        deleted:
          type: array
          items:
            $ref: '#/components/schemas/DeletedUniqueId'
          description: The unique IDs that were deleted.
        disconnectedUniqueIds:
          type: array
          items:
            type: string
          description: The unique IDs that were disconnected.
      required:
      - status
      - errors
      - deleted
      - disconnectedUniqueIds
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ProviderEndpointConfiguration:
      type: object
      properties:
        marketplaceConfiguration:
          $ref: '#/components/schemas/ProviderMarketplaceConfiguration'
      description: Exactly one member is set.
    ProviderServiceSummary:
      type: object
      properties:
        providerServiceArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the providerService.
        providerName:
          type: string
          description: The name of the provider. This name is typically the company name.
        providerServiceDisplayName:
          type: string
          description: The display name of the provider service.
        providerServiceName:
          type: string
          description: The name of the product that the provider service provides.
        providerServiceType:
          type: string
          enum:
          - ASSIGNMENT
          - ID_MAPPING
          description: The type of provider service.
      required:
      - providerServiceArn
      - providerName
      - providerServiceDisplayName
      - providerServiceName
      - providerServiceType
    GenerateMatchIdInput:
      type: object
      properties:
        workflowName:
          type: string
          description: The name of the rule-based matching workflow.
        records:
          type: array
          items:
            $ref: '#/components/schemas/Record'
          description: The records to match.
        processingType:
          type: string
          enum:
          - CONSISTENT
          - EVENTUAL
          - EVENTUAL_NO_LOOKUP
          description: 'The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results. If not specified, defaults to CONSISTENT. CONSISTENT: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time. EVENTUAL (shown as Background in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, wit'
      required:
      - workflowName
      - records
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    DeletedUniqueId:
      type: object
      properties:
        uniqueId:
          type: string
          description: The unique ID of the deleted item.
      required:
      - uniqueId
    MatchGroup:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/MatchedRecord'
          description: The matched records.
        matchId:
          type: string
          description: The match ID.
        matchRule:
          type: string
          description: The match rule of the match group.
      required:
      - records
      - matchId
      - matchRule
    GetProviderServiceInput:
      type: object
      properties:
        providerName:
          type: string
          description: The name of the provider. This name is typically the company name.
        providerServiceName:
          type: string
          description: The ARN (Amazon Resource Name) of the product that the provider service provides.
      required:
      - providerName
      - providerServiceName
    GetProviderServiceOutput:
      type: object
      properties:
        providerName:
          type: string
          description: The name of the provider. This name is typically the company name.
        providerServiceName:
          type: string
          description: The name of the product that the provider service provides.
        providerServiceDisplayName:
          type: string
          description: The display name of the provider service.
        providerServiceType:
          type: string
          enum:
          - ASSIGNMENT
          - ID_MAPPING
          description: The type of provider service.
        providerServiceArn:
          type: string
          description: The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.
        providerConfigurationDefinition:
          type: object
          description: The definition of the provider configuration.
        providerIdNameSpaceConfiguration:
          $ref: '#/components/schemas/ProviderIdNameSpaceConfiguration'
        providerJobConfiguration:
          type: object
          description: Provider service job configurations.
        providerEndpointConfiguration:
          $ref: '#/components/schemas/ProviderEndpointConfiguration'
        anonymizedOutput:
          type: boolean
          description: Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.
        providerEntityOutputDefinition:
          type: object
          description: The definition of the provider entity output.
        providerIntermediateDataAccessConfiguration:
          $ref: '#/components/schemas/ProviderIntermediateDataAccessConfiguration'
        providerComponentSchema:
          $ref: '#/components/schemas/ProviderComponentSchema'
      required:
      - providerName
      - providerServiceName
      - providerServiceDisplayName
      - providerServiceType
      - providerServiceArn
      - providerEndpointConfiguration
      - anonymizedOutput
      - providerEntityOutputDefinition
    ProviderMarketplaceConfiguration:
      type: object
      properties:
        dataSetId:
          type: string
          description: The dataset ID on Data Exchange.
        revisionId:
          type: string
          description: The revision ID on Data Exchange.
        assetId:
          type: string
          description: The asset ID on Data Exchange.
        listingId:
          type: string
          description: The listing ID on Data Exchange.
      required:
      - dataSetId
      - revisionId
      - assetId
      - listingId
    ListProviderServicesOutput:
      type: object
      properties:
        providerServiceSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ProviderServiceSummary'
          description: A list of ProviderServices objects.
        nextToken:
          type: string
          description: The pagination token from the previous API call.
    FailedRecord:
      type: object
      properties:
        inputSourceARN:
          type: string
          description: The input source ARN of the record that didn't generate a Match ID.
        uniqueId:
          type: string
          description: The unique ID of the record that didn't generate a Match ID.
        errorMessage:
          type: string
          description: The error message for the record that didn't generate a Match ID.
      required:
      - inputSourceARN
      - uniqueId
      - errorMessage
    Record:
      type: object
      properties:
        inputSourceARN:
          type: string
          description: The input source ARN of the record.
        uniqueId:
          type: string
          description: The unique ID of the record.
        recordAttributeMap:
          type: object
          additionalProperties:
            type: string
          description: The record's attribute map.
      required:
      - inputSourceARN
      - uniqueId
      - recordAttributeMap
    ProviderSchemaAttribute:
      type: object
      properties:
        fieldName:
          type: string
          description: 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 provider schema attribute. 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 | DATE | IPV4 | IPV6 | MAID Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID'
        subType:
          type: string
          description: The sub type of the provider schema attribute.
        hashing:
          type: boolean
          description: The hashing attribute of the provider schema.
      required:
      - fieldName
      - type
    GenerateMatchIdOutput:
      type: object
      properties:
        matchGroups:
          type: array
          items:
            $ref: '#/components/schemas/MatchGroup'
          description: The match groups from the generated match ID.
        failedRecords:
          type: array
          items:
            $ref: '#/components/schemas/FailedRecord'
          description: The records that didn't receive a generated Match ID.
      required:
      - matchGroups
      - failedRecords
    ListProviderServicesInput:
      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.
        providerName:
          type: string
          description: The name of the provider. This name is typically the company name.
    ProviderIdNameSpaceConfiguration:
      type: object
      properties:
        description:
          type: string
          description: The description of the ID namespace.
        providerTargetConfigurationDefinition:
          type: object
          description: Configurations required for the target ID namespace.
        providerSourceConfigurationDefinition:
          type: object
          description: Configurations required for the source ID namespace.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    MatchedRecord:
      type: object
      properties:
        inputSourceARN:
          type: string
          description: The input source ARN of the matched record.
        recordId:
          type: string
          description: The record ID of the matched record.
      required:
      - inputSourceARN
      - recordId
    DeleteUniqueIdError:
      type: object
      properties:
        uniqueId:
          type: string
          description: The unique ID that couldn't be deleted.
        errorType:
          type: string
          enum:
          - SERVICE_ERROR
          - VALIDATION_ERROR
          description: The error type for the delete unique ID operation. The SERVICE_ERROR value indicates that an internal service-side problem occurred during the deletion operation. The VALIDATION_ERROR value indicates that the deletion operation couldn't complete because of invalid input parameters or data.
      required:
      - uniqueId
      - errorType
    ProviderIntermediateDataAccessConfiguration:
      type: object
      properties:
        awsAccountIds:
          type: array
          items:
            type: string
          description: The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.
        requiredBucketActions:
          type: array
          items:
            type: string
          description: The S3 bucket actions that the provider requires permission for.
    ProviderComponentSchema:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: array
            items:
              type: string
          description: Input schema for the provider service.
        providerSchemaAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ProviderSchemaAttribute'
          description: The provider schema attributes.
  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)