aws-sdk-customerprofiles 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9807cd1cb915479c1936925a7323284eb6ea79bcd367161b21a6f5077320955b
-  data.tar.gz: 31957275151a4ccddf2381596a4fc8c1c33c46a999d88f243230788c4ae1e2ab
+  metadata.gz: 1cf8252e3e392e9db017f0496fb466f12e1e6c4175df18911628f7204d7fee3f
+  data.tar.gz: e574411ae7d0fb5fffc597863a7147b0e03a368efeea1d54a3d5615c7f7c66b6
 SHA512:
-  metadata.gz: 6583830c8f9436e3f9932a23cc95bfc8116a614d1fe40026be982e25b1d034e6ddd495576b102a795645bd75a337f773c1ac7ee4208e0632f978872d72b0af5a
-  data.tar.gz: 8c28098fa6d8a3e5f4b446b2e4e8a18c844f7288943a744fd671a3c4a8a469b7ec797172132be1050767e4f7600c2f3e2ed934439198e44f6d380672362bc6c2
+  metadata.gz: 7ed826c479c4f35dccb78b28c13a14f4b4cc90b9c2fcf2a210f9769b4675aa80b255f65d14855d3940db0125b39aa2809bcda94acc0e2a51a1287f18be91d057
+  data.tar.gz: 3e837f6b804a568c1bf6b4bf541979e51eeaaee932226f64e8e6c22b0c7e78d558e4096146dbed7638c991c6149c7c37b4a54153345d79bfc8b7c0ceb1e9b74d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.21.0 (2022-06-30)
+------------------
+
+* 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.
+
 1.20.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.20.0
+1.21.0

data/lib/aws-sdk-customerprofiles/client.rb

@@ -362,7 +362,13 @@ module Aws::CustomerProfiles
     #   The unique identifier of a customer profile.
     #
     # @option params [required, String] :key_name
-    #   A searchable identifier of a customer profile.
+    #   A searchable identifier of a customer profile. The predefined keys you
+    #   can use include: \_account, \_profileId, \_assetId, \_caseId,
+    #   \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
+    #   \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
+    #   \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
+    #   \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
+    #   \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
     #
     # @option params [required, Array<String>] :values
     #   A list of key values.
@@ -492,6 +498,7 @@ module Aws::CustomerProfiles
     #           conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #           source_name: "string1To255",
     #         },
+    #         min_allowed_confidence_score_for_merging: 1.0,
     #       },
     #       exporting_config: {
     #         s3_exporting: {
@@ -520,6 +527,7 @@ module Aws::CustomerProfiles
     #   resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
     #   resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
     #   resp.matching.auto_merging.conflict_resolution.source_name #=> String
+    #   resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
     #   resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
     #   resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
@@ -1095,6 +1103,10 @@ module Aws::CustomerProfiles
     #   How the auto-merging process should resolve conflicts between
     #   different profiles.
     #
+    # @option params [Float] :min_allowed_confidence_score_for_merging
+    #   Minimum confidence score required for profiles within a matching group
+    #   to be merged during the auto-merge process.
+    #
     # @return [Types::GetAutoMergingPreviewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetAutoMergingPreviewResponse#domain_name #domain_name} => String
@@ -1115,6 +1127,7 @@ module Aws::CustomerProfiles
     #       conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #       source_name: "string1To255",
     #     },
+    #     min_allowed_confidence_score_for_merging: 1.0,
     #   })
     #
     # @example Response structure
@@ -1175,6 +1188,7 @@ module Aws::CustomerProfiles
     #   resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
     #   resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
     #   resp.matching.auto_merging.conflict_resolution.source_name #=> String
+    #   resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
     #   resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
     #   resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
@@ -1245,6 +1259,7 @@ module Aws::CustomerProfiles
     #   resp.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
     #   resp.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
     #   resp.auto_merging.conflict_resolution.source_name #=> String
+    #   resp.auto_merging.min_allowed_confidence_score_for_merging #=> Float
     #   resp.exporting_location.s3_exporting.s3_bucket_name #=> String
     #   resp.exporting_location.s3_exporting.s3_key_name #=> String
     #   resp.job_stats.number_of_profiles_reviewed #=> Integer
@@ -2362,7 +2377,14 @@ module Aws::CustomerProfiles
     #   Description of the profile object type.
     #
     # @option params [String] :template_id
-    #   A unique identifier for the object template.
+    #   A unique identifier for the object template. For some attributes in
+    #   the request, the service will use the default value from the object
+    #   template when TemplateId is present. If these attributes are present
+    #   in the request, the service may return a `BadRequestException`. These
+    #   attributes include: AllowProfileCreation,
+    #   SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
+    #   AllowProfileCreation is set to true when TemplateId is set, the
+    #   service may return a `BadRequestException`.
     #
     # @option params [Integer] :expiration_days
     #   The number of days until the data in the object expires.
@@ -2747,6 +2769,7 @@ module Aws::CustomerProfiles
     #           conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #           source_name: "string1To255",
     #         },
+    #         min_allowed_confidence_score_for_merging: 1.0,
     #       },
     #       exporting_config: {
     #         s3_exporting: {
@@ -2775,6 +2798,7 @@ module Aws::CustomerProfiles
     #   resp.matching.auto_merging.consolidation.matching_attributes_list[0][0] #=> String
     #   resp.matching.auto_merging.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
     #   resp.matching.auto_merging.conflict_resolution.source_name #=> String
+    #   resp.matching.auto_merging.min_allowed_confidence_score_for_merging #=> Float
     #   resp.matching.exporting_config.s3_exporting.s3_bucket_name #=> String
     #   resp.matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
@@ -2974,7 +2998,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.20.0'
+      context[:gem_version] = '1.21.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-customerprofiles/client_api.rb

@@ -61,6 +61,7 @@ module Aws::CustomerProfiles
     DomainList = Shapes::ListShape.new(name: 'DomainList')
     DomainStats = Shapes::StructureShape.new(name: 'DomainStats')
     Double = Shapes::FloatShape.new(name: 'Double')
+    Double0To1 = Shapes::FloatShape.new(name: 'Double0To1')
     ExportingConfig = Shapes::StructureShape.new(name: 'ExportingConfig')
     ExportingLocation = Shapes::StructureShape.new(name: 'ExportingLocation')
     FieldContentType = Shapes::StringShape.new(name: 'FieldContentType')
@@ -296,6 +297,7 @@ module Aws::CustomerProfiles
     AutoMerging.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, required: true, location_name: "Enabled"))
     AutoMerging.add_member(:consolidation, Shapes::ShapeRef.new(shape: Consolidation, location_name: "Consolidation"))
     AutoMerging.add_member(:conflict_resolution, Shapes::ShapeRef.new(shape: ConflictResolution, location_name: "ConflictResolution"))
+    AutoMerging.add_member(:min_allowed_confidence_score_for_merging, Shapes::ShapeRef.new(shape: Double0To1, location_name: "MinAllowedConfidenceScoreForMerging"))
     AutoMerging.struct_class = Types::AutoMerging
 
     BadRequestException.add_member(:message, Shapes::ShapeRef.new(shape: message, location_name: "Message"))
@@ -482,6 +484,7 @@ module Aws::CustomerProfiles
     GetAutoMergingPreviewRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
     GetAutoMergingPreviewRequest.add_member(:consolidation, Shapes::ShapeRef.new(shape: Consolidation, required: true, location_name: "Consolidation"))
     GetAutoMergingPreviewRequest.add_member(:conflict_resolution, Shapes::ShapeRef.new(shape: ConflictResolution, required: true, location_name: "ConflictResolution"))
+    GetAutoMergingPreviewRequest.add_member(:min_allowed_confidence_score_for_merging, Shapes::ShapeRef.new(shape: Double0To1, location_name: "MinAllowedConfidenceScoreForMerging"))
     GetAutoMergingPreviewRequest.struct_class = Types::GetAutoMergingPreviewRequest
 
     GetAutoMergingPreviewResponse.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "DomainName"))

data/lib/aws-sdk-customerprofiles/types.rb

@@ -38,7 +38,13 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] key_name
-    #   A searchable identifier of a customer profile.
+    #   A searchable identifier of a customer profile. The predefined keys
+    #   you can use include: \_account, \_profileId, \_assetId, \_caseId,
+    #   \_orderId, \_fullName, \_phone, \_email, \_ctrContactId,
+    #   \_marketoLeadId, \_salesforceAccountId, \_salesforceContactId,
+    #   \_salesforceAssetId, \_zendeskUserId, \_zendeskExternalId,
+    #   \_zendeskTicketId, \_serviceNowSystemId, \_serviceNowIncidentId,
+    #   \_segmentUserId, \_shopifyCustomerId, \_shopifyOrderId.
     #   @return [String]
     #
     # @!attribute [rw] values
@@ -376,6 +382,7 @@ module Aws::CustomerProfiles
     #           conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #           source_name: "string1To255",
     #         },
+    #         min_allowed_confidence_score_for_merging: 1.0,
     #       }
     #
     # @!attribute [rw] enabled
@@ -395,12 +402,20 @@ module Aws::CustomerProfiles
     #   which `EmailAddress` should be used?
     #   @return [Types::ConflictResolution]
     #
+    # @!attribute [rw] min_allowed_confidence_score_for_merging
+    #   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.
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AutoMerging AWS API Documentation
     #
     class AutoMerging < Struct.new(
       :enabled,
       :consolidation,
-      :conflict_resolution)
+      :conflict_resolution,
+      :min_allowed_confidence_score_for_merging)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -580,6 +595,7 @@ module Aws::CustomerProfiles
     #               conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #               source_name: "string1To255",
     #             },
+    #             min_allowed_confidence_score_for_merging: 1.0,
     #           },
     #           exporting_config: {
     #             s3_exporting: {
@@ -1691,6 +1707,7 @@ module Aws::CustomerProfiles
     #           conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #           source_name: "string1To255",
     #         },
+    #         min_allowed_confidence_score_for_merging: 1.0,
     #       }
     #
     # @!attribute [rw] domain_name
@@ -1706,12 +1723,18 @@ module Aws::CustomerProfiles
     #   different profiles.
     #   @return [Types::ConflictResolution]
     #
+    # @!attribute [rw] min_allowed_confidence_score_for_merging
+    #   Minimum confidence score required for profiles within a matching
+    #   group to be merged during the auto-merge process.
+    #   @return [Float]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetAutoMergingPreviewRequest AWS API Documentation
     #
     class GetAutoMergingPreviewRequest < Struct.new(
       :domain_name,
       :consolidation,
-      :conflict_resolution)
+      :conflict_resolution,
+      :min_allowed_confidence_score_for_merging)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3369,9 +3392,15 @@ module Aws::CustomerProfiles
     #   @return [Array<String>]
     #
     # @!attribute [rw] confidence_score
-    #   A number between 0 and 1 that represents the confidence level of
-    #   assigning profiles to a matching group. A score of 1 likely
-    #   indicates an exact match.
+    #   A number between 0 and 1, where a higher score means higher
+    #   similarity. Examining match confidence scores lets you distinguish
+    #   between groups of similar records in which the system is highly
+    #   confident (which you may decide to merge), groups of similar records
+    #   about which the system is uncertain (which you may decide to have
+    #   reviewed by a human), and groups of similar records that the system
+    #   deems to be unlikely (which you may decide to reject). Given
+    #   confidence scores vary as per the data input, it should not be used
+    #   an absolute measure of matching quality.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MatchItem AWS API Documentation
@@ -3406,6 +3435,7 @@ module Aws::CustomerProfiles
     #             conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #             source_name: "string1To255",
     #           },
+    #           min_allowed_confidence_score_for_merging: 1.0,
     #         },
     #         exporting_config: {
     #           s3_exporting: {
@@ -4047,7 +4077,14 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] template_id
-    #   A unique identifier for the object template.
+    #   A unique identifier for the object template. For some attributes in
+    #   the request, the service will use the default value from the object
+    #   template when TemplateId is present. If these attributes are present
+    #   in the request, the service may return a `BadRequestException`.
+    #   These attributes include: AllowProfileCreation,
+    #   SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
+    #   AllowProfileCreation is set to true when TemplateId is set, the
+    #   service may return a `BadRequestException`.
     #   @return [String]
     #
     # @!attribute [rw] expiration_days
@@ -4899,6 +4936,7 @@ module Aws::CustomerProfiles
     #               conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
     #               source_name: "string1To255",
     #             },
+    #             min_allowed_confidence_score_for_merging: 1.0,
     #           },
     #           exporting_config: {
     #             s3_exporting: {

data/lib/aws-sdk-customerprofiles.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-customerprofiles/customizations'
 # @!group service
 module Aws::CustomerProfiles
 
-  GEM_VERSION = '1.20.0'
+  GEM_VERSION = '1.21.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-customerprofiles
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core