aws-sdk-customerprofiles 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01a1b6acb989d0dbee6b707f8bc8b7775418ba7b1ad2fdd607d5d1f63d6b10a6
-  data.tar.gz: db90febe6c3bc5ad3cf9580bf3f3da380be91895b07301caf8ebc5d42ff1f2a1
+  metadata.gz: d08270ee45732b3861cd2b3d6f649c34b5e0025c6335b5266274cc363a3b973f
+  data.tar.gz: 9c070744ed8e28f7c2e2c5138edeb822cfbf65f5a65e1da8dc3a88d2973547aa
 SHA512:
-  metadata.gz: a5675fecab3e60eaab0f1addec1f53971a1e1ec6062f118432913f3133289587cbc75bc3ffc481666064796b1d499e9de07ffbd89ea91d5599de5062df23adc2
-  data.tar.gz: b7d0f5067d95ed1a1846d7c983932eb1da8f2fe27341d269f648ed49c2f78498adc4809b1e26c40486786cff02d3ffece33cc494c623633bd8142af494e0cb2d
+  metadata.gz: 89effe39941773b84ebdf628675adb04260b2a45ceebd6dc1d6d05d0872d26e8d5ff611833669afbdbcc2c7707464c91d714a1f724d8c6d00b0a4456905f53ff
+  data.tar.gz: 3085171dd3999f03434fc035db404f53b22e00af341ab74a7cba654e87375936c300cdf58246d5627078aff204d6eb81c183981d26b5253c5774904e82ad3478

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 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)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.9.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.9.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.
     #
@@ -402,8 +410,15 @@ module Aws::CustomerProfiles
     #   to the DeadLetterQueue.
     #
     # @option params [Types::MatchingRequest] :matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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.
@@ -930,7 +945,7 @@ module Aws::CustomerProfiles
     # GetMatches returns potentially matching profiles, based on the results
     # of the latest run of a machine learning process.
     #
-    # Amazon Connect runs a batch process every Saturday at 12AM UTC to
+    # 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.
     #
@@ -955,6 +970,13 @@ module Aws::CustomerProfiles
     #
     # * 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
@@ -1049,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
@@ -1105,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
     #
@@ -1350,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;
@@ -1363,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
@@ -1760,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"],
     #         },
     #       ],
@@ -1785,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
@@ -1989,6 +2020,14 @@ module Aws::CustomerProfiles
     #
     # 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 of the domain.
     #
@@ -2010,8 +2049,15 @@ module Aws::CustomerProfiles
     #   to the DeadLetterQueue.
     #
     # @option params [Types::MatchingRequest] :matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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.
@@ -2246,7 +2292,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -97,6 +97,7 @@ module Aws::CustomerProfiles
     MergeProfilesRequest = Shapes::StructureShape.new(name: 'MergeProfilesRequest')
     MergeProfilesResponse = Shapes::StructureShape.new(name: 'MergeProfilesResponse')
     Object = Shapes::StringShape.new(name: 'Object')
+    ObjectFilter = Shapes::StructureShape.new(name: 'ObjectFilter')
     ObjectTypeField = Shapes::StructureShape.new(name: 'ObjectTypeField')
     ObjectTypeKey = Shapes::StructureShape.new(name: 'ObjectTypeKey')
     ObjectTypeKeyList = Shapes::ListShape.new(name: 'ObjectTypeKeyList')
@@ -513,6 +514,7 @@ module Aws::CustomerProfiles
     ListProfileObjectsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
     ListProfileObjectsRequest.add_member(:object_type_name, Shapes::ShapeRef.new(shape: typeName, required: true, location_name: "ObjectTypeName"))
     ListProfileObjectsRequest.add_member(:profile_id, Shapes::ShapeRef.new(shape: uuid, required: true, location_name: "ProfileId"))
+    ListProfileObjectsRequest.add_member(:object_filter, Shapes::ShapeRef.new(shape: ObjectFilter, location_name: "ObjectFilter"))
     ListProfileObjectsRequest.struct_class = Types::ListProfileObjectsRequest
 
     ListProfileObjectsResponse.add_member(:items, Shapes::ShapeRef.new(shape: ProfileObjectList, location_name: "Items"))
@@ -549,6 +551,10 @@ module Aws::CustomerProfiles
     MergeProfilesResponse.add_member(:message, Shapes::ShapeRef.new(shape: message, location_name: "Message"))
     MergeProfilesResponse.struct_class = Types::MergeProfilesResponse
 
+    ObjectFilter.add_member(:key_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "KeyName"))
+    ObjectFilter.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, required: true, location_name: "Values"))
+    ObjectFilter.struct_class = Types::ObjectFilter
+
     ObjectTypeField.add_member(:source, Shapes::ShapeRef.new(shape: text, location_name: "Source"))
     ObjectTypeField.add_member(:target, Shapes::ShapeRef.new(shape: text, location_name: "Target"))
     ObjectTypeField.add_member(:content_type, Shapes::ShapeRef.new(shape: FieldContentType, location_name: "ContentType"))

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

@@ -254,8 +254,15 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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
     #   @return [Types::MatchingRequest]
     #
     # @!attribute [rw] tags
@@ -297,8 +304,15 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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
     #   @return [Types::MatchingResponse]
     #
     # @!attribute [rw] created_at
@@ -1110,8 +1124,15 @@ module Aws::CustomerProfiles
     #   @return [Types::DomainStats]
     #
     # @!attribute [rw] matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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
     #   @return [Types::MatchingResponse]
     #
     # @!attribute [rw] created_at
@@ -1853,6 +1874,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
+    #         },
     #       }
     #
     # @!attribute [rw] next_token
@@ -1875,6 +1900,12 @@ module Aws::CustomerProfiles
     #   The unique identifier of a customer profile.
     #   @return [String]
     #
+    # @!attribute [rw] 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::ObjectFilter]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListProfileObjectsRequest AWS API Documentation
     #
     class ListProfileObjectsRequest < Struct.new(
@@ -1882,7 +1913,8 @@ module Aws::CustomerProfiles
       :max_results,
       :domain_name,
       :object_type_name,
-      :profile_id)
+      :profile_id,
+      :object_filter)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2088,6 +2120,38 @@ module Aws::CustomerProfiles
       include Aws::Structure
     end
 
+    # The filter applied to ListProfileObjects response to include profile
+    # objects with the specified index values. This filter is only supported
+    # for ObjectTypeName \_asset and \_case.
+    #
+    # @note When making an API call, you may pass ObjectFilter
+    #   data as a hash:
+    #
+    #       {
+    #         key_name: "name", # required
+    #         values: ["string1To255"], # required
+    #       }
+    #
+    # @!attribute [rw] key_name
+    #   A searchable identifier of a standard profile object. The predefined
+    #   keys you can use to search for \_asset include: \_assetId,
+    #   \_assetName, \_serialNumber. The predefined keys you can use to
+    #   search for \_case include: \_caseId.
+    #   @return [String]
+    #
+    # @!attribute [rw] values
+    #   A list of key values.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ObjectFilter AWS API Documentation
+    #
+    class ObjectFilter < Struct.new(
+      :key_name,
+      :values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents a field in a ProfileObjectType.
     #
     # @note When making an API call, you may pass ObjectTypeField
@@ -2132,21 +2196,22 @@ module Aws::CustomerProfiles
     #   data as a hash:
     #
     #       {
-    #         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"],
     #       }
     #
     # @!attribute [rw] standard_identifiers
     #   The types of keys that a ProfileObject can have. Each ProfileObject
-    #   can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means
-    #   that this key can be used to tie an object to a PROFILE. UNIQUE
-    #   means that it can be used to uniquely identify an object. If a key a
-    #   is marked as SECONDARY, it will be used to search for profiles after
-    #   all other PROFILE keys have been searched. A LOOKUP\_ONLY key is
-    #   only used to match a profile but is not persisted to be used for
-    #   searching of the profile. A NEW\_ONLY key is only used if the
-    #   profile does not already exist before the object is ingested,
-    #   otherwise it is only used for matching objects to profiles.
+    #   can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET
+    #   or CASE means that this key can be used to tie an object to a
+    #   PROFILE, ASSET or CASE respectively. UNIQUE means that it can be
+    #   used to uniquely identify an object. If a key a is marked as
+    #   SECONDARY, it will be used to search for profiles after all other
+    #   PROFILE keys have been searched. A LOOKUP\_ONLY key is only used to
+    #   match a profile but is not persisted to be used for searching of the
+    #   profile. A NEW\_ONLY key is only used if the profile does not
+    #   already exist before the object is ingested, otherwise it is only
+    #   used for matching objects to profiles.
     #   @return [Array<String>]
     #
     # @!attribute [rw] field_names
@@ -2496,7 +2561,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"],
     #             },
     #           ],
@@ -3317,8 +3382,15 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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
     #   @return [Types::MatchingRequest]
     #
     # @!attribute [rw] tags
@@ -3360,8 +3432,15 @@ module Aws::CustomerProfiles
     #   @return [String]
     #
     # @!attribute [rw] matching
-    #   The process of matching duplicate profiles. This process runs every
-    #   Saturday at 12AM.
+    #   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
     #   @return [Types::MatchingResponse]
     #
     # @!attribute [rw] created_at

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-customerprofiles
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core