AWS::EntityResolution::SchemaMapping SchemaInputAttribute

Filter View

All

A configuration object for defining input data fields in AWS Entity Resolution. The SchemaInputAttribute specifies how individual fields in your input data should be processed and matched.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "FieldName" : String,
  "GroupName" : String,
  "Hashed" : Boolean,
  "MatchKey" : String,
  "SubType" : String,
  "Type" : String
}

YAML

  FieldName: String
  GroupName: String
  Hashed: Boolean
  MatchKey: String
  SubType: String
  Type: String

Properties

FieldName

A string containing the field name.

Required: Yes

Type: String

Pattern: ^[a-zA-Z_0-9- \t]*$

Minimum: 0

Maximum: 255

Update requires: No interruption

GroupName

A string that instructs AWS 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 AWS Entity Resolution to concatenate them into a single value.

Required: No

Type: String

Pattern: ^[a-zA-Z_0-9- \t]*$

Minimum: 0

Maximum: 255

Update requires: No interruption

Hashed

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: No

Type: Boolean

Update requires: No interruption

MatchKey

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, AWS 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.

Required: No

Type: String

Pattern: ^[a-zA-Z_0-9- \t]*$

Minimum: 0

Maximum: 255

Update requires: No interruption

SubType

The subtype of the attribute, selected from a list of values.

Required: No

Type: String

Update requires: No interruption

Type

The type of the attribute, selected from a list of values.

Note

Normalization is only supported for NAME, ADDRESS, PHONE, and EMAIL_ADDRESS.

If you want to normalize NAME_FIRST, NAME_MIDDLE, and NAME_LAST, you must group them by assigning them to the NAME groupName.

If you want to normalize ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, and ADDRESS_POSTALCODE, you must group them by assigning them to the ADDRESS groupName.

If you want to normalize PHONE_NUMBER and PHONE_COUNTRYCODE, you must group them by assigning them to the PHONE groupName.

Required: Yes

Type: String

Allowed values: 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

Update requires: No interruption