View Source aws_customer_profiles (aws v1.0.4)
Amazon Connect Customer Profiles
Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide: https://docs.aws.amazon.com/connect/latest/adminguide/.Summary
Functions
Associates a new key value with a specific profile, such as a Contact Record ContactId.
Creates a new calculated attribute definition.
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.
Creates an integration workflow.
Creates a standard profile.
Deletes an existing calculated attribute definition.
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
Deletes the specified workflow and all its corresponding resources.
Tests the auto-merging settings of your Identity Resolution Job without merging your data.
Returns information about an Identity Resolution Job in a specific domain.
Before calling this API, use CreateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html or UpdateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html to enable identity resolution: set Matching
to true.
Returns the template information for a specific object type.
Returns a set of profiles that belong to the same matching group using the matchId
or profileId
.
Lists all of the Identity Resolution Jobs in your domain.
MatchIds
that belong to the given domain.Displays the tags associated with an Amazon Connect Customer Profiles resource.
Runs an AWS Lambda job that does the following
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
Adds additional objects to customer profiles of a given ObjectType.
Defines a ProfileObjectType.
Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys.
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
Updates an existing calculated attribute definition.
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
Updates the properties of a profile.
Functions
Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.create_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input)
View SourceCreates a new calculated attribute definition.
After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference oneObjectType
and at most, two fields from that ObjectType
.
create_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input0, Options0)
View SourceCreates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.
You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html to enable identity resolution: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html: set Matching
to true.
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domaincreate_event_stream(Client, DomainName, EventStreamName, Input0, Options0)
View SourceCreates an integration workflow.
An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.delete_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input)
View SourceDeletes an existing calculated attribute definition.
Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.delete_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input0, Options0)
View Sourcedelete_event_stream(Client, DomainName, EventStreamName, Input0, Options0)
View Sourcedelete_profile_object_type(Client, DomainName, ObjectTypeName, Input)
View SourceRemoves a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.delete_profile_object_type(Client, DomainName, ObjectTypeName, Input0, Options0)
View SourceDeletes the specified workflow and all its corresponding resources.
This is an async process.Tests the auto-merging settings of your Identity Resolution Job without merging your data.
It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as onlyFirstName
or only LastName
), there may be a large number of matches. This increases the chances of erroneous merges.
get_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName)
View Sourceget_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, QueryMap, HeadersMap)
View Sourceget_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, QueryMap, HeadersMap, Options0)
View Sourceget_calculated_attribute_for_profile(Client, CalculatedAttributeName, DomainName, ProfileId)
View Sourceget_calculated_attribute_for_profile(Client, CalculatedAttributeName, DomainName, ProfileId, QueryMap, HeadersMap)
View Sourceget_calculated_attribute_for_profile(Client, CalculatedAttributeName, DomainName, ProfileId, QueryMap, HeadersMap, Options0)
View Sourceget_event_stream(Client, DomainName, EventStreamName, QueryMap, HeadersMap)
View Sourceget_event_stream(Client, DomainName, EventStreamName, QueryMap, HeadersMap, Options0)
View SourceReturns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles: https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html.get_identity_resolution_job(Client, DomainName, JobId, QueryMap, HeadersMap)
View Sourceget_identity_resolution_job(Client, DomainName, JobId, QueryMap, HeadersMap, Options0)
View SourceBefore calling this API, use CreateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html or UpdateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html to enable identity resolution: set Matching
to true.
GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.
The process of matching duplicate profiles. If Matching
= true
, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html API to return and review the results. Or, if you have configured ExportingConfig
in the MatchingRequest
, you can download the results from S3.
Amazon Connect uses the following profile attributes to identify matches:
PhoneNumber
HomePhoneNumber
BusinessPhoneNumber
MobilePhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
FullName
get_profile_object_type(Client, DomainName, ObjectTypeName, QueryMap, HeadersMap)
View Sourceget_profile_object_type(Client, DomainName, ObjectTypeName, QueryMap, HeadersMap, Options0)
View SourceReturns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.get_profile_object_type_template(Client, TemplateId, QueryMap, HeadersMap)
View Sourceget_profile_object_type_template(Client, TemplateId, QueryMap, HeadersMap, Options0)
View SourceReturns a set of profiles that belong to the same matching group using the matchId
or profileId
.
RULE_BASED_MATCHING
or ML_BASED_MATCHING
.
get_workflow(Client, DomainName, WorkflowId, QueryMap, HeadersMap)
View Sourceget_workflow(Client, DomainName, WorkflowId, QueryMap, HeadersMap, Options0)
View Sourceget_workflow_steps(Client, DomainName, WorkflowId, QueryMap, HeadersMap)
View Sourceget_workflow_steps(Client, DomainName, WorkflowId, QueryMap, HeadersMap, Options0)
View Sourcelist_calculated_attribute_definitions(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_calculated_attribute_definitions(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcelist_calculated_attributes_for_profile(Client, DomainName, ProfileId)
View Sourcelist_calculated_attributes_for_profile(Client, DomainName, ProfileId, QueryMap, HeadersMap)
View Sourcelist_calculated_attributes_for_profile(Client, DomainName, ProfileId, QueryMap, HeadersMap, Options0)
View Sourcelist_event_streams(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceLists all of the Identity Resolution Jobs in your domain.
The response sorts the list byJobStartTime
.
list_identity_resolution_jobs(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_identity_resolution_jobs(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcelist_integrations(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcelist_profile_object_type_templates(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_profile_object_types(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_profile_object_types(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceMatchIds
that belong to the given domain.
list_rule_based_matches(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceDisplays the tags associated with an Amazon Connect Customer Profiles resource.
In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceRuns an AWS Lambda job that does the following:
All the profileKeys in the
ProfileToBeMerged
will be moved to the main profile.All the objects in the
ProfileToBeMerged
will be moved to the main profile.All the
ProfileToBeMerged
will be deleted at the end.All the profileKeys in the
ProfileIdsToBeMerged
will be moved to the main profile.Standard fields are merged as follows:
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
When there are conflicting fields:
If no
SourceProfileIds
entry is specified, the main Profile value is always taken.If a
SourceProfileIds
entry is specified, the specified profileId is always taken, even if it is a NULL value.
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource : https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html/ UntagResource: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html.Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.put_profile_object_type(Client, DomainName, ObjectTypeName, Input)
View SourceDefines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html/UntagResource: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html.put_profile_object_type(Client, DomainName, ObjectTypeName, Input0, Options0)
View SourceSearches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys.
A search key is a data type pair that consists of a KeyName
and Values
list.
AND
or OR
logic.
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.update_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input)
View SourceUpdates an existing calculated attribute definition.
When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.update_calculated_attribute_definition(Client, CalculatedAttributeName, DomainName, Input0, Options0)
View SourceUpdates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html to enable identity resolution: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html: set Matching
to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention: https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html/UntagResource: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html.Updates the properties of a profile.
The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.