2022/06/30 - Amazon Connect Customer Profiles - 5 updated api methods
Changes This release adds the optional MinAllowedConfidenceScoreForMerging parameter to the CreateDomain, UpdateDomain, and GetAutoMergingPreview APIs in Customer Profiles. This parameter is used as a threshold to influence the profile auto-merging step of the Identity Resolution process.
{'Matching': {'AutoMerging': {'MinAllowedConfidenceScoreForMerging': 'double'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
integer
[REQUIRED]
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
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.
Enabled (boolean) -- [REQUIRED]
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) -- [REQUIRED]
The day when the Identity Resolution Job should run every week.
Time (string) -- [REQUIRED]
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) -- [REQUIRED]
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) -- [REQUIRED]
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
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.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'MinAllowedConfidenceScoreForMerging': 'double'}
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.
Warning
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.
See also: AWS API Documentation
Request Syntax
client.get_auto_merging_preview(
DomainName='string',
Consolidation={
'MatchingAttributesList': [
[
'string',
],
]
},
ConflictResolution={
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
MinAllowedConfidenceScoreForMerging=123.0
)
string
[REQUIRED]
The unique name of the domain.
dict
[REQUIRED]
A list of matching attributes that represent matching criteria.
MatchingAttributesList (list) -- [REQUIRED]
A list of matching criteria.
(list) --
(string) --
dict
[REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
float
Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
dict
Response Syntax
{
'DomainName': 'string',
'NumberOfMatchesInSample': 123,
'NumberOfProfilesInSample': 123,
'NumberOfProfilesWillBeMerged': 123
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
NumberOfMatchesInSample (integer) --
The number of match groups in the domain that have been reviewed in this preview dry run.
NumberOfProfilesInSample (integer) --
The number of profiles found in this preview dry run.
NumberOfProfilesWillBeMerged (integer) --
The number of profiles that would be merged if this wasn't a preview dry run.
{'Matching': {'AutoMerging': {'MinAllowedConfidenceScoreForMerging': 'double'}}}
Returns information about a specific domain.
See also: AWS API Documentation
Request Syntax
client.get_domain(
DomainName='string'
)
string
[REQUIRED]
The unique name of the domain.
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Stats': {
'ProfileCount': 123,
'MeteringProfileCount': 123,
'ObjectCount': 123,
'TotalSize': 123
},
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Stats (dict) --
Usage-specific statistics about the domain.
ProfileCount (integer) --
The total number of profiles currently in the domain.
MeteringProfileCount (integer) --
The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
ObjectCount (integer) --
The total number of objects in domain.
TotalSize (integer) --
The total size, in bytes, of all objects in the domain.
Matching (dict) --
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.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
{'AutoMerging': {'MinAllowedConfidenceScoreForMerging': 'double'}}
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 .
See also: AWS API Documentation
Request Syntax
client.get_identity_resolution_job(
DomainName='string',
JobId='string'
)
string
[REQUIRED]
The unique name of the domain.
string
[REQUIRED]
The unique identifier of the Identity Resolution Job.
dict
Response Syntax
{
'DomainName': 'string',
'JobId': 'string',
'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
'Message': 'string',
'JobStartTime': datetime(2015, 1, 1),
'JobEndTime': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'JobExpirationTime': datetime(2015, 1, 1),
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingLocation': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
},
'JobStats': {
'NumberOfProfilesReviewed': 123,
'NumberOfMatchesFound': 123,
'NumberOfMergesDone': 123
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
JobId (string) --
The unique identifier of the Identity Resolution Job.
Status (string) --
The status of the Identity Resolution Job.
PENDING : The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.
PREPROCESSING : The Identity Resolution Job is loading your data.
FIND_MATCHING : The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.
MERGING : The Identity Resolution Job is merging duplicate profiles.
COMPLETED : The Identity Resolution Job completed successfully.
PARTIAL_SUCCESS : There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.
FAILED : The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
Message (string) --
The error messages that are generated when the Identity Resolution Job runs.
JobStartTime (datetime) --
The timestamp of when the Identity Resolution Job was started or will be started.
JobEndTime (datetime) --
The timestamp of when the Identity Resolution Job was completed.
LastUpdatedAt (datetime) --
The timestamp of when the Identity Resolution Job was most recently edited.
JobExpirationTime (datetime) --
The timestamp of when the Identity Resolution Job will expire.
AutoMerging (dict) --
Configuration settings for how to perform the auto-merging of profiles.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingLocation (dict) --
The S3 location where the Identity Resolution Job writes result files.
S3Exporting (dict) --
Information about the S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket name where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
JobStats (dict) --
Statistics about the Identity Resolution Job.
NumberOfProfilesReviewed (integer) --
The number of profiles reviewed.
NumberOfMatchesFound (integer) --
The number of matches found.
NumberOfMergesDone (integer) --
The number of merges completed.
{'Matching': {'AutoMerging': {'MinAllowedConfidenceScoreForMerging': 'double'}}}
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.
See also: AWS API Documentation
Request Syntax
client.update_domain(
DomainName='string',
DefaultExpirationDays=123,
DefaultEncryptionKey='string',
DeadLetterQueueUrl='string',
Matching={
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique name of the domain.
integer
The default number of days until the data within the domain expires.
string
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
string
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
dict
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.
Enabled (boolean) -- [REQUIRED]
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) -- [REQUIRED]
The day when the Identity Resolution Job should run every week.
Time (string) -- [REQUIRED]
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) -- [REQUIRED]
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) -- [REQUIRED]
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) -- [REQUIRED]
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) -- [REQUIRED]
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'DomainName': 'string',
'DefaultExpirationDays': 123,
'DefaultEncryptionKey': 'string',
'DeadLetterQueueUrl': 'string',
'Matching': {
'Enabled': True|False,
'JobSchedule': {
'DayOfTheWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'Time': 'string'
},
'AutoMerging': {
'Enabled': True|False,
'Consolidation': {
'MatchingAttributesList': [
[
'string',
],
]
},
'ConflictResolution': {
'ConflictResolvingModel': 'RECENCY'|'SOURCE',
'SourceName': 'string'
},
'MinAllowedConfidenceScoreForMerging': 123.0
},
'ExportingConfig': {
'S3Exporting': {
'S3BucketName': 'string',
'S3KeyName': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
DomainName (string) --
The unique name of the domain.
DefaultExpirationDays (integer) --
The default number of days until the data within the domain expires.
DefaultEncryptionKey (string) --
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
DeadLetterQueueUrl (string) --
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
Matching (dict) --
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.
Enabled (boolean) --
The flag that enables the matching process of duplicate profiles.
JobSchedule (dict) --
The day and time when do you want to start the Identity Resolution Job every week.
DayOfTheWeek (string) --
The day when the Identity Resolution Job should run every week.
Time (string) --
The time when the Identity Resolution Job should run every week.
AutoMerging (dict) --
Configuration information about the auto-merging process.
Enabled (boolean) --
The flag that enables the auto-merging of duplicate profiles.
Consolidation (dict) --
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.
MatchingAttributesList (list) --
A list of matching criteria.
(list) --
(string) --
ConflictResolution (dict) --
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?
ConflictResolvingModel (string) --
How the auto-merging process should resolve conflicts between different profiles.
RECENCY : Uses the data that was most recently updated.
SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.
SourceName (string) --
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .
MinAllowedConfidenceScoreForMerging (float) --
A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.
ExportingConfig (dict) --
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
S3Exporting (dict) --
The S3 location where Identity Resolution Jobs write result files.
S3BucketName (string) --
The name of the S3 bucket where Identity Resolution Jobs write result files.
S3KeyName (string) --
The S3 key name of the location where Identity Resolution Jobs write result files.
CreatedAt (datetime) --
The timestamp of when the domain was created.
LastUpdatedAt (datetime) --
The timestamp of when the domain was most recently edited.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --