Package-level declarations

Types

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

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

Link copied to clipboard
data class CalculatedAttributeDefinitionConditions(val objectCount: Int? = null, val range: CalculatedAttributeDefinitionRange? = null, val threshold: CalculatedAttributeDefinitionThreshold? = null)

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

Link copied to clipboard

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

Link copied to clipboard

The threshold for the calculated attribute.

Link copied to clipboard
data class DestinationDetailsProperties(val status: EventStreamStatus, val uri: String)

Details regarding the Kinesis stream.

Link copied to clipboard
data class DomainAttributeTypesSelector(val address: List<String>? = null, val attributeMatchingModel: DomainAttributeTypesSelectorAttributeMatchingModel, val emailAddress: List<String>? = null, val phoneNumber: List<String>? = null)

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

Link copied to clipboard
data class DomainAutoMerging(val conflictResolution: DomainConflictResolution? = null, val consolidation: DomainConsolidation? = null, val enabled: Boolean, val minAllowedConfidenceScoreForMerging: Double? = null)

Configuration information about the auto-merging process.

Link copied to clipboard
data class DomainConflictResolution(val conflictResolvingModel: DomainConflictResolutionConflictResolvingModel, val sourceName: String? = null)

How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

Link copied to clipboard
data class DomainConsolidation(val matchingAttributesList: List<List<String>>)

A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

Link copied to clipboard
data class DomainExportingConfig(val s3Exporting: DomainS3ExportingConfig? = null)

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

Link copied to clipboard
data class DomainJobSchedule(val dayOfTheWeek: DomainJobScheduleDayOfTheWeek, val time: String)

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

Link copied to clipboard
data class DomainMatching(val autoMerging: DomainAutoMerging? = null, val enabled: Boolean, val exportingConfig: DomainExportingConfig? = null, val jobSchedule: DomainJobSchedule? = null)

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.

Link copied to clipboard
data class DomainMatchingRule(val rule: List<String>)

Specifies how does the rule-based matching process should match profiles.

Link copied to clipboard
data class DomainRuleBasedMatching(val attributeTypesSelector: DomainAttributeTypesSelector? = null, val conflictResolution: DomainConflictResolution? = null, val enabled: Boolean, val exportingConfig: DomainExportingConfig? = null, val matchingRules: List<DomainMatchingRule>? = null, val maxAllowedRuleLevelForMatching: Int? = null, val maxAllowedRuleLevelForMerging: Int? = null, val status: DomainRuleBasedMatchingStatus? = null)

The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

Link copied to clipboard
data class DomainS3ExportingConfig(val s3BucketName: String, val s3KeyName: String? = null)

The S3 location where Identity Resolution Jobs write result files.

Link copied to clipboard
data class DomainStats(val meteringProfileCount: Double? = null, val objectCount: Double? = null, val profileCount: Double? = null, val totalSize: Double? = null)

Usage-specific statistics about the domain.

Link copied to clipboard
data class GetCalculatedAttributeDefinitionResult(val attributeDetails: CalculatedAttributeDefinitionAttributeDetails? = null, val conditions: CalculatedAttributeDefinitionConditions? = null, val createdAt: String? = null, val description: String? = null, val displayName: String? = null, val lastUpdatedAt: String? = null, val statistic: CalculatedAttributeDefinitionStatistic? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetDomainResult(val createdAt: String? = null, val deadLetterQueueUrl: String? = null, val defaultEncryptionKey: String? = null, val defaultExpirationDays: Int? = null, val lastUpdatedAt: String? = null, val matching: DomainMatching? = null, val ruleBasedMatching: DomainRuleBasedMatching? = null, val stats: DomainStats? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetEventStreamResult(val createdAt: String? = null, val destinationDetails: DestinationDetailsProperties? = null, val eventStreamArn: String? = null, val state: EventStreamState? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetIntegrationResult(val createdAt: String? = null, val lastUpdatedAt: String? = null, val objectTypeName: String? = null, val objectTypeNames: List<IntegrationObjectTypeMapping>? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetObjectTypeResult(val allowProfileCreation: Boolean? = null, val createdAt: String? = null, val description: String? = null, val encryptionKey: String? = null, val expirationDays: Int? = null, val fields: List<ObjectTypeFieldMap>? = null, val keys: List<ObjectTypeKeyMap>? = null, val lastUpdatedAt: String? = null, val sourceLastUpdatedTimestampFormat: String? = null, val tags: List<Tag>? = null, val templateId: String? = null)
Link copied to clipboard
Link copied to clipboard
data class IntegrationFlowDefinition(val description: String? = null, val flowName: String, val kmsArn: String, val sourceFlowConfig: IntegrationSourceFlowConfig, val tasks: List<IntegrationTask>, val triggerConfig: IntegrationTriggerConfig)
Link copied to clipboard
data class IntegrationIncrementalPullConfig(val datetimeTypeFieldName: String? = null)
Link copied to clipboard
Link copied to clipboard
data class IntegrationObjectTypeMapping(val key: String, val value: String)
Link copied to clipboard
data class IntegrationS3SourceProperties(val bucketName: String, val bucketPrefix: String? = null)
Link copied to clipboard
data class IntegrationSalesforceSourceProperties(val enableDynamicFieldUpdate: Boolean? = null, val includeDeletedRecords: Boolean? = null, val object: String)
Link copied to clipboard
data class IntegrationScheduledTriggerProperties(val dataPullMode: IntegrationScheduledTriggerPropertiesDataPullMode? = null, val firstExecutionFrom: Double? = null, val scheduleEndTime: Double? = null, val scheduleExpression: String, val scheduleOffset: Int? = null, val scheduleStartTime: Double? = null, val timezone: String? = null)
Link copied to clipboard
data class IntegrationSourceFlowConfig(val connectorProfileName: String? = null, val connectorType: IntegrationConnectorType, val incrementalPullConfig: IntegrationIncrementalPullConfig? = null, val sourceConnectorProperties: IntegrationSourceConnectorProperties)
Link copied to clipboard
data class IntegrationTask(val connectorOperator: IntegrationConnectorOperator? = null, val destinationField: String? = null, val sourceFields: List<String>, val taskProperties: List<IntegrationTaskPropertiesMap>? = null, val taskType: IntegrationTaskType)
Link copied to clipboard
data class IntegrationTaskPropertiesMap(val operatorPropertyKey: IntegrationOperatorPropertiesKeys, val property: String)
Link copied to clipboard
data class IntegrationTriggerConfig(val triggerProperties: IntegrationTriggerProperties? = null, val triggerType: IntegrationTriggerType)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class ObjectTypeField(val contentType: ObjectTypeFieldContentType? = null, val source: String? = null, val target: String? = null)

Represents a field in a ProfileObjectType.

Link copied to clipboard
data class ObjectTypeFieldMap(val name: String? = null, val objectTypeField: ObjectTypeField? = null)
Link copied to clipboard
data class ObjectTypeKey(val fieldNames: List<String>? = null, val standardIdentifiers: List<ObjectTypeKeyStandardIdentifiersItem>? = null)

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.

Link copied to clipboard
data class ObjectTypeKeyMap(val name: String? = null, val objectTypeKeyList: List<ObjectTypeKey>? = null)