@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_METRIC
ENDPOINT_PREFIX
addProfileKey, 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, updateProfile
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addProfileKey, 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, updateProfile
public static AmazonCustomerProfilesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest request)
AmazonCustomerProfilesAsync
Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
addProfileKeyAsync
in interface AmazonCustomerProfilesAsync
public Future<AddProfileKeyResult> addProfileKeyAsync(AddProfileKeyRequest request, AsyncHandler<AddProfileKeyRequest,AddProfileKeyResult> asyncHandler)
AmazonCustomerProfilesAsync
Associates a new key value with a specific profile, such as a Contact Record ContactId.
A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.
addProfileKeyAsync
in interface AmazonCustomerProfilesAsync
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.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 AmazonCustomerProfilesAsync
public 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 AmazonCustomerProfilesAsync
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.public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request)
AmazonCustomerProfilesAsync
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to
enable identity
resolution: set Matching
to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
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 AmazonCustomerProfilesAsync
public Future<CreateDomainResult> createDomainAsync(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
AmazonCustomerProfilesAsync
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to
enable identity
resolution: set Matching
to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
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 AmazonCustomerProfilesAsync
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.public Future<CreateEventStreamResult> createEventStreamAsync(CreateEventStreamRequest request)
AmazonCustomerProfilesAsync
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
createEventStreamAsync
in interface AmazonCustomerProfilesAsync
public Future<CreateEventStreamResult> createEventStreamAsync(CreateEventStreamRequest request, AsyncHandler<CreateEventStreamRequest,CreateEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsync
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.
Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain
createEventStreamAsync
in interface AmazonCustomerProfilesAsync
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.public Future<CreateIntegrationWorkflowResult> createIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request)
AmazonCustomerProfilesAsync
Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
createIntegrationWorkflowAsync
in interface AmazonCustomerProfilesAsync
public Future<CreateIntegrationWorkflowResult> createIntegrationWorkflowAsync(CreateIntegrationWorkflowRequest request, AsyncHandler<CreateIntegrationWorkflowRequest,CreateIntegrationWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsync
Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
createIntegrationWorkflowAsync
in interface AmazonCustomerProfilesAsync
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.public Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request)
AmazonCustomerProfilesAsync
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileAsync
in interface AmazonCustomerProfilesAsync
public Future<CreateProfileResult> createProfileAsync(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResult> asyncHandler)
AmazonCustomerProfilesAsync
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteCalculatedAttributeDefinitionResult> deleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsync
Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
deleteCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteCalculatedAttributeDefinitionResult> deleteCalculatedAttributeDefinitionAsync(DeleteCalculatedAttributeDefinitionRequest request, AsyncHandler<DeleteCalculatedAttributeDefinitionRequest,DeleteCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsync
Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.
deleteCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request)
AmazonCustomerProfilesAsync
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
AmazonCustomerProfilesAsync
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteEventStreamResult> deleteEventStreamAsync(DeleteEventStreamRequest request)
AmazonCustomerProfilesAsync
Disables and deletes the specified event stream.
deleteEventStreamAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteEventStreamResult> deleteEventStreamAsync(DeleteEventStreamRequest request, AsyncHandler<DeleteEventStreamRequest,DeleteEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsync
Disables and deletes the specified event stream.
deleteEventStreamAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest request)
AmazonCustomerProfilesAsync
Removes an integration from a specific domain.
deleteIntegrationAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest request, AsyncHandler<DeleteIntegrationRequest,DeleteIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsync
Removes an integration from a specific domain.
deleteIntegrationAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request)
AmazonCustomerProfilesAsync
Deletes the standard customer profile and all data pertaining to the profile.
deleteProfileAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteProfileResult> deleteProfileAsync(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResult> asyncHandler)
AmazonCustomerProfilesAsync
Deletes the standard customer profile and all data pertaining to the profile.
deleteProfileAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest request)
AmazonCustomerProfilesAsync
Removes a searchable key from a customer profile.
deleteProfileKeyAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteProfileKeyResult> deleteProfileKeyAsync(DeleteProfileKeyRequest request, AsyncHandler<DeleteProfileKeyRequest,DeleteProfileKeyResult> asyncHandler)
AmazonCustomerProfilesAsync
Removes a searchable key from a customer profile.
deleteProfileKeyAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest request)
AmazonCustomerProfilesAsync
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteProfileObjectResult> deleteProfileObjectAsync(DeleteProfileObjectRequest request, AsyncHandler<DeleteProfileObjectRequest,DeleteProfileObjectResult> asyncHandler)
AmazonCustomerProfilesAsync
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request)
AmazonCustomerProfilesAsync
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.
deleteProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteProfileObjectTypeResult> deleteProfileObjectTypeAsync(DeleteProfileObjectTypeRequest request, AsyncHandler<DeleteProfileObjectTypeRequest,DeleteProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
deleteProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request)
AmazonCustomerProfilesAsync
Deletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflowAsync
in interface AmazonCustomerProfilesAsync
public Future<DeleteWorkflowResult> deleteWorkflowAsync(DeleteWorkflowRequest request, AsyncHandler<DeleteWorkflowRequest,DeleteWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsync
Deletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflowAsync
in interface AmazonCustomerProfilesAsync
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.public Future<DetectProfileObjectTypeResult> detectProfileObjectTypeAsync(DetectProfileObjectTypeRequest request)
AmazonCustomerProfilesAsync
The process of detecting profile object type mapping by using given objects.
detectProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
public Future<DetectProfileObjectTypeResult> detectProfileObjectTypeAsync(DetectProfileObjectTypeRequest request, AsyncHandler<DetectProfileObjectTypeRequest,DetectProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsync
The process of detecting profile object type mapping by using given objects.
detectProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetAutoMergingPreviewResult> getAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request)
AmazonCustomerProfilesAsync
Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity
Resolution Job. Include at least two matching attributes. If your matching list includes too few
attributes (such as only FirstName
or only LastName
), there may be a large number of
matches. This increases the chances of erroneous merges.
getAutoMergingPreviewAsync
in interface AmazonCustomerProfilesAsync
public Future<GetAutoMergingPreviewResult> getAutoMergingPreviewAsync(GetAutoMergingPreviewRequest request, AsyncHandler<GetAutoMergingPreviewRequest,GetAutoMergingPreviewResult> asyncHandler)
AmazonCustomerProfilesAsync
Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.
You can't view which profiles are matched and would be merged.
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity
Resolution Job. Include at least two matching attributes. If your matching list includes too few
attributes (such as only FirstName
or only LastName
), there may be a large number of
matches. This increases the chances of erroneous merges.
getAutoMergingPreviewAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetCalculatedAttributeDefinitionResult> getCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsync
Provides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
public Future<GetCalculatedAttributeDefinitionResult> getCalculatedAttributeDefinitionAsync(GetCalculatedAttributeDefinitionRequest request, AsyncHandler<GetCalculatedAttributeDefinitionRequest,GetCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsync
Provides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetCalculatedAttributeForProfileResult> getCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request)
AmazonCustomerProfilesAsync
Retrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfileAsync
in interface AmazonCustomerProfilesAsync
public Future<GetCalculatedAttributeForProfileResult> getCalculatedAttributeForProfileAsync(GetCalculatedAttributeForProfileRequest request, AsyncHandler<GetCalculatedAttributeForProfileRequest,GetCalculatedAttributeForProfileResult> asyncHandler)
AmazonCustomerProfilesAsync
Retrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfileAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetDomainResult> getDomainAsync(GetDomainRequest request)
AmazonCustomerProfilesAsync
Returns information about a specific domain.
getDomainAsync
in interface AmazonCustomerProfilesAsync
public Future<GetDomainResult> getDomainAsync(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns information about a specific domain.
getDomainAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetEventStreamResult> getEventStreamAsync(GetEventStreamRequest request)
AmazonCustomerProfilesAsync
Returns information about the specified event stream in a specific domain.
getEventStreamAsync
in interface AmazonCustomerProfilesAsync
public Future<GetEventStreamResult> getEventStreamAsync(GetEventStreamRequest request, AsyncHandler<GetEventStreamRequest,GetEventStreamResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns information about the specified event stream in a specific domain.
getEventStreamAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetIdentityResolutionJobResult> getIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request)
AmazonCustomerProfilesAsync
Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
getIdentityResolutionJobAsync
in interface AmazonCustomerProfilesAsync
public Future<GetIdentityResolutionJobResult> getIdentityResolutionJobAsync(GetIdentityResolutionJobRequest request, AsyncHandler<GetIdentityResolutionJobRequest,GetIdentityResolutionJobResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
getIdentityResolutionJobAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest request)
AmazonCustomerProfilesAsync
Returns an integration for a domain.
getIntegrationAsync
in interface AmazonCustomerProfilesAsync
public Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest request, AsyncHandler<GetIntegrationRequest,GetIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns an integration for a domain.
getIntegrationAsync
in interface AmazonCustomerProfilesAsync
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.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 AmazonCustomerProfilesAsync
public 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 AmazonCustomerProfilesAsync
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.public Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest request)
AmazonCustomerProfilesAsync
Returns the object types for a specific domain.
getProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
public Future<GetProfileObjectTypeResult> getProfileObjectTypeAsync(GetProfileObjectTypeRequest request, AsyncHandler<GetProfileObjectTypeRequest,GetProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns the object types for a specific domain.
getProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request)
AmazonCustomerProfilesAsync
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.
getProfileObjectTypeTemplateAsync
in interface AmazonCustomerProfilesAsync
public Future<GetProfileObjectTypeTemplateResult> getProfileObjectTypeTemplateAsync(GetProfileObjectTypeTemplateRequest request, AsyncHandler<GetProfileObjectTypeTemplateRequest,GetProfileObjectTypeTemplateResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
getProfileObjectTypeTemplateAsync
in interface AmazonCustomerProfilesAsync
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.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 AmazonCustomerProfilesAsync
public 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 AmazonCustomerProfilesAsync
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.public Future<GetWorkflowResult> getWorkflowAsync(GetWorkflowRequest request)
AmazonCustomerProfilesAsync
Get details of specified workflow.
getWorkflowAsync
in interface AmazonCustomerProfilesAsync
public Future<GetWorkflowResult> getWorkflowAsync(GetWorkflowRequest request, AsyncHandler<GetWorkflowRequest,GetWorkflowResult> asyncHandler)
AmazonCustomerProfilesAsync
Get details of specified workflow.
getWorkflowAsync
in interface AmazonCustomerProfilesAsync
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.public Future<GetWorkflowStepsResult> getWorkflowStepsAsync(GetWorkflowStepsRequest request)
AmazonCustomerProfilesAsync
Get granular list of steps in workflow.
getWorkflowStepsAsync
in interface AmazonCustomerProfilesAsync
public Future<GetWorkflowStepsResult> getWorkflowStepsAsync(GetWorkflowStepsRequest request, AsyncHandler<GetWorkflowStepsRequest,GetWorkflowStepsResult> asyncHandler)
AmazonCustomerProfilesAsync
Get granular list of steps in workflow.
getWorkflowStepsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest request)
AmazonCustomerProfilesAsync
Lists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListAccountIntegrationsResult> listAccountIntegrationsAsync(ListAccountIntegrationsRequest request, AsyncHandler<ListAccountIntegrationsRequest,ListAccountIntegrationsResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListCalculatedAttributeDefinitionsResult> listCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request)
AmazonCustomerProfilesAsync
Lists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitionsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListCalculatedAttributeDefinitionsResult> listCalculatedAttributeDefinitionsAsync(ListCalculatedAttributeDefinitionsRequest request, AsyncHandler<ListCalculatedAttributeDefinitionsRequest,ListCalculatedAttributeDefinitionsResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitionsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListCalculatedAttributesForProfileResult> listCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request)
AmazonCustomerProfilesAsync
Retrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfileAsync
in interface AmazonCustomerProfilesAsync
public Future<ListCalculatedAttributesForProfileResult> listCalculatedAttributesForProfileAsync(ListCalculatedAttributesForProfileRequest request, AsyncHandler<ListCalculatedAttributesForProfileRequest,ListCalculatedAttributesForProfileResult> asyncHandler)
AmazonCustomerProfilesAsync
Retrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfileAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request)
AmazonCustomerProfilesAsync
Returns a list of all the domains for an AWS account that have been created.
listDomainsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a list of all the domains for an AWS account that have been created.
listDomainsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListEventStreamsResult> listEventStreamsAsync(ListEventStreamsRequest request)
AmazonCustomerProfilesAsync
Returns a list of all the event streams in a specific domain.
listEventStreamsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListEventStreamsResult> listEventStreamsAsync(ListEventStreamsRequest request, AsyncHandler<ListEventStreamsRequest,ListEventStreamsResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a list of all the event streams in a specific domain.
listEventStreamsAsync
in interface AmazonCustomerProfilesAsync
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.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 AmazonCustomerProfilesAsync
public 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 AmazonCustomerProfilesAsync
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.public Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest request)
AmazonCustomerProfilesAsync
Lists all of the integrations in your domain.
listIntegrationsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListIntegrationsResult> listIntegrationsAsync(ListIntegrationsRequest request, AsyncHandler<ListIntegrationsRequest,ListIntegrationsResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists all of the integrations in your domain.
listIntegrationsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request)
AmazonCustomerProfilesAsync
Lists all of the template information for object types.
listProfileObjectTypeTemplatesAsync
in interface AmazonCustomerProfilesAsync
public Future<ListProfileObjectTypeTemplatesResult> listProfileObjectTypeTemplatesAsync(ListProfileObjectTypeTemplatesRequest request, AsyncHandler<ListProfileObjectTypeTemplatesRequest,ListProfileObjectTypeTemplatesResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists all of the template information for object types.
listProfileObjectTypeTemplatesAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest request)
AmazonCustomerProfilesAsync
Lists all of the templates available within the service.
listProfileObjectTypesAsync
in interface AmazonCustomerProfilesAsync
public Future<ListProfileObjectTypesResult> listProfileObjectTypesAsync(ListProfileObjectTypesRequest request, AsyncHandler<ListProfileObjectTypesRequest,ListProfileObjectTypesResult> asyncHandler)
AmazonCustomerProfilesAsync
Lists all of the templates available within the service.
listProfileObjectTypesAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest request)
AmazonCustomerProfilesAsync
Returns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListProfileObjectsResult> listProfileObjectsAsync(ListProfileObjectsRequest request, AsyncHandler<ListProfileObjectsRequest,ListProfileObjectsResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListRuleBasedMatchesResult> listRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request)
AmazonCustomerProfilesAsync
Returns a set of MatchIds
that belong to the given domain.
listRuleBasedMatchesAsync
in interface AmazonCustomerProfilesAsync
public Future<ListRuleBasedMatchesResult> listRuleBasedMatchesAsync(ListRuleBasedMatchesRequest request, AsyncHandler<ListRuleBasedMatchesRequest,ListRuleBasedMatchesResult> asyncHandler)
AmazonCustomerProfilesAsync
Returns a set of MatchIds
that belong to the given domain.
listRuleBasedMatchesAsync
in interface AmazonCustomerProfilesAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonCustomerProfilesAsync
Displays 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 AmazonCustomerProfilesAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonCustomerProfilesAsync
Displays 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 AmazonCustomerProfilesAsync
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.public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request)
AmazonCustomerProfilesAsync
Query to list all workflows.
listWorkflowsAsync
in interface AmazonCustomerProfilesAsync
public Future<ListWorkflowsResult> listWorkflowsAsync(ListWorkflowsRequest request, AsyncHandler<ListWorkflowsRequest,ListWorkflowsResult> asyncHandler)
AmazonCustomerProfilesAsync
Query to list all workflows.
listWorkflowsAsync
in interface AmazonCustomerProfilesAsync
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.public Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest request)
AmazonCustomerProfilesAsync
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).
mergeProfilesAsync
in interface AmazonCustomerProfilesAsync
public Future<MergeProfilesResult> mergeProfilesAsync(MergeProfilesRequest request, AsyncHandler<MergeProfilesRequest,MergeProfilesResult> asyncHandler)
AmazonCustomerProfilesAsync
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).
mergeProfilesAsync
in interface AmazonCustomerProfilesAsync
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.public Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest request)
AmazonCustomerProfilesAsync
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
putIntegrationAsync
in interface AmazonCustomerProfilesAsync
public Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest request, AsyncHandler<PutIntegrationRequest,PutIntegrationResult> asyncHandler)
AmazonCustomerProfilesAsync
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
putIntegrationAsync
in interface AmazonCustomerProfilesAsync
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.public Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest request)
AmazonCustomerProfilesAsync
Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
putProfileObjectAsync
in interface AmazonCustomerProfilesAsync
public Future<PutProfileObjectResult> putProfileObjectAsync(PutProfileObjectRequest request, AsyncHandler<PutProfileObjectRequest,PutProfileObjectResult> asyncHandler)
AmazonCustomerProfilesAsync
Adds additional objects to customer profiles of a given ObjectType.
When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.
When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.
PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.
putProfileObjectAsync
in interface AmazonCustomerProfilesAsync
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.public Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest request)
AmazonCustomerProfilesAsync
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
public Future<PutProfileObjectTypeResult> putProfileObjectTypeAsync(PutProfileObjectTypeRequest request, AsyncHandler<PutProfileObjectTypeRequest,PutProfileObjectTypeResult> asyncHandler)
AmazonCustomerProfilesAsync
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectTypeAsync
in interface AmazonCustomerProfilesAsync
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.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 AmazonCustomerProfilesAsync
public 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 AmazonCustomerProfilesAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonCustomerProfilesAsync
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.
tagResourceAsync
in interface AmazonCustomerProfilesAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
tagResourceAsync
in interface AmazonCustomerProfilesAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonCustomerProfilesAsync
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.
untagResourceAsync
in interface AmazonCustomerProfilesAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
untagResourceAsync
in interface AmazonCustomerProfilesAsync
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.public Future<UpdateCalculatedAttributeDefinitionResult> updateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesAsync
Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
updateCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
public Future<UpdateCalculatedAttributeDefinitionResult> updateCalculatedAttributeDefinitionAsync(UpdateCalculatedAttributeDefinitionRequest request, AsyncHandler<UpdateCalculatedAttributeDefinitionRequest,UpdateCalculatedAttributeDefinitionResult> asyncHandler)
AmazonCustomerProfilesAsync
Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.
updateCalculatedAttributeDefinitionAsync
in interface AmazonCustomerProfilesAsync
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.public Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest request)
AmazonCustomerProfilesAsync
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to
enable identity
resolution: set Matching
to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
updateDomainAsync
in interface AmazonCustomerProfilesAsync
public Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest request, AsyncHandler<UpdateDomainRequest,UpdateDomainResult> asyncHandler)
AmazonCustomerProfilesAsync
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to
enable identity
resolution: set Matching
to true.
To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.
To add or remove tags on an existing Domain, see TagResource/UntagResource.
updateDomainAsync
in interface AmazonCustomerProfilesAsync
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.public Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request)
AmazonCustomerProfilesAsync
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.
updateProfileAsync
in interface AmazonCustomerProfilesAsync
public Future<UpdateProfileResult> updateProfileAsync(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResult> asyncHandler)
AmazonCustomerProfilesAsync
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.
updateProfileAsync
in interface AmazonCustomerProfilesAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonCustomerProfiles
shutdown
in class AmazonCustomerProfilesClient