aws-sdk-customerprofiles 1.6.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42cec8721c4f629deb11cfde3f4f11cc0e48cc6084ffff896ff2cb439f31999
-  data.tar.gz: 881173fa9b9cf461375e4fcb0f0fe92878af5ef0f59022f6b103fbe18d629a5c
+  metadata.gz: d08270ee45732b3861cd2b3d6f649c34b5e0025c6335b5266274cc363a3b973f
+  data.tar.gz: 9c070744ed8e28f7c2e2c5138edeb822cfbf65f5a65e1da8dc3a88d2973547aa
 SHA512:
-  metadata.gz: abc20df7cc3071a035d3a92957a47879ca79df479e34a73d733bea3867c4a5b2c42b155d1de2724955291458176c55fe3e108a4958e4d42cbce9a39618d769b2
-  data.tar.gz: 4ed50f0318b59af9277dbe4f75a5ec6368ef78b940e1285c222a64750fa9d0179b9cce0aedfe1c2dd31d0621675e7149cf77ba9bd84076af6462eafd0318a62a
+  metadata.gz: 89effe39941773b84ebdf628675adb04260b2a45ceebd6dc1d6d05d0872d26e8d5ff611833669afbdbcc2c7707464c91d714a1f724d8c6d00b0a4456905f53ff
+  data.tar.gz: 3085171dd3999f03434fc035db404f53b22e00af341ab74a7cba654e87375936c300cdf58246d5627078aff204d6eb81c183981d26b5253c5774904e82ad3478

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.10.0 (2021-08-13)
+------------------
+
+* Feature - This release introduces Standard Profile Objects, namely Asset and Case which contain values populated by data from third party systems and belong to a specific profile. This release adds an optional parameter, ObjectFilter to the ListProfileObjects API in order to search for these Standard Objects.
+
+1.9.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.8.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.7.0 (2021-04-30)
+------------------
+
+* Feature - This release introduces GetMatches and MergeProfiles APIs to fetch and merge duplicate profiles
+
 1.6.0 (2021-04-08)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.10.0

data/lib/aws-sdk-customerprofiles.rb

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

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

@@ -383,6 +383,14 @@ module Aws::CustomerProfiles
     # 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][1] to enable [identity resolution][2]\:
+    # set `Matching` to true.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
+    # [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
+    #
     # @option params [required, String] :domain_name
     #   The unique name of the domain.
     #
@@ -401,6 +409,17 @@ module Aws::CustomerProfiles
     #   operation to enable Amazon Connect Customer Profiles to send messages
     #   to the DeadLetterQueue.
     #
+    # @option params [Types::MatchingRequest] :matching
+    #   The process of matching duplicate profiles. If Matching = true, Amazon
+    #   Connect Customer Profiles starts a weekly batch process every Saturday
+    #   at 12AM UTC to detect duplicate profiles in your domains. After that
+    #   batch process completes, use the [GetMatches][1] API to return and
+    #   review the results.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags used to organize, track, or control access for this resource.
     #
@@ -410,6 +429,7 @@ module Aws::CustomerProfiles
     #   * {Types::CreateDomainResponse#default_expiration_days #default_expiration_days} => Integer
     #   * {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#created_at #created_at} => Time
     #   * {Types::CreateDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::CreateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -421,6 +441,9 @@ module Aws::CustomerProfiles
     #     default_expiration_days: 1, # required
     #     default_encryption_key: "encryptionKey",
     #     dead_letter_queue_url: "sqsQueueUrl",
+    #     matching: {
+    #       enabled: false, # required
+    #     },
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -432,6 +455,7 @@ module Aws::CustomerProfiles
     #   resp.default_expiration_days #=> Integer
     #   resp.default_encryption_key #=> String
     #   resp.dead_letter_queue_url #=> String
+    #   resp.matching.enabled #=> Boolean
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -458,7 +482,7 @@ module Aws::CustomerProfiles
     #   A unique account number that you have given to the customer.
     #
     # @option params [String] :additional_information
-    #   Any additional information relevant to the customer's profile.
+    #   Any additional information relevant to the customer’s profile.
     #
     # @option params [String] :party_type
     #   The type of profile used to describe the customer.
@@ -482,8 +506,8 @@ module Aws::CustomerProfiles
     #   The gender with which the customer identifies.
     #
     # @option params [String] :phone_number
-    #   The customer's phone number, which has not been specified as a
-    #   mobile, home, or business number.
+    #   The customer’s phone number, which has not been specified as a mobile,
+    #   home, or business number.
     #
     # @option params [String] :mobile_phone_number
     #   The customer’s mobile phone number.
@@ -495,7 +519,7 @@ module Aws::CustomerProfiles
     #   The customer’s business phone number.
     #
     # @option params [String] :email_address
-    #   The customer's email address, which has not been specified as a
+    #   The customer’s email address, which has not been specified as a
     #   personal or business address.
     #
     # @option params [String] :personal_email_address
@@ -824,7 +848,7 @@ module Aws::CustomerProfiles
     # Returns information about a specific domain.
     #
     # @option params [required, String] :domain_name
-    #   A unique name for the domain.
+    #   The unique name of the domain.
     #
     # @return [Types::GetDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -833,6 +857,7 @@ module Aws::CustomerProfiles
     #   * {Types::GetDomainResponse#default_encryption_key #default_encryption_key} => String
     #   * {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#created_at #created_at} => Time
     #   * {Types::GetDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::GetDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -853,6 +878,7 @@ module Aws::CustomerProfiles
     #   resp.stats.metering_profile_count #=> Integer
     #   resp.stats.object_count #=> Integer
     #   resp.stats.total_size #=> Integer
+    #   resp.matching.enabled #=> Boolean
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -910,6 +936,97 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # This API is in preview release for Amazon Connect and subject to
+    # change.
+    #
+    # Before calling this API, use [CreateDomain][1] or [UpdateDomain][2] to
+    # enable identity resolution: set `Matching` to true.
+    #
+    # GetMatches returns potentially matching profiles, based on the results
+    # of the latest run of a machine learning process.
+    #
+    # Amazon Connect starts a batch process every Saturday at 12AM UTC to
+    # identify matching profiles. The results are returned up to seven days
+    # after the Saturday run.
+    #
+    # Amazon Connect uses the following profile attributes to identify
+    # matches:
+    #
+    # * PhoneNumber
+    #
+    # * HomePhoneNumber
+    #
+    # * BusinessPhoneNumber
+    #
+    # * MobilePhoneNumber
+    #
+    # * EmailAddress
+    #
+    # * PersonalEmailAddress
+    #
+    # * BusinessEmailAddress
+    #
+    # * FullName
+    #
+    # * BusinessName
+    #
+    # For example, two or more profiles—with spelling mistakes such as
+    # **John Doe** and **Jhn Doe**, or different casing email addresses such
+    # as **JOHN\_DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**, or
+    # different phone number formats such as **555-010-0000** and
+    # **+1-555-010-0000**—can be detected as belonging to the same customer
+    # **John Doe** and merged into a unified profile.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
+    # [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response in the next request to retrieve the next set of
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page.
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @return [Types::GetMatchesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetMatchesResponse#next_token #next_token} => String
+    #   * {Types::GetMatchesResponse#match_generation_date #match_generation_date} => Time
+    #   * {Types::GetMatchesResponse#potential_matches #potential_matches} => Integer
+    #   * {Types::GetMatchesResponse#matches #matches} => Array&lt;Types::MatchItem&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_matches({
+    #     next_token: "token",
+    #     max_results: 1,
+    #     domain_name: "name", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.match_generation_date #=> Time
+    #   resp.potential_matches #=> Integer
+    #   resp.matches #=> Array
+    #   resp.matches[0].match_id #=> String
+    #   resp.matches[0].profile_ids #=> Array
+    #   resp.matches[0].profile_ids[0] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetMatches AWS API Documentation
+    #
+    # @overload get_matches(params = {})
+    # @param [Hash] params ({})
+    def get_matches(params = {}, options = {})
+      req = build_request(:get_matches, params)
+      req.send_request(options)
+    end
+
     # Returns the object types for a specific domain.
     #
     # @option params [required, String] :domain_name
@@ -954,7 +1071,7 @@ module Aws::CustomerProfiles
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
-    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
+    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
     #   resp.keys["name"][0].field_names #=> Array
     #   resp.keys["name"][0].field_names[0] #=> String
     #   resp.created_at #=> Time
@@ -1010,7 +1127,7 @@ module Aws::CustomerProfiles
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
-    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
+    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
     #   resp.keys["name"][0].field_names #=> Array
     #   resp.keys["name"][0].field_names[0] #=> String
     #
@@ -1255,6 +1372,11 @@ module Aws::CustomerProfiles
     # @option params [required, String] :profile_id
     #   The unique identifier of a customer profile.
     #
+    # @option params [Types::ObjectFilter] :object_filter
+    #   Applies a filter to the response to include profile objects with the
+    #   specified index values. This filter is only supported for
+    #   ObjectTypeName \_asset and \_case.
+    #
     # @return [Types::ListProfileObjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListProfileObjectsResponse#items #items} => Array&lt;Types::ListProfileObjectsItem&gt;
@@ -1268,6 +1390,10 @@ module Aws::CustomerProfiles
     #     domain_name: "name", # required
     #     object_type_name: "typeName", # required
     #     profile_id: "uuid", # required
+    #     object_filter: {
+    #       key_name: "name", # required
+    #       values: ["string1To255"], # required
+    #     },
     #   })
     #
     # @example Response structure
@@ -1318,6 +1444,109 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
+    # This API is in preview release for Amazon Connect and subject to
+    # change.
+    #
+    # Runs an AWS Lambda job that does the following:
+    #
+    # 1.  All the profileKeys in the `ProfileToBeMerged` will be moved to
+    #     the main profile.
+    #
+    # 2.  All the objects in the `ProfileToBeMerged` will be moved to the
+    #     main profile.
+    #
+    # 3.  All the `ProfileToBeMerged` will be deleted at the end.
+    #
+    # 4.  All the profileKeys in the `ProfileIdsToBeMerged` will be moved to
+    #     the main profile.
+    #
+    # 5.  Standard fields are merged as follows:
+    #
+    #     1.  Fields are always "union"-ed if there are no conflicts in
+    #         standard fields or attributeKeys.
+    #
+    #     2.  When there are conflicting fields:
+    #
+    #         1.  If no `SourceProfileIds` entry is specified, the main
+    #             Profile value is always taken.
+    #
+    #         2.  If a `SourceProfileIds` entry is specified, the specified
+    #             profileId is always taken, even if it is a NULL value.
+    #
+    # You can use MergeProfiles together with [GetMatches][1], which returns
+    # potentially matching profiles, or use it with the results of another
+    # matching system. After profiles have been merged, they cannot be
+    # separated (unmerged).
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
+    #
+    # @option params [required, String] :domain_name
+    #   The unique name of the domain.
+    #
+    # @option params [required, String] :main_profile_id
+    #   The identifier of the profile to be taken.
+    #
+    # @option params [required, Array<String>] :profile_ids_to_be_merged
+    #   The identifier of the profile to be merged into MainProfileId.
+    #
+    # @option params [Types::FieldSourceProfileIds] :field_source_profile_ids
+    #   The identifiers of the fields in the profile that has the information
+    #   you want to apply to the merge. For example, say you want to merge
+    #   EmailAddress from Profile1 into MainProfile. This would be the
+    #   identifier of the EmailAddress field in Profile1.
+    #
+    # @return [Types::MergeProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::MergeProfilesResponse#message #message} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.merge_profiles({
+    #     domain_name: "name", # required
+    #     main_profile_id: "uuid", # required
+    #     profile_ids_to_be_merged: ["uuid"], # required
+    #     field_source_profile_ids: {
+    #       account_number: "uuid",
+    #       additional_information: "uuid",
+    #       party_type: "uuid",
+    #       business_name: "uuid",
+    #       first_name: "uuid",
+    #       middle_name: "uuid",
+    #       last_name: "uuid",
+    #       birth_date: "uuid",
+    #       gender: "uuid",
+    #       phone_number: "uuid",
+    #       mobile_phone_number: "uuid",
+    #       home_phone_number: "uuid",
+    #       business_phone_number: "uuid",
+    #       email_address: "uuid",
+    #       personal_email_address: "uuid",
+    #       business_email_address: "uuid",
+    #       address: "uuid",
+    #       shipping_address: "uuid",
+    #       mailing_address: "uuid",
+    #       billing_address: "uuid",
+    #       attributes: {
+    #         "string1To255" => "uuid",
+    #       },
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.message #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/MergeProfiles AWS API Documentation
+    #
+    # @overload merge_profiles(params = {})
+    # @param [Hash] params ({})
+    def merge_profiles(params = {}, options = {})
+      req = build_request(:merge_profiles, params)
+      req.send_request(options)
+    end
+
     # Adds an integration between the service and a third-party service,
     # which includes Amazon AppFlow and Amazon Connect.
     #
@@ -1562,7 +1791,7 @@ module Aws::CustomerProfiles
     #     keys: {
     #       "name" => [
     #         {
-    #           standard_identifiers: ["PROFILE"], # accepts PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
+    #           standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY
     #           field_names: ["name"],
     #         },
     #       ],
@@ -1587,7 +1816,7 @@ module Aws::CustomerProfiles
     #   resp.keys #=> Hash
     #   resp.keys["name"] #=> Array
     #   resp.keys["name"][0].standard_identifiers #=> Array
-    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
+    #   resp.keys["name"][0].standard_identifiers[0] #=> String, one of "PROFILE", "ASSET", "CASE", "UNIQUE", "SECONDARY", "LOOKUP_ONLY", "NEW_ONLY"
     #   resp.keys["name"][0].field_names #=> Array
     #   resp.keys["name"][0].field_names[0] #=> String
     #   resp.created_at #=> Time
@@ -1789,10 +2018,18 @@ module Aws::CustomerProfiles
     # Updates the properties of a domain, including creating or selecting a
     # dead letter queue or an encryption key.
     #
-    # Once a domain is created, the name can’t be changed.
+    # After a domain is created, the name can’t be changed.
+    #
+    # Use this API or [CreateDomain][1] to enable [identity resolution][2]\:
+    # set `Matching` to true.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html
+    # [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
     #
     # @option params [required, String] :domain_name
-    #   The unique name for the domain.
+    #   The unique name of the domain.
     #
     # @option params [Integer] :default_expiration_days
     #   The default number of days until the data within the domain expires.
@@ -1811,6 +2048,17 @@ module Aws::CustomerProfiles
     #   operation to enable Amazon Connect Customer Profiles to send messages
     #   to the DeadLetterQueue.
     #
+    # @option params [Types::MatchingRequest] :matching
+    #   The process of matching duplicate profiles. If Matching = true, Amazon
+    #   Connect Customer Profiles starts a weekly batch process every Saturday
+    #   at 12AM UTC to detect duplicate profiles in your domains. After that
+    #   batch process completes, use the [GetMatches][1] API to return and
+    #   review the results.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags used to organize, track, or control access for this resource.
     #
@@ -1820,6 +2068,7 @@ module Aws::CustomerProfiles
     #   * {Types::UpdateDomainResponse#default_expiration_days #default_expiration_days} => Integer
     #   * {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#created_at #created_at} => Time
     #   * {Types::UpdateDomainResponse#last_updated_at #last_updated_at} => Time
     #   * {Types::UpdateDomainResponse#tags #tags} => Hash&lt;String,String&gt;
@@ -1831,6 +2080,9 @@ module Aws::CustomerProfiles
     #     default_expiration_days: 1,
     #     default_encryption_key: "encryptionKey",
     #     dead_letter_queue_url: "sqsQueueUrl",
+    #     matching: {
+    #       enabled: false, # required
+    #     },
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -1842,6 +2094,7 @@ module Aws::CustomerProfiles
     #   resp.default_expiration_days #=> Integer
     #   resp.default_encryption_key #=> String
     #   resp.dead_letter_queue_url #=> String
+    #   resp.matching.enabled #=> Boolean
     #   resp.created_at #=> Time
     #   resp.last_updated_at #=> Time
     #   resp.tags #=> Hash
@@ -1870,7 +2123,7 @@ module Aws::CustomerProfiles
     #   The unique identifier of a customer profile.
     #
     # @option params [String] :additional_information
-    #   Any additional information relevant to the customer's profile.
+    #   Any additional information relevant to the customer’s profile.
     #
     # @option params [String] :account_number
     #   A unique account number that you have given to the customer.
@@ -1897,8 +2150,8 @@ module Aws::CustomerProfiles
     #   The gender with which the customer identifies.
     #
     # @option params [String] :phone_number
-    #   The customer's phone number, which has not been specified as a
-    #   mobile, home, or business number.
+    #   The customer’s phone number, which has not been specified as a mobile,
+    #   home, or business number.
     #
     # @option params [String] :mobile_phone_number
     #   The customer’s mobile phone number.
@@ -1910,7 +2163,7 @@ module Aws::CustomerProfiles
     #   The customer’s business phone number.
     #
     # @option params [String] :email_address
-    #   The customer's email address, which has not been specified as a
+    #   The customer’s email address, which has not been specified as a
     #   personal or business address.
     #
     # @option params [String] :personal_email_address
@@ -2039,7 +2292,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.6.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end