EntityResolution / Client / get_schema_mapping

get_schema_mapping#

EntityResolution.Client.get_schema_mapping(**kwargs)#

Returns the SchemaMapping of a given name.

Request Syntax

response = client.get_schema_mapping(
    schemaName='string'
)

Parameters:

schemaName (string) –

[REQUIRED]

The name of the schema to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'hasWorkflows': True|False,
    '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',
    'tags': {
        'string': 'string'
    },
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The timestamp of when the SchemaMapping was created.
- description (string) –
  
  A description of the schema.
- hasWorkflows (boolean) –
  
  Specifies whether the schema mapping has been applied to a workflow.
- mappedInputFields (list) –
  
  A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.
  - (dict) –
    
    An object containing FieldName, Type, GroupName, MatchKey, 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.
    - 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.
- tags (dict) –
  
  The tags used to organize, track, or control access for this resource.
  - (string) –
    - (string) –
- updatedAt (datetime) –
  
  The timestamp of when the SchemaMapping was last updated.

Exceptions

EntityResolution.Client.exceptions.ThrottlingException
EntityResolution.Client.exceptions.InternalServerException
EntityResolution.Client.exceptions.ResourceNotFoundException
EntityResolution.Client.exceptions.AccessDeniedException
EntityResolution.Client.exceptions.ValidationException