AbstractAmazonCustomerProfiles (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.customerprofiles.AbstractAmazonCustomerProfiles

All Implemented Interfaces:

AmazonCustomerProfiles

Direct Known Subclasses:

AbstractAmazonCustomerProfilesAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCustomerProfiles
extends Object
implements AmazonCustomerProfiles
```
Abstract implementation of AmazonCustomerProfiles. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.customerprofiles.AmazonCustomerProfiles
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addProfileKey
```
public AddProfileKeyResult addProfileKey(AddProfileKeyRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    addProfileKey in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the AddProfileKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCalculatedAttributeDefinition
```
public CreateCalculatedAttributeDefinitionResult createCalculatedAttributeDefinition(CreateCalculatedAttributeDefinitionRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    createCalculatedAttributeDefinition in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the CreateCalculatedAttributeDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDomain
```
public CreateDomainResult createDomain(CreateDomainRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    createDomain in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEventStream
```
public CreateEventStreamResult createEventStream(CreateEventStreamRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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
    
    Specified by:
    
    createEventStream in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the CreateEventStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createIntegrationWorkflow
```
public CreateIntegrationWorkflowResult createIntegrationWorkflow(CreateIntegrationWorkflowRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    createIntegrationWorkflow in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the CreateIntegrationWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProfile
```
public CreateProfileResult createProfile(CreateProfileRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Creates a standard profile.
    
    A standard profile represents the following attributes for a customer profile in a domain.
    
    Specified by:
    
    createProfile in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the CreateProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCalculatedAttributeDefinition
```
public DeleteCalculatedAttributeDefinitionResult deleteCalculatedAttributeDefinition(DeleteCalculatedAttributeDefinitionRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    deleteCalculatedAttributeDefinition in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteCalculatedAttributeDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDomain
```
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.
    
    Specified by:
    
    deleteDomain in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEventStream
```
public DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Disables and deletes the specified event stream.
    
    Specified by:
    
    deleteEventStream in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteEventStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteIntegration
```
public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Removes an integration from a specific domain.
    
    Specified by:
    
    deleteIntegration in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteIntegration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfile
```
public DeleteProfileResult deleteProfile(DeleteProfileRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Deletes the standard customer profile and all data pertaining to the profile.
    
    Specified by:
    
    deleteProfile in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfileKey
```
public DeleteProfileKeyResult deleteProfileKey(DeleteProfileKeyRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Removes a searchable key from a customer profile.
    
    Specified by:
    
    deleteProfileKey in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteProfileKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfileObject
```
public DeleteProfileObjectResult deleteProfileObject(DeleteProfileObjectRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Removes an object associated with a profile of a given ProfileObjectType.
    
    Specified by:
    
    deleteProfileObject in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteProfileObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfileObjectType
```
public DeleteProfileObjectTypeResult deleteProfileObjectType(DeleteProfileObjectTypeRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    deleteProfileObjectType in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteProfileObjectType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkflow
```
public DeleteWorkflowResult deleteWorkflow(DeleteWorkflowRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Deletes the specified workflow and all its corresponding resources. This is an async process.
    
    Specified by:
    
    deleteWorkflow in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DeleteWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectProfileObjectType
```
public DetectProfileObjectTypeResult detectProfileObjectType(DetectProfileObjectTypeRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    The process of detecting profile object type mapping by using given objects.
    
    Specified by:
    
    detectProfileObjectType in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the DetectProfileObjectType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAutoMergingPreview
```
public GetAutoMergingPreviewResult getAutoMergingPreview(GetAutoMergingPreviewRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    getAutoMergingPreview in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetAutoMergingPreview operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCalculatedAttributeDefinition
```
public GetCalculatedAttributeDefinitionResult getCalculatedAttributeDefinition(GetCalculatedAttributeDefinitionRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Provides more information on a calculated attribute definition for Customer Profiles.
    
    Specified by:
    
    getCalculatedAttributeDefinition in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetCalculatedAttributeDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCalculatedAttributeForProfile
```
public GetCalculatedAttributeForProfileResult getCalculatedAttributeForProfile(GetCalculatedAttributeForProfileRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Retrieve a calculated attribute for a customer profile.
    
    Specified by:
    
    getCalculatedAttributeForProfile in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetCalculatedAttributeForProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDomain
```
public GetDomainResult getDomain(GetDomainRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns information about a specific domain.
    
    Specified by:
    
    getDomain in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEventStream
```
public GetEventStreamResult getEventStream(GetEventStreamRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns information about the specified event stream in a specific domain.
    
    Specified by:
    
    getEventStream in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetEventStream operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIdentityResolutionJob
```
public GetIdentityResolutionJobResult getIdentityResolutionJob(GetIdentityResolutionJobRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    getIdentityResolutionJob in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetIdentityResolutionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIntegration
```
public GetIntegrationResult getIntegration(GetIntegrationRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns an integration for a domain.
    
    Specified by:
    
    getIntegration in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetIntegration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getMatches
```
public GetMatchesResult getMatches(GetMatchesRequest request)
```
    Description copied from interface: 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 [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.
    Specified by:
    
    getMatches in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetMatches operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getProfileObjectType
```
public GetProfileObjectTypeResult getProfileObjectType(GetProfileObjectTypeRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns the object types for a specific domain.
    
    Specified by:
    
    getProfileObjectType in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetProfileObjectType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getProfileObjectTypeTemplate
```
public GetProfileObjectTypeTemplateResult getProfileObjectTypeTemplate(GetProfileObjectTypeTemplateRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    getProfileObjectTypeTemplate in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetProfileObjectTypeTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSimilarProfiles
```
public GetSimilarProfilesResult getSimilarProfiles(GetSimilarProfilesRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getSimilarProfiles in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetSimilarProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWorkflow
```
public GetWorkflowResult getWorkflow(GetWorkflowRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Get details of specified workflow.
    
    Specified by:
    
    getWorkflow in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetWorkflow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWorkflowSteps
```
public GetWorkflowStepsResult getWorkflowSteps(GetWorkflowStepsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Get granular list of steps in workflow.
    
    Specified by:
    
    getWorkflowSteps in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the GetWorkflowSteps operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccountIntegrations
```
public ListAccountIntegrationsResult listAccountIntegrations(ListAccountIntegrationsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists all of the integrations associated to a specific URI in the AWS account.
    
    Specified by:
    
    listAccountIntegrations in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListAccountIntegrations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCalculatedAttributeDefinitions
```
public ListCalculatedAttributeDefinitionsResult listCalculatedAttributeDefinitions(ListCalculatedAttributeDefinitionsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists calculated attribute definitions for Customer Profiles
    
    Specified by:
    
    listCalculatedAttributeDefinitions in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListCalculatedAttributeDefinitions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCalculatedAttributesForProfile
```
public ListCalculatedAttributesForProfileResult listCalculatedAttributesForProfile(ListCalculatedAttributesForProfileRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Retrieve a list of calculated attributes for a customer profile.
    
    Specified by:
    
    listCalculatedAttributesForProfile in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListCalculatedAttributesForProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDomains
```
public ListDomainsResult listDomains(ListDomainsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns a list of all the domains for an AWS account that have been created.
    
    Specified by:
    
    listDomains in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListDomains operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventStreams
```
public ListEventStreamsResult listEventStreams(ListEventStreamsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns a list of all the event streams in a specific domain.
    
    Specified by:
    
    listEventStreams in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListEventStreams operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIdentityResolutionJobs
```
public ListIdentityResolutionJobsResult listIdentityResolutionJobs(ListIdentityResolutionJobsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.
    
    Specified by:
    
    listIdentityResolutionJobs in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListIdentityResolutionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIntegrations
```
public ListIntegrationsResult listIntegrations(ListIntegrationsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists all of the integrations in your domain.
    
    Specified by:
    
    listIntegrations in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListIntegrations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProfileObjectTypeTemplates
```
public ListProfileObjectTypeTemplatesResult listProfileObjectTypeTemplates(ListProfileObjectTypeTemplatesRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists all of the template information for object types.
    
    Specified by:
    
    listProfileObjectTypeTemplates in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListProfileObjectTypeTemplates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProfileObjectTypes
```
public ListProfileObjectTypesResult listProfileObjectTypes(ListProfileObjectTypesRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Lists all of the templates available within the service.
    
    Specified by:
    
    listProfileObjectTypes in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListProfileObjectTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProfileObjects
```
public ListProfileObjectsResult listProfileObjects(ListProfileObjectsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns a list of objects associated with a profile of a given ProfileObjectType.
    
    Specified by:
    
    listProfileObjects in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListProfileObjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuleBasedMatches
```
public ListRuleBasedMatchesResult listRuleBasedMatches(ListRuleBasedMatchesRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Returns a set of MatchIds that belong to the given domain.
    
    Specified by:
    
    listRuleBasedMatches in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListRuleBasedMatches operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.
    
    Specified by:
    
    listTagsForResource in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkflows
```
public ListWorkflowsResult listWorkflows(ListWorkflowsRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Query to list all workflows.
    
    Specified by:
    
    listWorkflows in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the ListWorkflows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - mergeProfiles
```
public MergeProfilesResult mergeProfiles(MergeProfilesRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    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:
      
      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).
    Specified by:
    
    mergeProfiles in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the MergeProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putIntegration
```
public PutIntegrationResult putIntegration(PutIntegrationRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    putIntegration in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the PutIntegration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putProfileObject
```
public PutProfileObjectResult putProfileObject(PutProfileObjectRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    putProfileObject in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the PutProfileObject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putProfileObjectType
```
public PutProfileObjectTypeResult putProfileObjectType(PutProfileObjectTypeRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    Defines a ProfileObjectType.
    
    To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
    
    Specified by:
    
    putProfileObjectType in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the PutProfileObjectType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchProfiles
```
public SearchProfilesResult searchProfiles(SearchProfilesRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    searchProfiles in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the SearchProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    untagResource in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCalculatedAttributeDefinition
```
public UpdateCalculatedAttributeDefinitionResult updateCalculatedAttributeDefinition(UpdateCalculatedAttributeDefinitionRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    updateCalculatedAttributeDefinition in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the UpdateCalculatedAttributeDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDomain
```
public UpdateDomainResult updateDomain(UpdateDomainRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    updateDomain in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the UpdateDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateProfile
```
public UpdateProfileResult updateProfile(UpdateProfileRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    updateProfile in interface AmazonCustomerProfiles
    
    Returns:
    
    Result of the UpdateProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonCustomerProfiles
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCustomerProfiles
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCustomerProfiles
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.679

Class AbstractAmazonCustomerProfiles

Field Summary

Fields inherited from interface com.amazonaws.services.customerprofiles.AmazonCustomerProfiles

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addProfileKey

createCalculatedAttributeDefinition

createDomain

createEventStream

createIntegrationWorkflow

createProfile

deleteCalculatedAttributeDefinition

deleteDomain

deleteEventStream

deleteIntegration

deleteProfile

deleteProfileKey

deleteProfileObject

deleteProfileObjectType

deleteWorkflow

detectProfileObjectType

getAutoMergingPreview

getCalculatedAttributeDefinition

getCalculatedAttributeForProfile

getDomain

getEventStream

getIdentityResolutionJob

getIntegration

getMatches

getProfileObjectType

getProfileObjectTypeTemplate

getSimilarProfiles

getWorkflow

getWorkflowSteps

listAccountIntegrations

listCalculatedAttributeDefinitions

listCalculatedAttributesForProfile

listDomains

listEventStreams

listIdentityResolutionJobs

listIntegrations

listProfileObjectTypeTemplates

listProfileObjectTypes

listProfileObjects

listRuleBasedMatches

listTagsForResource

listWorkflows

mergeProfiles

putIntegration

putProfileObject

putProfileObjectType

searchProfiles

tagResource

untagResource

updateCalculatedAttributeDefinition

updateDomain

updateProfile

shutdown

getCachedResponseMetadata