EntityResolution / Client / create_schema_mapping

create_schema_mapping#

EntityResolution.Client.create_schema_mapping(**kwargs)#

Creates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.

Request Syntax

response = client.create_schema_mapping(
    description='string',
    mappedInputFields=[
        {
            'fieldName': 'string',
            'groupName': 'string',
            'hashed': True|False,
            'matchKey': 'string',
            'subType': 'string',
            'type': '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'
        },
    ],
    schemaName='string',
    tags={
        'string': 'string'
    }
)

Parameters:

description (string) – A description of the schema.
mappedInputFields (list) –
[REQUIRED]

A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
- (dict) –
  
  An object containing FieldName, Type, GroupName, MatchKey, Hashing, and SubType.
  - fieldName (string) – [REQUIRED]
    
    A string containing the field name.
  - groupName (string) –
    
    A string that instructs 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 groupName will prompt Entity Resolution to concatenate them into a single value.
  - hashed (boolean) –
    
    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.
  - matchKey (string) –
    
    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, 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.
  - subType (string) –
    
    The subtype of the attribute, selected from a list of values.
  - type (string) – [REQUIRED]
    
    The type of the attribute, selected from a list of values.
schemaName (string) –
[REQUIRED]

The name of the schema. There can’t be multiple SchemaMappings with the same name.
tags (dict) –
The tags used to organize, track, or control access for this resource.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'mappedInputFields': [
        {
            'fieldName': 'string',
            'groupName': 'string',
            'hashed': True|False,
            'matchKey': 'string',
            'subType': 'string',
            'type': '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'
        },
    ],
    'schemaArn': 'string',
    'schemaName': 'string'
}

Response Structure

(dict) –
- description (string) –
  
  A description of the schema.
- mappedInputFields (list) –
  
  A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.
  - (dict) –
    
    An object containing FieldName, Type, GroupName, MatchKey, Hashing, and SubType.
    - fieldName (string) –
      
      A string containing the field name.
    - groupName (string) –
      
      A string that instructs 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 groupName will prompt Entity Resolution to concatenate them into a single value.
    - hashed (boolean) –
      
      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.
    - matchKey (string) –
      
      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, 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.
    - subType (string) –
      
      The subtype of the attribute, selected from a list of values.
    - type (string) –
      
      The type of the attribute, selected from a list of values.
- schemaArn (string) –
  
  The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
- schemaName (string) –
  
  The name of the schema.

Exceptions

EntityResolution.Client.exceptions.ThrottlingException
EntityResolution.Client.exceptions.InternalServerException
EntityResolution.Client.exceptions.AccessDeniedException
EntityResolution.Client.exceptions.ExceedsLimitException
EntityResolution.Client.exceptions.ConflictException
EntityResolution.Client.exceptions.ValidationException