SchemaInputAttribute
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.
Contents
- fieldName
-
A string containing the field name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^[a-zA-Z_0-9- ]*$
Required: Yes
- type
-
The type of the attribute, selected from a list of values.
Note
Normalization is only supported for
NAME
,ADDRESS
,PHONE
, andEMAIL_ADDRESS
.If you want to normalize
NAME_FIRST
,NAME_MIDDLE
, andNAME_LAST
, you must group them by assigning them to theNAME
groupName
.If you want to normalize
ADDRESS_STREET1
,ADDRESS_STREET2
,ADDRESS_STREET3
,ADDRESS_CITY
,ADDRESS_STATE
,ADDRESS_COUNTRY
, andADDRESS_POSTALCODE
, you must group them by assigning them to theADDRESS
groupName
.If you want to normalize
PHONE_NUMBER
andPHONE_COUNTRYCODE
, you must group them by assigning them to thePHONE
groupName
.Type: String
Valid 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
Required: Yes
- 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
, andNAME_LAST
, assigning them a commongroupName
will prompt AWS Entity Resolution to concatenate them into a single value.Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^[a-zA-Z_0-9- ]*$
Required: No
- 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.Type: Boolean
Required: No
- 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
andshipping_address
. By assigning amatchKey
calledaddress
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.Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^[a-zA-Z_0-9- ]*$
Required: No
- subType
-
The subtype of the attribute, selected from a list of values.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^[a-zA-Z_0-9- ]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: