Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomerProfiles

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. If you're new to Amazon Connect, you might find it helpful to review the Amazon Connect Administrator Guide.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of CustomerProfilesClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

addProfileKey

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

    Parameters

    Returns Promise<AddProfileKeyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: AddProfileKeyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<AddProfileKeyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

createDomain

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

    Parameters

    Returns Promise<CreateDomainCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: CreateDomainCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<CreateDomainCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

createIntegrationWorkflow

createProfile

deleteDomain

deleteIntegration

deleteProfile

deleteProfileKey

deleteProfileObject

deleteProfileObjectType

deleteWorkflow

destroy

  • destroy(): void
  • 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.

    Returns void

getAutoMergingPreview

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

    Parameters

    Returns Promise<GetAutoMergingPreviewCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: GetAutoMergingPreviewCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetAutoMergingPreviewCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

getDomain

getIdentityResolutionJob

getIntegration

getMatches

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

    Parameters

    Returns Promise<GetMatchesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: GetMatchesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMatchesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

getProfileObjectType

getProfileObjectTypeTemplate

getWorkflow

getWorkflowSteps

listAccountIntegrations

listDomains

listIdentityResolutionJobs

listIntegrations

listProfileObjectTypeTemplates

listProfileObjectTypes

listProfileObjects

listTagsForResource

listWorkflows

mergeProfiles

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

    Parameters

    Returns Promise<MergeProfilesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: MergeProfilesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<MergeProfilesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

putIntegration

putProfileObject

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

    Parameters

    Returns Promise<PutProfileObjectCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: PutProfileObjectCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutProfileObjectCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

putProfileObjectType

searchProfiles

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

    Parameters

    Returns Promise<SearchProfilesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: SearchProfilesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<SearchProfilesCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

send

tagResource

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

    Parameters

    Returns Promise<TagResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: TagResourceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<TagResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

untagResource

updateDomain

updateProfile

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

    Parameters

    Returns Promise<UpdateProfileCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: UpdateProfileCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<UpdateProfileCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void