AWS.CustomerProfiles (aws-elixir v0.8.0) View Source

Amazon Connect Customer Profiles

Welcome to the Amazon Connect Customer Profiles API Reference.

This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.

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 also review the Amazon Connect Administrator Guide.

Link to this section Summary

Functions

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

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.

Returns information about a specific domain.

Returns an integration for a domain.

This API is in preview release for Amazon Connect and subject to change.

Returns the template information for a specific object type.

Lists all of the integrations associated to a specific URI in the AWS account.

Returns a list of all the domains for an AWS account that have been created.

Returns a list of objects associated with a profile of a given ProfileObjectType.

Displays the tags associated with an Amazon Connect Customer Profiles resource.

This API is in preview release for Amazon Connect and subject to change.

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.

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

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 the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

Updates the properties of a profile.

Link to this section Functions

Link to this function

add_profile_key(client, domain_name, input, options \\ [])

View Source

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) 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.

Link to this function

create_domain(client, domain_name, input, options \\ [])

View Source

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.

Link to this function

create_profile(client, domain_name, input, options \\ [])

View Source

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Link to this function

delete_domain(client, domain_name, input, options \\ [])

View Source

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

Link to this function

delete_integration(client, domain_name, input, options \\ [])

View Source

Removes an integration from a specific domain.

Link to this function

delete_profile(client, domain_name, input, options \\ [])

View Source

Deletes the standard customer profile and all data pertaining to the profile.

Link to this function

delete_profile_key(client, domain_name, input, options \\ [])

View Source

Removes a searchable key from a customer profile.

Link to this function

delete_profile_object(client, domain_name, input, options \\ [])

View Source

Removes an object associated with a profile of a given ProfileObjectType.

Link to this function

delete_profile_object_type(client, domain_name, object_type_name, input, options \\ [])

View Source

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

Link to this function

get_domain(client, domain_name, options \\ [])

View Source

Returns information about a specific domain.

Link to this function

get_integration(client, domain_name, input, options \\ [])

View Source

Returns an integration for a domain.

Link to this function

get_matches(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

This API is in preview release for Amazon Connect and subject to change.

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

Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

  • BusinessName

Link to this function

get_profile_object_type(client, domain_name, object_type_name, options \\ [])

View Source

Returns the object types for a specific domain.

Link to this function

get_profile_object_type_template(client, template_id, options \\ [])

View Source

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

Link to this function

list_account_integrations(client, input, options \\ [])

View Source

Lists all of the integrations associated to a specific URI in the AWS account.

Link to this function

list_domains(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all the domains for an AWS account that have been created.

Link to this function

list_integrations(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all of the integrations in your domain.

Link to this function

list_profile_object_type_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all of the template information for object types.

Link to this function

list_profile_object_types(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all of the templates available within the service.

Link to this function

list_profile_objects(client, domain_name, input, options \\ [])

View Source

Returns a list of objects associated with a profile of a given ProfileObjectType.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Displays the tags associated with an Amazon Connect Customer Profiles resource.

In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Link to this function

merge_profiles(client, domain_name, input, options \\ [])

View Source

This API is in preview release for Amazon Connect and subject to change.

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

Link to this function

put_integration(client, domain_name, input, options \\ [])

View Source

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.

Link to this function

put_profile_object(client, domain_name, input, options \\ [])

View Source

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), 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 CTRs 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.

Link to this function

put_profile_object_type(client, domain_name, object_type_name, input, options \\ [])

View Source

Defines a ProfileObjectType.

Link to this function

search_profiles(client, domain_name, input, options \\ [])

View Source

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

update_domain(client, domain_name, input, options \\ [])

View Source

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.

Link to this function

update_profile(client, domain_name, input, options \\ [])

View Source

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.