@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCustomerProfiles
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonCustomerProfiles instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddProfileKeyResult |
addProfileKey(AddProfileKeyRequest addProfileKeyRequest)
Associates a new key value with a specific profile, such as a Contact Record ContactId.
|
CreateCalculatedAttributeDefinitionResult |
createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest)
Creates a new calculated attribute definition.
|
CreateDomainResult |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types,
profile keys, and encryption keys.
|
CreateEventStreamResult |
createEventStream(CreateEventStreamRequest createEventStreamRequest)
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 createIntegrationWorkflowRequest)
Creates an integration workflow.
|
CreateProfileResult |
createProfile(CreateProfileRequest createProfileRequest)
Creates a standard profile.
|
DeleteCalculatedAttributeDefinitionResult |
deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest)
Deletes an existing calculated attribute definition.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related
objects.
|
DeleteEventStreamResult |
deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
Disables and deletes the specified event stream.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Removes an integration from a specific domain.
|
DeleteProfileResult |
deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the standard customer profile and all data pertaining to the profile.
|
DeleteProfileKeyResult |
deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)
Removes a searchable key from a customer profile.
|
DeleteProfileObjectResult |
deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)
Removes an object associated with a profile of a given ProfileObjectType.
|
DeleteProfileObjectTypeResult |
deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.
|
DeleteWorkflowResult |
deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow and all its corresponding resources.
|
DetectProfileObjectTypeResult |
detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest)
The process of detecting profile object type mapping by using given objects.
|
GetAutoMergingPreviewResult |
getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest)
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 getCalculatedAttributeDefinitionRequest)
Provides more information on a calculated attribute definition for Customer Profiles.
|
GetCalculatedAttributeForProfileResult |
getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest)
Retrieve a calculated attribute for a customer profile.
|
GetDomainResult |
getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain.
|
GetEventStreamResult |
getEventStream(GetEventStreamRequest getEventStreamRequest)
Returns information about the specified event stream in a specific domain.
|
GetIdentityResolutionJobResult |
getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest)
Returns information about an Identity Resolution Job in a specific domain.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Returns an integration for a domain.
|
GetMatchesResult |
getMatches(GetMatchesRequest getMatchesRequest)
Before calling this API, use CreateDomain or
UpdateDomain
to enable identity resolution: set
Matching to true. |
GetProfileObjectTypeResult |
getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)
Returns the object types for a specific domain.
|
GetProfileObjectTypeTemplateResult |
getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
Returns the template information for a specific object type.
|
GetSimilarProfilesResult |
getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest)
Returns a set of profiles that belong to the same matching group using the
matchId or
profileId. |
GetWorkflowResult |
getWorkflow(GetWorkflowRequest getWorkflowRequest)
Get details of specified workflow.
|
GetWorkflowStepsResult |
getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)
Get granular list of steps in workflow.
|
ListAccountIntegrationsResult |
listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)
Lists all of the integrations associated to a specific URI in the AWS account.
|
ListCalculatedAttributeDefinitionsResult |
listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest)
Lists calculated attribute definitions for Customer Profiles
|
ListCalculatedAttributesForProfileResult |
listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest)
Retrieve a list of calculated attributes for a customer profile.
|
ListDomainsResult |
listDomains(ListDomainsRequest listDomainsRequest)
Returns a list of all the domains for an AWS account that have been created.
|
ListEventStreamsResult |
listEventStreams(ListEventStreamsRequest listEventStreamsRequest)
Returns a list of all the event streams in a specific domain.
|
ListIdentityResolutionJobsResult |
listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)
Lists all of the Identity Resolution Jobs in your domain.
|
ListIntegrationsResult |
listIntegrations(ListIntegrationsRequest listIntegrationsRequest)
Lists all of the integrations in your domain.
|
ListProfileObjectsResult |
listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)
Returns a list of objects associated with a profile of a given ProfileObjectType.
|
ListProfileObjectTypesResult |
listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)
Lists all of the templates available within the service.
|
ListProfileObjectTypeTemplatesResult |
listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
|
ListRuleBasedMatchesResult |
listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)
Returns a set of
MatchIds that belong to the given domain. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an Amazon Connect Customer Profiles resource.
|
ListWorkflowsResult |
listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Query to list all workflows.
|
MergeProfilesResult |
mergeProfiles(MergeProfilesRequest mergeProfilesRequest)
Runs an AWS Lambda job that does the following:
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest putIntegrationRequest)
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon
Connect.
|
PutProfileObjectResult |
putProfileObject(PutProfileObjectRequest putProfileObjectRequest)
Adds additional objects to customer profiles of a given ObjectType.
|
PutProfileObjectTypeResult |
putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)
Defines a ProfileObjectType.
|
SearchProfilesResult |
searchProfiles(SearchProfilesRequest searchProfilesRequest)
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 tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Connect Customer Profiles resource.
|
UpdateCalculatedAttributeDefinitionResult |
updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest)
Updates an existing calculated attribute definition.
|
UpdateDomainResult |
updateDomain(UpdateDomainRequest updateDomainRequest)
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
|
UpdateProfileResult |
updateProfile(UpdateProfileRequest updateProfileRequest)
Updates the properties of a profile.
|
static final String ENDPOINT_PREFIX
AddProfileKeyResult addProfileKey(AddProfileKeyRequest addProfileKeyRequest)
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.
addProfileKeyRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.CreateCalculatedAttributeDefinitionResult createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest createCalculatedAttributeDefinitionRequest)
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.
createCalculatedAttributeDefinitionRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.
Use this API or UpdateDomain to
enable identity
resolution: set Matching to true.
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.
createDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.CreateEventStreamResult createEventStream(CreateEventStreamRequest createEventStreamRequest)
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
createEventStreamRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.CreateIntegrationWorkflowResult createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest)
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.
createIntegrationWorkflowRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
Creates a standard profile.
A standard profile represents the following attributes for a customer profile in a domain.
createProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteCalculatedAttributeDefinitionResult deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest deleteCalculatedAttributeDefinitionRequest)
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.
deleteCalculatedAttributeDefinitionRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
deleteDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
Disables and deletes the specified event stream.
deleteEventStreamRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Removes an integration from a specific domain.
deleteIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
Deletes the standard customer profile and all data pertaining to the profile.
deleteProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteProfileKeyResult deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)
Removes a searchable key from a customer profile.
deleteProfileKeyRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteProfileObjectResult deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)
Removes an object associated with a profile of a given ProfileObjectType.
deleteProfileObjectRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteProfileObjectTypeResult deleteProfileObjectType(DeleteProfileObjectTypeRequest deleteProfileObjectTypeRequest)
Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.
deleteProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)
Deletes the specified workflow and all its corresponding resources. This is an async process.
deleteWorkflowRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.DetectProfileObjectTypeResult detectProfileObjectType(DetectProfileObjectTypeRequest detectProfileObjectTypeRequest)
The process of detecting profile object type mapping by using given objects.
detectProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetAutoMergingPreviewResult getAutoMergingPreview(GetAutoMergingPreviewRequest getAutoMergingPreviewRequest)
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.
getAutoMergingPreviewRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetCalculatedAttributeDefinitionResult getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest getCalculatedAttributeDefinitionRequest)
Provides more information on a calculated attribute definition for Customer Profiles.
getCalculatedAttributeDefinitionRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetCalculatedAttributeForProfileResult getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest getCalculatedAttributeForProfileRequest)
Retrieve a calculated attribute for a customer profile.
getCalculatedAttributeForProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetDomainResult getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain.
getDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)
Returns information about the specified event stream in a specific domain.
getEventStreamRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetIdentityResolutionJobResult getIdentityResolutionJob(GetIdentityResolutionJobRequest getIdentityResolutionJobRequest)
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.
getIdentityResolutionJobRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Returns an integration for a domain.
getIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetMatchesResult getMatches(GetMatchesRequest getMatchesRequest)
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.
getMatchesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetProfileObjectTypeResult getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)
Returns the object types for a specific domain.
getProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetProfileObjectTypeTemplateResult getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest getProfileObjectTypeTemplateRequest)
Returns the template information for a specific object type.
A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.
getProfileObjectTypeTemplateRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetSimilarProfilesResult getSimilarProfiles(GetSimilarProfilesRequest getSimilarProfilesRequest)
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.
getSimilarProfilesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetWorkflowResult getWorkflow(GetWorkflowRequest getWorkflowRequest)
Get details of specified workflow.
getWorkflowRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.GetWorkflowStepsResult getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)
Get granular list of steps in workflow.
getWorkflowStepsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListAccountIntegrationsResult listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)
Lists all of the integrations associated to a specific URI in the AWS account.
listAccountIntegrationsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListCalculatedAttributeDefinitionsResult listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest listCalculatedAttributeDefinitionsRequest)
Lists calculated attribute definitions for Customer Profiles
listCalculatedAttributeDefinitionsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListCalculatedAttributesForProfileResult listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest listCalculatedAttributesForProfileRequest)
Retrieve a list of calculated attributes for a customer profile.
listCalculatedAttributesForProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
Returns a list of all the domains for an AWS account that have been created.
listDomainsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListEventStreamsResult listEventStreams(ListEventStreamsRequest listEventStreamsRequest)
Returns a list of all the event streams in a specific domain.
listEventStreamsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListIdentityResolutionJobsResult listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)
Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by
JobStartTime.
listIdentityResolutionJobsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListIntegrationsResult listIntegrations(ListIntegrationsRequest listIntegrationsRequest)
Lists all of the integrations in your domain.
listIntegrationsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListProfileObjectTypeTemplatesResult listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)
Lists all of the template information for object types.
listProfileObjectTypeTemplatesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListProfileObjectTypesResult listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)
Lists all of the templates available within the service.
listProfileObjectTypesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListProfileObjectsResult listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)
Returns a list of objects associated with a profile of a given ProfileObjectType.
listProfileObjectsRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListRuleBasedMatchesResult listRuleBasedMatches(ListRuleBasedMatchesRequest listRuleBasedMatchesRequest)
Returns a set of MatchIds that belong to the given domain.
listRuleBasedMatchesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
listTagsForResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest)
Query to list all workflows.
listWorkflowsRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.MergeProfilesResult mergeProfiles(MergeProfilesRequest mergeProfilesRequest)
Runs an AWS Lambda job that does the following:
All the profileKeys in the ProfileToBeMerged will be moved to the main profile.
All the objects in the ProfileToBeMerged will be moved to the main profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.
Standard fields are merged as follows:
Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.
When there are conflicting fields:
If no SourceProfileIds entry is specified, the main Profile value is always taken.
If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a
NULL value.
You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).
mergeProfilesRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.
An integration can belong to only one domain.
To add or remove tags on an existing Integration, see TagResource / UntagResource.
putIntegrationRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.PutProfileObjectResult putProfileObject(PutProfileObjectRequest putProfileObjectRequest)
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.
putProfileObjectRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.PutProfileObjectTypeResult putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
putProfileObjectTypeRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)
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.
searchProfilesRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
tagResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
untagResourceRequest - InternalServerException - An internal service error occurred.BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.UpdateCalculatedAttributeDefinitionResult updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest updateCalculatedAttributeDefinitionRequest)
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.
updateCalculatedAttributeDefinitionRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.UpdateDomainResult updateDomain(UpdateDomainRequest updateDomainRequest)
Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.
After a domain is created, the name can’t be changed.
Use this API or CreateDomain to
enable identity
resolution: set Matching to true.
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.
updateDomainRequest - BadRequestException - The input you provided is invalid.ResourceNotFoundException - The requested resource does not exist, or access was denied.AccessDeniedException - You do not have sufficient access to perform this action.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
updateProfileRequest - BadRequestException - The input you provided is invalid.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - The requested resource does not exist, or access was denied.ThrottlingException - You exceeded the maximum number of requests.InternalServerException - An internal service error occurred.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response 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.
request - The originally executed request.