SchemaInputAttribute

An object containing FieldField, Type, GroupName, and MatchKey.

Amazon Web ServicesData IntegrationData MatchingEntity ResolutionMachine Learning

Properties

Name Type Description
fieldName object
groupName object
matchKey object
type object
View JSON Schema on GitHub

JSON Schema

amazon-entity-resolution-schema-input-attribute-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-entity-resolution/refs/heads/main/json-schema/amazon-entity-resolution-schema-input-attribute-schema.json",
  "title": "SchemaInputAttribute",
  "description": "An object containing <code>FieldField</code>, <code>Type</code>, <code>GroupName</code>, and <code>MatchKey</code>.",
  "type": "object",
  "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."
        }
      ]
    }
  },
  "required": [
    "fieldName",
    "type"
  ]
}