Standard identifiers for setting attributes on the key in Customer Profiles - Amazon Connect
Compatible identifiers

Standard identifiers for setting attributes on the key in Customer Profiles

Standard identifiers allow you to set attributes on the key. Decide which identifiers to use based on how you want the data to be ingested in the profiles. For example, you mark phone number with the identifier PROFILE. This means phone number is to be treated as unique identifier. If Customer Profiles gets two contacts with the same phone number, the contacts are going to be merged into a single profile.

Identifier name Description

UNIQUE

This identifier must be specified by exactly one index for each object type. This key is used to uniquely identify objects of the object type for either fetching them or if needed update a submitted object at a later date.

All the fields that make up the UNIQUE keys are required to be specified when submitting a new object or it is rejected.

PROFILE

This identifier means that this key uniquely identifies a profile. When this identifier is specified, it means that during ingestion, Customer Profiles looks for any profile that has this key associated with it.

  • If a profile is found, then the object is assigned to that profile.

  • If more than one profile is found when searching for this key, the match is rejected. (Only keys that uniquely identify a profile should be used as unique keys except for special circumstances.)

LOOKUP_ONLY

This identifier indicates the key is not stored after ingesting the object. The key is only to be used for determining the profile during ingestion.

The key value is not associated with the profile during ingestion, which means it can't be used to allow searching for it or matching later ingested objects to the same key.

Note

  • You cannot specify a key as both a UNIQUE identifier and a LOOKUP_ONLY identifier.

  • You can only use PROFILE together with LOOKUP_ONLY if there is at least one other key that has the PROFILE identifier without the NEW_ONLY or LOOKUP_ONLY identifiers. The only exception is the _profileId key, which can have the PROFILE and LOOKUP_ONLY identifier combination on its own.

NEW_ONLY

If the profile does not already exist before the object is ingested, the key is associated with the profile. Otherwise the key is only used for matching objects to profiles.

Note

  • You cannot specify a key as both a UNIQUE identifier and a NEW_ONLY identifier.

  • You can only use PROFILE together with NEW_ONLY if there is at least one other key that has the PROFILE identifier without the NEW_ONLY or LOOKUP_ONLY identifiers.

SECONDARY

During the matching of an object to a profile, Customer Profiles first looks up all PROFILE keys that do not have the SECONDARY identifier. These are considered first. SECONDARY keys are only considered if no matching profile is found using these keys.

ASSET

This identifier means that this key uniquely identifies an asset. When this identifier is specified, it means that during ingestion, Customer Profiles looks for any asset that has this key associated with it.

  • If an asset is found, then the object is assigned to that asset.

  • If more than one asset is found when searching for this key, the match is rejected. (Only keys that uniquely identify an asset should be used as unique keys except for special circumstances.)

ORDER

This identifier means that this key uniquely identifies an order. When this identifier is specified, it means that during ingestion, Customer Profiles looks for any order that has this key associated with it.

  • If an order is found, then the object is assigned to that order.

  • If more than one order is found when searching for this key, the match is rejected. (Only keys that uniquely identify an order should be used as unique keys except for special circumstances.)

CASE

This identifier means that this key uniquely identifies a case. When this identifier is specified, it means that during ingestion, Customer Profiles looks for any case that has this key associated with it.

  • If a case is found, then the object is assigned to that case.

  • If more than one case is found when searching for this key, the match is rejected. (Only keys that uniquely identify a case should be used as unique keys except for special circumstances.)

Compatible identifiers

Matrix showing allowed and restricted identifiers and key names for different data types.