@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCustomerProfilesAsyncClient extends AmazonCustomerProfilesClient implements AmazonCustomerProfilesAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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 Use Customer Profiles in the Amazon Connect Administrator's Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddProfileKey, builder, createCalculatedAttributeDefinition, createDomain, createEventStream, createIntegrationWorkflow, createProfile, deleteCalculatedAttributeDefinition, deleteDomain, deleteEventStream, deleteIntegration, deleteProfile, deleteProfileKey, deleteProfileObject, deleteProfileObjectType, deleteWorkflow, detectProfileObjectType, getAutoMergingPreview, getCachedResponseMetadata, getCalculatedAttributeDefinition, getCalculatedAttributeForProfile, getDomain, getEventStream, getIdentityResolutionJob, getIntegration, getMatches, getProfileObjectType, getProfileObjectTypeTemplate, getSimilarProfiles, getWorkflow, getWorkflowSteps, listAccountIntegrations, listCalculatedAttributeDefinitions, listCalculatedAttributesForProfile, listDomains, listEventStreams, listIdentityResolutionJobs, listIntegrations, listProfileObjects, listProfileObjectTypes, listProfileObjectTypeTemplates, listRuleBasedMatches, listTagsForResource, listWorkflows, mergeProfiles, putIntegration, putProfileObject, putProfileObjectType, searchProfiles, tagResource, untagResource, updateCalculatedAttributeDefinition, updateDomain, updateProfileaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddProfileKey, createCalculatedAttributeDefinition, createDomain, createEventStream, createIntegrationWorkflow, createProfile, deleteCalculatedAttributeDefinition, deleteDomain, deleteEventStream, deleteIntegration, deleteProfile, deleteProfileKey, deleteProfileObject, deleteProfileObjectType, deleteWorkflow, detectProfileObjectType, getAutoMergingPreview, getCachedResponseMetadata, getCalculatedAttributeDefinition, getCalculatedAttributeForProfile, getDomain, getEventStream, getIdentityResolutionJob, getIntegration, getMatches, getProfileObjectType, getProfileObjectTypeTemplate, getSimilarProfiles, getWorkflow, getWorkflowSteps, listAccountIntegrations, listCalculatedAttributeDefinitions, listCalculatedAttributesForProfile, listDomains, listEventStreams, listIdentityResolutionJobs, listIntegrations, listProfileObjects, listProfileObjectTypes, listProfileObjectTypeTemplates, listRuleBasedMatches, listTagsForResource, listWorkflows, mergeProfiles, putIntegration, putProfileObject, putProfileObjectType, searchProfiles, tagResource, untagResource, updateCalculatedAttributeDefinition, updateDomain, updateProfilepublic static AmazonCustomerProfilesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest request)
AmazonCustomerProfilesAsyncAssociates 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.
addProfileKeyAsync in interface AmazonCustomerProfilesAsyncpublic Future<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest request, AsyncHandler<AddProfileKeyRequest,AddProfileKeyResult> asyncHandler)
AmazonCustomerProfilesAsyncAssociates 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.
addProfileKeyAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<CreateCalculatedAttributeDefinitionResult> createCalculatedAttributeDefinitionAsync(CreateCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsync
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 GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles
within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields
from that ObjectType.
createCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncpublic Future<CreateCalculatedAttributeDefinitionResult> createCalculatedAttributeDefinitionAsync(CreateCalculatedAttributeDefinitionRequest request, AsyncHandler<CreateCalculatedAttributeDefinitionRequest,CreateCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsync
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 GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles
within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields
from that ObjectType.
createCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request)
AmazonCustomerProfilesAsyncCreates 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.
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 Enable Customer Profiles.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
createDomainAsync in interface AmazonCustomerProfilesAsyncpublic Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
AmazonCustomerProfilesAsyncCreates 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.
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 Enable Customer Profiles.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
createDomainAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<CreateEventStreamResult> createEventStreamAsync(CreateEventStreamRequest request)
AmazonCustomerProfilesAsyncCreates 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
createEventStreamAsync in interface AmazonCustomerProfilesAsyncpublic Future<CreateEventStreamResult> createEventStreamAsync(CreateEventStreamRequest request, AsyncHandler<CreateEventStreamRequest,CreateEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsyncCreates 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
createEventStreamAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<CreateIntegrationWorkflowResult> createIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request)
AmazonCustomerProfilesAsyncCreates 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.
createIntegrationWorkflowAsync in interface AmazonCustomerProfilesAsyncpublic Future<CreateIntegrationWorkflowResult> createIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request, AsyncHandler<CreateIntegrationWorkflowRequest,CreateIntegrationWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsyncCreates 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.
createIntegrationWorkflowAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request)
AmazonCustomerProfilesAsyncCreates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileAsync in interface AmazonCustomerProfilesAsyncpublic Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
AmazonCustomerProfilesAsyncCreates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteCalculatedAttributeDefinitionResult> deleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsyncDeletes 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.
deleteCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteCalculatedAttributeDefinitionResult> deleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request, AsyncHandler<DeleteCalculatedAttributeDefinitionRequest,DeleteCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsyncDeletes 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.
deleteCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request)
AmazonCustomerProfilesAsyncDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
AmazonCustomerProfilesAsyncDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteEventStreamResult> deleteEventStreamAsync(DeleteEventStreamRequest request)
AmazonCustomerProfilesAsyncDisables and deletes the specified event stream.
deleteEventStreamAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteEventStreamResult> deleteEventStreamAsync(DeleteEventStreamRequest request, AsyncHandler<DeleteEventStreamRequest,DeleteEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsyncDisables and deletes the specified event stream.
deleteEventStreamAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest request)
AmazonCustomerProfilesAsyncRemoves an integration from a specific domain.
deleteIntegrationAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest request, AsyncHandler<DeleteIntegrationRequest,DeleteIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsyncRemoves an integration from a specific domain.
deleteIntegrationAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request)
AmazonCustomerProfilesAsyncDeletes the standard customer profile and all data pertaining to the profile.
deleteProfileAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
AmazonCustomerProfilesAsyncDeletes the standard customer profile and all data pertaining to the profile.
deleteProfileAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest request)
AmazonCustomerProfilesAsyncRemoves a searchable key from a customer profile.
deleteProfileKeyAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest request, AsyncHandler<DeleteProfileKeyRequest,DeleteProfileKeyResult> asyncHandler)
AmazonCustomerProfilesAsyncRemoves a searchable key from a customer profile.
deleteProfileKeyAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest request)
AmazonCustomerProfilesAsyncRemoves an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest request, AsyncHandler<DeleteProfileObjectRequest,DeleteProfileObjectResult> asyncHandler)
AmazonCustomerProfilesAsyncRemoves an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request)
AmazonCustomerProfilesAsyncRemoves 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.
deleteProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request, AsyncHandler<DeleteProfileObjectTypeRequest,DeleteProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsyncRemoves 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.
deleteProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request)
AmazonCustomerProfilesAsyncDeletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflowAsync in interface AmazonCustomerProfilesAsyncpublic Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsyncDeletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflowAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<DetectProfileObjectTypeResult> detectProfileObjectTypeAsync(DetectProfileObjectTypeRequest request)
AmazonCustomerProfilesAsyncThe process of detecting profile object type mapping by using given objects.
detectProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncpublic Future<DetectProfileObjectTypeResult> detectProfileObjectTypeAsync(DetectProfileObjectTypeRequest request, AsyncHandler<DetectProfileObjectTypeRequest,DetectProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsyncThe process of detecting profile object type mapping by using given objects.
detectProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetAutoMergingPreviewResult> getAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request)
AmazonCustomerProfilesAsyncTests 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.
getAutoMergingPreviewAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetAutoMergingPreviewResult> getAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request, AsyncHandler<GetAutoMergingPreviewRequest,GetAutoMergingPreviewResult> asyncHandler)
AmazonCustomerProfilesAsyncTests 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.
getAutoMergingPreviewAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetCalculatedAttributeDefinitionResult> getCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsyncProvides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetCalculatedAttributeDefinitionResult> getCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request, AsyncHandler<GetCalculatedAttributeDefinitionRequest,GetCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsyncProvides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetCalculatedAttributeForProfileResult> getCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request)
AmazonCustomerProfilesAsyncRetrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfileAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetCalculatedAttributeForProfileResult> getCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request, AsyncHandler<GetCalculatedAttributeForProfileRequest,GetCalculatedAttributeForProfileResult> asyncHandler)
AmazonCustomerProfilesAsyncRetrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfileAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetDomainResult> getDomainAsync(GetDomainRequest request)
AmazonCustomerProfilesAsyncReturns information about a specific domain.
getDomainAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetDomainResult> getDomainAsync(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns information about a specific domain.
getDomainAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetEventStreamResult> getEventStreamAsync(GetEventStreamRequest request)
AmazonCustomerProfilesAsyncReturns information about the specified event stream in a specific domain.
getEventStreamAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetEventStreamResult> getEventStreamAsync(GetEventStreamRequest request, AsyncHandler<GetEventStreamRequest,GetEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns information about the specified event stream in a specific domain.
getEventStreamAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetIdentityResolutionJobResult> getIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request)
AmazonCustomerProfilesAsyncReturns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
getIdentityResolutionJobAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetIdentityResolutionJobResult> getIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request, AsyncHandler<GetIdentityResolutionJobRequest,GetIdentityResolutionJobResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
getIdentityResolutionJobAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest request)
AmazonCustomerProfilesAsyncReturns an integration for a domain.
getIntegrationAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest request, AsyncHandler<GetIntegrationRequest,GetIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns an integration for a domain.
getIntegrationAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetMatchesResult> getMatchesAsync(GetMatchesRequest request)
AmazonCustomerProfilesAsync
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.
getMatchesAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetMatchesResult> getMatchesAsync(GetMatchesRequest request, AsyncHandler<GetMatchesRequest,GetMatchesResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
getMatchesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest request)
AmazonCustomerProfilesAsyncReturns the object types for a specific domain.
getProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest request, AsyncHandler<GetProfileObjectTypeRequest,GetProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns the object types for a specific domain.
getProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request)
AmazonCustomerProfilesAsyncReturns 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.
getProfileObjectTypeTemplateAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request, AsyncHandler<GetProfileObjectTypeTemplateRequest,GetProfileObjectTypeTemplateResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns 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.
getProfileObjectTypeTemplateAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetSimilarProfilesResult> getSimilarProfilesAsync(GetSimilarProfilesRequest request)
AmazonCustomerProfilesAsync
Returns a set of profiles that belong to the same matching group using the matchId or
profileId. You can also specify the type of matching that you want for finding similar profiles
using either RULE_BASED_MATCHING or ML_BASED_MATCHING.
getSimilarProfilesAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetSimilarProfilesResult> getSimilarProfilesAsync(GetSimilarProfilesRequest request, AsyncHandler<GetSimilarProfilesRequest,GetSimilarProfilesResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a set of profiles that belong to the same matching group using the matchId or
profileId. You can also specify the type of matching that you want for finding similar profiles
using either RULE_BASED_MATCHING or ML_BASED_MATCHING.
getSimilarProfilesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetWorkflowResult> getWorkflowAsync(GetWorkflowRequest request)
AmazonCustomerProfilesAsyncGet details of specified workflow.
getWorkflowAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetWorkflowResult> getWorkflowAsync(GetWorkflowRequest request, AsyncHandler<GetWorkflowRequest,GetWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsyncGet details of specified workflow.
getWorkflowAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<GetWorkflowStepsResult> getWorkflowStepsAsync(GetWorkflowStepsRequest request)
AmazonCustomerProfilesAsyncGet granular list of steps in workflow.
getWorkflowStepsAsync in interface AmazonCustomerProfilesAsyncpublic Future<GetWorkflowStepsResult> getWorkflowStepsAsync(GetWorkflowStepsRequest request, AsyncHandler<GetWorkflowStepsRequest,GetWorkflowStepsResult> asyncHandler)
AmazonCustomerProfilesAsyncGet granular list of steps in workflow.
getWorkflowStepsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest request)
AmazonCustomerProfilesAsyncLists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest request, AsyncHandler<ListAccountIntegrationsRequest,ListAccountIntegrationsResult> asyncHandler)
AmazonCustomerProfilesAsyncLists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListCalculatedAttributeDefinitionsResult> listCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request)
AmazonCustomerProfilesAsyncLists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitionsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListCalculatedAttributeDefinitionsResult> listCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request, AsyncHandler<ListCalculatedAttributeDefinitionsRequest,ListCalculatedAttributeDefinitionsResult> asyncHandler)
AmazonCustomerProfilesAsyncLists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitionsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListCalculatedAttributesForProfileResult> listCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request)
AmazonCustomerProfilesAsyncRetrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfileAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListCalculatedAttributesForProfileResult> listCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request, AsyncHandler<ListCalculatedAttributesForProfileRequest,ListCalculatedAttributesForProfileResult> asyncHandler)
AmazonCustomerProfilesAsyncRetrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfileAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request)
AmazonCustomerProfilesAsyncReturns a list of all the domains for an AWS account that have been created.
listDomainsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns a list of all the domains for an AWS account that have been created.
listDomainsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListEventStreamsResult> listEventStreamsAsync(ListEventStreamsRequest request)
AmazonCustomerProfilesAsyncReturns a list of all the event streams in a specific domain.
listEventStreamsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListEventStreamsResult> listEventStreamsAsync(ListEventStreamsRequest request, AsyncHandler<ListEventStreamsRequest,ListEventStreamsResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns a list of all the event streams in a specific domain.
listEventStreamsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListIdentityResolutionJobsResult> listIdentityResolutionJobsAsync(ListIdentityResolutionJobsRequest request)
AmazonCustomerProfilesAsync
Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime.
listIdentityResolutionJobsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListIdentityResolutionJobsResult> listIdentityResolutionJobsAsync(ListIdentityResolutionJobsRequest request, AsyncHandler<ListIdentityResolutionJobsRequest,ListIdentityResolutionJobsResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime.
listIdentityResolutionJobsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest request)
AmazonCustomerProfilesAsyncLists all of the integrations in your domain.
listIntegrationsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest request, AsyncHandler<ListIntegrationsRequest,ListIntegrationsResult> asyncHandler)
AmazonCustomerProfilesAsyncLists all of the integrations in your domain.
listIntegrationsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request)
AmazonCustomerProfilesAsyncLists all of the template information for object types.
listProfileObjectTypeTemplatesAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request, AsyncHandler<ListProfileObjectTypeTemplatesRequest,ListProfileObjectTypeTemplatesResult> asyncHandler)
AmazonCustomerProfilesAsyncLists all of the template information for object types.
listProfileObjectTypeTemplatesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest request)
AmazonCustomerProfilesAsyncLists all of the templates available within the service.
listProfileObjectTypesAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest request, AsyncHandler<ListProfileObjectTypesRequest,ListProfileObjectTypesResult> asyncHandler)
AmazonCustomerProfilesAsyncLists all of the templates available within the service.
listProfileObjectTypesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest request)
AmazonCustomerProfilesAsyncReturns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest request, AsyncHandler<ListProfileObjectsRequest,ListProfileObjectsResult> asyncHandler)
AmazonCustomerProfilesAsyncReturns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListRuleBasedMatchesResult> listRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request)
AmazonCustomerProfilesAsync
Returns a set of MatchIds that belong to the given domain.
listRuleBasedMatchesAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListRuleBasedMatchesResult> listRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request, AsyncHandler<ListRuleBasedMatchesRequest,ListRuleBasedMatchesResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a set of MatchIds that belong to the given domain.
listRuleBasedMatchesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonCustomerProfilesAsyncDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResourceAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonCustomerProfilesAsyncDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResourceAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request)
AmazonCustomerProfilesAsyncQuery to list all workflows.
listWorkflowsAsync in interface AmazonCustomerProfilesAsyncpublic Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
AmazonCustomerProfilesAsyncQuery to list all workflows.
listWorkflowsAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest request)
AmazonCustomerProfilesAsyncRuns 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).
mergeProfilesAsync in interface AmazonCustomerProfilesAsyncpublic Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest request, AsyncHandler<MergeProfilesRequest,MergeProfilesResult> asyncHandler)
AmazonCustomerProfilesAsyncRuns 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).
mergeProfilesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest request)
AmazonCustomerProfilesAsyncAdds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
putIntegrationAsync in interface AmazonCustomerProfilesAsyncpublic Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest request, AsyncHandler<PutIntegrationRequest,PutIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsyncAdds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
putIntegrationAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest request)
AmazonCustomerProfilesAsyncAdds 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.
putProfileObjectAsync in interface AmazonCustomerProfilesAsyncpublic Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest request, AsyncHandler<PutProfileObjectRequest,PutProfileObjectResult> asyncHandler)
AmazonCustomerProfilesAsyncAdds 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.
putProfileObjectAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest request)
AmazonCustomerProfilesAsyncDefines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncpublic Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest request, AsyncHandler<PutProfileObjectTypeRequest,PutProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsyncDefines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectTypeAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<SearchProfilesResult> searchProfilesAsync(SearchProfilesRequest request)
AmazonCustomerProfilesAsync
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.
searchProfilesAsync in interface AmazonCustomerProfilesAsyncpublic Future<SearchProfilesResult> searchProfilesAsync(SearchProfilesRequest request, AsyncHandler<SearchProfilesRequest,SearchProfilesResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
searchProfilesAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonCustomerProfilesAsyncAssigns 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.
tagResourceAsync in interface AmazonCustomerProfilesAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonCustomerProfilesAsyncAssigns 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.
tagResourceAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonCustomerProfilesAsyncRemoves 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.
untagResourceAsync in interface AmazonCustomerProfilesAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonCustomerProfilesAsyncRemoves 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.
untagResourceAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<UpdateCalculatedAttributeDefinitionResult> updateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsyncUpdates 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.
updateCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncpublic Future<UpdateCalculatedAttributeDefinitionResult> updateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request, AsyncHandler<UpdateCalculatedAttributeDefinitionRequest,UpdateCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsyncUpdates 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.
updateCalculatedAttributeDefinitionAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest request)
AmazonCustomerProfilesAsyncUpdates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to
enable identity
resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
updateDomainAsync in interface AmazonCustomerProfilesAsyncpublic Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest request, AsyncHandler<UpdateDomainRequest,UpdateDomainResult> asyncHandler)
AmazonCustomerProfilesAsyncUpdates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to
enable identity
resolution: set Matching to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
updateDomainAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request)
AmazonCustomerProfilesAsyncUpdates 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.
updateProfileAsync in interface AmazonCustomerProfilesAsyncpublic Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
AmazonCustomerProfilesAsyncUpdates 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.
updateProfileAsync in interface AmazonCustomerProfilesAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonCustomerProfilesshutdown in class AmazonCustomerProfilesClient