Module Awso_customer_profiles_lwtSource

include module type of struct include Values end
include module type of struct include Awso_customer_profiles.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Overrides the original range on a calculated attribute definition.

Sourcemodule String_ = Awso_customer_profiles.Values.String_

An object to override the original condition block of a calculated attribute.

Object to hold the dimensions of a profile's fields to segment on.

Object that segments on various Customer Profile's fields.

Sourcemodule Text = Awso_customer_profiles.Values.Text

Configuration parameters for events in the personalization system.

Object that segments on Customer Profile's Calculated Attributes.

Object that segments on Customer Profile's address object.

Object that segments on various Customer Profile's date fields.

Object that segments on various Customer profile's fields that are larger than normal.

Object to hold the dimension of a profile type field to segment on.

Object that defines how to filter the incoming objects for the calculated attribute.

The criteria that a specific object attribute must meet to trigger the destination.

Object that defines users contact preference.

The object used to segment on attributes within the customer profile.

The properties that are applied when Marketo is being used as a source.

The properties that are applied when Amazon S3 is being used as the flow source.

The properties that are applied when Salesforce is being used as a source.

The properties that are applied when ServiceNow is being used as a source.

The properties that are applied when using Zendesk as a flow source.

The operation to be performed on the provided source fields.

Specifies the configuration details of a scheduled-trigger flow that you define. Currently, these settings only apply to the scheduled-trigger type.

Configuration settings that define how events are processed and tracked.

Configuration settings for inference behavior of the recommender.

Defines a column in a recommender schema, including the target field name and optional feature and content type settings for training.

A data type pair that consists of a KeyName and Values list that were used to find a profile returned in response to a SearchProfiles request.

Object that holds what profile and calculated attributes to segment on.

The source segments to build off of.

Contains the map of attribute names to attribute dimensions.

An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.

Specifies the configuration used when importing incremental records from the source.

Specifies the information that is required to query a particular Amazon AppFlow connector. Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.

A class for modeling different type of tasks. Task implementation varies based on the TaskType.

Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.

A specific event dimension to be assessed.

Configuration settings that define the behavior and parameters of a recommender.

The S3 location where Identity Resolution Jobs write result files.

A generic address associated with the customer that is not mailing, shipping, or billing.

Object that defines users preferred methods of engagement.

Represents a field in a ProfileObjectType.

Batch defines the boundaries for ingestion for each step in APPFLOW_INTEGRATION workflow. APPFLOW_INTEGRATION workflow splits ingestion based on these boundaries.

Contains information about the configuration of the source connector used in the flow.

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Defines a limit and the time period during which it is enforced.

How the auto-merging process should resolve conflicts between different profiles.

The matching criteria to be used during the auto-merging process.

Configuration information about the S3 bucket where Identity Resolution Jobs write result files.

Specifies how does the rule-based matching process should match profiles. You can choose from the following attributes to build the matching Rule: AccountNumber Address.Address Address.City Address.Country Address.County Address.PostalCode Address.State Address.Province BirthDate BusinessName EmailAddress FirstName Gender LastName MiddleName PhoneNumber Any customized profile attributes that start with the Attributes

The details of a single attribute item specified in the mathematical expression.

A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

Contains information about an update operation performed on a recommender.

The S3 location where Identity Resolution Jobs write result files.

Statistics about the Identity Resolution Job.

Summary information about the Kinesis data stream

Workflow step details for APPFLOW_INTEGRATION workflow.

The standard profile of a customer.

Contains dimensions that determine what to segment on.

Defines the characteristics and rules for sorting by a specific attribute.

Represents an item in the catalog with its complete set of attributes and metadata.

Object that holds the dimensions to filter on.

The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

Specifies the circumstances under which the event should trigger the destination.

Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.

Configuration settings for how to perform the auto-merging of profiles.

Configuration information about the S3 bucket where Identity Resolution Jobs writes result files. You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.

The day and time when do you want to start the Identity Resolution Job every week.

Configuration information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles. You can choose how profiles are compared across attribute types and which attribute to use for matching from each type. There are three attribute types you can configure: Email type You can choose from Email, BusinessEmail, and PersonalEmail Phone number type You can choose from Phone, HomePhone, and MobilePhone Address type You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.

The relative time period over which data is included in the aggregation.

The threshold for the calculated attribute.

A data type pair that consists of a KeyName and Values list that is used in conjunction with the KeyName and Values parameters to search for profiles using the SearchProfiles API.

The standard domain object type.

List containing the values for the given attribute.

A workflow in list of workflows.

The summary information for an individual upload job.

Object holding the segment definition fields.

Provides a summary of a recommender's configuration and current state.

Provides a summary of a recommender schema's configuration and current state.

Defines the algorithm and approach used to generate recommendations.

Provides a summary of a recommender filter's configuration and current state.

A ProfileObject in a list of ProfileObjects.

A ProfileObjectType instance.

A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.

Contains profile history record metadata.

Item that contains the attribute and when it was last updated.

Represents an item in the list of object type attribute values with its associated metadata.

An integration in list of integrations.

Information about the Identity Resolution Job.

The summary of the event trigger.

An instance of EventStream in a list of EventStreams.

An object in a list that represents a domain.

Represents an item in the list of domain object types, containing basic information about a specific object type within a domain.

The layout object that contains LayoutDefinitionName, Description, DisplayName, IsDefault, LayoutType, Tags, CreatedAt, LastUpdatedAt

The details of a single calculated attribute for a profile.

The details of a single calculated attribute definition.

List containing steps in workflow.

Structure holding all APPFLOW_INTEGRATION specific workflow attributes.

Workflow specific execution metrics for APPFLOW_INTEGRATION workflow.

Object that holds failures for membership.

Object that holds the results for membership.

Contains metrics and performance indicators from the training of a recommender model.

Represents a single recommendation generated by the recommender system.

A filter that specifies criteria for including or excluding items from recommendations.

Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Sourcemodule GetObjectTypeAttributeStatisticsPercentiles = Awso_customer_profiles.Values.GetObjectTypeAttributeStatisticsPercentiles

Contains percentile statistics for object type attributes.

The Match group object.

Contains ProfileObjectType mapping information from the model.

Details for workflow of type APPFLOW_INTEGRATION.

Error object describing why a specific profile failed.

Sourcemodule BatchGetCalculatedAttributeForProfileError = Awso_customer_profiles.Values.BatchGetCalculatedAttributeForProfileError

Error object describing why a specific profile and calculated attribute failed.

The object containing the values of a single calculated attribute value.

You do not have sufficient access to perform this action.

The input you provided is invalid.

An internal service error occurred.

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

You exceeded the maximum number of requests.

Updates associated with the address properties of a customer profile.

Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.

The data store response.

The flag that enables the matching process of duplicate profiles.

The response of the Rule-based matching request.

The data store request.

The flag that enables the matching process of duplicate profiles.

The request to enable the rule-based matching.

Mathematical expression and a list of attribute items specified in that expression.

The conditions including range, object count, and threshold for the calculated attribute.

A duplicate customer profile that is to be merged into a main profile.

Sourcemodule ListRecommenderRecipesRequestMaxResultsInteger = Awso_customer_profiles.Values.ListRecommenderRecipesRequestMaxResultsInteger

The filter applied to ListProfileObjects response to include profile objects with the specified index values.

Structure to hold workflow attributes.

Generic object containing workflow execution metrics.

The summary of results for an upload job, including the number of updated, created, and failed records.

Contains all groups of the segment definition.

Defines how segments should be sorted and ordered in the results.

Sourcemodule GetRecommenderRequestTrainingMetricsCountInteger = Awso_customer_profiles.Values.GetRecommenderRequestTrainingMetricsCountInteger

Configuration for metadata to include in recommendation responses.

Statistical measurements for object type attributes including basic statistics and percentiles.

Details of the destination being used for the EventStream.

Usage-specific statistics about the domain.

Defines how to filter the objects coming in for calculated attributes.

Contains all groups of the segment definition.

Configuration data for integration workflow.

Sourcemodule BatchGetCalculatedAttributeForProfileErrorList = Awso_customer_profiles.Values.BatchGetCalculatedAttributeForProfileErrorList
Sourcemodule BatchGetCalculatedAttributeForProfileIdList = Awso_customer_profiles.Values.BatchGetCalculatedAttributeForProfileIdList

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

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.

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.

Update the properties of an Event Trigger.

Update the properties of an Event Trigger.

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.

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.

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Sourcemodule UpdateCalculatedAttributeDefinitionResponse = Awso_customer_profiles.Values.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.

Sourcemodule UpdateCalculatedAttributeDefinitionRequest = Awso_customer_profiles.Values.UpdateCalculatedAttributeDefinitionRequest

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.

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.

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.

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.

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.

This API stops the processing of an upload job.

This API stops the processing of an upload job.

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

This API starts the processing of an upload job to ingest profile data.

This API starts the processing of an upload job to ingest profile data.

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

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.

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.

Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

Defines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

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.

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.

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.

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.

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

Fetch the possible attribute values given the attribute name.

Fetch the possible attribute values given the attribute name.

Runs an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved to the main profile. All the objects in the ProfileToBeMerged will be moved to the main profile. All the ProfileToBeMerged will be deleted at the end. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile. 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).

Runs an AWS Lambda job that does the following: All the profileKeys in the ProfileToBeMerged will be moved to the main profile. All the objects in the ProfileToBeMerged will be moved to the main profile. All the ProfileToBeMerged will be deleted at the end. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile. 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).

Query to list all workflows.

Query to list all workflows.

This API retrieves a list of upload jobs for the specified domain.

This API retrieves a list of upload jobs for the specified domain.

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

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

Lists all segment definitions under a domain.

Lists all segment definitions under a domain.

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

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

Returns a list of recommenders in the specified domain.

Returns a list of recommenders in the specified domain.

Returns a list of recommender schemas in the specified domain.

Returns a list of recommender schemas in the specified domain.

Returns a list of available recommender recipes that can be used to create recommenders.

Returns a list of available recommender recipes that can be used to create recommenders.

Returns a list of recommender filters in the specified domain.

Returns a list of recommender filters in the specified domain.

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

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

Lists all of the templates available within the service.

Lists all of the templates available within the service.

Lists all of the template information for object types.

Lists all of the template information for object types.

Returns a list of history records for a specific profile, for a specific domain.

Returns a list of history records for a specific profile, for a specific domain.

Fetch the possible attribute values given the attribute name.

Fetch the possible attribute values given the attribute name.

The 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. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

The 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. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

Lists all of the integrations in your domain.

Lists all of the integrations in your domain.

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

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

List all Event Triggers under a domain.

List all Event Triggers under a domain.

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

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

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

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

List all DomainObjectType(s) in a Customer Profiles domain.

List all DomainObjectType(s) in a Customer Profiles domain.

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Sourcemodule ListCalculatedAttributesForProfileResponse = Awso_customer_profiles.Values.ListCalculatedAttributesForProfileResponse

Retrieve a list of calculated attributes for a customer profile.

Retrieve a list of calculated attributes for a customer profile.

Sourcemodule ListCalculatedAttributeDefinitionsResponse = Awso_customer_profiles.Values.ListCalculatedAttributeDefinitionsResponse

Lists calculated attribute definitions for Customer Profiles

Lists calculated attribute definitions for Customer Profiles

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

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

Get granular list of steps in workflow.

Get granular list of steps in workflow.

Get details of specified workflow.

Get details of specified workflow.

This API retrieves the details of a specific upload job.

This API retrieves the details of a specific upload job.

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.

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.

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.

Retrieve the latest status of a segment snapshot.

Retrieve the latest status of a segment snapshot.

Determines if the given profiles are within a segment.

Determines if the given profiles are within a segment.

Gets the result of a segment estimate query.

Gets the result of a segment estimate query.

Gets a segment definition from the domain.

Gets a segment definition from the domain.

Retrieves information about a specific recommender schema in a domain.

Retrieves information about a specific recommender schema in a domain.

Retrieves a recommender.

Retrieves a recommender.

Retrieves information about a specific recommender filter in a domain.

Retrieves information about a specific recommender filter in a domain.

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

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.

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.

Returns the object types for a specific domain.

Returns the object types for a specific domain.

Returns a history record for a specific profile, for a specific domain.

Returns a history record for a specific profile, for a specific domain.

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics. You'll receive null values in two scenarios: During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily). For attributes that don't contain numeric values.

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics. You'll receive null values in two scenarios: During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily). For attributes that don't contain numeric values.

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 JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, 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.

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 JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, 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.

Returns an integration for a domain.

Returns an integration for a domain.

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.

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.

Get a specific Event Trigger from the domain.

Get a specific Event Trigger from the domain.

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

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

Returns information about a specific domain.

Returns information about a specific domain.

Return a DomainObjectType for the input Domain and ObjectType names.

Return a DomainObjectType for the input Domain and ObjectType names.

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Retrieve a calculated attribute for a customer profile.

Retrieve a calculated attribute for a customer profile.

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

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

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.

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.

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

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

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

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

Deletes a segment definition from the domain.

Deletes a segment definition from the domain.

Deletes a recommender schema from a domain.

Deletes a recommender schema from a domain.

Deletes a recommender.

Deletes a recommender.

Deletes a recommender filter from a domain.

Deletes a recommender filter from a domain.

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

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

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.

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.

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

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

Removes a searchable key from a customer profile.

Removes a searchable key from a customer profile.

Removes an integration from a specific domain.

Removes an integration from a specific domain.

Disable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated.

Disable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated.

Disables and deletes the specified event stream.

Disables and deletes the specified event stream.

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

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

Delete a DomainObjectType for the given Domain and ObjectType name.

Delete a DomainObjectType for the given Domain and ObjectType name.

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Sourcemodule DeleteCalculatedAttributeDefinitionResponse = Awso_customer_profiles.Values.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.

Sourcemodule DeleteCalculatedAttributeDefinitionRequest = Awso_customer_profiles.Values.DeleteCalculatedAttributeDefinitionRequest

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.

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.

Triggers a job to export a segment to a specified destination.

Triggers a job to export a segment to a specified destination.

Creates a segment estimate query.

Creates a segment estimate query.

Creates a segment definition associated to the given domain.

Creates a segment definition associated to the given domain.

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Creates a recommender schema. A recommender schema defines the set of data columns available for training recommenders and filters under a domain.

Creates a recommender

Creates a recommender

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

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

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

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.

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.

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream.

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

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

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. It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

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. It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see Enable Customer Profiles. Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Sourcemodule CreateCalculatedAttributeDefinitionResponse = Awso_customer_profiles.Values.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.

Sourcemodule CreateCalculatedAttributeDefinitionRequest = Awso_customer_profiles.Values.CreateCalculatedAttributeDefinitionRequest

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.

Get a batch of profiles.

Get a batch of profiles.

Sourcemodule BatchGetCalculatedAttributeForProfileResponse = Awso_customer_profiles.Values.BatchGetCalculatedAttributeForProfileResponse

Fetch the possible attribute values given the attribute name.

Sourcemodule BatchGetCalculatedAttributeForProfileRequest = Awso_customer_profiles.Values.BatchGetCalculatedAttributeForProfileRequest

Fetch the possible attribute values given the attribute name.

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.

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.