aws-sdk-customerprofiles 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03cf9cfce6be419e6b6410e9f48f4429d47c923ab8ad650a072dad70bfd6798d
-  data.tar.gz: 9ee21be8c5711df078cea3507ce3e17e6107e7a035338fe4b117903e24a8d235
+  metadata.gz: 873f685772d2b81ed1bd473376590ebb073ffdfd4337bf7fa7956b26da63307c
+  data.tar.gz: 10d62a0420366eefcb3ba8788ec895b7b0af66470ed54f447f9f0aff5932618e
 SHA512:
-  metadata.gz: d30f9b58207015f9476744677031b47b2a5692822a9f91cc1e6e44584cb9e941b7c3a07f0fcfafcecd2b54690b06e5e305d88f2ad61c3c586f102fd48e90d139
-  data.tar.gz: 0b71ce4c7a787c8027a8f3636debb01cf7cc8b064b7295a83ae58e845d8c1b05f81b47e06b8f4828131f3679904b6a3f7ad3d4f5c0c5c4f803d6d7e3e1f2cb58
+  metadata.gz: 7035a3ffe7ad88607d0a7d26290e73089d1148bc4a905d5bd12a32bf63a28bf2810f40683f631ce6cd097bcd76d8e5967f56a90ba3a32aed3cdee047a0cf2ec3
+  data.tar.gz: a62a75ba126b5792bedb14b5cfb849b5a361f9454f49572b365faa09f1a120331393ef380094ed048e32c8b18a480ff5b1dc05ec5d3aa29b8c2c72e56c0f424f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.24.0 (2022-11-14)
+------------------
+
+* Feature - This release enhances the SearchProfiles API by providing functionality to search for profiles using multiple keys and logical operators.
+
 1.23.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.23.0
+1.24.0

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

@@ -2532,8 +2532,14 @@ module Aws::CustomerProfiles
       req.send_request(options)
     end
 
-    # Searches for profiles within a specific domain name using name, phone
-    # number, email address, account number, or a custom defined index.
+    # Searches for profiles within a specific domain using one or more
+    # predefined search keys (e.g., \_fullName, \_phone, \_email, \_account,
+    # etc.) and/or custom-defined search keys. A search key is a data type
+    # pair that consists of a `KeyName` and `Values` list.
+    #
+    # This operation supports searching for profiles with a minimum of 1
+    # key-value(s) pair and up to 5 key-value(s) pairs using either `AND` or
+    # `OR` logic.
     #
     # @option params [String] :next_token
     #   The pagination token from the previous SearchProfiles API call.
@@ -2541,6 +2547,8 @@ module Aws::CustomerProfiles
     # @option params [Integer] :max_results
     #   The maximum number of objects returned per page.
     #
+    #   The default is 20 if this parameter is not included in the request.
+    #
     # @option params [required, String] :domain_name
     #   The unique name of the domain.
     #
@@ -2556,6 +2564,33 @@ module Aws::CustomerProfiles
     # @option params [required, Array<String>] :values
     #   A list of key values.
     #
+    # @option params [Array<Types::AdditionalSearchKey>] :additional_search_keys
+    #   A list of `AdditionalSearchKey` objects that are each searchable
+    #   identifiers of a profile. Each `AdditionalSearchKey` object contains a
+    #   `KeyName` and a list of `Values` associated with that specific key
+    #   (i.e., a key-value(s) pair). These additional search keys will be used
+    #   in conjunction with the `LogicalOperator` and the required `KeyName`
+    #   and `Values` parameters to search for profiles that satisfy the search
+    #   criteria.
+    #
+    # @option params [String] :logical_operator
+    #   Relationship between all specified search keys that will be used to
+    #   search for profiles. This includes the required `KeyName` and `Values`
+    #   parameters as well as any key-value(s) pairs specified in the
+    #   `AdditionalSearchKeys` list.
+    #
+    #   This parameter influences which profiles will be returned in the
+    #   response in the following manner:
+    #
+    #   * `AND` - The response only includes profiles that match all of the
+    #     search keys.
+    #
+    #   * `OR` - The response includes profiles that match at least one of the
+    #     search keys.
+    #
+    #   The `OR` relationship is the default behavior if this parameter is not
+    #   included in the request.
+    #
     # @return [Types::SearchProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::SearchProfilesResponse#items #items} => Array&lt;Types::Profile&gt;
@@ -2569,6 +2604,13 @@ module Aws::CustomerProfiles
     #     domain_name: "name", # required
     #     key_name: "name", # required
     #     values: ["string1To255"], # required
+    #     additional_search_keys: [
+    #       {
+    #         key_name: "name", # required
+    #         values: ["string1To255"], # required
+    #       },
+    #     ],
+    #     logical_operator: "AND", # accepts AND, OR
     #   })
     #
     # @example Response structure
@@ -2633,6 +2675,10 @@ module Aws::CustomerProfiles
     #   resp.items[0].billing_address.postal_code #=> String
     #   resp.items[0].attributes #=> Hash
     #   resp.items[0].attributes["string1To255"] #=> String
+    #   resp.items[0].found_by_items #=> Array
+    #   resp.items[0].found_by_items[0].key_name #=> String
+    #   resp.items[0].found_by_items[0].values #=> Array
+    #   resp.items[0].found_by_items[0].values[0] #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfiles AWS API Documentation
@@ -3042,7 +3088,7 @@ module Aws::CustomerProfiles
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-customerprofiles'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -16,6 +16,7 @@ module Aws::CustomerProfiles
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     AddProfileKeyRequest = Shapes::StructureShape.new(name: 'AddProfileKeyRequest')
     AddProfileKeyResponse = Shapes::StructureShape.new(name: 'AddProfileKeyResponse')
+    AdditionalSearchKey = Shapes::StructureShape.new(name: 'AdditionalSearchKey')
     Address = Shapes::StructureShape.new(name: 'Address')
     AppflowIntegration = Shapes::StructureShape.new(name: 'AppflowIntegration')
     AppflowIntegrationWorkflowAttributes = Shapes::StructureShape.new(name: 'AppflowIntegrationWorkflowAttributes')
@@ -71,6 +72,7 @@ module Aws::CustomerProfiles
     FlowDefinition = Shapes::StructureShape.new(name: 'FlowDefinition')
     FlowDescription = Shapes::StringShape.new(name: 'FlowDescription')
     FlowName = Shapes::StringShape.new(name: 'FlowName')
+    FoundByKeyValue = Shapes::StructureShape.new(name: 'FoundByKeyValue')
     Gender = Shapes::StringShape.new(name: 'Gender')
     GetAutoMergingPreviewRequest = Shapes::StructureShape.new(name: 'GetAutoMergingPreviewRequest')
     GetAutoMergingPreviewResponse = Shapes::StructureShape.new(name: 'GetAutoMergingPreviewResponse')
@@ -213,9 +215,12 @@ module Aws::CustomerProfiles
     WorkflowType = Shapes::StringShape.new(name: 'WorkflowType')
     ZendeskConnectorOperator = Shapes::StringShape.new(name: 'ZendeskConnectorOperator')
     ZendeskSourceProperties = Shapes::StructureShape.new(name: 'ZendeskSourceProperties')
+    additionalSearchKeysList = Shapes::ListShape.new(name: 'additionalSearchKeysList')
     boolean = Shapes::BooleanShape.new(name: 'boolean')
     encryptionKey = Shapes::StringShape.new(name: 'encryptionKey')
     expirationDaysInteger = Shapes::IntegerShape.new(name: 'expirationDaysInteger')
+    foundByList = Shapes::ListShape.new(name: 'foundByList')
+    logicalOperator = Shapes::StringShape.new(name: 'logicalOperator')
     long = Shapes::IntegerShape.new(name: 'long')
     matchesNumber = Shapes::IntegerShape.new(name: 'matchesNumber')
     maxSize100 = Shapes::IntegerShape.new(name: 'maxSize100')
@@ -252,6 +257,10 @@ module Aws::CustomerProfiles
     AddProfileKeyResponse.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, location_name: "Values"))
     AddProfileKeyResponse.struct_class = Types::AddProfileKeyResponse
 
+    AdditionalSearchKey.add_member(:key_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "KeyName"))
+    AdditionalSearchKey.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, required: true, location_name: "Values"))
+    AdditionalSearchKey.struct_class = Types::AdditionalSearchKey
+
     Address.add_member(:address_1, Shapes::ShapeRef.new(shape: string1To255, location_name: "Address1"))
     Address.add_member(:address_2, Shapes::ShapeRef.new(shape: string1To255, location_name: "Address2"))
     Address.add_member(:address_3, Shapes::ShapeRef.new(shape: string1To255, location_name: "Address3"))
@@ -481,6 +490,10 @@ module Aws::CustomerProfiles
     FlowDefinition.add_member(:trigger_config, Shapes::ShapeRef.new(shape: TriggerConfig, required: true, location_name: "TriggerConfig"))
     FlowDefinition.struct_class = Types::FlowDefinition
 
+    FoundByKeyValue.add_member(:key_name, Shapes::ShapeRef.new(shape: name, location_name: "KeyName"))
+    FoundByKeyValue.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, location_name: "Values"))
+    FoundByKeyValue.struct_class = Types::FoundByKeyValue
+
     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"))
@@ -843,6 +856,7 @@ module Aws::CustomerProfiles
     Profile.add_member(:mailing_address, Shapes::ShapeRef.new(shape: Address, location_name: "MailingAddress"))
     Profile.add_member(:billing_address, Shapes::ShapeRef.new(shape: Address, location_name: "BillingAddress"))
     Profile.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
+    Profile.add_member(:found_by_items, Shapes::ShapeRef.new(shape: foundByList, location_name: "FoundByItems"))
     Profile.struct_class = Types::Profile
 
     ProfileIdList.member = Shapes::ShapeRef.new(shape: uuid)
@@ -945,6 +959,8 @@ module Aws::CustomerProfiles
     SearchProfilesRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
     SearchProfilesRequest.add_member(:key_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "KeyName"))
     SearchProfilesRequest.add_member(:values, Shapes::ShapeRef.new(shape: requestValueList, required: true, location_name: "Values"))
+    SearchProfilesRequest.add_member(:additional_search_keys, Shapes::ShapeRef.new(shape: additionalSearchKeysList, location_name: "AdditionalSearchKeys"))
+    SearchProfilesRequest.add_member(:logical_operator, Shapes::ShapeRef.new(shape: logicalOperator, location_name: "LogicalOperator"))
     SearchProfilesRequest.struct_class = Types::SearchProfilesRequest
 
     SearchProfilesResponse.add_member(:items, Shapes::ShapeRef.new(shape: ProfileList, location_name: "Items"))
@@ -1087,6 +1103,10 @@ module Aws::CustomerProfiles
     ZendeskSourceProperties.add_member(:object, Shapes::ShapeRef.new(shape: Object, required: true, location_name: "Object"))
     ZendeskSourceProperties.struct_class = Types::ZendeskSourceProperties
 
+    additionalSearchKeysList.member = Shapes::ShapeRef.new(shape: AdditionalSearchKey)
+
+    foundByList.member = Shapes::ShapeRef.new(shape: FoundByKeyValue)
+
     requestValueList.member = Shapes::ShapeRef.new(shape: string1To255)
 
 

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

@@ -83,6 +83,41 @@ module Aws::CustomerProfiles
       include Aws::Structure
     end
 
+    # A data type pair that consists of a `KeyName` and `Values` list that
+    # is used in conjunction with the [KeyName][1] and [Values][2]
+    # parameters to search for profiles using the [SearchProfiles][3] API.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName
+    # [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values
+    # [3]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
+    #
+    # @note When making an API call, you may pass AdditionalSearchKey
+    #   data as a hash:
+    #
+    #       {
+    #         key_name: "name", # required
+    #         values: ["string1To255"], # required
+    #       }
+    #
+    # @!attribute [rw] key_name
+    #   A searchable identifier of a customer profile.
+    #   @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/AdditionalSearchKey AWS API Documentation
+    #
+    class AdditionalSearchKey < Struct.new(
+      :key_name,
+      :values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A generic address associated with the customer that is not mailing,
     # shipping, or billing.
     #
@@ -1693,6 +1728,31 @@ module Aws::CustomerProfiles
       include Aws::Structure
     end
 
+    # A data type pair that consists of a `KeyName` and `Values` list that
+    # were used to find a profile returned in response to a
+    # [SearchProfiles][1] request.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
+    #
+    # @!attribute [rw] key_name
+    #   A searchable identifier of a customer profile.
+    #   @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/FoundByKeyValue AWS API Documentation
+    #
+    class FoundByKeyValue < Struct.new(
+      :key_name,
+      :values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetAutoMergingPreviewRequest
     #   data as a hash:
     #
@@ -3796,6 +3856,34 @@ module Aws::CustomerProfiles
     #   A key value pair of attributes of a customer profile.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] found_by_items
+    #   A list of items used to find a profile returned in a
+    #   [SearchProfiles][1] response. An item is a key-value(s) pair that
+    #   matches an attribute in the profile.
+    #
+    #   If the optional `AdditionalSearchKeys` parameter was included in the
+    #   [SearchProfiles][1] request, the `FoundByItems` list should be
+    #   interpreted based on the `LogicalOperator` used in the request:
+    #
+    #   * `AND` - The profile included in the response matched all of the
+    #     search keys specified in the request. The `FoundByItems` will
+    #     include all of the key-value(s) pairs that were specified in the
+    #     request (as this is a requirement of `AND` search logic).
+    #
+    #   * `OR` - The profile included in the response matched at least one
+    #     of the search keys specified in the request. The `FoundByItems`
+    #     will include each of the key-value(s) pairs that the profile was
+    #     found by.
+    #
+    #   The `OR` relationship is the default behavior if the
+    #   `LogicalOperator` parameter is not included in the
+    #   [SearchProfiles][1] request.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
+    #   @return [Array<Types::FoundByKeyValue>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Profile AWS API Documentation
     #
     class Profile < Struct.new(
@@ -3820,7 +3908,8 @@ module Aws::CustomerProfiles
       :shipping_address,
       :mailing_address,
       :billing_address,
-      :attributes)
+      :attributes,
+      :found_by_items)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4445,6 +4534,13 @@ module Aws::CustomerProfiles
     #         domain_name: "name", # required
     #         key_name: "name", # required
     #         values: ["string1To255"], # required
+    #         additional_search_keys: [
+    #           {
+    #             key_name: "name", # required
+    #             values: ["string1To255"], # required
+    #           },
+    #         ],
+    #         logical_operator: "AND", # accepts AND, OR
     #       }
     #
     # @!attribute [rw] next_token
@@ -4453,6 +4549,8 @@ module Aws::CustomerProfiles
     #
     # @!attribute [rw] max_results
     #   The maximum number of objects returned per page.
+    #
+    #   The default is 20 if this parameter is not included in the request.
     #   @return [Integer]
     #
     # @!attribute [rw] domain_name
@@ -4473,6 +4571,35 @@ module Aws::CustomerProfiles
     #   A list of key values.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] additional_search_keys
+    #   A list of `AdditionalSearchKey` objects that are each searchable
+    #   identifiers of a profile. Each `AdditionalSearchKey` object contains
+    #   a `KeyName` and a list of `Values` associated with that specific key
+    #   (i.e., a key-value(s) pair). These additional search keys will be
+    #   used in conjunction with the `LogicalOperator` and the required
+    #   `KeyName` and `Values` parameters to search for profiles that
+    #   satisfy the search criteria.
+    #   @return [Array<Types::AdditionalSearchKey>]
+    #
+    # @!attribute [rw] logical_operator
+    #   Relationship between all specified search keys that will be used to
+    #   search for profiles. This includes the required `KeyName` and
+    #   `Values` parameters as well as any key-value(s) pairs specified in
+    #   the `AdditionalSearchKeys` list.
+    #
+    #   This parameter influences which profiles will be returned in the
+    #   response in the following manner:
+    #
+    #   * `AND` - The response only includes profiles that match all of the
+    #     search keys.
+    #
+    #   * `OR` - The response includes profiles that match at least one of
+    #     the search keys.
+    #
+    #   The `OR` relationship is the default behavior if this parameter is
+    #   not included in the request.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfilesRequest AWS API Documentation
     #
     class SearchProfilesRequest < Struct.new(
@@ -4480,13 +4607,15 @@ module Aws::CustomerProfiles
       :max_results,
       :domain_name,
       :key_name,
-      :values)
+      :values,
+      :additional_search_keys,
+      :logical_operator)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] items
-    #   The list of SearchProfiles instances.
+    #   The list of Profiles matching the search criteria.
     #   @return [Array<Types::Profile>]
     #
     # @!attribute [rw] next_token

data/lib/aws-sdk-customerprofiles.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-customerprofiles/customizations'
 # @!group service
 module Aws::CustomerProfiles
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.24.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-customerprofiles
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core