aws customer-profiles
Customer Profiles actions Customer Profiles data types Connect Customer 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 Connect Customer contact center. AWS CLI reference
115 commands Its page in the AWS CLI reference
Commands
add-profile-keyAssociates a new key value with a specific profile, such as a Contact Record ContactId.associate-stream-for-segmentsAssociates an Amazon Kinesis data stream to receive segment membership events for a given domain.batch-get-calculated-attribute-for-profileFetch the possible attribute values given the attribute name.batch-get-profileGet a batch of profiles.batch-put-profile-objectAdds multiple profile objects to a domain of a given ObjectType in a single API call.create-calculated-attribute-definitionCreates a new calculated attribute definition.create-domainCreates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.create-domain-layoutCreates the layout to view data for a specific domain.create-event-streamCreates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Connect Customer Customer Profiles.create-event-triggerCreates an event trigger, which specifies the rules when to perform action based on customer's ingested data.create-integration-workflowCreates an integration workflow.create-profileCreates a standard profile.create-recommenderCreates a recommendercreate-recommender-filterCreates a recommender filter.create-recommender-schemaCreates a recommender schema.create-segment-definitionCreates a segment definition associated to the given domain.create-segment-estimateCreates a segment estimate query.create-segment-snapshotTriggers a job to export a segment to a specified destination.create-upload-jobCreates an Upload job to ingest data for segment imports.delete-calculated-attribute-definitionDeletes an existing calculated attribute definition.delete-domainDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.delete-domain-layoutDeletes the layout used to view data for a specific domain.delete-domain-object-typeDelete a DomainObjectType for the given Domain and ObjectType name.delete-event-streamDisables and deletes the specified event stream.delete-event-triggerDisable and deletes the Event Trigger.delete-integrationRemoves an integration from a specific domain.delete-profileDeletes the standard customer profile and all data pertaining to the profile.delete-profile-keyRemoves a searchable key from a customer profile.delete-profile-objectRemoves an object associated with a profile of a given ProfileObjectType.delete-profile-object-typeRemoves a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.delete-recommenderDeletes a recommender.delete-recommender-filterDeletes a recommender filter from a domain.delete-recommender-schemaDeletes a recommender schema from a domain.delete-segment-definitionDeletes a segment definition from the domain.delete-segment-subscriptionDeletes a segment subscription for membership events.delete-workflowDeletes the specified workflow and all its corresponding resources.detect-profile-object-typeThe process of detecting profile object type mapping by using given objects.disassociate-stream-for-segmentsDisassociates the Amazon Kinesis data stream configured for segment membership events.get-auto-merging-previewTests the auto-merging settings of your Identity Resolution Job without merging your data.get-calculated-attribute-definitionProvides more information on a calculated attribute definition for Customer Profiles.get-calculated-attribute-for-profileRetrieve a calculated attribute for a customer profile.get-domainReturns information about a specific domain.get-domain-layoutGets the layout to view data for a specific domain.get-domain-object-typeReturn a DomainObjectType for the input Domain and ObjectType names.get-event-streamReturns information about the specified event stream in a specific domain.get-event-triggerGet a specific Event Trigger from the domain.get-identity-resolution-jobReturns information about an Identity Resolution Job in a specific domain.get-integrationReturns an integration for a domain.get-matchesBefore calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.get-object-type-attribute-statisticsThe GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled.get-profile-history-recordReturns a history record for a specific profile, for a specific domain.get-profile-object-typeReturns the object types for a specific domain.get-profile-object-type-templateReturns the template information for a specific object type.get-profile-recommendationsFetches the recommendations for a profile in the input Customer Profiles domain.get-recommenderRetrieves a recommender.get-recommender-filterRetrieves information about a specific recommender filter in a domain.get-recommender-schemaRetrieves information about a specific recommender schema in a domain.get-segment-definitionGets a segment definition from the domain.get-segment-estimateGets the result of a segment estimate query.get-segment-membershipDetermines if the given profiles are within a segment.get-segment-snapshotRetrieve the latest status of a segment snapshot.get-segment-subscriptionReturns the current subscription configuration, execution schedule, and status for segment membership events.get-similar-profilesReturns a set of profiles that belong to the same matching group using the matchId or profileId.get-stream-for-segmentsReturns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments.get-upload-jobThis API retrieves the details of a specific upload job.get-upload-job-pathThis API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.get-workflowGet details of specified workflow.get-workflow-stepsGet granular list of steps in workflow.list-account-integrationsLists all of the integrations associated to a specific URI in the AWS account.list-calculated-attribute-definitionsLists calculated attribute definitions for Customer Profileslist-calculated-attributes-for-profileRetrieve a list of calculated attributes for a customer profile.list-domain-layoutsLists the existing layouts that can be used to view data for a specific domain.list-domain-object-typesList all DomainObjectType(s) in a Customer Profiles domain.list-domainsReturns a list of all the domains for an AWS account that have been created.list-event-streamsReturns a list of all the event streams in a specific domain.list-event-triggersList all Event Triggers under a domain.list-identity-resolution-jobsLists all of the Identity Resolution Jobs in your domain.list-integrationsLists all of the integrations in your domain.list-object-type-attribute-valuesThe ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types.list-object-type-attributesFetch the possible attribute values given the attribute name.list-profile-attribute-valuesFetch the possible attribute values given the attribute name.list-profile-history-recordsReturns a list of history records for a specific profile, for a specific domain.list-profile-object-type-templatesLists all of the template information for object types.list-profile-object-typesLists all of the templates available within the service.list-profile-objectsReturns a list of objects associated with a profile of a given ProfileObjectType.list-recommender-filtersReturns a list of recommender filters in the specified domain.list-recommender-recipesReturns a list of available recommender recipes that can be used to create recommenders.list-recommender-schemasReturns a list of recommender schemas in the specified domain.list-recommendersReturns a list of recommenders in the specified domain.list-rule-based-matchesReturns a set of MatchIds that belong to the given domain.list-segment-definitionsLists all segment definitions under a domain.list-segment-subscription-eventsReturns the most recent membership events for a segment.list-tags-for-resourceDisplays the tags associated with an Amazon Connect Customer Profiles resource.list-upload-jobsThis API retrieves a list of upload jobs for the specified domain.list-workflowsQuery to list all workflows.merge-profilesRuns an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved to the main profile.put-domain-object-typeCreate/Update a DomainObjectType in a Customer Profiles domain.put-integrationAdds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.put-profile-objectAdds additional objects to customer profiles of a given ObjectType.put-profile-object-typeDefines a ProfileObjectType.put-segment-subscriptionCreates or updates a segment subscription for membership events.search-profilesSearches 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.search-recommendationsRetrieves recommendations for a profile in a specific domain.start-recommenderStarts a recommender that was previously stopped.start-upload-jobThis API starts the processing of an upload job to ingest profile data.stop-recommenderStops a recommender, suspending its ability to generate recommendations.stop-upload-jobThis API stops the processing of an upload job.tag-resourceAssigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.untag-resourceRemoves one or more tags from the specified Amazon Connect Customer Profiles resource.update-calculated-attribute-definitionUpdates an existing calculated attribute definition.update-domainUpdates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.update-domain-layoutUpdates the layout used to view data for a specific domain.update-event-triggerUpdate the properties of an Event Trigger.update-profileUpdates the properties of a profile.update-recommenderUpdates the properties of an existing recommender, allowing you to modify its configuration and description.