(constructor)

[configuration]

Constructs a new instance of the <code>CustomerProfilesClient</code> class

config

The resolved configuration of CustomerProfilesClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-customer-profiles!CustomerProfilesClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

CustomerProfilesClient

<fullname>Amazon Connect Customer Profiles</fullname> <ul> <li> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Customer_Profiles.html">Customer Profiles actions</a> </li> <li> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Customer_Profiles.html">Customer Profiles data types</a> </li> </ul> 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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles.html">Use Customer Profiles</a> in the Amazon Connect Administrator's Guide.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AddProfileKeyCommand

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.

BatchGetCalculatedAttributeForProfileCommand

Fetch the possible attribute values given the attribute name.

BatchGetProfileCommand

CreateCalculatedAttributeDefinitionCommand

Creates 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 <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html">GetCalculatedAttributeForProfile</a> API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one <code>ObjectType</code> and at most, two fields from that <code>ObjectType</code>.

CreateDomainCommand

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 <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity resolution</a>: set <code>Matching</code> to true. To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should apply. <note> 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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-customer-profiles.html#enable-customer-profiles-step1">Enable Customer Profiles</a>. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. </note>

CreateEventStreamCommand

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 domain

CreateEventTriggerCommand

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

CreateIntegrationWorkflowCommand

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.

CreateProfileCommand

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

CreateSegmentDefinitionCommand

Creates a segment definition associated to the given domain.

CreateSegmentEstimateCommand

CreateSegmentSnapshotCommand

Triggers a job to export a segment to a specified destination.

DeleteCalculatedAttributeDefinitionCommand

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

DeleteDomainCommand

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

DeleteEventStreamCommand

Disables and deletes the specified event stream.

DeleteEventTriggerCommand

Disable and deletes the Event Trigger. <note> You cannot delete an Event Trigger with an active Integration associated. </note>

DeleteIntegrationCommand

Removes an integration from a specific domain.

DeleteProfileCommand

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

DeleteProfileKeyCommand

Removes a searchable key from a customer profile.

DeleteProfileObjectCommand

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

DeleteProfileObjectTypeCommand

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.

DeleteSegmentDefinitionCommand

Deletes a segment definition from the domain.

DeleteWorkflowCommand

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

DetectProfileObjectTypeCommand

The process of detecting profile object type mapping by using given objects.

GetAutoMergingPreviewCommand

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

GetCalculatedAttributeDefinitionCommand

Provides more information on a calculated attribute definition for Customer Profiles.

GetCalculatedAttributeForProfileCommand

Retrieve a calculated attribute for a customer profile.

GetDomainCommand

Returns information about a specific domain.

GetEventStreamCommand

Returns information about the specified event stream in a specific domain.

GetEventTriggerCommand

Get a specific Event Trigger from the domain.

GetIdentityResolutionJobCommand

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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html">Use Identity Resolution to consolidate similar profiles</a>.

GetIntegrationCommand

Returns an integration for a domain.

GetMatchesCommand

Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to enable identity resolution: set <code>Matching</code> to true. GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. <important> The process of matching duplicate profiles. If <code>Matching</code> = <code>true</code>, 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 <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <code>ExportingConfig</code> in the <code>MatchingRequest</code>, you can download the results from S3. </important> Amazon Connect uses the following profile attributes to identify matches: <ul> <li> PhoneNumber </li> <li> HomePhoneNumber </li> <li> BusinessPhoneNumber </li> <li> MobilePhoneNumber </li> <li> EmailAddress </li> <li> PersonalEmailAddress </li> <li> BusinessEmailAddress </li> <li> FullName </li> </ul> For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOEANYCOMPANY.COM and johndoeanycompany.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.

GetProfileObjectTypeCommand

Returns the object types for a specific domain.

GetProfileObjectTypeTemplateCommand

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.

GetSegmentDefinitionCommand

Gets a segment definition from the domain.

GetSegmentEstimateCommand

Gets the result of a segment estimate query.

GetSegmentMembershipCommand

Determines if the given profiles are within a segment.

GetSegmentSnapshotCommand

Retrieve the latest status of a segment snapshot.

GetSimilarProfilesCommand

Returns a set of profiles that belong to the same matching group using the <code>matchId</code> or <code>profileId</code>. You can also specify the type of matching that you want for finding similar profiles using either <code>RULE_BASED_MATCHING</code> or <code>ML_BASED_MATCHING</code>.

GetWorkflowCommand

Get details of specified workflow.

GetWorkflowStepsCommand

Get granular list of steps in workflow.

ListAccountIntegrationsCommand

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

ListCalculatedAttributeDefinitionsCommand

Lists calculated attribute definitions for Customer Profiles

ListCalculatedAttributesForProfileCommand

Retrieve a list of calculated attributes for a customer profile.

ListDomainsCommand

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

ListEventStreamsCommand

Returns a list of all the event streams in a specific domain.

ListEventTriggersCommand

List all Event Triggers under a domain.

ListIdentityResolutionJobsCommand

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

ListIntegrationsCommand

Lists all of the integrations in your domain.

ListObjectTypeAttributesCommand

ListProfileAttributeValuesCommand

ListProfileObjectTypeTemplatesCommand

Lists all of the template information for object types.

ListProfileObjectTypesCommand

Lists all of the templates available within the service.

ListProfileObjectsCommand

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

ListRuleBasedMatchesCommand

Returns a set of <code>MatchIds</code> that belong to the given domain.

ListSegmentDefinitionsCommand

Lists all segment definitions under a domain.

ListTagsForResourceCommand

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

ListWorkflowsCommand

MergeProfilesCommand

Runs an AWS Lambda job that does the following: <ol> <li> All the profileKeys in the <code>ProfileToBeMerged</code> will be moved to the main profile. </li> <li> All the objects in the <code>ProfileToBeMerged</code> will be moved to the main profile. </li> <li> All the <code>ProfileToBeMerged</code> will be deleted at the end. </li> <li> All the profileKeys in the <code>ProfileIdsToBeMerged</code> will be moved to the main profile. </li> <li> Standard fields are merged as follows: <ol> <li> Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. </li> <li> When there are conflicting fields: <ol> <li> If no <code>SourceProfileIds</code> entry is specified, the main Profile value is always taken. </li> <li> If a <code>SourceProfileIds</code> entry is specified, the specified profileId is always taken, even if it is a NULL value. </li> </ol> </li> </ol> </li> </ol> You can use MergeProfiles together with <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>, 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).

PutIntegrationCommand

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 <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html"> UntagResource</a>.

PutProfileObjectCommand

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.

PutProfileObjectTypeCommand

Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.

SearchProfilesCommand

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 <code>KeyName</code> and <code>Values</code> 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 <code>AND</code> or <code>OR</code> logic.

TagResourceCommand

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.

UntagResourceCommand

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.

UpdateCalculatedAttributeDefinitionCommand

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

UpdateDomainCommand

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 <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity resolution</a>: set <code>Matching</code> to true. To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should apply. To add or remove tags on an existing Domain, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>.

UpdateEventTriggerCommand

Update the properties of an Event Trigger.

UpdateProfileCommand

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.