View Source AWS.CustomerProfiles (aws-elixir 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.
For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles in the Amazon Connect Administrator's Guide.
Link to this section Summary
Functions
Associates a new key value with a specific profile, such as a Contact Record ContactId.
Fetch the possible attribute values given the attribute name.
Get a batch of profiles.
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 event trigger, which specifies the rules when to perform action based on customer's ingested data.
Creates an integration workflow.
Creates a standard profile.
Creates a segment definition associated to the given domain.
Creates a segment estimate query.
Triggers a job to export a segment to a specified destination.
Deletes an existing calculated attribute definition.
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
Disables and deletes the specified event stream.
Disable and deletes the Event Trigger.
Removes an integration from a specific domain.
Deletes the standard customer profile and all data pertaining to the profile.
Removes a searchable key from a customer profile.
Removes an object associated with a profile of a given ProfileObjectType.
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
Deletes a segment definition from the domain.
Deletes the specified workflow and all its corresponding resources.
The process of detecting profile object type mapping by using given objects.
Tests the auto-merging settings of your Identity Resolution Job without merging your data.
Provides more information on a calculated attribute definition for Customer Profiles.
Retrieve a calculated attribute for a customer profile.
Returns information about a specific domain.
Returns information about the specified event stream in a specific domain.
Get a specific Event Trigger from the domain.
Returns information about an Identity Resolution Job in a specific domain.
Returns an integration for a domain.
Before calling this API, use
CreateDomain or
UpdateDomain
to
enable identity resolution: set Matching to true.
Returns the object types for a specific domain.
Returns the template information for a specific object type.
Gets a segment definition from the domain.
Gets the result of a segment estimate query.
Determines if the given profiles are within a segment.
Retrieve the latest status of a segment snapshot.
Returns a set of profiles that belong to the same matching group using the
matchId or profileId.
Get details of specified workflow.
Get granular list of steps in workflow.
Lists all of the integrations associated to a specific URI in the AWS account.
Lists calculated attribute definitions for Customer Profiles
Retrieve a list of calculated attributes for a customer profile.
Returns a list of all the domains for an AWS account that have been created.
Returns a list of all the event streams in a specific domain.
List all Event Triggers under a domain.
Lists all of the Identity Resolution Jobs in your domain.
Lists all of the integrations in your domain.
Fetch the possible attribute values given the attribute name.
Fetch the possible attribute values given the attribute name.
Lists all of the template information for object types.
Lists all of the templates available within the service.
Returns a list of objects associated with a profile of a given ProfileObjectType.
Returns a set of MatchIds that belong to the given domain.
Lists all segment definitions under a domain.
Displays the tags associated with an Amazon Connect Customer Profiles resource.
Query to list all workflows.
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.
Update the properties of an Event Trigger.
Updates the properties of a profile.
Link to this section 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.
batch_get_calculated_attribute_for_profile(client, calculated_attribute_name, domain_name, input, options \\ [])
View SourceFetch the possible attribute values given the attribute name.
Get a batch of profiles.
create_calculated_attribute_definition(client, calculated_attribute_name, domain_name, input, options \\ [])
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
API. Defining a calculated attribute makes it
available for all profiles within a domain. Each calculated attribute can only
reference
one ObjectType and at most, two fields from that
ObjectType.
Creates 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 to
enable identity
resolution:
set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
create_event_stream(client, domain_name, event_stream_name, input, options \\ [])
View SourceCreates 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 domain
create_event_trigger(client, domain_name, event_trigger_name, input, options \\ [])
View SourceCreates an event trigger, which specifies the rules when to perform action based on customer's ingested data.
Each event stream can be associated with only one integration in the same region and AWS account as the event stream.
create_integration_workflow(client, domain_name, input, options \\ [])
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.
create_segment_definition(client, domain_name, segment_definition_name, input, options \\ [])
View SourceCreates a segment definition associated to the given domain.
create_segment_estimate(client, domain_name, input, options \\ [])
View SourceCreates a segment estimate query.
create_segment_snapshot(client, domain_name, segment_definition_name, input, options \\ [])
View SourceTriggers a job to export a segment to a specified destination.
delete_calculated_attribute_definition(client, calculated_attribute_name, domain_name, input, options \\ [])
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.
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
delete_event_stream(client, domain_name, event_stream_name, input, options \\ [])
View SourceDisables and deletes the specified event stream.
delete_event_trigger(client, domain_name, event_trigger_name, input, options \\ [])
View SourceDisable and deletes the Event Trigger.
You cannot delete an Event Trigger with an active Integration associated.
Removes an integration from a specific domain.
Deletes the standard customer profile and all data pertaining to the profile.
Removes a searchable key from a customer profile.
Removes an object associated with a profile of a given ProfileObjectType.
delete_profile_object_type(client, domain_name, object_type_name, input, options \\ [])
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_segment_definition(client, domain_name, segment_definition_name, input, options \\ [])
View SourceDeletes a segment definition from the domain.
delete_workflow(client, domain_name, workflow_id, input, options \\ [])
View SourceDeletes the specified workflow and all its corresponding resources.
This is an async process.
detect_profile_object_type(client, domain_name, input, options \\ [])
View SourceThe process of detecting profile object type mapping by using given objects.
get_auto_merging_preview(client, domain_name, input, options \\ [])
View SourceTests 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 only
FirstName or only LastName), there may be a large number of
matches. This increases the chances of erroneous merges.
get_calculated_attribute_definition(client, calculated_attribute_name, domain_name, options \\ [])
View SourceProvides more information on a calculated attribute definition for Customer Profiles.
get_calculated_attribute_for_profile(client, calculated_attribute_name, domain_name, profile_id, options \\ [])
View SourceRetrieve a calculated attribute for a customer profile.
Returns information about a specific domain.
get_event_stream(client, domain_name, event_stream_name, options \\ [])
View SourceReturns information about the specified event stream in a specific domain.
get_event_trigger(client, domain_name, event_trigger_name, options \\ [])
View SourceGet a specific Event Trigger from the domain.
get_identity_resolution_job(client, domain_name, job_id, options \\ [])
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.
Returns an integration for a domain.
get_matches(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceBefore calling this API, use
CreateDomain or
UpdateDomain
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
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
For example, two or more profiles—with spelling mistakes such as ## John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
get_profile_object_type(client, domain_name, object_type_name, options \\ [])
View SourceReturns the object types for a specific domain.
get_profile_object_type_template(client, template_id, options \\ [])
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_segment_definition(client, domain_name, segment_definition_name, options \\ [])
View SourceGets a segment definition from the domain.
get_segment_estimate(client, domain_name, estimate_id, options \\ [])
View SourceGets the result of a segment estimate query.
get_segment_membership(client, domain_name, segment_definition_name, input, options \\ [])
View SourceDetermines if the given profiles are within a segment.
get_segment_snapshot(client, domain_name, segment_definition_name, snapshot_id, options \\ [])
View SourceRetrieve the latest status of a segment snapshot.
Returns a set of profiles that belong to the same matching group using the
matchId or profileId.
You can also specify the type of
matching that you want for finding similar profiles using either
RULE_BASED_MATCHING or ML_BASED_MATCHING.
Get details of specified workflow.
get_workflow_steps(client, domain_name, workflow_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGet granular list of steps in workflow.
Lists all of the integrations associated to a specific URI in the AWS account.
list_calculated_attribute_definitions(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists calculated attribute definitions for Customer Profiles
list_calculated_attributes_for_profile(client, domain_name, profile_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve a list of calculated attributes for a customer profile.
list_domains(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the domains for an AWS account that have been created.
list_event_streams(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the event streams in a specific domain.
list_event_triggers(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all Event Triggers under a domain.
list_identity_resolution_jobs(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the Identity Resolution Jobs in your domain.
The response sorts the list by
JobStartTime.
list_integrations(client, domain_name, include_hidden \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the integrations in your domain.
list_object_type_attributes(client, domain_name, object_type_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceFetch the possible attribute values given the attribute name.
list_profile_attribute_values(client, attribute_name, domain_name, options \\ [])
View SourceFetch the possible attribute values given the attribute name.
list_profile_object_type_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the template information for object types.
list_profile_object_types(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the templates available within the service.
Returns a list of objects associated with a profile of a given ProfileObjectType.
list_rule_based_matches(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a set of MatchIds that belong to the given domain.
list_segment_definitions(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all segment definitions under a domain.
Displays the tags associated with an Amazon Connect Customer Profiles resource.
In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Query to list all workflows.
Runs an AWS Lambda job that does the following:
1.
All the profileKeys in the ProfileToBeMerged will be moved to the
main profile.
2.
All the objects in the ProfileToBeMerged will be moved to the main
profile.
3.
All the ProfileToBeMerged will be deleted at the end.
4.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the
main profile.
5. Standard fields are merged as follows:
1.Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
2.When there are conflicting fields:
1.If no SourceProfileIds entry is specified, the main
Profile value is always taken.
2.If a SourceProfileIds entry is specified, the specified
profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
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 /[
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, domain_name, object_type_name, input, options \\ [])
View SourceDefines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
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.
A
search key is a data type pair that consists of a KeyName and
Values list.
This operation supports searching for profiles with a minimum of 1 key-value(s)
pair and
up to 5 key-value(s) pairs using either 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, calculated_attribute_name, domain_name, input, options \\ [])
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.
Updates 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 to
enable identity
resolution:
set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
update_event_trigger(client, domain_name, event_trigger_name, input, options \\ [])
View SourceUpdate the properties of an Event Trigger.
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.