customerprofiles/aws.sdk.kotlin.services.customerprofiles

Package-level declarations

Types

Link copied to clipboard
interface CustomerProfilesClient : SdkClient

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 review the Amazon Connect Administrator Guide.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun CustomerProfilesClient.addProfileKey(crossinline block: AddProfileKeyRequest.Builder.() -> Unit): AddProfileKeyResponse

Associates a new key value with a specific profile, such as a Contact Record ContactId.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.createCalculatedAttributeDefinition(crossinline block: CreateCalculatedAttributeDefinitionRequest.Builder.() -> Unit): CreateCalculatedAttributeDefinitionResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.createDomain(crossinline block: CreateDomainRequest.Builder.() -> Unit): CreateDomainResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.createEventStream(crossinline block: CreateEventStreamRequest.Builder.() -> Unit): CreateEventStreamResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.createIntegrationWorkflow(crossinline block: CreateIntegrationWorkflowRequest.Builder.() -> Unit): CreateIntegrationWorkflowResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.createProfile(crossinline block: CreateProfileRequest.Builder.() -> Unit): CreateProfileResponse

Creates a standard profile.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteCalculatedAttributeDefinition(crossinline block: DeleteCalculatedAttributeDefinitionRequest.Builder.() -> Unit): DeleteCalculatedAttributeDefinitionResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteDomain(crossinline block: DeleteDomainRequest.Builder.() -> Unit): DeleteDomainResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteEventStream(crossinline block: DeleteEventStreamRequest.Builder.() -> Unit): DeleteEventStreamResponse

Disables and deletes the specified event stream.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteIntegration(crossinline block: DeleteIntegrationRequest.Builder.() -> Unit): DeleteIntegrationResponse

Removes an integration from a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteProfile(crossinline block: DeleteProfileRequest.Builder.() -> Unit): DeleteProfileResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteProfileKey(crossinline block: DeleteProfileKeyRequest.Builder.() -> Unit): DeleteProfileKeyResponse

Removes a searchable key from a customer profile.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteProfileObject(crossinline block: DeleteProfileObjectRequest.Builder.() -> Unit): DeleteProfileObjectResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteProfileObjectType(crossinline block: DeleteProfileObjectTypeRequest.Builder.() -> Unit): DeleteProfileObjectTypeResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.deleteWorkflow(crossinline block: DeleteWorkflowRequest.Builder.() -> Unit): DeleteWorkflowResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.detectProfileObjectType(crossinline block: DetectProfileObjectTypeRequest.Builder.() -> Unit): DetectProfileObjectTypeResponse

The process of detecting profile object type mapping by using given objects.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getAutoMergingPreview(crossinline block: GetAutoMergingPreviewRequest.Builder.() -> Unit): GetAutoMergingPreviewResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getCalculatedAttributeDefinition(crossinline block: GetCalculatedAttributeDefinitionRequest.Builder.() -> Unit): GetCalculatedAttributeDefinitionResponse

Provides more information on a calculated attribute definition for Customer Profiles.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getCalculatedAttributeForProfile(crossinline block: GetCalculatedAttributeForProfileRequest.Builder.() -> Unit): GetCalculatedAttributeForProfileResponse

Retrieve a calculated attribute for a customer profile.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getDomain(crossinline block: GetDomainRequest.Builder.() -> Unit): GetDomainResponse

Returns information about a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getEventStream(crossinline block: GetEventStreamRequest.Builder.() -> Unit): GetEventStreamResponse

Returns information about the specified event stream in a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getIdentityResolutionJob(crossinline block: GetIdentityResolutionJobRequest.Builder.() -> Unit): GetIdentityResolutionJobResponse

Returns information about an Identity Resolution Job in a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getIntegration(crossinline block: GetIntegrationRequest.Builder.() -> Unit): GetIntegrationResponse

Returns an integration for a domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getMatches(crossinline block: GetMatchesRequest.Builder.() -> Unit): GetMatchesResponse

Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getProfileObjectType(crossinline block: GetProfileObjectTypeRequest.Builder.() -> Unit): GetProfileObjectTypeResponse

Returns the object types for a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getProfileObjectTypeTemplate(crossinline block: GetProfileObjectTypeTemplateRequest.Builder.() -> Unit): GetProfileObjectTypeTemplateResponse

Returns the template information for a specific object type.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getSimilarProfiles(crossinline block: GetSimilarProfilesRequest.Builder.() -> Unit): GetSimilarProfilesResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getWorkflow(crossinline block: GetWorkflowRequest.Builder.() -> Unit): GetWorkflowResponse

Get details of specified workflow.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.getWorkflowSteps(crossinline block: GetWorkflowStepsRequest.Builder.() -> Unit): GetWorkflowStepsResponse

Get granular list of steps in workflow.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listAccountIntegrations(crossinline block: ListAccountIntegrationsRequest.Builder.() -> Unit): ListAccountIntegrationsResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listCalculatedAttributeDefinitions(crossinline block: ListCalculatedAttributeDefinitionsRequest.Builder.() -> Unit): ListCalculatedAttributeDefinitionsResponse

Lists calculated attribute definitions for Customer Profiles

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listCalculatedAttributesForProfile(crossinline block: ListCalculatedAttributesForProfileRequest.Builder.() -> Unit): ListCalculatedAttributesForProfileResponse

Retrieve a list of calculated attributes for a customer profile.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listEventStreams(crossinline block: ListEventStreamsRequest.Builder.() -> Unit): ListEventStreamsResponse

Returns a list of all the event streams in a specific domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listIdentityResolutionJobs(crossinline block: ListIdentityResolutionJobsRequest.Builder.() -> Unit): ListIdentityResolutionJobsResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listIntegrations(crossinline block: ListIntegrationsRequest.Builder.() -> Unit): ListIntegrationsResponse

Lists all of the integrations in your domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listProfileObjects(crossinline block: ListProfileObjectsRequest.Builder.() -> Unit): ListProfileObjectsResponse

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

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listProfileObjectTypes(crossinline block: ListProfileObjectTypesRequest.Builder.() -> Unit): ListProfileObjectTypesResponse

Lists all of the templates available within the service.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listProfileObjectTypeTemplates(crossinline block: ListProfileObjectTypeTemplatesRequest.Builder.() -> Unit): ListProfileObjectTypeTemplatesResponse

Lists all of the template information for object types.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listRuleBasedMatches(crossinline block: ListRuleBasedMatchesRequest.Builder.() -> Unit): ListRuleBasedMatchesResponse

Returns a set of MatchIds that belong to the given domain.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.listWorkflows(crossinline block: ListWorkflowsRequest.Builder.() -> Unit): ListWorkflowsResponse

Query to list all workflows.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.mergeProfiles(crossinline block: MergeProfilesRequest.Builder.() -> Unit): MergeProfilesResponse

Runs an AWS Lambda job that does the following:

Link copied to clipboard
inline suspend fun CustomerProfilesClient.putIntegration(crossinline block: PutIntegrationRequest.Builder.() -> Unit): PutIntegrationResponse

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.putProfileObject(crossinline block: PutProfileObjectRequest.Builder.() -> Unit): PutProfileObjectResponse

Adds additional objects to customer profiles of a given ObjectType.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.putProfileObjectType(crossinline block: PutProfileObjectTypeRequest.Builder.() -> Unit): PutProfileObjectTypeResponse

Defines a ProfileObjectType.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.searchProfiles(crossinline block: SearchProfilesRequest.Builder.() -> Unit): SearchProfilesResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.updateCalculatedAttributeDefinition(crossinline block: UpdateCalculatedAttributeDefinitionRequest.Builder.() -> Unit): UpdateCalculatedAttributeDefinitionResponse

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.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.updateDomain(crossinline block: UpdateDomainRequest.Builder.() -> Unit): UpdateDomainResponse

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

Link copied to clipboard
inline suspend fun CustomerProfilesClient.updateProfile(crossinline block: UpdateProfileRequest.Builder.() -> Unit): UpdateProfileResponse

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

Link copied to clipboard
fun CustomerProfilesClient.withConfig(block: CustomerProfilesClient.Config.Builder.() -> Unit): CustomerProfilesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.