Values (u.bd1fbe2ccff02fd1cddfdcb5f1e38e71.awso.0.9.1.doc.awso.customer-profiles.Awso_customer

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule End : sig ... end

Sourcemodule RangeUnit : sig ... end

Sourcemodule Start : sig ... end

Sourcemodule String1To255 : sig ... end

Sourcemodule RangeOverride : sig ... end

Overrides the original range on a calculated attribute definition.

Sourcemodule StringDimensionType : sig ... end

Sourcemodule Values : sig ... end

Sourcemodule AttributeDimensionType : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule String1To1000 : sig ... end

Sourcemodule ProfileType : sig ... end

Sourcemodule Double : sig ... end

Sourcemodule EventParametersEventTypeString : sig ... end

Sourcemodule EventParametersEventWeightDouble : sig ... end

Sourcemodule ConditionOverrides : sig ... end

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

Sourcemodule ProfileDimension : sig ... end

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

Sourcemodule AttributeDimension : sig ... end

Object that segments on various Customer Profile's fields.

Sourcemodule DateDimensionType : sig ... end

Sourcemodule DateValues : sig ... end

Sourcemodule ExtraLengthValues : sig ... end

Sourcemodule ProfileTypeDimensionType : sig ... end

Sourcemodule ProfileTypeValues : sig ... end

Sourcemodule FilterDimensionType : sig ... end

Sourcemodule ValueList : sig ... end

Sourcemodule ComparisonOperator : sig ... end

Sourcemodule EventTriggerValues : sig ... end

Sourcemodule FieldName : sig ... end

Sourcemodule Text : sig ... end

Sourcemodule EventParameters : sig ... end

Configuration parameters for events in the personalization system.

Sourcemodule ContactType : sig ... end

Sourcemodule Name : sig ... end

Sourcemodule Uuid : sig ... end

Sourcemodule CalculatedAttributeDimension : sig ... end

Object that segments on Customer Profile's Calculated Attributes.

Sourcemodule TypeName : sig ... end

Sourcemodule AddressDimension : sig ... end

Object that segments on Customer Profile's address object.

Sourcemodule CustomAttributes : sig ... end

Sourcemodule DateDimension : sig ... end

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

Sourcemodule ExtraLengthValueProfileDimension : sig ... end

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

Sourcemodule ProfileTypeDimension : sig ... end

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

Sourcemodule FilterAttributeDimension : sig ... end

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

Sourcemodule AttributeName : sig ... end

Sourcemodule StandardIdentifier : sig ... end

Sourcemodule Object : sig ... end

Sourcemodule BucketName : sig ... end

Sourcemodule BucketPrefix : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule MarketoConnectorOperator : sig ... end

Sourcemodule S3ConnectorOperator : sig ... end

Sourcemodule SalesforceConnectorOperator : sig ... end

Sourcemodule ServiceNowConnectorOperator : sig ... end

Sourcemodule ZendeskConnectorOperator : sig ... end

Sourcemodule StringTo2048 : sig ... end

Sourcemodule OperatorPropertiesKeys : sig ... end

Sourcemodule Property : sig ... end

Sourcemodule DataPullMode : sig ... end

Sourcemodule Date : sig ... end

Sourcemodule ScheduleExpression : sig ... end

Sourcemodule ScheduleOffset : sig ... end

Sourcemodule Timezone : sig ... end

Sourcemodule ObjectAttribute : sig ... end

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

Sourcemodule EventParametersList : sig ... end

Sourcemodule ColumnNamesList : sig ... end

Sourcemodule InferenceConfigMinProvisionedTPSInteger : sig ... end

Sourcemodule ContentType : sig ... end

Sourcemodule FeatureType : sig ... end

Sourcemodule ContactPreference : sig ... end

Object that defines users contact preference.

Sourcemodule RequestValueList : sig ... end

Sourcemodule CalculatedCustomAttributes : sig ... end

Sourcemodule ProfileAttributes : sig ... end

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

Sourcemodule AttributeMap : sig ... end

Sourcemodule FieldNameList : sig ... end

Sourcemodule StandardIdentifierList : sig ... end

Sourcemodule DatetimeTypeFieldName : sig ... end

Sourcemodule MarketoSourceProperties : sig ... end

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

Sourcemodule S3SourceProperties : sig ... end

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

Sourcemodule SalesforceSourceProperties : sig ... end

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

Sourcemodule ServiceNowSourceProperties : sig ... end

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

Sourcemodule ZendeskSourceProperties : sig ... end

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

Sourcemodule ConnectorOperator : sig ... end

The operation to be performed on the provided source fields.

Sourcemodule DestinationField : sig ... end

Sourcemodule SourceFields : sig ... end

Sourcemodule TaskPropertiesMap : sig ... end

Sourcemodule TaskType : sig ... end

Sourcemodule ScheduledTriggerProperties : sig ... end

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

Sourcemodule ObjectAttributes : sig ... end

Sourcemodule MatchingAttributes : sig ... end

Sourcemodule EventsConfig : sig ... end

Configuration settings that define how events are processed and tracked.

Sourcemodule IncludedColumns : sig ... end

Sourcemodule InferenceConfig : sig ... end

Configuration settings for inference behavior of the recommender.

Sourcemodule RecommenderConfigTrainingFrequencyInteger : sig ... end

Sourcemodule RecommenderSchemaField : sig ... end

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

Sourcemodule S3BucketName : sig ... end

Sourcemodule S3KeyName : sig ... end

Sourcemodule EmailPreferenceList : sig ... end

Sourcemodule PhonePreferenceList : sig ... end

Sourcemodule FoundByKeyValue : sig ... end

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.

Sourcemodule Dimension : sig ... end

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

Sourcemodule SourceSegment : sig ... end

The source segments to build off of.

Sourcemodule FilterDimension : sig ... end

Contains the map of attribute names to attribute dimensions.

Sourcemodule FieldContentType : sig ... end

Sourcemodule ObjectTypeKey : sig ... end

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.

Sourcemodule Timestamp : sig ... end

Sourcemodule ConnectorProfileName : sig ... end

Sourcemodule IncrementalPullConfig : sig ... end

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

Sourcemodule SourceConnectorProperties : sig ... end

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

Sourcemodule SourceConnectorType : sig ... end

Sourcemodule Task : sig ... end

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

Sourcemodule TriggerProperties : sig ... end

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

Sourcemodule TriggerType : sig ... end

Sourcemodule EventTriggerDimension : sig ... end

A specific event dimension to be assessed.

Sourcemodule PeriodUnit : sig ... end

Sourcemodule MaxSize1000 : sig ... end

Sourcemodule MaxSize24 : sig ... end

Sourcemodule ConflictResolvingModel : sig ... end

Sourcemodule MatchingAttributesList : sig ... end

Sourcemodule S3KeyNameCustomerOutputConfig : sig ... end

Sourcemodule MatchingRuleAttributeList : sig ... end

Sourcemodule ValueRangeEnd : sig ... end

Sourcemodule ValueRangeStart : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule RecommenderConfig : sig ... end

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

Sourcemodule RecommenderStatus : sig ... end

Sourcemodule RecommenderSchemaFieldList : sig ... end

Sourcemodule S3ExportingLocation : sig ... end

The S3 location where Identity Resolution Jobs write result files.

Sourcemodule Long : sig ... end

Sourcemodule EventStreamDestinationStatus : sig ... end

Sourcemodule FlowName : sig ... end

Sourcemodule Status : sig ... end

Sourcemodule Address : sig ... end

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

Sourcemodule Attributes : sig ... end

Sourcemodule EngagementPreferences : sig ... end

Object that defines users preferred methods of engagement.

Sourcemodule Gender : sig ... end

Sourcemodule PartyType : sig ... end

Sourcemodule FoundByList : sig ... end

Sourcemodule SensitiveString1To1000 : sig ... end

Sourcemodule SensitiveString1To255 : sig ... end

Sourcemodule DimensionList : sig ... end

Sourcemodule IncludeOptions : sig ... end

Sourcemodule SourceSegmentList : sig ... end

Sourcemodule SegmentSortDataType : sig ... end

Sourcemodule SegmentSortOrder : sig ... end

Sourcemodule SortAttributeType : sig ... end

Sourcemodule TrainingMetricName : sig ... end

Sourcemodule RecommenderFilterAttributeName : sig ... end

Sourcemodule RecommenderFilterAttributeValue : sig ... end

Sourcemodule FilterDimensionList : sig ... end

Sourcemodule Type : sig ... end

Sourcemodule ObjectTypeField : sig ... end

Represents a field in a ProfileObjectType.

Sourcemodule ObjectTypeKeyList : sig ... end

Sourcemodule Batch : sig ... end

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

Sourcemodule FlowDescription : sig ... end

Sourcemodule KmsArn : sig ... end

Sourcemodule SourceFlowConfig : sig ... end

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

Sourcemodule Tasks : sig ... end

Sourcemodule TriggerConfig : sig ... end

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

Sourcemodule EventTriggerDimensions : sig ... end

Sourcemodule EventTriggerLogicalOperator : sig ... end

Sourcemodule Period : sig ... end

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

Sourcemodule PercentageInteger : sig ... end

Sourcemodule ConflictResolution : sig ... end

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

Sourcemodule Consolidation : sig ... end

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

Sourcemodule Double0To1 : sig ... end

Sourcemodule OptionalBoolean : sig ... end

Sourcemodule S3ExportingConfig : sig ... end

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

Sourcemodule JobScheduleDayOfTheWeek : sig ... end

Sourcemodule JobScheduleTime : sig ... end

Sourcemodule AddressList : sig ... end

Sourcemodule AttributeMatchingModel : sig ... end

Sourcemodule EmailList : sig ... end

Sourcemodule PhoneNumberList : sig ... end

Sourcemodule MatchingRule : sig ... end

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

Sourcemodule AttributeItem : sig ... end

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

Sourcemodule Unit : sig ... end

Sourcemodule Value : sig ... end

Sourcemodule ValueRange : sig ... end

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.

Sourcemodule Operator : sig ... end

Sourcemodule WorkflowType : sig ... end

Sourcemodule StatusReason : sig ... end

Sourcemodule UploadJobStatus : sig ... end

Sourcemodule ExpirationDaysInteger : sig ... end

Sourcemodule SegmentDefinitionArn : sig ... end

Sourcemodule SegmentType : sig ... end

Sourcemodule TagMap : sig ... end

Sourcemodule SensitiveString1To4000 : sig ... end

Sourcemodule RecommenderRecipeName : sig ... end

Sourcemodule RecommenderUpdate : sig ... end

Contains information about an update operation performed on a recommender.

Sourcemodule SensitiveText : sig ... end

Sourcemodule RecommenderSchemaFields : sig ... end

Sourcemodule RecommenderSchemaStatus : sig ... end

Sourcemodule RecommenderFilterExpression : sig ... end

Sourcemodule RecommenderFilterName : sig ... end

Sourcemodule RecommenderFilterStatus : sig ... end

Sourcemodule StringifiedJson : sig ... end

Sourcemodule MinSize0 : sig ... end

Sourcemodule MinSize1 : sig ... end

Sourcemodule ActionType : sig ... end

Sourcemodule EventTriggerNames : sig ... end

Sourcemodule ObjectTypeNames : sig ... end

Sourcemodule RoleArn : sig ... end

Sourcemodule Scope : sig ... end

Sourcemodule ExportingLocation : sig ... end

The S3 location where Identity Resolution Jobs write result files.

Sourcemodule IdentityResolutionJobStatus : sig ... end

Sourcemodule JobStats : sig ... end

Statistics about the Identity Resolution Job.

Sourcemodule DestinationSummary : sig ... end

Summary information about the Kinesis data stream

Sourcemodule EventStreamState : sig ... end

Sourcemodule SensitiveString1To10000 : sig ... end

Sourcemodule LayoutType : sig ... end

Sourcemodule DisplayName : sig ... end

Sourcemodule ReadinessStatus : sig ... end

Sourcemodule AppflowIntegrationWorkflowStep : sig ... end

Workflow step details for APPFLOW_INTEGRATION workflow.

Sourcemodule GetSegmentMembershipMessage : sig ... end

Sourcemodule GetSegmentMembershipStatus : sig ... end

Sourcemodule ProfileId : sig ... end

Sourcemodule Profile : sig ... end

The standard profile of a customer.

Sourcemodule QueryResult : sig ... end

Sourcemodule Group : sig ... end

Contains dimensions that determine what to segment on.

Sourcemodule SortAttribute : sig ... end

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

Sourcemodule Metrics : sig ... end

Sourcemodule CatalogItem : sig ... end

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

Sourcemodule MetadataColumnName : sig ... end

Sourcemodule RecommenderFilterValues : sig ... end

Sourcemodule PercentPromotedItems : sig ... end

Sourcemodule ProfileIdList : sig ... end

Sourcemodule FilterGroup : sig ... end

Object that holds the dimensions to filter on.

Sourcemodule FieldMap : sig ... end

Sourcemodule KeyMap : sig ... end

Sourcemodule Batches : sig ... end

Sourcemodule FlowDefinition : sig ... end

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.

Sourcemodule Message : sig ... end

Sourcemodule String0To255 : sig ... end

Sourcemodule EventTriggerCondition : sig ... end

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

Sourcemodule Periods : sig ... end

Sourcemodule OptionalLong : sig ... end

Sourcemodule Readiness : sig ... end

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

Sourcemodule AutoMerging : sig ... end

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

Sourcemodule ExportingConfig : sig ... end

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.

Sourcemodule JobSchedule : sig ... end

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

Sourcemodule AttributeTypesSelector : sig ... end

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.

Sourcemodule MatchingRules : sig ... end

Sourcemodule MaxAllowedRuleLevelForMatching : sig ... end

Sourcemodule MaxAllowedRuleLevelForMerging : sig ... end

Sourcemodule RuleBasedMatchingStatus : sig ... end

Sourcemodule AttributeList : sig ... end

Sourcemodule ObjectCount : sig ... end

Sourcemodule Range : sig ... end

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

Sourcemodule Threshold : sig ... end

The threshold for the calculated attribute.

Sourcemodule AdditionalSearchKey : sig ... end

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.

Sourcemodule DomainObjectTypeField : sig ... end

The standard domain object type.

Sourcemodule DomainObjectTypeFieldName : sig ... end

Sourcemodule AttributeValueItem : sig ... end

List containing the values for the given attribute.

Sourcemodule AttributeSourceIdMap : sig ... end

Sourcemodule ListWorkflowsItem : sig ... end

A workflow in list of workflows.

Sourcemodule UploadJobItem : sig ... end

The summary information for an individual upload job.

Sourcemodule SegmentDefinitionItem : sig ... end

Object holding the segment definition fields.

Sourcemodule RecommenderSummary : sig ... end

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

Sourcemodule RecommenderSchemaSummary : sig ... end

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

Sourcemodule RecommenderRecipe : sig ... end

Defines the algorithm and approach used to generate recommendations.

Sourcemodule RecommenderFilterSummary : sig ... end

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

Sourcemodule ListProfileObjectsItem : sig ... end

A ProfileObject in a list of ProfileObjects.

Sourcemodule ListProfileObjectTypeItem : sig ... end

A ProfileObjectType instance.

Sourcemodule ListProfileObjectTypeTemplateItem : sig ... end

A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.

Sourcemodule ProfileHistoryRecord : sig ... end

Contains profile history record metadata.

Sourcemodule ListObjectTypeAttributeItem : sig ... end

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

Sourcemodule ListObjectTypeAttributeValuesItem : sig ... end

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

Sourcemodule ListIntegrationItem : sig ... end

An integration in list of integrations.

Sourcemodule IdentityResolutionJob : sig ... end

Information about the Identity Resolution Job.

Sourcemodule EventTriggerSummaryItem : sig ... end

The summary of the event trigger.

Sourcemodule EventStreamSummary : sig ... end

An instance of EventStream in a list of EventStreams.

Sourcemodule ListDomainItem : sig ... end

An object in a list that represents a domain.

Sourcemodule DomainObjectTypesListItem : sig ... end

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

Sourcemodule LayoutItem : sig ... end

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

Sourcemodule ListCalculatedAttributeForProfileItem : sig ... end

The details of a single calculated attribute for a profile.

Sourcemodule ListCalculatedAttributeDefinitionItem : sig ... end

The details of a single calculated attribute definition.

Sourcemodule WorkflowStepItem : sig ... end

List containing steps in workflow.

Sourcemodule AppflowIntegrationWorkflowAttributes : sig ... end

Structure holding all APPFLOW_INTEGRATION specific workflow attributes.

Sourcemodule AppflowIntegrationWorkflowMetrics : sig ... end

Workflow specific execution metrics for APPFLOW_INTEGRATION workflow.

Sourcemodule ProfileQueryFailures : sig ... end

Object that holds failures for membership.

Sourcemodule ProfileQueryResult : sig ... end

Object that holds the results for membership.

Sourcemodule SegmentGroupList : sig ... end

Sourcemodule SortAttributeList : sig ... end

Sourcemodule TrainingMetrics : sig ... end

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

Sourcemodule Recommendation : sig ... end

Represents a single recommendation generated by the recommender system.

Sourcemodule MetadataColumnsList : sig ... end

Sourcemodule ContextKey : sig ... end

Sourcemodule RecommenderFilter : sig ... end

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

Sourcemodule RecommenderPromotionalFilter : sig ... end

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

Sourcemodule GetObjectTypeAttributeStatisticsPercentiles : sig ... end

Contains percentile statistics for object type attributes.

Sourcemodule MatchItem : sig ... end

The Match group object.

Sourcemodule GroupList : sig ... end

Sourcemodule Include : sig ... end

Sourcemodule DetectedProfileObjectType : sig ... end

Contains ProfileObjectType mapping information from the model.

Sourcemodule AppflowIntegration : sig ... end

Details for workflow of type APPFLOW_INTEGRATION.

Sourcemodule BatchGetProfileError : sig ... end

Error object describing why a specific profile failed.

Sourcemodule BatchGetCalculatedAttributeForProfileError : sig ... end

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

Sourcemodule CalculatedAttributeValue : sig ... end

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

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule BadRequestException : sig ... end

The input you provided is invalid.

Sourcemodule InternalServerException : sig ... end

An internal service error occurred.

Sourcemodule ResourceNotFoundException : sig ... end

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

Sourcemodule ThrottlingException : sig ... end

You exceeded the maximum number of requests.

Sourcemodule UpdateAddress : sig ... end

Updates associated with the address properties of a customer profile.

Sourcemodule UpdateAttributes : sig ... end

Sourcemodule SensitiveString0To1000 : sig ... end

Sourcemodule SensitiveString0To255 : sig ... end

Sourcemodule EventTriggerConditions : sig ... end

Sourcemodule EventTriggerLimits : sig ... end

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

Sourcemodule DataStoreResponse : sig ... end

The data store response.

Sourcemodule MatchingResponse : sig ... end

The flag that enables the matching process of duplicate profiles.

Sourcemodule RuleBasedMatchingResponse : sig ... end

The response of the Rule-based matching request.

Sourcemodule EncryptionKey : sig ... end

Sourcemodule SqsQueueUrl : sig ... end

Sourcemodule DataStoreRequest : sig ... end

The data store request.

Sourcemodule MatchingRequest : sig ... end

The flag that enables the matching process of duplicate profiles.

Sourcemodule RuleBasedMatchingRequest : sig ... end

The request to enable the rule-based matching.

Sourcemodule SensitiveString1To2000000 : sig ... end

Sourcemodule AttributeDetails : sig ... end

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

Sourcemodule Conditions : sig ... end

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

Sourcemodule Statistic : sig ... end

Sourcemodule TagArn : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule ProfileList : sig ... end

Sourcemodule Token : sig ... end

Sourcemodule AdditionalSearchKeysList : sig ... end

Sourcemodule LogicalOperator : sig ... end

Sourcemodule MaxSize100 : sig ... end

Sourcemodule DomainObjectTypeFields : sig ... end

Sourcemodule AttributeValueItemList : sig ... end

Sourcemodule StatusCode : sig ... end

Sourcemodule FieldSourceProfileIds : sig ... end

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

Sourcemodule ProfileIdToBeMergedList : sig ... end

Sourcemodule WorkflowList : sig ... end

Sourcemodule UploadJobsList : sig ... end

Sourcemodule MaxSize500 : sig ... end

Sourcemodule SegmentDefinitionsList : sig ... end

Sourcemodule MatchIdList : sig ... end

Sourcemodule RecommenderSummaryList : sig ... end

Sourcemodule ListRecommendersRequestMaxResultsInteger : sig ... end

Sourcemodule RecommenderSchemaSummaryList : sig ... end

Sourcemodule RecommenderRecipesList : sig ... end

Sourcemodule ListRecommenderRecipesRequestMaxResultsInteger : sig ... end

Sourcemodule RecommenderFilterSummaryList : sig ... end

Sourcemodule ProfileObjectList : sig ... end

Sourcemodule ObjectFilter : sig ... end

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

Sourcemodule ProfileObjectTypeList : sig ... end

Sourcemodule ProfileObjectTypeTemplateList : sig ... end

Sourcemodule ProfileHistoryRecords : sig ... end

Sourcemodule ListObjectTypeAttributesList : sig ... end

Sourcemodule ListObjectTypeAttributeValuesList : sig ... end

Sourcemodule IntegrationList : sig ... end

Sourcemodule IdentityResolutionJobsList : sig ... end

Sourcemodule EventTriggerSummaryList : sig ... end

Sourcemodule EventStreamSummaryList : sig ... end

Sourcemodule DomainList : sig ... end

Sourcemodule DomainObjectTypesList : sig ... end

Sourcemodule LayoutList : sig ... end

Sourcemodule CalculatedAttributesForProfileList : sig ... end

Sourcemodule CalculatedAttributeDefinitionsList : sig ... end

Sourcemodule WorkflowStepsList : sig ... end

Sourcemodule WorkflowAttributes : sig ... end

Structure to hold workflow attributes.

Sourcemodule WorkflowMetrics : sig ... end

Generic object containing workflow execution metrics.

Sourcemodule ResultsSummary : sig ... end

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

Sourcemodule MatchType : sig ... end

Sourcemodule RuleLevel : sig ... end

Sourcemodule DataFormat : sig ... end

Sourcemodule SegmentSnapshotStatus : sig ... end

Sourcemodule Failures : sig ... end

Sourcemodule Profiles : sig ... end

Sourcemodule ProfileIds : sig ... end

Sourcemodule EstimateStatus : sig ... end

Sourcemodule SegmentGroup : sig ... end

Contains all groups of the segment definition.

Sourcemodule SegmentSort : sig ... end

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

Sourcemodule SensitiveString1To50000 : sig ... end

Sourcemodule TrainingMetricsList : sig ... end

Sourcemodule GetRecommenderRequestTrainingMetricsCountInteger : sig ... end

Sourcemodule Recommendations : sig ... end

Sourcemodule CandidateIdList : sig ... end

Sourcemodule MetadataConfig : sig ... end

Configuration for metadata to include in recommendation responses.

Sourcemodule RecommenderContext : sig ... end

Sourcemodule RecommenderFilters : sig ... end

Sourcemodule RecommenderPromotionalFilters : sig ... end

Sourcemodule GetObjectTypeAttributeStatisticsStats : sig ... end

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

Sourcemodule MatchesList : sig ... end

Sourcemodule MatchesNumber : sig ... end

Sourcemodule EventStreamDestinationDetails : sig ... end

Details of the destination being used for the EventStream.

Sourcemodule DomainStats : sig ... end

Usage-specific statistics about the domain.

Sourcemodule Filter : sig ... end

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

Sourcemodule DetectedProfileObjectTypes : sig ... end

Sourcemodule Objects : sig ... end

Sourcemodule SegmentGroupStructure : sig ... end

Contains all groups of the segment definition.

Sourcemodule Arn : sig ... end

Sourcemodule IntegrationConfig : sig ... end

Configuration data for integration workflow.

Sourcemodule BatchGetProfileErrorList : sig ... end

Sourcemodule BatchGetProfileIdList : sig ... end

Sourcemodule BatchGetCalculatedAttributeForProfileErrorList : sig ... end

Sourcemodule CalculatedAttributeValueList : sig ... end

Sourcemodule BatchGetCalculatedAttributeForProfileIdList : sig ... end

Sourcemodule UpdateRecommenderResponse : sig ... end

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

Sourcemodule UpdateRecommenderRequest : sig ... end

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

Sourcemodule UpdateProfileResponse : sig ... end

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.

Sourcemodule UpdateProfileRequest : sig ... end

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.

Sourcemodule UpdateEventTriggerResponse : sig ... end

Update the properties of an Event Trigger.

Sourcemodule UpdateEventTriggerRequest : sig ... end

Update the properties of an Event Trigger.

Sourcemodule UpdateDomainResponse : sig ... end

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.

Sourcemodule UpdateDomainRequest : sig ... end

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.

Sourcemodule UpdateDomainLayoutResponse : sig ... end

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

Sourcemodule UpdateDomainLayoutRequest : sig ... end

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 : sig ... end

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 : sig ... end

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 UntagResourceResponse : sig ... end

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.

Sourcemodule UntagResourceRequest : sig ... end

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.

Sourcemodule TagResourceResponse : sig ... end

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.

Sourcemodule TagResourceRequest : sig ... end

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.

Sourcemodule StopUploadJobResponse : sig ... end

This API stops the processing of an upload job.

Sourcemodule StopUploadJobRequest : sig ... end

This API stops the processing of an upload job.

Sourcemodule StopRecommenderResponse : sig ... end

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

Sourcemodule StopRecommenderRequest : sig ... end

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

Sourcemodule StartUploadJobResponse : sig ... end

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

Sourcemodule StartUploadJobRequest : sig ... end

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

Sourcemodule StartRecommenderResponse : sig ... end

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

Sourcemodule StartRecommenderRequest : sig ... end

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

Sourcemodule SearchProfilesResponse : sig ... end

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.

Sourcemodule SearchProfilesRequest : sig ... end

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.

Sourcemodule PutProfileObjectTypeResponse : sig ... end

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

Sourcemodule PutProfileObjectTypeRequest : sig ... end

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

Sourcemodule PutProfileObjectResponse : sig ... end

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.

Sourcemodule PutProfileObjectRequest : sig ... end

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.

Sourcemodule PutIntegrationResponse : sig ... end

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.

Sourcemodule PutIntegrationRequest : sig ... end

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.

Sourcemodule PutDomainObjectTypeResponse : sig ... end

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

Sourcemodule PutDomainObjectTypeRequest : sig ... end

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

Sourcemodule ProfileAttributeValuesResponse : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule ProfileAttributeValuesRequest : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule MergeProfilesResponse : sig ... end

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).

Sourcemodule MergeProfilesRequest : sig ... end

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).

Sourcemodule ListWorkflowsResponse : sig ... end

Query to list all workflows.

Sourcemodule ListWorkflowsRequest : sig ... end

Query to list all workflows.

Sourcemodule ListUploadJobsResponse : sig ... end

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

Sourcemodule ListUploadJobsRequest : sig ... end

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

Sourcemodule ListTagsForResourceResponse : sig ... end

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

Sourcemodule ListTagsForResourceRequest : sig ... end

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

Sourcemodule ListSegmentDefinitionsResponse : sig ... end

Lists all segment definitions under a domain.

Sourcemodule ListSegmentDefinitionsRequest : sig ... end

Lists all segment definitions under a domain.

Sourcemodule ListRuleBasedMatchesResponse : sig ... end

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

Sourcemodule ListRuleBasedMatchesRequest : sig ... end

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

Sourcemodule ListRecommendersResponse : sig ... end

Returns a list of recommenders in the specified domain.

Sourcemodule ListRecommendersRequest : sig ... end

Returns a list of recommenders in the specified domain.

Sourcemodule ListRecommenderSchemasResponse : sig ... end

Returns a list of recommender schemas in the specified domain.

Sourcemodule ListRecommenderSchemasRequest : sig ... end

Returns a list of recommender schemas in the specified domain.

Sourcemodule ListRecommenderRecipesResponse : sig ... end

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

Sourcemodule ListRecommenderRecipesRequest : sig ... end

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

Sourcemodule ListRecommenderFiltersResponse : sig ... end

Returns a list of recommender filters in the specified domain.

Sourcemodule ListRecommenderFiltersRequest : sig ... end

Returns a list of recommender filters in the specified domain.

Sourcemodule ListProfileObjectsResponse : sig ... end

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

Sourcemodule ListProfileObjectsRequest : sig ... end

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

Sourcemodule ListProfileObjectTypesResponse : sig ... end

Lists all of the templates available within the service.

Sourcemodule ListProfileObjectTypesRequest : sig ... end

Lists all of the templates available within the service.

Sourcemodule ListProfileObjectTypeTemplatesResponse : sig ... end

Lists all of the template information for object types.

Sourcemodule ListProfileObjectTypeTemplatesRequest : sig ... end

Lists all of the template information for object types.

Sourcemodule ListProfileHistoryRecordsResponse : sig ... end

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

Sourcemodule ListProfileHistoryRecordsRequest : sig ... end

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

Sourcemodule ListObjectTypeAttributesResponse : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule ListObjectTypeAttributesRequest : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule ListObjectTypeAttributeValuesResponse : sig ... end

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.

Sourcemodule ListObjectTypeAttributeValuesRequest : sig ... end

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.

Sourcemodule ListIntegrationsResponse : sig ... end

Lists all of the integrations in your domain.

Sourcemodule ListIntegrationsRequest : sig ... end

Lists all of the integrations in your domain.

Sourcemodule ListIdentityResolutionJobsResponse : sig ... end

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

Sourcemodule ListIdentityResolutionJobsRequest : sig ... end

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

Sourcemodule ListEventTriggersResponse : sig ... end

List all Event Triggers under a domain.

Sourcemodule ListEventTriggersRequest : sig ... end

List all Event Triggers under a domain.

Sourcemodule ListEventStreamsResponse : sig ... end

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

Sourcemodule ListEventStreamsRequest : sig ... end

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

Sourcemodule ListDomainsResponse : sig ... end

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

Sourcemodule ListDomainsRequest : sig ... end

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

Sourcemodule ListDomainObjectTypesResponse : sig ... end

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

Sourcemodule ListDomainObjectTypesRequest : sig ... end

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

Sourcemodule ListDomainLayoutsResponse : sig ... end

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 ListDomainLayoutsRequest : sig ... end

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 : sig ... end

Retrieve a list of calculated attributes for a customer profile.

Sourcemodule ListCalculatedAttributesForProfileRequest : sig ... end

Retrieve a list of calculated attributes for a customer profile.

Sourcemodule ListCalculatedAttributeDefinitionsResponse : sig ... end

Lists calculated attribute definitions for Customer Profiles

Sourcemodule ListCalculatedAttributeDefinitionsRequest : sig ... end

Lists calculated attribute definitions for Customer Profiles

Sourcemodule ListAccountIntegrationsResponse : sig ... end

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

Sourcemodule ListAccountIntegrationsRequest : sig ... end

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

Sourcemodule GetWorkflowStepsResponse : sig ... end

Get granular list of steps in workflow.

Sourcemodule GetWorkflowStepsRequest : sig ... end

Get granular list of steps in workflow.

Sourcemodule GetWorkflowResponse : sig ... end

Get details of specified workflow.

Sourcemodule GetWorkflowRequest : sig ... end

Get details of specified workflow.

Sourcemodule GetUploadJobResponse : sig ... end

This API retrieves the details of a specific upload job.

Sourcemodule GetUploadJobRequest : sig ... end

This API retrieves the details of a specific upload job.

Sourcemodule GetUploadJobPathResponse : sig ... end

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

Sourcemodule GetUploadJobPathRequest : sig ... end

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

Sourcemodule GetSimilarProfilesResponse : sig ... end

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.

Sourcemodule GetSimilarProfilesRequest : sig ... end

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.

Sourcemodule GetSegmentSnapshotResponse : sig ... end

Retrieve the latest status of a segment snapshot.

Sourcemodule GetSegmentSnapshotRequest : sig ... end

Retrieve the latest status of a segment snapshot.

Sourcemodule GetSegmentMembershipResponse : sig ... end

Determines if the given profiles are within a segment.

Sourcemodule GetSegmentMembershipRequest : sig ... end

Determines if the given profiles are within a segment.

Sourcemodule GetSegmentEstimateResponse : sig ... end

Gets the result of a segment estimate query.

Sourcemodule GetSegmentEstimateRequest : sig ... end

Gets the result of a segment estimate query.

Sourcemodule GetSegmentDefinitionResponse : sig ... end

Gets a segment definition from the domain.

Sourcemodule GetSegmentDefinitionRequest : sig ... end

Gets a segment definition from the domain.

Sourcemodule GetRecommenderSchemaResponse : sig ... end

Retrieves information about a specific recommender schema in a domain.

Sourcemodule GetRecommenderSchemaRequest : sig ... end

Retrieves information about a specific recommender schema in a domain.

Sourcemodule GetRecommenderResponse : sig ... end

Retrieves a recommender.

Sourcemodule GetRecommenderRequest : sig ... end

Retrieves a recommender.

Sourcemodule GetRecommenderFilterResponse : sig ... end

Retrieves information about a specific recommender filter in a domain.

Sourcemodule GetRecommenderFilterRequest : sig ... end

Retrieves information about a specific recommender filter in a domain.

Sourcemodule GetProfileRecommendationsResponse : sig ... end

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

Sourcemodule GetProfileRecommendationsRequest : sig ... end

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

Sourcemodule GetProfileObjectTypeTemplateResponse : sig ... end

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.

Sourcemodule GetProfileObjectTypeTemplateRequest : sig ... end

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.

Sourcemodule GetProfileObjectTypeResponse : sig ... end

Returns the object types for a specific domain.

Sourcemodule GetProfileObjectTypeRequest : sig ... end

Returns the object types for a specific domain.

Sourcemodule GetProfileHistoryRecordResponse : sig ... end

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

Sourcemodule GetProfileHistoryRecordRequest : sig ... end

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

Sourcemodule GetObjectTypeAttributeStatisticsResponse : sig ... end

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.

Sourcemodule GetObjectTypeAttributeStatisticsRequest : sig ... end

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.

Sourcemodule GetMatchesResponse : sig ... end

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.

Sourcemodule GetMatchesRequest : sig ... end

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.

Sourcemodule GetIntegrationResponse : sig ... end

Returns an integration for a domain.

Sourcemodule GetIntegrationRequest : sig ... end

Returns an integration for a domain.

Sourcemodule GetIdentityResolutionJobResponse : sig ... end

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.

Sourcemodule GetIdentityResolutionJobRequest : sig ... end

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.

Sourcemodule GetEventTriggerResponse : sig ... end

Get a specific Event Trigger from the domain.

Sourcemodule GetEventTriggerRequest : sig ... end

Get a specific Event Trigger from the domain.

Sourcemodule GetEventStreamResponse : sig ... end

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

Sourcemodule GetEventStreamRequest : sig ... end

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

Sourcemodule GetDomainResponse : sig ... end

Returns information about a specific domain.

Sourcemodule GetDomainRequest : sig ... end

Returns information about a specific domain.

Sourcemodule GetDomainObjectTypeResponse : sig ... end

Return a DomainObjectType for the input Domain and ObjectType names.

Sourcemodule GetDomainObjectTypeRequest : sig ... end

Return a DomainObjectType for the input Domain and ObjectType names.

Sourcemodule GetDomainLayoutResponse : sig ... end

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

Sourcemodule GetDomainLayoutRequest : sig ... end

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

Sourcemodule GetCalculatedAttributeForProfileResponse : sig ... end

Retrieve a calculated attribute for a customer profile.

Sourcemodule GetCalculatedAttributeForProfileRequest : sig ... end

Retrieve a calculated attribute for a customer profile.

Sourcemodule GetCalculatedAttributeDefinitionResponse : sig ... end

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

Sourcemodule GetCalculatedAttributeDefinitionRequest : sig ... end

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

Sourcemodule GetAutoMergingPreviewResponse : sig ... end

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.

Sourcemodule GetAutoMergingPreviewRequest : sig ... end

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.

Sourcemodule DetectProfileObjectTypeResponse : sig ... end

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

Sourcemodule DetectProfileObjectTypeRequest : sig ... end

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

Sourcemodule DeleteWorkflowResponse : sig ... end

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

Sourcemodule DeleteWorkflowRequest : sig ... end

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

Sourcemodule DeleteSegmentDefinitionResponse : sig ... end

Deletes a segment definition from the domain.

Sourcemodule DeleteSegmentDefinitionRequest : sig ... end

Deletes a segment definition from the domain.

Sourcemodule DeleteRecommenderSchemaResponse : sig ... end

Deletes a recommender schema from a domain.

Sourcemodule DeleteRecommenderSchemaRequest : sig ... end

Deletes a recommender schema from a domain.

Sourcemodule DeleteRecommenderResponse : sig ... end

Deletes a recommender.

Sourcemodule DeleteRecommenderRequest : sig ... end

Deletes a recommender.

Sourcemodule DeleteRecommenderFilterResponse : sig ... end

Deletes a recommender filter from a domain.

Sourcemodule DeleteRecommenderFilterRequest : sig ... end

Deletes a recommender filter from a domain.

Sourcemodule DeleteProfileResponse : sig ... end

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

Sourcemodule DeleteProfileRequest : sig ... end

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

Sourcemodule DeleteProfileObjectTypeResponse : sig ... end

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.

Sourcemodule DeleteProfileObjectTypeRequest : sig ... end

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.

Sourcemodule DeleteProfileObjectResponse : sig ... end

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

Sourcemodule DeleteProfileObjectRequest : sig ... end

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

Sourcemodule DeleteProfileKeyResponse : sig ... end

Removes a searchable key from a customer profile.

Sourcemodule DeleteProfileKeyRequest : sig ... end

Removes a searchable key from a customer profile.

Sourcemodule DeleteIntegrationResponse : sig ... end

Removes an integration from a specific domain.

Sourcemodule DeleteIntegrationRequest : sig ... end

Removes an integration from a specific domain.

Sourcemodule DeleteEventTriggerResponse : sig ... end

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

Sourcemodule DeleteEventTriggerRequest : sig ... end

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

Sourcemodule DeleteEventStreamResponse : sig ... end

Disables and deletes the specified event stream.

Sourcemodule DeleteEventStreamRequest : sig ... end

Disables and deletes the specified event stream.

Sourcemodule DeleteDomainResponse : sig ... end

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

Sourcemodule DeleteDomainRequest : sig ... end

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

Sourcemodule DeleteDomainObjectTypeResponse : sig ... end

Delete a DomainObjectType for the given Domain and ObjectType name.

Sourcemodule DeleteDomainObjectTypeRequest : sig ... end

Delete a DomainObjectType for the given Domain and ObjectType name.

Sourcemodule DeleteDomainLayoutResponse : sig ... end

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

Sourcemodule DeleteDomainLayoutRequest : sig ... end

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 : sig ... end

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 : sig ... end

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 CreateUploadJobResponse : sig ... end

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.

Sourcemodule CreateUploadJobRequest : sig ... end

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.

Sourcemodule CreateSegmentSnapshotResponse : sig ... end

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

Sourcemodule CreateSegmentSnapshotRequest : sig ... end

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

Sourcemodule CreateSegmentEstimateResponse : sig ... end

Creates a segment estimate query.

Sourcemodule CreateSegmentEstimateRequest : sig ... end

Creates a segment estimate query.

Sourcemodule CreateSegmentDefinitionResponse : sig ... end

Creates a segment definition associated to the given domain.

Sourcemodule CreateSegmentDefinitionRequest : sig ... end

Creates a segment definition associated to the given domain.

Sourcemodule CreateRecommenderSchemaResponse : sig ... end

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

Sourcemodule CreateRecommenderSchemaRequest : sig ... end

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

Sourcemodule CreateRecommenderResponse : sig ... end

Creates a recommender

Sourcemodule CreateRecommenderRequest : sig ... end

Creates a recommender

Sourcemodule CreateRecommenderFilterResponse : sig ... end

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

Sourcemodule CreateRecommenderFilterRequest : sig ... end

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

Sourcemodule CreateProfileResponse : sig ... end

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

Sourcemodule CreateProfileRequest : sig ... end

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

Sourcemodule CreateIntegrationWorkflowResponse : sig ... end

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.

Sourcemodule CreateIntegrationWorkflowRequest : sig ... end

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.

Sourcemodule CreateEventTriggerResponse : sig ... end

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.

Sourcemodule CreateEventTriggerRequest : sig ... end

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.

Sourcemodule CreateEventStreamResponse : sig ... end

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

Sourcemodule CreateEventStreamRequest : sig ... end

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

Sourcemodule CreateDomainResponse : sig ... end

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.

Sourcemodule CreateDomainRequest : sig ... end

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.

Sourcemodule CreateDomainLayoutResponse : sig ... end

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

Sourcemodule CreateDomainLayoutRequest : sig ... end

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

Sourcemodule CreateCalculatedAttributeDefinitionResponse : sig ... end

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 : sig ... end

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 BatchGetProfileResponse : sig ... end

Get a batch of profiles.

Sourcemodule BatchGetProfileRequest : sig ... end

Get a batch of profiles.

Sourcemodule BatchGetCalculatedAttributeForProfileResponse : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule BatchGetCalculatedAttributeForProfileRequest : sig ... end

Fetch the possible attribute values given the attribute name.

Sourcemodule AddProfileKeyResponse : sig ... end

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.

Sourcemodule AddProfileKeyRequest : sig ... end

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.