@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCustomerProfiles extends Object implements AmazonCustomerProfiles
AmazonCustomerProfiles. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AddProfileKeyResult |
addProfileKey(AddProfileKeyRequest request)
Associates a new key value with a specific profile, such as a Contact Record ContactId.
|
CreateCalculatedAttributeDefinitionResult |
createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest request)
Creates a new calculated attribute definition.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types,
profile keys, and encryption keys.
|
CreateEventStreamResult |
createEventStream(CreateEventStreamRequest request)
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.
|
CreateIntegrationWorkflowResult |
createIntegrationWorkflow(CreateIntegrationWorkflowRequest request)
Creates an integration workflow.
|
CreateProfileResult |
createProfile(CreateProfileRequest request)
Creates a standard profile.
|
DeleteCalculatedAttributeDefinitionResult |
deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest request)
Deletes an existing calculated attribute definition.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related
objects.
|
DeleteEventStreamResult |
deleteEventStream(DeleteEventStreamRequest request)
Disables and deletes the specified event stream.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest request)
Removes an integration from a specific domain.
|
DeleteProfileResult |
deleteProfile(DeleteProfileRequest request)
Deletes the standard customer profile and all data pertaining to the profile.
|
DeleteProfileKeyResult |
deleteProfileKey(DeleteProfileKeyRequest request)
Removes a searchable key from a customer profile.
|
DeleteProfileObjectResult |
deleteProfileObject(DeleteProfileObjectRequest request)
Removes an object associated with a profile of a given ProfileObjectType.
|
DeleteProfileObjectTypeResult |
deleteProfileObjectType(DeleteProfileObjectTypeRequest request)
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
|
DeleteWorkflowResult |
deleteWorkflow(DeleteWorkflowRequest request)
Deletes the specified workflow and all its corresponding resources.
|
DetectProfileObjectTypeResult |
detectProfileObjectType(DetectProfileObjectTypeRequest request)
The process of detecting profile object type mapping by using given objects.
|
GetAutoMergingPreviewResult |
getAutoMergingPreview(GetAutoMergingPreviewRequest request)
Tests the auto-merging settings of your Identity Resolution Job without merging your data.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCalculatedAttributeDefinitionResult |
getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest request)
Provides more information on a calculated attribute definition for Customer Profiles.
|
GetCalculatedAttributeForProfileResult |
getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest request)
Retrieve a calculated attribute for a customer profile.
|
GetDomainResult |
getDomain(GetDomainRequest request)
Returns information about a specific domain.
|
GetEventStreamResult |
getEventStream(GetEventStreamRequest request)
Returns information about the specified event stream in a specific domain.
|
GetIdentityResolutionJobResult |
getIdentityResolutionJob(GetIdentityResolutionJobRequest request)
Returns information about an Identity Resolution Job in a specific domain.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest request)
Returns an integration for a domain.
|
GetMatchesResult |
getMatches(GetMatchesRequest request)
Before calling this API, use CreateDomain or
UpdateDomain
to enable identity resolution: set
Matching to true. |
GetProfileObjectTypeResult |
getProfileObjectType(GetProfileObjectTypeRequest request)
Returns the object types for a specific domain.
|
GetProfileObjectTypeTemplateResult |
getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest request)
Returns the template information for a specific object type.
|
GetSimilarProfilesResult |
getSimilarProfiles(GetSimilarProfilesRequest request)
Returns a set of profiles that belong to the same matching group using the
matchId or
profileId. |
GetWorkflowResult |
getWorkflow(GetWorkflowRequest request)
Get details of specified workflow.
|
GetWorkflowStepsResult |
getWorkflowSteps(GetWorkflowStepsRequest request)
Get granular list of steps in workflow.
|
ListAccountIntegrationsResult |
listAccountIntegrations(ListAccountIntegrationsRequest request)
Lists all of the integrations associated to a specific URI in the AWS account.
|
ListCalculatedAttributeDefinitionsResult |
listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest request)
Lists calculated attribute definitions for Customer Profiles
|
ListCalculatedAttributesForProfileResult |
listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest request)
Retrieve a list of calculated attributes for a customer profile.
|
ListDomainsResult |
listDomains(ListDomainsRequest request)
Returns a list of all the domains for an AWS account that have been created.
|
ListEventStreamsResult |
listEventStreams(ListEventStreamsRequest request)
Returns a list of all the event streams in a specific domain.
|
ListIdentityResolutionJobsResult |
listIdentityResolutionJobs(ListIdentityResolutionJobsRequest request)
Lists all of the Identity Resolution Jobs in your domain.
|
ListIntegrationsResult |
listIntegrations(ListIntegrationsRequest request)
Lists all of the integrations in your domain.
|
ListProfileObjectsResult |
listProfileObjects(ListProfileObjectsRequest request)
Returns a list of objects associated with a profile of a given ProfileObjectType.
|
ListProfileObjectTypesResult |
listProfileObjectTypes(ListProfileObjectTypesRequest request)
Lists all of the templates available within the service.
|
ListProfileObjectTypeTemplatesResult |
listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest request)
Lists all of the template information for object types.
|
ListRuleBasedMatchesResult |
listRuleBasedMatches(ListRuleBasedMatchesRequest request)
Returns a set of
MatchIds that belong to the given domain. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Displays the tags associated with an Amazon Connect Customer Profiles resource.
|
ListWorkflowsResult |
listWorkflows(ListWorkflowsRequest request)
Query to list all workflows.
|
MergeProfilesResult |
mergeProfiles(MergeProfilesRequest request)
Runs an AWS Lambda job that does the following:
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest request)
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon
Connect.
|
PutProfileObjectResult |
putProfileObject(PutProfileObjectRequest request)
Adds additional objects to customer profiles of a given ObjectType.
|
PutProfileObjectTypeResult |
putProfileObjectType(PutProfileObjectTypeRequest request)
Defines a ProfileObjectType.
|
SearchProfilesResult |
searchProfiles(SearchProfilesRequest request)
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.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
|
UpdateCalculatedAttributeDefinitionResult |
updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest request)
Updates an existing calculated attribute definition.
|
UpdateDomainResult |
updateDomain(UpdateDomainRequest request)
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
|
UpdateProfileResult |
updateProfile(UpdateProfileRequest request)
Updates the properties of a profile.
|
public AddProfileKeyResult addProfileKey(AddProfileKeyRequest request)
AmazonCustomerProfilesAssociates 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.
addProfileKey in interface AmazonCustomerProfilespublic CreateCalculatedAttributeDefinitionResult createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfiles
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.
createCalculatedAttributeDefinition in interface AmazonCustomerProfilespublic CreateDomainResult createDomain(CreateDomainRequest request)
AmazonCustomerProfilesCreates 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.
createDomain in interface AmazonCustomerProfilespublic CreateEventStreamResult createEventStream(CreateEventStreamRequest request)
AmazonCustomerProfilesCreates 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
createEventStream in interface AmazonCustomerProfilespublic CreateIntegrationWorkflowResult createIntegrationWorkflow(CreateIntegrationWorkflowRequest request)
AmazonCustomerProfilesCreates 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.
createIntegrationWorkflow in interface AmazonCustomerProfilespublic CreateProfileResult createProfile(CreateProfileRequest request)
AmazonCustomerProfilesCreates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfile in interface AmazonCustomerProfilespublic DeleteCalculatedAttributeDefinitionResult deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesDeletes 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.
deleteCalculatedAttributeDefinition in interface AmazonCustomerProfilespublic DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonCustomerProfilesDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomain in interface AmazonCustomerProfilespublic DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest request)
AmazonCustomerProfilesDisables and deletes the specified event stream.
deleteEventStream in interface AmazonCustomerProfilespublic DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
AmazonCustomerProfilesRemoves an integration from a specific domain.
deleteIntegration in interface AmazonCustomerProfilespublic DeleteProfileResult deleteProfile(DeleteProfileRequest request)
AmazonCustomerProfilesDeletes the standard customer profile and all data pertaining to the profile.
deleteProfile in interface AmazonCustomerProfilespublic DeleteProfileKeyResult deleteProfileKey(DeleteProfileKeyRequest request)
AmazonCustomerProfilesRemoves a searchable key from a customer profile.
deleteProfileKey in interface AmazonCustomerProfilespublic DeleteProfileObjectResult deleteProfileObject(DeleteProfileObjectRequest request)
AmazonCustomerProfilesRemoves an object associated with a profile of a given ProfileObjectType.
deleteProfileObject in interface AmazonCustomerProfilespublic DeleteProfileObjectTypeResult deleteProfileObjectType(DeleteProfileObjectTypeRequest request)
AmazonCustomerProfilesRemoves 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.
deleteProfileObjectType in interface AmazonCustomerProfilespublic DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
AmazonCustomerProfilesDeletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflow in interface AmazonCustomerProfilespublic DetectProfileObjectTypeResult detectProfileObjectType(DetectProfileObjectTypeRequest request)
AmazonCustomerProfilesThe process of detecting profile object type mapping by using given objects.
detectProfileObjectType in interface AmazonCustomerProfilespublic GetAutoMergingPreviewResult getAutoMergingPreview(GetAutoMergingPreviewRequest request)
AmazonCustomerProfilesTests 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.
getAutoMergingPreview in interface AmazonCustomerProfilespublic GetCalculatedAttributeDefinitionResult getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesProvides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinition in interface AmazonCustomerProfilespublic GetCalculatedAttributeForProfileResult getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest request)
AmazonCustomerProfilesRetrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfile in interface AmazonCustomerProfilespublic GetDomainResult getDomain(GetDomainRequest request)
AmazonCustomerProfilesReturns information about a specific domain.
getDomain in interface AmazonCustomerProfilespublic GetEventStreamResult getEventStream(GetEventStreamRequest request)
AmazonCustomerProfilesReturns information about the specified event stream in a specific domain.
getEventStream in interface AmazonCustomerProfilespublic GetIdentityResolutionJobResult getIdentityResolutionJob(GetIdentityResolutionJobRequest request)
AmazonCustomerProfilesReturns 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.
getIdentityResolutionJob in interface AmazonCustomerProfilespublic GetIntegrationResult getIntegration(GetIntegrationRequest request)
AmazonCustomerProfilesReturns an integration for a domain.
getIntegration in interface AmazonCustomerProfilespublic GetMatchesResult getMatches(GetMatchesRequest request)
AmazonCustomerProfiles
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.
getMatches in interface AmazonCustomerProfilespublic GetProfileObjectTypeResult getProfileObjectType(GetProfileObjectTypeRequest request)
AmazonCustomerProfilesReturns the object types for a specific domain.
getProfileObjectType in interface AmazonCustomerProfilespublic GetProfileObjectTypeTemplateResult getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest request)
AmazonCustomerProfilesReturns 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.
getProfileObjectTypeTemplate in interface AmazonCustomerProfilespublic GetSimilarProfilesResult getSimilarProfiles(GetSimilarProfilesRequest request)
AmazonCustomerProfiles
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.
getSimilarProfiles in interface AmazonCustomerProfilespublic GetWorkflowResult getWorkflow(GetWorkflowRequest request)
AmazonCustomerProfilesGet details of specified workflow.
getWorkflow in interface AmazonCustomerProfilespublic GetWorkflowStepsResult getWorkflowSteps(GetWorkflowStepsRequest request)
AmazonCustomerProfilesGet granular list of steps in workflow.
getWorkflowSteps in interface AmazonCustomerProfilespublic ListAccountIntegrationsResult listAccountIntegrations(ListAccountIntegrationsRequest request)
AmazonCustomerProfilesLists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrations in interface AmazonCustomerProfilespublic ListCalculatedAttributeDefinitionsResult listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest request)
AmazonCustomerProfilesLists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitions in interface AmazonCustomerProfilespublic ListCalculatedAttributesForProfileResult listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest request)
AmazonCustomerProfilesRetrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfile in interface AmazonCustomerProfilespublic ListDomainsResult listDomains(ListDomainsRequest request)
AmazonCustomerProfilesReturns a list of all the domains for an AWS account that have been created.
listDomains in interface AmazonCustomerProfilespublic ListEventStreamsResult listEventStreams(ListEventStreamsRequest request)
AmazonCustomerProfilesReturns a list of all the event streams in a specific domain.
listEventStreams in interface AmazonCustomerProfilespublic ListIdentityResolutionJobsResult listIdentityResolutionJobs(ListIdentityResolutionJobsRequest request)
AmazonCustomerProfiles
Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime.
listIdentityResolutionJobs in interface AmazonCustomerProfilespublic ListIntegrationsResult listIntegrations(ListIntegrationsRequest request)
AmazonCustomerProfilesLists all of the integrations in your domain.
listIntegrations in interface AmazonCustomerProfilespublic ListProfileObjectTypeTemplatesResult listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest request)
AmazonCustomerProfilesLists all of the template information for object types.
listProfileObjectTypeTemplates in interface AmazonCustomerProfilespublic ListProfileObjectTypesResult listProfileObjectTypes(ListProfileObjectTypesRequest request)
AmazonCustomerProfilesLists all of the templates available within the service.
listProfileObjectTypes in interface AmazonCustomerProfilespublic ListProfileObjectsResult listProfileObjects(ListProfileObjectsRequest request)
AmazonCustomerProfilesReturns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjects in interface AmazonCustomerProfilespublic ListRuleBasedMatchesResult listRuleBasedMatches(ListRuleBasedMatchesRequest request)
AmazonCustomerProfiles
Returns a set of MatchIds that belong to the given domain.
listRuleBasedMatches in interface AmazonCustomerProfilespublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonCustomerProfilesDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResource in interface AmazonCustomerProfilespublic ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
AmazonCustomerProfilesQuery to list all workflows.
listWorkflows in interface AmazonCustomerProfilespublic MergeProfilesResult mergeProfiles(MergeProfilesRequest request)
AmazonCustomerProfilesRuns 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).
mergeProfiles in interface AmazonCustomerProfilespublic PutIntegrationResult putIntegration(PutIntegrationRequest request)
AmazonCustomerProfilesAdds 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.
putIntegration in interface AmazonCustomerProfilespublic PutProfileObjectResult putProfileObject(PutProfileObjectRequest request)
AmazonCustomerProfilesAdds 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.
putProfileObject in interface AmazonCustomerProfilespublic PutProfileObjectTypeResult putProfileObjectType(PutProfileObjectTypeRequest request)
AmazonCustomerProfilesDefines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectType in interface AmazonCustomerProfilespublic SearchProfilesResult searchProfiles(SearchProfilesRequest request)
AmazonCustomerProfiles
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.
searchProfiles in interface AmazonCustomerProfilespublic TagResourceResult tagResource(TagResourceRequest request)
AmazonCustomerProfilesAssigns 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.
tagResource in interface AmazonCustomerProfilespublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonCustomerProfilesRemoves 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.
untagResource in interface AmazonCustomerProfilespublic UpdateCalculatedAttributeDefinitionResult updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest request)
AmazonCustomerProfilesUpdates 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.
updateCalculatedAttributeDefinition in interface AmazonCustomerProfilespublic UpdateDomainResult updateDomain(UpdateDomainRequest request)
AmazonCustomerProfilesUpdates 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.
updateDomain in interface AmazonCustomerProfilespublic UpdateProfileResult updateProfile(UpdateProfileRequest request)
AmazonCustomerProfilesUpdates 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.
updateProfile in interface AmazonCustomerProfilespublic void shutdown()
AmazonCustomerProfilesshutdown in interface AmazonCustomerProfilespublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCustomerProfilesResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonCustomerProfilesrequest - The originally executed request.