@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCustomerProfilesAsync extends AmazonCustomerProfiles
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCustomerProfilesAsync instead.
Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.
Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
If you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<AddProfileKeyResult> |
addProfileKeyAsync(AddProfileKeyRequest addProfileKeyRequest)
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
|
Future<AddProfileKeyResult> |
addProfileKeyAsync(AddProfileKeyRequest addProfileKeyRequest,
AsyncHandler<AddProfileKeyRequest,AddProfileKeyResult> asyncHandler)
Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
|
Future<CreateDomainResult> |
createDomainAsync(CreateDomainRequest createDomainRequest)
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types,
profile keys, and encryption keys.
|
Future<CreateDomainResult> |
createDomainAsync(CreateDomainRequest createDomainRequest,
AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types,
profile keys, and encryption keys.
|
Future<CreateProfileResult> |
createProfileAsync(CreateProfileRequest createProfileRequest)
Creates a standard profile.
|
Future<CreateProfileResult> |
createProfileAsync(CreateProfileRequest createProfileRequest,
AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
Creates a standard profile.
|
Future<DeleteDomainResult> |
deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related
objects.
|
Future<DeleteDomainResult> |
deleteDomainAsync(DeleteDomainRequest deleteDomainRequest,
AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related
objects.
|
Future<DeleteIntegrationResult> |
deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest)
Removes an integration from a specific domain.
|
Future<DeleteIntegrationResult> |
deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest,
AsyncHandler<DeleteIntegrationRequest,DeleteIntegrationResult> asyncHandler)
Removes an integration from a specific domain.
|
Future<DeleteProfileResult> |
deleteProfileAsync(DeleteProfileRequest deleteProfileRequest)
Deletes the standard customer profile and all data pertaining to the profile.
|
Future<DeleteProfileResult> |
deleteProfileAsync(DeleteProfileRequest deleteProfileRequest,
AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
Deletes the standard customer profile and all data pertaining to the profile.
|
Future<DeleteProfileKeyResult> |
deleteProfileKeyAsync(DeleteProfileKeyRequest deleteProfileKeyRequest)
Removes a searchable key from a customer profile.
|
Future<DeleteProfileKeyResult> |
deleteProfileKeyAsync(DeleteProfileKeyRequest deleteProfileKeyRequest,
AsyncHandler<DeleteProfileKeyRequest,DeleteProfileKeyResult> asyncHandler)
Removes a searchable key from a customer profile.
|
Future<DeleteProfileObjectResult> |
deleteProfileObjectAsync(DeleteProfileObjectRequest deleteProfileObjectRequest)
Removes an object associated with a profile of a given ProfileObjectType.
|
Future<DeleteProfileObjectResult> |
deleteProfileObjectAsync(DeleteProfileObjectRequest deleteProfileObjectRequest,
AsyncHandler<DeleteProfileObjectRequest,DeleteProfileObjectResult> asyncHandler)
Removes an object associated with a profile of a given ProfileObjectType.
|
Future<DeleteProfileObjectTypeResult> |
deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
|
Future<DeleteProfileObjectTypeResult> |
deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest,
AsyncHandler<DeleteProfileObjectTypeRequest,DeleteProfileObjectTypeResult> asyncHandler)
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
|
Future<GetDomainResult> |
getDomainAsync(GetDomainRequest getDomainRequest)
Returns information about a specific domain.
|
Future<GetDomainResult> |
getDomainAsync(GetDomainRequest getDomainRequest,
AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
Returns information about a specific domain.
|
Future<GetIntegrationResult> |
getIntegrationAsync(GetIntegrationRequest getIntegrationRequest)
Returns an integration for a domain.
|
Future<GetIntegrationResult> |
getIntegrationAsync(GetIntegrationRequest getIntegrationRequest,
AsyncHandler<GetIntegrationRequest,GetIntegrationResult> asyncHandler)
Returns an integration for a domain.
|
Future<GetMatchesResult> |
getMatchesAsync(GetMatchesRequest getMatchesRequest)
This API is in preview release for Amazon Connect and subject to change.
|
Future<GetMatchesResult> |
getMatchesAsync(GetMatchesRequest getMatchesRequest,
AsyncHandler<GetMatchesRequest,GetMatchesResult> asyncHandler)
This API is in preview release for Amazon Connect and subject to change.
|
Future<GetProfileObjectTypeResult> |
getProfileObjectTypeAsync(GetProfileObjectTypeRequest getProfileObjectTypeRequest)
Returns the object types for a specific domain.
|
Future<GetProfileObjectTypeResult> |
getProfileObjectTypeAsync(GetProfileObjectTypeRequest getProfileObjectTypeRequest,
AsyncHandler<GetProfileObjectTypeRequest,GetProfileObjectTypeResult> asyncHandler)
Returns the object types for a specific domain.
|
Future<GetProfileObjectTypeTemplateResult> |
getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
Returns the template information for a specific object type.
|
Future<GetProfileObjectTypeTemplateResult> |
getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest,
AsyncHandler<GetProfileObjectTypeTemplateRequest,GetProfileObjectTypeTemplateResult> asyncHandler)
Returns the template information for a specific object type.
|
Future<ListAccountIntegrationsResult> |
listAccountIntegrationsAsync(ListAccountIntegrationsRequest listAccountIntegrationsRequest)
Lists all of the integrations associated to a specific URI in the AWS account.
|
Future<ListAccountIntegrationsResult> |
listAccountIntegrationsAsync(ListAccountIntegrationsRequest listAccountIntegrationsRequest,
AsyncHandler<ListAccountIntegrationsRequest,ListAccountIntegrationsResult> asyncHandler)
Lists all of the integrations associated to a specific URI in the AWS account.
|
Future<ListDomainsResult> |
listDomainsAsync(ListDomainsRequest listDomainsRequest)
Returns a list of all the domains for an AWS account that have been created.
|
Future<ListDomainsResult> |
listDomainsAsync(ListDomainsRequest listDomainsRequest,
AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
Returns a list of all the domains for an AWS account that have been created.
|
Future<ListIntegrationsResult> |
listIntegrationsAsync(ListIntegrationsRequest listIntegrationsRequest)
Lists all of the integrations in your domain.
|
Future<ListIntegrationsResult> |
listIntegrationsAsync(ListIntegrationsRequest listIntegrationsRequest,
AsyncHandler<ListIntegrationsRequest,ListIntegrationsResult> asyncHandler)
Lists all of the integrations in your domain.
|
Future<ListProfileObjectsResult> |
listProfileObjectsAsync(ListProfileObjectsRequest listProfileObjectsRequest)
Returns a list of objects associated with a profile of a given ProfileObjectType.
|
Future<ListProfileObjectsResult> |
listProfileObjectsAsync(ListProfileObjectsRequest listProfileObjectsRequest,
AsyncHandler<ListProfileObjectsRequest,ListProfileObjectsResult> asyncHandler)
Returns a list of objects associated with a profile of a given ProfileObjectType.
|
Future<ListProfileObjectTypesResult> |
listProfileObjectTypesAsync(ListProfileObjectTypesRequest listProfileObjectTypesRequest)
Lists all of the templates available within the service.
|
Future<ListProfileObjectTypesResult> |
listProfileObjectTypesAsync(ListProfileObjectTypesRequest listProfileObjectTypesRequest,
AsyncHandler<ListProfileObjectTypesRequest,ListProfileObjectTypesResult> asyncHandler)
Lists all of the templates available within the service.
|
Future<ListProfileObjectTypeTemplatesResult> |
listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
|
Future<ListProfileObjectTypeTemplatesResult> |
listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest,
AsyncHandler<ListProfileObjectTypeTemplatesRequest,ListProfileObjectTypeTemplatesResult> asyncHandler)
Lists all of the template information for object types.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an Amazon Connect Customer Profiles resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with an Amazon Connect Customer Profiles resource.
|
Future<MergeProfilesResult> |
mergeProfilesAsync(MergeProfilesRequest mergeProfilesRequest)
This API is in preview release for Amazon Connect and subject to change.
|
Future<MergeProfilesResult> |
mergeProfilesAsync(MergeProfilesRequest mergeProfilesRequest,
AsyncHandler<MergeProfilesRequest,MergeProfilesResult> asyncHandler)
This API is in preview release for Amazon Connect and subject to change.
|
Future<PutIntegrationResult> |
putIntegrationAsync(PutIntegrationRequest putIntegrationRequest)
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon
Connect.
|
Future<PutIntegrationResult> |
putIntegrationAsync(PutIntegrationRequest putIntegrationRequest,
AsyncHandler<PutIntegrationRequest,PutIntegrationResult> asyncHandler)
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon
Connect.
|
Future<PutProfileObjectResult> |
putProfileObjectAsync(PutProfileObjectRequest putProfileObjectRequest)
Adds additional objects to customer profiles of a given ObjectType.
|
Future<PutProfileObjectResult> |
putProfileObjectAsync(PutProfileObjectRequest putProfileObjectRequest,
AsyncHandler<PutProfileObjectRequest,PutProfileObjectResult> asyncHandler)
Adds additional objects to customer profiles of a given ObjectType.
|
Future<PutProfileObjectTypeResult> |
putProfileObjectTypeAsync(PutProfileObjectTypeRequest putProfileObjectTypeRequest)
Defines a ProfileObjectType.
|
Future<PutProfileObjectTypeResult> |
putProfileObjectTypeAsync(PutProfileObjectTypeRequest putProfileObjectTypeRequest,
AsyncHandler<PutProfileObjectTypeRequest,PutProfileObjectTypeResult> asyncHandler)
Defines a ProfileObjectType.
|
Future<SearchProfilesResult> |
searchProfilesAsync(SearchProfilesRequest searchProfilesRequest)
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a
custom defined index.
|
Future<SearchProfilesResult> |
searchProfilesAsync(SearchProfilesRequest searchProfilesRequest,
AsyncHandler<SearchProfilesRequest,SearchProfilesResult> asyncHandler)
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a
custom defined index.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
|
Future<UpdateDomainResult> |
updateDomainAsync(UpdateDomainRequest updateDomainRequest)
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
|
Future<UpdateDomainResult> |
updateDomainAsync(UpdateDomainRequest updateDomainRequest,
AsyncHandler<UpdateDomainRequest,UpdateDomainResult> asyncHandler)
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
|
Future<UpdateProfileResult> |
updateProfileAsync(UpdateProfileRequest updateProfileRequest)
Updates the properties of a profile.
|
Future<UpdateProfileResult> |
updateProfileAsync(UpdateProfileRequest updateProfileRequest,
AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
Updates the properties of a profile.
|
addProfileKey, createDomain, createProfile, deleteDomain, deleteIntegration, deleteProfile, deleteProfileKey, deleteProfileObject, deleteProfileObjectType, getCachedResponseMetadata, getDomain, getIntegration, getMatches, getProfileObjectType, getProfileObjectTypeTemplate, listAccountIntegrations, listDomains, listIntegrations, listProfileObjects, listProfileObjectTypes, listProfileObjectTypeTemplates, listTagsForResource, mergeProfiles, putIntegration, putProfileObject, putProfileObjectType, searchProfiles, shutdown, tagResource, untagResource, updateDomain, updateProfileFuture<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest addProfileKeyRequest)
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.
addProfileKeyRequest - Future<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest addProfileKeyRequest, AsyncHandler<AddProfileKeyRequest,AddProfileKeyResult> asyncHandler)
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.
addProfileKeyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
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.
createDomainRequest - Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
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.
createDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateProfileResult> createProfileAsync(CreateProfileRequest createProfileRequest)
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileRequest - Future<CreateProfileResult> createProfileAsync(CreateProfileRequest createProfileRequest, AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainRequest - Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest)
Removes an integration from a specific domain.
deleteIntegrationRequest - Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest, AsyncHandler<DeleteIntegrationRequest,DeleteIntegrationResult> asyncHandler)
Removes an integration from a specific domain.
deleteIntegrationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest deleteProfileRequest)
Deletes the standard customer profile and all data pertaining to the profile.
deleteProfileRequest - Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest deleteProfileRequest, AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
Deletes the standard customer profile and all data pertaining to the profile.
deleteProfileRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest deleteProfileKeyRequest)
Removes a searchable key from a customer profile.
deleteProfileKeyRequest - Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest deleteProfileKeyRequest, AsyncHandler<DeleteProfileKeyRequest,DeleteProfileKeyResult> asyncHandler)
Removes a searchable key from a customer profile.
deleteProfileKeyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest deleteProfileObjectRequest)
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectRequest - Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest deleteProfileObjectRequest, AsyncHandler<DeleteProfileObjectRequest,DeleteProfileObjectResult> asyncHandler)
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)
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.
deleteProfileObjectTypeRequest - Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest, AsyncHandler<DeleteProfileObjectTypeRequest,DeleteProfileObjectTypeResult> asyncHandler)
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.
deleteProfileObjectTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDomainResult> getDomainAsync(GetDomainRequest getDomainRequest)
Returns information about a specific domain.
getDomainRequest - Future<GetDomainResult> getDomainAsync(GetDomainRequest getDomainRequest, AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
Returns information about a specific domain.
getDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest getIntegrationRequest)
Returns an integration for a domain.
getIntegrationRequest - Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest getIntegrationRequest, AsyncHandler<GetIntegrationRequest,GetIntegrationResult> asyncHandler)
Returns an integration for a domain.
getIntegrationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMatchesResult> getMatchesAsync(GetMatchesRequest getMatchesRequest)
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 starts 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
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as [email protected] and [email protected], 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.
getMatchesRequest - Future<GetMatchesResult> getMatchesAsync(GetMatchesRequest getMatchesRequest, AsyncHandler<GetMatchesRequest,GetMatchesResult> asyncHandler)
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 starts 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
For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as [email protected] and [email protected], 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.
getMatchesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest getProfileObjectTypeRequest)
Returns the object types for a specific domain.
getProfileObjectTypeRequest - Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest getProfileObjectTypeRequest, AsyncHandler<GetProfileObjectTypeRequest,GetProfileObjectTypeResult> asyncHandler)
Returns the object types for a specific domain.
getProfileObjectTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
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.
getProfileObjectTypeTemplateRequest - Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest, AsyncHandler<GetProfileObjectTypeTemplateRequest,GetProfileObjectTypeTemplateResult> asyncHandler)
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.
getProfileObjectTypeTemplateRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest listAccountIntegrationsRequest)
Lists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsRequest - Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest listAccountIntegrationsRequest, AsyncHandler<ListAccountIntegrationsRequest,ListAccountIntegrationsResult> asyncHandler)
Lists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest)
Returns a list of all the domains for an AWS account that have been created.
listDomainsRequest - Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
Returns a list of all the domains for an AWS account that have been created.
listDomainsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest listIntegrationsRequest)
Lists all of the integrations in your domain.
listIntegrationsRequest - Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest listIntegrationsRequest, AsyncHandler<ListIntegrationsRequest,ListIntegrationsResult> asyncHandler)
Lists all of the integrations in your domain.
listIntegrationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
listProfileObjectTypeTemplatesRequest - Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest, AsyncHandler<ListProfileObjectTypeTemplatesRequest,ListProfileObjectTypeTemplatesResult> asyncHandler)
Lists all of the template information for object types.
listProfileObjectTypeTemplatesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest listProfileObjectTypesRequest)
Lists all of the templates available within the service.
listProfileObjectTypesRequest - Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest listProfileObjectTypesRequest, AsyncHandler<ListProfileObjectTypesRequest,ListProfileObjectTypesResult> asyncHandler)
Lists all of the templates available within the service.
listProfileObjectTypesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest listProfileObjectsRequest)
Returns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsRequest - Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest listProfileObjectsRequest, AsyncHandler<ListProfileObjectsRequest,ListProfileObjectsResult> asyncHandler)
Returns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest mergeProfilesRequest)
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).
mergeProfilesRequest - Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest mergeProfilesRequest, AsyncHandler<MergeProfilesRequest,MergeProfilesResult> asyncHandler)
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).
mergeProfilesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest putIntegrationRequest)
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.
putIntegrationRequest - Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest putIntegrationRequest, AsyncHandler<PutIntegrationRequest,PutIntegrationResult> asyncHandler)
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.
putIntegrationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest putProfileObjectRequest)
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.
putProfileObjectRequest - Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest putProfileObjectRequest, AsyncHandler<PutProfileObjectRequest,PutProfileObjectResult> asyncHandler)
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.
putProfileObjectRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest putProfileObjectTypeRequest)
Defines a ProfileObjectType.
putProfileObjectTypeRequest - Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest putProfileObjectTypeRequest, AsyncHandler<PutProfileObjectTypeRequest,PutProfileObjectTypeResult> asyncHandler)
Defines a ProfileObjectType.
putProfileObjectTypeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SearchProfilesResult> searchProfilesAsync(SearchProfilesRequest searchProfilesRequest)
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
searchProfilesRequest - Future<SearchProfilesResult> searchProfilesAsync(SearchProfilesRequest searchProfilesRequest, AsyncHandler<SearchProfilesRequest,SearchProfilesResult> asyncHandler)
Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.
searchProfilesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
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.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
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.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest updateDomainRequest)
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.
updateDomainRequest - Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest updateDomainRequest, AsyncHandler<UpdateDomainRequest,UpdateDomainResult> asyncHandler)
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.
updateDomainRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest updateProfileRequest)
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.
updateProfileRequest - Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest updateProfileRequest, AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
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.
updateProfileRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.