EntityResolution / Client / update_schema_mapping

update_schema_mapping#

EntityResolution.Client.update_schema_mapping(**kwargs)#

Updates a schema mapping.

Note

A schema is immutable if it is being used by a workflow. Therefore, you can’t update a schema mapping if it’s associated with a workflow.

See also: AWS API Documentation

Request Syntax

response = client.update_schema_mapping(
    description='string',
    mappedInputFields=[
        {
            'fieldName': 'string',
            'groupName': 'string',
            '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'
)
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, and MatchKey.

      • fieldName (string) – [REQUIRED]

        A string containing the field name.

      • groupName (string) –

        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 GroupName will prompt Entity Resolution to concatenate them into a single value.

      • matchKey (string) –

        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 MatchKey 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.

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'mappedInputFields': [
        {
            'fieldName': 'string',
            'groupName': 'string',
            '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, and MatchKey.

        • fieldName (string) –

          A string containing the field name.

        • groupName (string) –

          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 GroupName will prompt Entity Resolution to concatenate them into a single value.

        • matchKey (string) –

          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 MatchKey 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