View a markdown version of this page

Data retrieval APIs for Amazon Connect Customer Profiles - AWS Online Register of Data Formats

Data retrieval APIs for Amazon Connect Customer Profiles

Amazon Connect Customer Profiles provides the following APIs for data retrieval.

Actions Description Access level
BatchGetCalculatedAttributeForProfileRetrieve a calculated attribute for the specific profiles in the domainRead
BatchGetProfileGet profiles in the domainRead
DetectProfileObjectTypeAuto detect object typeRead
GetAutoMergingPreviewGet a preview of auto merging in a domainRead
GetCalculatedAttributeDefinitionGet a calculated attribute definition in the domainRead
GetCalculatedAttributeForProfileRetrieve a calculated attribute for a specific profile in the domainRead
GetDomainGet a specific domain in an accountRead
GetDomainLayoutGet a layout in the domainRead
GetDomainObjectTypeGet a specific domain object type in the domainRead
GetEventStreamGet a specific event stream in a domainRead
GetEventTriggerGet an event trigger in the domainRead
GetIdentityResolutionJobGet an identity resolution job in a domainRead
GetIntegrationGet a specific integrations in a domainRead
GetMatchesGet profile matches in a domainList
GetObjectTypeAttributeStatisticsGet statistics of a specific attribute for object type in the domainRead
GetProfileHistoryRecordGet a profile history record for a profile in a domainRead
GetProfileInsightsList insights for a profileRead
GetProfileObjectTypeGet a specific profile object type in the domainRead
GetProfileObjectTypeTemplateGet a specific object type templateRead
GetProfileRecommendationsList recommendations for a profileRead
GetRecommenderGet Recommender details in a domainRead
GetRecommenderFilterGet recommender filter details in the domainRead
GetRecommenderSchemaGet recommender schema details in the domainRead
GetSegmentDefinitionGet a segment definition in the domainRead
GetSegmentEstimateGet a segment estimate in the domainRead
GetSegmentMembershipDetermine if the given profiles are part of a segment in the domainRead
GetSegmentSnapshotGet a segment snapshot in the domainRead
GetSimilarProfilesGet all the similar profiles in the domainList
GetSnapshotGet a snapshot in the domainRead
GetUploadJobGet details of an upload job in the domainRead
GetUploadJobPathGet a pre-signed URL to upload file for an upload jobRead
GetWorkflowGet workflow details in a domainRead
GetWorkflowStepsGet workflow step details in a domainRead
ListAccountIntegrationsList all the integrations in the accountList
ListCalculatedAttributeDefinitionsList all the calculated attribute definitions in the domainList
ListCalculatedAttributesForProfileList all calculated attributes for a specific profile in the domainList
ListDomainLayoutsList all the layouts in the domainList
ListDomainObjectTypesList all the domain object types in the domainList
ListDomainObjectsList domain objects in a domainList
ListDomainsList all the domains in an accountList
ListEventStreamsList all the event streams in a specific domainList
ListEventTriggersList all the event triggers in the domainList
ListIdentityResolutionJobsList identity resolution jobs in a domainList
ListIntegrationsList all the integrations in a specific domainList
ListObjectTypeAttributeValuesList values of a specific attribute for object type in the domainList
ListObjectTypeAttributesList all the attributes of a specific object type in the domainList
ListProfileAttributeValuesList all the values of a profile attribute in the domainList
ListProfileHistoryRecordsList all the profile history records for a profile in a domainList
ListProfileObjectTypeTemplatesList all the profile object type templates in the accountList
ListProfileObjectTypesList all the profile object types in the domainList
ListProfileObjectsList all the profile objects for a profileList
ListRecommenderFiltersList all recommender filters in the domainList
ListRecommenderRecipesList all the Recommenders Recipes in the domainList
ListRecommenderSchemasList all recommender schemas in the domainList
ListRecommendersList all the Recommenders in the domainList
ListRuleBasedMatchesList all the rule-based matching result in the domainList
ListSegmentDefinitionsList all the segment definitions in the domainList
ListTagsForResourceList tags for a resourceRead
ListUploadJobsList all upload jobs in the domainList
ListWorkflowsList all the workflows in a specific domainList
SearchProfilesSearch for profiles in a domainRead