aws-sdk-customerprofiles 1.20.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-customerprofiles/client.rb +27 -3
- data/lib/aws-sdk-customerprofiles/client_api.rb +3 -0
- data/lib/aws-sdk-customerprofiles/types.rb +45 -7
- data/lib/aws-sdk-customerprofiles.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1cf8252e3e392e9db017f0496fb466f12e1e6c4175df18911628f7204d7fee3f
|
4
|
+
data.tar.gz: e574411ae7d0fb5fffc597863a7147b0e03a368efeea1d54a3d5615c7f7c66b6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7ed826c479c4f35dccb78b28c13a14f4b4cc90b9c2fcf2a210f9769b4675aa80b255f65d14855d3940db0125b39aa2809bcda94acc0e2a51a1287f18be91d057
|
7
|
+
data.tar.gz: 3e837f6b804a568c1bf6b4bf541979e51eeaaee932226f64e8e6c22b0c7e78d558e4096146dbed7638c991c6149c7c37b4a54153345d79bfc8b7c0ceb1e9b74d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.21.0 (2022-06-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - 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.
|
8
|
+
|
4
9
|
1.20.0 (2022-02-24)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.21.0
|
@@ -362,7 +362,13 @@ module Aws::CustomerProfiles
|
|
362
362
|
# The unique identifier of a customer profile.
|
363
363
|
#
|
364
364
|
# @option params [required, String] :key_name
|
365
|
-
# A searchable identifier of a customer profile.
|
365
|
+
# A searchable identifier of a customer profile. The predefined keys you
|
366
|
+
# can use include: \_account, \_profileId, \_assetId, \_caseId,
|
367
|
+
# \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
|
368
|
+
# \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
|
369
|
+
# \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
|
370
|
+
# \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
|
371
|
+
# \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
|
366
372
|
#
|
367
373
|
# @option params [required, Array<String>] :values
|
368
374
|
# A list of key values.
|
@@ -492,6 +498,7 @@ module Aws::CustomerProfiles
|
|
492
498
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
493
499
|
# source_name: "string1To255",
|
494
500
|
# },
|
501
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
495
502
|
# },
|
496
503
|
# exporting_config: {
|
497
504
|
# s3_exporting: {
|
@@ -520,6 +527,7 @@ module Aws::CustomerProfiles
|
|
520
527
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
521
528
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
522
529
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
530
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
523
531
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
524
532
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
525
533
|
# resp.created_at #=> Time
|
@@ -1095,6 +1103,10 @@ module Aws::CustomerProfiles
|
|
1095
1103
|
# How the auto-merging process should resolve conflicts between
|
1096
1104
|
# different profiles.
|
1097
1105
|
#
|
1106
|
+
# @option params [Float] :min_allowed_confidence_score_for_merging
|
1107
|
+
# Minimum confidence score required for profiles within a matching group
|
1108
|
+
# to be merged during the auto-merge process.
|
1109
|
+
#
|
1098
1110
|
# @return [Types::GetAutoMergingPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1099
1111
|
#
|
1100
1112
|
# * {Types::GetAutoMergingPreviewResponse#domain_name #domain_name} => String
|
@@ -1115,6 +1127,7 @@ module Aws::CustomerProfiles
|
|
1115
1127
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
1116
1128
|
# source_name: "string1To255",
|
1117
1129
|
# },
|
1130
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
1118
1131
|
# })
|
1119
1132
|
#
|
1120
1133
|
# @example Response structure
|
@@ -1175,6 +1188,7 @@ module Aws::CustomerProfiles
|
|
1175
1188
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1176
1189
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1177
1190
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
1191
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
1178
1192
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
1179
1193
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
1180
1194
|
# resp.created_at #=> Time
|
@@ -1245,6 +1259,7 @@ module Aws::CustomerProfiles
|
|
1245
1259
|
# resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
1246
1260
|
# resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
1247
1261
|
# resp.auto_merging.conflict_resolution.source_name #=> String
|
1262
|
+
# resp.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
1248
1263
|
# resp.exporting_location.s3_exporting.s3_bucket_name #=> String
|
1249
1264
|
# resp.exporting_location.s3_exporting.s3_key_name #=> String
|
1250
1265
|
# resp.job_stats.number_of_profiles_reviewed #=> Integer
|
@@ -2362,7 +2377,14 @@ module Aws::CustomerProfiles
|
|
2362
2377
|
# Description of the profile object type.
|
2363
2378
|
#
|
2364
2379
|
# @option params [String] :template_id
|
2365
|
-
# A unique identifier for the object template.
|
2380
|
+
# A unique identifier for the object template. For some attributes in
|
2381
|
+
# the request, the service will use the default value from the object
|
2382
|
+
# template when TemplateId is present. If these attributes are present
|
2383
|
+
# in the request, the service may return a `BadRequestException`. These
|
2384
|
+
# attributes include: AllowProfileCreation,
|
2385
|
+
# SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
|
2386
|
+
# AllowProfileCreation is set to true when TemplateId is set, the
|
2387
|
+
# service may return a `BadRequestException`.
|
2366
2388
|
#
|
2367
2389
|
# @option params [Integer] :expiration_days
|
2368
2390
|
# The number of days until the data in the object expires.
|
@@ -2747,6 +2769,7 @@ module Aws::CustomerProfiles
|
|
2747
2769
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
2748
2770
|
# source_name: "string1To255",
|
2749
2771
|
# },
|
2772
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
2750
2773
|
# },
|
2751
2774
|
# exporting_config: {
|
2752
2775
|
# s3_exporting: {
|
@@ -2775,6 +2798,7 @@ module Aws::CustomerProfiles
|
|
2775
2798
|
# resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
|
2776
2799
|
# resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
|
2777
2800
|
# resp.matching.auto_merging.conflict_resolution.source_name #=> String
|
2801
|
+
# resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
|
2778
2802
|
# resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
|
2779
2803
|
# resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
|
2780
2804
|
# resp.created_at #=> Time
|
@@ -2974,7 +2998,7 @@ module Aws::CustomerProfiles
|
|
2974
2998
|
params: params,
|
2975
2999
|
config: config)
|
2976
3000
|
context[:gem_name] = 'aws-sdk-customerprofiles'
|
2977
|
-
context[:gem_version] = '1.
|
3001
|
+
context[:gem_version] = '1.21.0'
|
2978
3002
|
Seahorse::Client::Request.new(handlers, context)
|
2979
3003
|
end
|
2980
3004
|
|
@@ -61,6 +61,7 @@ module Aws::CustomerProfiles
|
|
61
61
|
DomainList = Shapes::ListShape.new(name: 'DomainList')
|
62
62
|
DomainStats = Shapes::StructureShape.new(name: 'DomainStats')
|
63
63
|
Double = Shapes::FloatShape.new(name: 'Double')
|
64
|
+
Double0To1 = Shapes::FloatShape.new(name: 'Double0To1')
|
64
65
|
ExportingConfig = Shapes::StructureShape.new(name: 'ExportingConfig')
|
65
66
|
ExportingLocation = Shapes::StructureShape.new(name: 'ExportingLocation')
|
66
67
|
FieldContentType = Shapes::StringShape.new(name: 'FieldContentType')
|
@@ -296,6 +297,7 @@ module Aws::CustomerProfiles
|
|
296
297
|
AutoMerging.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, required: true, location_name: "Enabled"))
|
297
298
|
AutoMerging.add_member(:consolidation, Shapes::ShapeRef.new(shape: Consolidation, location_name: "Consolidation"))
|
298
299
|
AutoMerging.add_member(:conflict_resolution, Shapes::ShapeRef.new(shape: ConflictResolution, location_name: "ConflictResolution"))
|
300
|
+
AutoMerging.add_member(:min_allowed_confidence_score_for_merging, Shapes::ShapeRef.new(shape: Double0To1, location_name: "MinAllowedConfidenceScoreForMerging"))
|
299
301
|
AutoMerging.struct_class = Types::AutoMerging
|
300
302
|
|
301
303
|
BadRequestException.add_member(:message, Shapes::ShapeRef.new(shape: message, location_name: "Message"))
|
@@ -482,6 +484,7 @@ module Aws::CustomerProfiles
|
|
482
484
|
GetAutoMergingPreviewRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
|
483
485
|
GetAutoMergingPreviewRequest.add_member(:consolidation, Shapes::ShapeRef.new(shape: Consolidation, required: true, location_name: "Consolidation"))
|
484
486
|
GetAutoMergingPreviewRequest.add_member(:conflict_resolution, Shapes::ShapeRef.new(shape: ConflictResolution, required: true, location_name: "ConflictResolution"))
|
487
|
+
GetAutoMergingPreviewRequest.add_member(:min_allowed_confidence_score_for_merging, Shapes::ShapeRef.new(shape: Double0To1, location_name: "MinAllowedConfidenceScoreForMerging"))
|
485
488
|
GetAutoMergingPreviewRequest.struct_class = Types::GetAutoMergingPreviewRequest
|
486
489
|
|
487
490
|
GetAutoMergingPreviewResponse.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "DomainName"))
|
@@ -38,7 +38,13 @@ module Aws::CustomerProfiles
|
|
38
38
|
# @return [String]
|
39
39
|
#
|
40
40
|
# @!attribute [rw] key_name
|
41
|
-
# A searchable identifier of a customer profile.
|
41
|
+
# A searchable identifier of a customer profile. The predefined keys
|
42
|
+
# you can use include: \_account, \_profileId, \_assetId, \_caseId,
|
43
|
+
# \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
|
44
|
+
# \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
|
45
|
+
# \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
|
46
|
+
# \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
|
47
|
+
# \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
|
42
48
|
# @return [String]
|
43
49
|
#
|
44
50
|
# @!attribute [rw] values
|
@@ -376,6 +382,7 @@ module Aws::CustomerProfiles
|
|
376
382
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
377
383
|
# source_name: "string1To255",
|
378
384
|
# },
|
385
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
379
386
|
# }
|
380
387
|
#
|
381
388
|
# @!attribute [rw] enabled
|
@@ -395,12 +402,20 @@ module Aws::CustomerProfiles
|
|
395
402
|
# which `EmailAddress` should be used?
|
396
403
|
# @return [Types::ConflictResolution]
|
397
404
|
#
|
405
|
+
# @!attribute [rw] min_allowed_confidence_score_for_merging
|
406
|
+
# A number between 0 and 1 that represents the minimum confidence
|
407
|
+
# score required for profiles within a matching group to be merged
|
408
|
+
# during the auto-merge process. A higher score means higher
|
409
|
+
# similarity required to merge profiles.
|
410
|
+
# @return [Float]
|
411
|
+
#
|
398
412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AutoMerging AWS API Documentation
|
399
413
|
#
|
400
414
|
class AutoMerging < Struct.new(
|
401
415
|
:enabled,
|
402
416
|
:consolidation,
|
403
|
-
:conflict_resolution
|
417
|
+
:conflict_resolution,
|
418
|
+
:min_allowed_confidence_score_for_merging)
|
404
419
|
SENSITIVE = []
|
405
420
|
include Aws::Structure
|
406
421
|
end
|
@@ -580,6 +595,7 @@ module Aws::CustomerProfiles
|
|
580
595
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
581
596
|
# source_name: "string1To255",
|
582
597
|
# },
|
598
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
583
599
|
# },
|
584
600
|
# exporting_config: {
|
585
601
|
# s3_exporting: {
|
@@ -1691,6 +1707,7 @@ module Aws::CustomerProfiles
|
|
1691
1707
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
1692
1708
|
# source_name: "string1To255",
|
1693
1709
|
# },
|
1710
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
1694
1711
|
# }
|
1695
1712
|
#
|
1696
1713
|
# @!attribute [rw] domain_name
|
@@ -1706,12 +1723,18 @@ module Aws::CustomerProfiles
|
|
1706
1723
|
# different profiles.
|
1707
1724
|
# @return [Types::ConflictResolution]
|
1708
1725
|
#
|
1726
|
+
# @!attribute [rw] min_allowed_confidence_score_for_merging
|
1727
|
+
# Minimum confidence score required for profiles within a matching
|
1728
|
+
# group to be merged during the auto-merge process.
|
1729
|
+
# @return [Float]
|
1730
|
+
#
|
1709
1731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetAutoMergingPreviewRequest AWS API Documentation
|
1710
1732
|
#
|
1711
1733
|
class GetAutoMergingPreviewRequest < Struct.new(
|
1712
1734
|
:domain_name,
|
1713
1735
|
:consolidation,
|
1714
|
-
:conflict_resolution
|
1736
|
+
:conflict_resolution,
|
1737
|
+
:min_allowed_confidence_score_for_merging)
|
1715
1738
|
SENSITIVE = []
|
1716
1739
|
include Aws::Structure
|
1717
1740
|
end
|
@@ -3369,9 +3392,15 @@ module Aws::CustomerProfiles
|
|
3369
3392
|
# @return [Array<String>]
|
3370
3393
|
#
|
3371
3394
|
# @!attribute [rw] confidence_score
|
3372
|
-
# A number between 0 and 1
|
3373
|
-
#
|
3374
|
-
#
|
3395
|
+
# A number between 0 and 1, where a higher score means higher
|
3396
|
+
# similarity. Examining match confidence scores lets you distinguish
|
3397
|
+
# between groups of similar records in which the system is highly
|
3398
|
+
# confident (which you may decide to merge), groups of similar records
|
3399
|
+
# about which the system is uncertain (which you may decide to have
|
3400
|
+
# reviewed by a human), and groups of similar records that the system
|
3401
|
+
# deems to be unlikely (which you may decide to reject). Given
|
3402
|
+
# confidence scores vary as per the data input, it should not be used
|
3403
|
+
# an absolute measure of matching quality.
|
3375
3404
|
# @return [Float]
|
3376
3405
|
#
|
3377
3406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchItem AWS API Documentation
|
@@ -3406,6 +3435,7 @@ module Aws::CustomerProfiles
|
|
3406
3435
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
3407
3436
|
# source_name: "string1To255",
|
3408
3437
|
# },
|
3438
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
3409
3439
|
# },
|
3410
3440
|
# exporting_config: {
|
3411
3441
|
# s3_exporting: {
|
@@ -4047,7 +4077,14 @@ module Aws::CustomerProfiles
|
|
4047
4077
|
# @return [String]
|
4048
4078
|
#
|
4049
4079
|
# @!attribute [rw] template_id
|
4050
|
-
# A unique identifier for the object template.
|
4080
|
+
# A unique identifier for the object template. For some attributes in
|
4081
|
+
# the request, the service will use the default value from the object
|
4082
|
+
# template when TemplateId is present. If these attributes are present
|
4083
|
+
# in the request, the service may return a `BadRequestException`.
|
4084
|
+
# These attributes include: AllowProfileCreation,
|
4085
|
+
# SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
|
4086
|
+
# AllowProfileCreation is set to true when TemplateId is set, the
|
4087
|
+
# service may return a `BadRequestException`.
|
4051
4088
|
# @return [String]
|
4052
4089
|
#
|
4053
4090
|
# @!attribute [rw] expiration_days
|
@@ -4899,6 +4936,7 @@ module Aws::CustomerProfiles
|
|
4899
4936
|
# conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
|
4900
4937
|
# source_name: "string1To255",
|
4901
4938
|
# },
|
4939
|
+
# min_allowed_confidence_score_for_merging: 1.0,
|
4902
4940
|
# },
|
4903
4941
|
# exporting_config: {
|
4904
4942
|
# s3_exporting: {
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-customerprofiles
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.21.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-06-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|