com.amazonaws.services.customerprofiles

Interface AmazonCustomerProfiles

All Known Subinterfaces:

AmazonCustomerProfilesAsync

All Known Implementing Classes:

AbstractAmazonCustomerProfiles, AbstractAmazonCustomerProfilesAsync, AmazonCustomerProfilesAsyncClient, AmazonCustomerProfilesClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCustomerProfiles

Interface for accessing Customer Profiles.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCustomerProfiles instead.

Amazon Connect Customer Profiles

Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.

If you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddProfileKeyResult	addProfileKey(AddProfileKeyRequest addProfileKeyRequest) Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.
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.
CreateIntegrationWorkflowResult	createIntegrationWorkflow(CreateIntegrationWorkflowRequest createIntegrationWorkflowRequest) Creates an integration workflow.
CreateProfileResult	createProfile(CreateProfileRequest createProfileRequest) Creates a standard profile.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
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.
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.
GetDomainResult	getDomain(GetDomainRequest getDomainRequest) Returns information about 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.
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.
ListDomainsResult	listDomains(ListDomainsRequest listDomainsRequest) Returns a list of all the domains for an AWS account that have been created.
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.
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 name using name, phone number, email address, account number, or a custom defined index.
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.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

addProfileKey

AddProfileKeyResult addProfileKey(AddProfileKeyRequest addProfileKeyRequest)

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Parameters:

addProfileKeyRequest -

Returns:

Result of the AddProfileKey operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDomain

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.

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createIntegrationWorkflow

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.

Parameters:

createIntegrationWorkflowRequest -

Returns:

Result of the CreateIntegrationWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createProfile

CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Parameters:

createProfileRequest -

Returns:

Result of the CreateProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDomain

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

Parameters:

deleteDomainRequest -

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteIntegration

DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)

Removes an integration from a specific domain.

Parameters:

deleteIntegrationRequest -

Returns:

Result of the DeleteIntegration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProfile

DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)

Deletes the standard customer profile and all data pertaining to the profile.

Parameters:

deleteProfileRequest -

Returns:

Result of the DeleteProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProfileKey

DeleteProfileKeyResult deleteProfileKey(DeleteProfileKeyRequest deleteProfileKeyRequest)

Removes a searchable key from a customer profile.

Parameters:

deleteProfileKeyRequest -

Returns:

Result of the DeleteProfileKey operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProfileObject

DeleteProfileObjectResult deleteProfileObject(DeleteProfileObjectRequest deleteProfileObjectRequest)

Removes an object associated with a profile of a given ProfileObjectType.

Parameters:

deleteProfileObjectRequest -

Returns:

Result of the DeleteProfileObject operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProfileObjectType

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.

Parameters:

deleteProfileObjectTypeRequest -

Returns:

Result of the DeleteProfileObjectType operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteWorkflow

DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest deleteWorkflowRequest)

Deletes the specified workflow and all its corresponding resources. This is an async process.

Parameters:

deleteWorkflowRequest -

Returns:

Result of the DeleteWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAutoMergingPreview

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.

Parameters:

getAutoMergingPreviewRequest -

Returns:

Result of the GetAutoMergingPreview operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDomain

GetDomainResult getDomain(GetDomainRequest getDomainRequest)

Returns information about a specific domain.

Parameters:

getDomainRequest -

Returns:

Result of the GetDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getIdentityResolutionJob

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.

Parameters:

getIdentityResolutionJobRequest -

Returns:

Result of the GetIdentityResolutionJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getIntegration

GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)

Returns an integration for a domain.

Parameters:

getIntegrationRequest -

Returns:

Result of the GetIntegration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getMatches

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 [email protected] and [email protected], or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

Parameters:

getMatchesRequest -

Returns:

Result of the GetMatches operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getProfileObjectType

GetProfileObjectTypeResult getProfileObjectType(GetProfileObjectTypeRequest getProfileObjectTypeRequest)

Returns the object types for a specific domain.

Parameters:

getProfileObjectTypeRequest -

Returns:

Result of the GetProfileObjectType operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getProfileObjectTypeTemplate

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.

Parameters:

getProfileObjectTypeTemplateRequest -

Returns:

Result of the GetProfileObjectTypeTemplate operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkflow

GetWorkflowResult getWorkflow(GetWorkflowRequest getWorkflowRequest)

Get details of specified workflow.

Parameters:

getWorkflowRequest -

Returns:

Result of the GetWorkflow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkflowSteps

GetWorkflowStepsResult getWorkflowSteps(GetWorkflowStepsRequest getWorkflowStepsRequest)

Get granular list of steps in workflow.

Parameters:

getWorkflowStepsRequest -

Returns:

Result of the GetWorkflowSteps operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAccountIntegrations

ListAccountIntegrationsResult listAccountIntegrations(ListAccountIntegrationsRequest listAccountIntegrationsRequest)

Lists all of the integrations associated to a specific URI in the AWS account.

Parameters:

listAccountIntegrationsRequest -

Returns:

Result of the ListAccountIntegrations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDomains

ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)

Returns a list of all the domains for an AWS account that have been created.

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listIdentityResolutionJobs

ListIdentityResolutionJobsResult listIdentityResolutionJobs(ListIdentityResolutionJobsRequest listIdentityResolutionJobsRequest)

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

Parameters:

listIdentityResolutionJobsRequest -

Returns:

Result of the ListIdentityResolutionJobs operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listIntegrations

ListIntegrationsResult listIntegrations(ListIntegrationsRequest listIntegrationsRequest)

Lists all of the integrations in your domain.

Parameters:

listIntegrationsRequest -

Returns:

Result of the ListIntegrations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listProfileObjectTypeTemplates

ListProfileObjectTypeTemplatesResult listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest listProfileObjectTypeTemplatesRequest)

Lists all of the template information for object types.

Parameters:

listProfileObjectTypeTemplatesRequest -

Returns:

Result of the ListProfileObjectTypeTemplates operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listProfileObjectTypes

ListProfileObjectTypesResult listProfileObjectTypes(ListProfileObjectTypesRequest listProfileObjectTypesRequest)

Lists all of the templates available within the service.

Parameters:

listProfileObjectTypesRequest -

Returns:

Result of the ListProfileObjectTypes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listProfileObjects

ListProfileObjectsResult listProfileObjects(ListProfileObjectsRequest listProfileObjectsRequest)

Returns a list of objects associated with a profile of a given ProfileObjectType.

Parameters:

listProfileObjectsRequest -

Returns:

Result of the ListProfileObjects operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

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.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - An internal service error occurred.

BadRequestException - The input you provided is invalid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

listWorkflows

ListWorkflowsResult listWorkflows(ListWorkflowsRequest listWorkflowsRequest)

Query to list all workflows.

Parameters:

listWorkflowsRequest -

Returns:

Result of the ListWorkflows operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

mergeProfiles

MergeProfilesResult mergeProfiles(MergeProfilesRequest mergeProfilesRequest)

Runs an AWS Lambda job that does the following:

1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

2. All the objects in the ProfileToBeMerged will be moved to the main profile.

3. All the ProfileToBeMerged will be deleted at the end.

4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

5. Standard fields are merged as follows:

   1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

   2. When there are conflicting fields:

      1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

      2. 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).

Parameters:

mergeProfilesRequest -

Returns:

Result of the MergeProfiles operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putIntegration

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.

Parameters:

putIntegrationRequest -

Returns:

Result of the PutIntegration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putProfileObject

PutProfileObjectResult putProfileObject(PutProfileObjectRequest putProfileObjectRequest)

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional CTRs with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Parameters:

putProfileObjectRequest -

Returns:

Result of the PutProfileObject operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putProfileObjectType

PutProfileObjectTypeResult putProfileObjectType(PutProfileObjectTypeRequest putProfileObjectTypeRequest)

Defines a ProfileObjectType.

Parameters:

putProfileObjectTypeRequest -

Returns:

Result of the PutProfileObjectType operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

searchProfiles

SearchProfilesResult searchProfiles(SearchProfilesRequest searchProfilesRequest)

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

Parameters:

searchProfilesRequest -

Returns:

Result of the SearchProfiles operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - An internal service error occurred.

BadRequestException - The input you provided is invalid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

untagResource

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - An internal service error occurred.

BadRequestException - The input you provided is invalid.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

updateDomain

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.

Parameters:

updateDomainRequest -

Returns:

Result of the UpdateDomain operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateProfile

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.

Parameters:

updateProfileRequest -

Returns:

Result of the UpdateProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.