Customer Profiles

add_profile_key(domain_name, key_name, profile_id, values)
add_profile_key(domain_name, key_name, profile_id, values, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.
• key_name: A searchable identifier of a customer profile.
• profile_id: The unique identifier of a customer profile.
• values: A list of key values.

create_domain(default_expiration_days, domain_name)
create_domain(default_expiration_days, domain_name, params::Dict{String,<:Any})

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.

Arguments

• default_expiration_days: The default number of days until the data within the domain expires.
• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeadLetterQueueUrl": The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
• "DefaultEncryptionKey": The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
• "Matching": The process of matching duplicate profiles. This process runs every Saturday at 12AM.
• "Tags": The tags used to organize, track, or control access for this resource.

create_profile(domain_name)
create_profile(domain_name, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccountNumber": A unique account number that you have given to the customer.
• "AdditionalInformation": Any additional information relevant to the customer’s profile.
• "Address": A generic address associated with the customer that is not mailing, shipping, or billing.
• "Attributes": A key value pair of attributes of a customer profile.
• "BillingAddress": The customer’s billing address.
• "BirthDate": The customer’s birth date.
• "BusinessEmailAddress": The customer’s business email address.
• "BusinessName": The name of the customer’s business.
• "BusinessPhoneNumber": The customer’s business phone number.
• "EmailAddress": The customer’s email address, which has not been specified as a personal or business address.
• "FirstName": The customer’s first name.
• "Gender": The gender with which the customer identifies.
• "HomePhoneNumber": The customer’s home phone number.
• "LastName": The customer’s last name.
• "MailingAddress": The customer’s mailing address.
• "MiddleName": The customer’s middle name.
• "MobilePhoneNumber": The customer’s mobile phone number.
• "PartyType": The type of profile used to describe the customer.
• "PersonalEmailAddress": The customer’s personal email address.
• "PhoneNumber": The customer’s phone number, which has not been specified as a mobile, home, or business number.
• "ShippingAddress": The customer’s shipping address.

delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.

delete_integration(domain_name, uri)
delete_integration(domain_name, uri, params::Dict{String,<:Any})

Removes an integration from a specific domain.

Arguments

• domain_name: The unique name of the domain.
• uri: The URI of the S3 bucket or any other type of data source.

delete_profile(domain_name, profile_id)
delete_profile(domain_name, profile_id, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.
• profile_id: The unique identifier of a customer profile.

delete_profile_key(domain_name, key_name, profile_id, values)
delete_profile_key(domain_name, key_name, profile_id, values, params::Dict{String,<:Any})

Removes a searchable key from a customer profile.

Arguments

• domain_name: The unique name of the domain.
• key_name: A searchable identifier of a customer profile.
• profile_id: The unique identifier of a customer profile.
• values: A list of key values.

delete_profile_object(domain_name, object_type_name, profile_id, profile_object_unique_key)
delete_profile_object(domain_name, object_type_name, profile_id, profile_object_unique_key, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.
• profile_id: The unique identifier of a customer profile.
• profile_object_unique_key: The unique identifier of the profile object generated by the service.

delete_profile_object_type(domain_name, object_type_name)
delete_profile_object_type(domain_name, object_type_name, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.

get_domain(domain_name)
get_domain(domain_name, params::Dict{String,<:Any})

Returns information about a specific domain.

Arguments

• domain_name: The unique name of the domain.

get_integration(domain_name, uri)
get_integration(domain_name, uri, params::Dict{String,<:Any})

Returns an integration for a domain.

Arguments

• domain_name: The unique name of the domain.
• uri: The URI of the S3 bucket or any other type of data source.

get_matches(domain_name)
get_matches(domain_name, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of results to return per page.
• "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

get_profile_object_type(domain_name, object_type_name)
get_profile_object_type(domain_name, object_type_name, params::Dict{String,<:Any})

Returns the object types for a specific domain.

Arguments

• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.

get_profile_object_type_template(template_id)
get_profile_object_type_template(template_id, params::Dict{String,<:Any})

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.

Arguments

• template_id: A unique identifier for the object template.

list_account_integrations(uri)
list_account_integrations(uri, params::Dict{String,<:Any})

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

Arguments

• uri: The URI of the S3 bucket or any other type of data source.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous ListAccountIntegrations API call.

list_domains()
list_domains(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous ListDomain API call.

list_integrations(domain_name)
list_integrations(domain_name, params::Dict{String,<:Any})

Lists all of the integrations in your domain.

Arguments

• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous ListIntegrations API call.

list_profile_object_type_templates()
list_profile_object_type_templates(params::Dict{String,<:Any})

Lists all of the template information for object types.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous ListObjectTypeTemplates API call.

list_profile_object_types(domain_name)
list_profile_object_types(domain_name, params::Dict{String,<:Any})

Lists all of the templates available within the service.

Arguments

• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": Identifies the next page of results to return.

list_profile_objects(domain_name, object_type_name, profile_id)
list_profile_objects(domain_name, object_type_name, profile_id, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.
• profile_id: The unique identifier of a customer profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous call to ListProfileObjects.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Arguments

• resource_arn: The ARN of the resource for which you want to view tags.

merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged)
merge_profiles(domain_name, main_profile_id, profile_ids_to_be_merged, params::Dict{String,<:Any})

This API is in preview release for Amazon Connect and subject to change. Runs 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. 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).

Arguments

• domain_name: The unique name of the domain.
• main_profile_id: The identifier of the profile to be taken.
• profile_ids_to_be_merged: The identifier of the profile to be merged into MainProfileId.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "FieldSourceProfileIds": The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.

put_integration(domain_name, object_type_name)
put_integration(domain_name, object_type_name, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "FlowDefinition": The configuration that controls how Customer Profiles retrieves data from the source.
• "Tags": The tags used to organize, track, or control access for this resource.
• "Uri": The URI of the S3 bucket or any other type of data source.

put_profile_object(domain_name, object, object_type_name)
put_profile_object(domain_name, object, object_type_name, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.
• object: A string that is serialized from a JSON object.
• object_type_name: The name of the profile object type.

put_profile_object_type(description, domain_name, object_type_name)
put_profile_object_type(description, domain_name, object_type_name, params::Dict{String,<:Any})

Defines a ProfileObjectType.

Arguments

• description: Description of the profile object type.
• domain_name: The unique name of the domain.
• object_type_name: The name of the profile object type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AllowProfileCreation": Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
• "EncryptionKey": The customer-provided key to encrypt the profile object that will be created in this profile object type.
• "ExpirationDays": The number of days until the data in the object expires.
• "Fields": A map of the name and ObjectType field.
• "Keys": A list of unique keys that can be used to map data to the profile.
• "Tags": The tags used to organize, track, or control access for this resource.
• "TemplateId": A unique identifier for the object template.

search_profiles(domain_name, key_name, values)
search_profiles(domain_name, key_name, values, params::Dict{String,<:Any})

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

Arguments

• domain_name: The unique name of the domain.
• key_name: A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.
• values: A list of key values.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "max-results": The maximum number of objects returned per page.
• "next-token": The pagination token from the previous SearchProfiles API call.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

• resource_arn: The ARN of the resource that you're adding tags to.
• tags: The tags used to organize, track, or control access for this resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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.

Arguments

• resource_arn: The ARN of the resource from which you are removing tags.
• tag_keys: The list of tag keys to remove from the resource.

update_domain(domain_name)
update_domain(domain_name, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeadLetterQueueUrl": The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
• "DefaultEncryptionKey": The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
• "DefaultExpirationDays": The default number of days until the data within the domain expires.
• "Matching": The process of matching duplicate profiles. This process runs every Saturday at 12AM.
• "Tags": The tags used to organize, track, or control access for this resource.

update_profile(domain_name, profile_id)
update_profile(domain_name, profile_id, params::Dict{String,<:Any})

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.

Arguments

• domain_name: The unique name of the domain.
• profile_id: The unique identifier of a customer profile.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccountNumber": A unique account number that you have given to the customer.
• "AdditionalInformation": Any additional information relevant to the customer’s profile.
• "Address": A generic address associated with the customer that is not mailing, shipping, or billing.
• "Attributes": A key value pair of attributes of a customer profile.
• "BillingAddress": The customer’s billing address.
• "BirthDate": The customer’s birth date.
• "BusinessEmailAddress": The customer’s business email address.
• "BusinessName": The name of the customer’s business.
• "BusinessPhoneNumber": The customer’s business phone number.
• "EmailAddress": The customer’s email address, which has not been specified as a personal or business address.
• "FirstName": The customer’s first name.
• "Gender": The gender with which the customer identifies.
• "HomePhoneNumber": The customer’s home phone number.
• "LastName": The customer’s last name.
• "MailingAddress": The customer’s mailing address.
• "MiddleName": The customer’s middle name.
• "MobilePhoneNumber": The customer’s mobile phone number.
• "PartyType": The type of profile used to describe the customer.
• "PersonalEmailAddress": The customer’s personal email address.
• "PhoneNumber": The customer’s phone number, which has not been specified as a mobile, home, or business number.
• "ShippingAddress": The customer’s shipping address.