aws-sdk-customerprofiles 1.34.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9feca08f2fee542d7df1d1b6d42ec6ba17cd821b0164d1adbbf53799e989aa4
-  data.tar.gz: 8879c8150a2f143c8966750661f7249b11b5aa88f4122b80cf8b9c4714b5941c
+  metadata.gz: b2397b7f2d45e6342f64f023dce128e73505e507234c984c18d21902e66e446a
+  data.tar.gz: ed7a881e7160fac748fb71aaca71bc340cadd19e74b067a9256576caa7c56111
 SHA512:
-  metadata.gz: 7bd33840823b1c608b8887a32852071d3cc85e88be08f1f418a7a9990a6a172a9b11f3eb60becafec11be0dea3089adcb87fea7e58e49f78d6c4160c0d339a43
-  data.tar.gz: a8b5b9fb704d94b7fd889a38f41327b04fda1b93f025cba070ae9f44cb7a9f82d0eec2600118a3282a77a560cf4f9ce79c0ac65ec5403ffe3736be59998c1ae3
+  metadata.gz: 2825abbede415d15a84e0258eb71156b8c87b9d5eb8e2e3c962616034d6bc473147e1e69b2d28ced002cf5683e3a656eaa08d446cd5e489dec016041950b88e9
+  data.tar.gz: 7fed9b377a7dc13c01ba8b2bd1b097947eb3133a1ead7d3a9a5be8e10000cf181fa41ddde502499e445266d61dfae4f75d15b98fff4e9763570c3c9ac4cf0128

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.36.0 (2023-08-31)
+------------------
+
+* Feature - Adds sensitive trait to various shapes in Customer Profiles API model.
+
+1.35.0 (2023-07-25)
+------------------
+
+* Feature - Amazon Connect Customer Profiles now supports rule-based resolution to match and merge similar profiles into unified profiles, helping companies deliver faster and more personalized customer service by providing access to relevant customer information for agents and automated experiences.
+
 1.34.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.34.0
+1.36.0

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

@@ -607,6 +607,15 @@ module Aws::CustomerProfiles
     #
     #   [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
     #
+    # @option params [Types::RuleBasedMatchingRequest] :rule_based_matching
+    #   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.
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags used to organize, track, or control access for this resource.
     #
@@ -617,6 +626,7 @@ module Aws::CustomerProfiles
     #   * {Types::CreateDomainResponse#default_encryption_key #default_encryption_key} => String
     #   * {Types::CreateDomainResponse#dead_letter_queue_url #dead_letter_queue_url} => String
     #   * {Types::CreateDomainResponse#matching #matching} => Types::MatchingResponse
+    #   * {Types::CreateDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
     #   * {Types::CreateDomainResponse#created_at #created_at} => Time
     #   * {Types::CreateDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::CreateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -654,6 +664,32 @@ module Aws::CustomerProfiles
     #         },
     #       },
     #     },
+    #     rule_based_matching: {
+    #       enabled: false, # required
+    #       matching_rules: [
+    #         {
+    #           rule: ["string1To255"], # required
+    #         },
+    #       ],
+    #       max_allowed_rule_level_for_merging: 1,
+    #       max_allowed_rule_level_for_matching: 1,
+    #       attribute_types_selector: {
+    #         attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
+    #         address: ["string1To255"],
+    #         phone_number: ["string1To255"],
+    #         email_address: ["string1To255"],
+    #       },
+    #       conflict_resolution: {
+    #         conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
+    #         source_name: "string1To255",
+    #       },
+    #       exporting_config: {
+    #         s3_exporting: {
+    #           s3_bucket_name: "s3BucketName", # required
+    #           s3_key_name: "s3KeyNameCustomerOutputConfig",
+    #         },
+    #       },
+    #     },
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -677,6 +713,24 @@ module Aws::CustomerProfiles
     #   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.rule_based_matching.enabled #=> Boolean
+    #   resp.rule_based_matching.matching_rules #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule[0] #=> String
+    #   resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
+    #   resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
+    #   resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
+    #   resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
+    #   resp.rule_based_matching.attribute_types_selector.address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.address[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.email_address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
+    #   resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
+    #   resp.rule_based_matching.conflict_resolution.source_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -961,22 +1015,22 @@ module Aws::CustomerProfiles
     #
     #   resp = client.create_profile({
     #     domain_name: "name", # required
-    #     account_number: "string1To255",
-    #     additional_information: "string1To1000",
+    #     account_number: "sensitiveString1To255",
+    #     additional_information: "sensitiveString1To1000",
     #     party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
-    #     business_name: "string1To255",
-    #     first_name: "string1To255",
-    #     middle_name: "string1To255",
-    #     last_name: "string1To255",
-    #     birth_date: "string1To255",
+    #     business_name: "sensitiveString1To255",
+    #     first_name: "sensitiveString1To255",
+    #     middle_name: "sensitiveString1To255",
+    #     last_name: "sensitiveString1To255",
+    #     birth_date: "sensitiveString1To255",
     #     gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
-    #     phone_number: "string1To255",
-    #     mobile_phone_number: "string1To255",
-    #     home_phone_number: "string1To255",
-    #     business_phone_number: "string1To255",
-    #     email_address: "string1To255",
-    #     personal_email_address: "string1To255",
-    #     business_email_address: "string1To255",
+    #     phone_number: "sensitiveString1To255",
+    #     mobile_phone_number: "sensitiveString1To255",
+    #     home_phone_number: "sensitiveString1To255",
+    #     business_phone_number: "sensitiveString1To255",
+    #     email_address: "sensitiveString1To255",
+    #     personal_email_address: "sensitiveString1To255",
+    #     business_email_address: "sensitiveString1To255",
     #     address: {
     #       address_1: "string1To255",
     #       address_2: "string1To255",
@@ -1028,8 +1082,8 @@ module Aws::CustomerProfiles
     #     attributes: {
     #       "string1To255" => "string1To255",
     #     },
-    #     party_type_string: "string1To255",
-    #     gender_string: "string1To255",
+    #     party_type_string: "sensitiveString1To255",
+    #     gender_string: "sensitiveString1To255",
     #   })
     #
     # @example Response structure
@@ -1520,6 +1574,7 @@ module Aws::CustomerProfiles
     #   * {Types::GetDomainResponse#dead_letter_queue_url #dead_letter_queue_url} => String
     #   * {Types::GetDomainResponse#stats #stats} => Types::DomainStats
     #   * {Types::GetDomainResponse#matching #matching} => Types::MatchingResponse
+    #   * {Types::GetDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
     #   * {Types::GetDomainResponse#created_at #created_at} => Time
     #   * {Types::GetDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::GetDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -1552,6 +1607,24 @@ module Aws::CustomerProfiles
     #   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.rule_based_matching.enabled #=> Boolean
+    #   resp.rule_based_matching.matching_rules #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule[0] #=> String
+    #   resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
+    #   resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
+    #   resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
+    #   resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
+    #   resp.rule_based_matching.attribute_types_selector.address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.address[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.email_address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
+    #   resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
+    #   resp.rule_based_matching.conflict_resolution.source_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -1947,6 +2020,68 @@ module Aws::CustomerProfiles
       req.send_request(options)
     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`.
+    #
+    # @option params [String] :next_token
+    #   The pagination token from the previous `GetSimilarProfiles` API call.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of objects returned per page.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :match_type
+    #   Specify the type of matching to get similar profiles for.
+    #
+    # @option params [required, String] :search_key
+    #   The string indicating the search key to be used.
+    #
+    # @option params [required, String] :search_value
+    #   The string based on `SearchKey` to be searched for similar profiles.
+    #
+    # @return [Types::GetSimilarProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetSimilarProfilesResponse#profile_ids #profile_ids} => Array&lt;String&gt;
+    #   * {Types::GetSimilarProfilesResponse#match_id #match_id} => String
+    #   * {Types::GetSimilarProfilesResponse#match_type #match_type} => String
+    #   * {Types::GetSimilarProfilesResponse#rule_level #rule_level} => Integer
+    #   * {Types::GetSimilarProfilesResponse#confidence_score #confidence_score} => Float
+    #   * {Types::GetSimilarProfilesResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_similar_profiles({
+    #     next_token: "token",
+    #     max_results: 1,
+    #     domain_name: "name", # required
+    #     match_type: "RULE_BASED_MATCHING", # required, accepts RULE_BASED_MATCHING, ML_BASED_MATCHING
+    #     search_key: "string1To255", # required
+    #     search_value: "string1To255", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.profile_ids #=> Array
+    #   resp.profile_ids[0] #=> String
+    #   resp.match_id #=> String
+    #   resp.match_type #=> String, one of "RULE_BASED_MATCHING", "ML_BASED_MATCHING"
+    #   resp.rule_level #=> Integer
+    #   resp.confidence_score #=> Float
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetSimilarProfiles AWS API Documentation
+    #
+    # @overload get_similar_profiles(params = {})
+    # @param [Hash] params ({})
+    def get_similar_profiles(params = {}, options = {})
+      req = build_request(:get_similar_profiles, params)
+      req.send_request(options)
+    end
+
     # Get details of specified workflow.
     #
     # @option params [required, String] :domain_name
@@ -2539,6 +2674,46 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # Returns a set of `MatchIds` that belong to the given domain.
+    #
+    # @option params [String] :next_token
+    #   The pagination token from the previous `ListRuleBasedMatches` API
+    #   call.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of `MatchIds` returned per page.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @return [Types::ListRuleBasedMatchesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListRuleBasedMatchesResponse#match_ids #match_ids} => Array&lt;String&gt;
+    #   * {Types::ListRuleBasedMatchesResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_rule_based_matches({
+    #     next_token: "token",
+    #     max_results: 1,
+    #     domain_name: "name", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.match_ids #=> Array
+    #   resp.match_ids[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRuleBasedMatches AWS API Documentation
+    #
+    # @overload list_rule_based_matches(params = {})
+    # @param [Hash] params ({})
+    def list_rule_based_matches(params = {}, options = {})
+      req = build_request(:list_rule_based_matches, params)
+      req.send_request(options)
+    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.
@@ -3009,7 +3184,7 @@ module Aws::CustomerProfiles
     #   resp = client.put_profile_object_type({
     #     domain_name: "name", # required
     #     object_type_name: "typeName", # required
-    #     description: "text", # required
+    #     description: "sensitiveText", # required
     #     template_id: "name",
     #     expiration_days: 1,
     #     encryption_key: "encryptionKey",
@@ -3440,6 +3615,15 @@ module Aws::CustomerProfiles
     #
     #   [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
     #
+    # @option params [Types::RuleBasedMatchingRequest] :rule_based_matching
+    #   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.
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags used to organize, track, or control access for this resource.
     #
@@ -3450,6 +3634,7 @@ module Aws::CustomerProfiles
     #   * {Types::UpdateDomainResponse#default_encryption_key #default_encryption_key} => String
     #   * {Types::UpdateDomainResponse#dead_letter_queue_url #dead_letter_queue_url} => String
     #   * {Types::UpdateDomainResponse#matching #matching} => Types::MatchingResponse
+    #   * {Types::UpdateDomainResponse#rule_based_matching #rule_based_matching} => Types::RuleBasedMatchingResponse
     #   * {Types::UpdateDomainResponse#created_at #created_at} => Time
     #   * {Types::UpdateDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::UpdateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -3487,6 +3672,32 @@ module Aws::CustomerProfiles
     #         },
     #       },
     #     },
+    #     rule_based_matching: {
+    #       enabled: false, # required
+    #       matching_rules: [
+    #         {
+    #           rule: ["string1To255"], # required
+    #         },
+    #       ],
+    #       max_allowed_rule_level_for_merging: 1,
+    #       max_allowed_rule_level_for_matching: 1,
+    #       attribute_types_selector: {
+    #         attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
+    #         address: ["string1To255"],
+    #         phone_number: ["string1To255"],
+    #         email_address: ["string1To255"],
+    #       },
+    #       conflict_resolution: {
+    #         conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
+    #         source_name: "string1To255",
+    #       },
+    #       exporting_config: {
+    #         s3_exporting: {
+    #           s3_bucket_name: "s3BucketName", # required
+    #           s3_key_name: "s3KeyNameCustomerOutputConfig",
+    #         },
+    #       },
+    #     },
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -3510,6 +3721,24 @@ module Aws::CustomerProfiles
     #   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.rule_based_matching.enabled #=> Boolean
+    #   resp.rule_based_matching.matching_rules #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule #=> Array
+    #   resp.rule_based_matching.matching_rules[0].rule[0] #=> String
+    #   resp.rule_based_matching.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE"
+    #   resp.rule_based_matching.max_allowed_rule_level_for_merging #=> Integer
+    #   resp.rule_based_matching.max_allowed_rule_level_for_matching #=> Integer
+    #   resp.rule_based_matching.attribute_types_selector.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
+    #   resp.rule_based_matching.attribute_types_selector.address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.address[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.phone_number #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.phone_number[0] #=> String
+    #   resp.rule_based_matching.attribute_types_selector.email_address #=> Array
+    #   resp.rule_based_matching.attribute_types_selector.email_address[0] #=> String
+    #   resp.rule_based_matching.conflict_resolution.conflict_resolving_model #=> String, one of "RECENCY", "SOURCE"
+    #   resp.rule_based_matching.conflict_resolution.source_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_bucket_name #=> String
+    #   resp.rule_based_matching.exporting_config.s3_exporting.s3_key_name #=> String
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -3618,22 +3847,22 @@ module Aws::CustomerProfiles
     #   resp = client.update_profile({
     #     domain_name: "name", # required
     #     profile_id: "uuid", # required
-    #     additional_information: "string0To1000",
-    #     account_number: "string0To255",
+    #     additional_information: "sensitiveString0To1000",
+    #     account_number: "sensitiveString0To255",
     #     party_type: "INDIVIDUAL", # accepts INDIVIDUAL, BUSINESS, OTHER
-    #     business_name: "string0To255",
-    #     first_name: "string0To255",
-    #     middle_name: "string0To255",
-    #     last_name: "string0To255",
-    #     birth_date: "string0To255",
+    #     business_name: "sensitiveString0To255",
+    #     first_name: "sensitiveString0To255",
+    #     middle_name: "sensitiveString0To255",
+    #     last_name: "sensitiveString0To255",
+    #     birth_date: "sensitiveString0To255",
     #     gender: "MALE", # accepts MALE, FEMALE, UNSPECIFIED
-    #     phone_number: "string0To255",
-    #     mobile_phone_number: "string0To255",
-    #     home_phone_number: "string0To255",
-    #     business_phone_number: "string0To255",
-    #     email_address: "string0To255",
-    #     personal_email_address: "string0To255",
-    #     business_email_address: "string0To255",
+    #     phone_number: "sensitiveString0To255",
+    #     mobile_phone_number: "sensitiveString0To255",
+    #     home_phone_number: "sensitiveString0To255",
+    #     business_phone_number: "sensitiveString0To255",
+    #     email_address: "sensitiveString0To255",
+    #     personal_email_address: "sensitiveString0To255",
+    #     business_email_address: "sensitiveString0To255",
     #     address: {
     #       address_1: "string0To255",
     #       address_2: "string0To255",
@@ -3685,8 +3914,8 @@ module Aws::CustomerProfiles
     #     attributes: {
     #       "string1To255" => "string0To255",
     #     },
-    #     party_type_string: "string0To255",
-    #     gender_string: "string0To255",
+    #     party_type_string: "sensitiveString0To255",
+    #     gender_string: "sensitiveString0To255",
     #   })
     #
     # @example Response structure
@@ -3715,7 +3944,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.34.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end