/domains/{DomainName}/workflows/integrations

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/keys

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.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}

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.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}

Returns information about a specific domain.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}

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 .

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles

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.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/integrations/delete

Removes an integration from a specific domain.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/delete

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/keys/delete

Removes a searchable key from a customer profile.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/objects/delete

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/object-types/{ObjectTypeName}

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.

• DomainName (path, required) — The unique name of the domain.
• ObjectTypeName (path, required) — The name of the profile object type.

/domains/{DomainName}/object-types/{ObjectTypeName}

Returns the object types for a specific domain.

• DomainName (path, required) — The unique name of the domain.
• ObjectTypeName (path, required) — The name of the profile object type.

/domains/{DomainName}/object-types/{ObjectTypeName}

Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource / UntagResource .

• DomainName (path, required) — The unique name of the domain.
• ObjectTypeName (path, required) — The name of the profile object type.

/domains/{DomainName}/workflows/{WorkflowId}

Deletes the specified workflow and all its corresponding resources. This is an async process.

• DomainName (path, required) — The unique name of the domain.
• WorkflowId (path, required) — Unique identifier for the workflow.

/domains/{DomainName}/workflows/{WorkflowId}

Get details of specified workflow.

• DomainName (path, required) — The unique name of the domain.
• WorkflowId (path, required) — Unique identifier for the workflow.

/domains/{DomainName}/identity-resolution-jobs/auto-merging-preview

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 only FirstName or only LastName ), there may be a large number of matches. This increases the chances of erroneous merges.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/identity-resolution-jobs/{JobId}

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

• DomainName (path, required) — The unique name of the domain.
• JobId (path, required) — The unique identifier of the Identity Resolution Job.

/domains/{DomainName}/integrations

Returns an integration for a domain.

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/integrations

Lists all of the integrations in your domain.

• DomainName (path, required) — The unique name of the domain.
• next-token (query) — The pagination token from the previous ListIntegrations API call.
• max-results (query, limit) — The maximum number of objects returned per page.
• include-hidden (query) — Boolean to indicate if hidden integration should be returned. Defaults to False .

/domains/{DomainName}/integrations

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 .

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/matches

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

• next-token (query) — 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.
• max-results (query, limit) — The maximum number of results to return per page.
• DomainName (path, required) — The unique name of the domain.

/templates/{TemplateId}

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.

• TemplateId (path, required) — A unique identifier for the object template.

/domains/{DomainName}/workflows/{WorkflowId}/steps

Get granular list of steps in workflow.

• DomainName (path, required) — The unique name of the domain.
• WorkflowId (path, required) — Unique identifier for the workflow.
• next-token (query) — 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.
• max-results (query, limit) — The maximum number of results to return per page.

/integrations

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

• next-token (query) — The pagination token from the previous ListAccountIntegrations API call.
• max-results (query, limit) — The maximum number of objects returned per page.
• include-hidden (query) — Boolean to indicate if hidden integration should be returned. Defaults to False .

/domains

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

• next-token (query) — The pagination token from the previous ListDomain API call.
• max-results (query, limit) — The maximum number of objects returned per page.

/domains/{DomainName}/identity-resolution-jobs

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime .

• DomainName (path, required) — The unique name of the domain.
• next-token (query) — 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.
• max-results (query, limit) — The maximum number of results to return per page.

/templates

Lists all of the template information for object types.

• next-token (query) — The pagination token from the previous ListObjectTypeTemplates API call.
• max-results (query, limit) — The maximum number of objects returned per page.

/domains/{DomainName}/object-types

Lists all of the templates available within the service.

• DomainName (path, required) — The unique name of the domain.
• next-token (query) — Identifies the next page of results to return.
• max-results (query, limit) — The maximum number of objects returned per page.

/domains/{DomainName}/profiles/objects

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

• next-token (query) — The pagination token from the previous call to ListProfileObjects.
• max-results (query, limit) — The maximum number of objects returned per page.
• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/objects

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.

• DomainName (path, required) — The unique name of the domain.

/tags/{resourceArn}

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

• resourceArn (path, required) — The ARN of the resource for which you want to view tags.

/tags/{resourceArn}

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.

• resourceArn (path, required) — The ARN of the resource that you're adding tags to.

/domains/{DomainName}/workflows

Query to list all workflows.

• DomainName (path, required) — The unique name of the domain.
• next-token (query) — 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.
• max-results (query, limit) — The maximum number of results to return per page.

/domains/{DomainName}/profiles/objects/merge

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

• DomainName (path, required) — The unique name of the domain.

/domains/{DomainName}/profiles/search

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.

• next-token (query) — The pagination token from the previous SearchProfiles API call.
• max-results (query, limit) — The maximum number of objects returned per page. The default is 20 if this parameter is not included in the request.
• DomainName (path, required) — The unique name of the domain.

/tags/{resourceArn}#tagKeys

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.

• resourceArn (path, required) — The ARN of the resource from which you are removing tags.
• tagKeys (query, required) — The list of tag keys to remove from the resource.