aws-sdk-customerprofiles 1.22.0 → 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -83,6 +83,41 @@ module Aws::CustomerProfiles
83
83
  include Aws::Structure
84
84
  end
85
85
 
86
+ # A data type pair that consists of a `KeyName` and `Values` list that
87
+ # is used in conjunction with the [KeyName][1] and [Values][2]
88
+ # parameters to search for profiles using the [SearchProfiles][3] API.
89
+ #
90
+ #
91
+ #
92
+ # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-KeyName
93
+ # [2]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html#customerprofiles-SearchProfiles-request-Values
94
+ # [3]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
95
+ #
96
+ # @note When making an API call, you may pass AdditionalSearchKey
97
+ # data as a hash:
98
+ #
99
+ # {
100
+ # key_name: "name", # required
101
+ # values: ["string1To255"], # required
102
+ # }
103
+ #
104
+ # @!attribute [rw] key_name
105
+ # A searchable identifier of a customer profile.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] values
109
+ # A list of key values.
110
+ # @return [Array<String>]
111
+ #
112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/AdditionalSearchKey AWS API Documentation
113
+ #
114
+ class AdditionalSearchKey < Struct.new(
115
+ :key_name,
116
+ :values)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
86
121
  # A generic address associated with the customer that is not mailing,
87
122
  # shipping, or billing.
88
123
  #
@@ -1693,6 +1728,31 @@ module Aws::CustomerProfiles
1693
1728
  include Aws::Structure
1694
1729
  end
1695
1730
 
1731
+ # A data type pair that consists of a `KeyName` and `Values` list that
1732
+ # were used to find a profile returned in response to a
1733
+ # [SearchProfiles][1] request.
1734
+ #
1735
+ #
1736
+ #
1737
+ # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
1738
+ #
1739
+ # @!attribute [rw] key_name
1740
+ # A searchable identifier of a customer profile.
1741
+ # @return [String]
1742
+ #
1743
+ # @!attribute [rw] values
1744
+ # A list of key values.
1745
+ # @return [Array<String>]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/FoundByKeyValue AWS API Documentation
1748
+ #
1749
+ class FoundByKeyValue < Struct.new(
1750
+ :key_name,
1751
+ :values)
1752
+ SENSITIVE = []
1753
+ include Aws::Structure
1754
+ end
1755
+
1696
1756
  # @note When making an API call, you may pass GetAutoMergingPreviewRequest
1697
1757
  # data as a hash:
1698
1758
  #
@@ -3796,6 +3856,34 @@ module Aws::CustomerProfiles
3796
3856
  # A key value pair of attributes of a customer profile.
3797
3857
  # @return [Hash<String,String>]
3798
3858
  #
3859
+ # @!attribute [rw] found_by_items
3860
+ # A list of items used to find a profile returned in a
3861
+ # [SearchProfiles][1] response. An item is a key-value(s) pair that
3862
+ # matches an attribute in the profile.
3863
+ #
3864
+ # If the optional `AdditionalSearchKeys` parameter was included in the
3865
+ # [SearchProfiles][1] request, the `FoundByItems` list should be
3866
+ # interpreted based on the `LogicalOperator` used in the request:
3867
+ #
3868
+ # * `AND` - The profile included in the response matched all of the
3869
+ # search keys specified in the request. The `FoundByItems` will
3870
+ # include all of the key-value(s) pairs that were specified in the
3871
+ # request (as this is a requirement of `AND` search logic).
3872
+ #
3873
+ # * `OR` - The profile included in the response matched at least one
3874
+ # of the search keys specified in the request. The `FoundByItems`
3875
+ # will include each of the key-value(s) pairs that the profile was
3876
+ # found by.
3877
+ #
3878
+ # The `OR` relationship is the default behavior if the
3879
+ # `LogicalOperator` parameter is not included in the
3880
+ # [SearchProfiles][1] request.
3881
+ #
3882
+ #
3883
+ #
3884
+ # [1]: https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html
3885
+ # @return [Array<Types::FoundByKeyValue>]
3886
+ #
3799
3887
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Profile AWS API Documentation
3800
3888
  #
3801
3889
  class Profile < Struct.new(
@@ -3820,7 +3908,8 @@ module Aws::CustomerProfiles
3820
3908
  :shipping_address,
3821
3909
  :mailing_address,
3822
3910
  :billing_address,
3823
- :attributes)
3911
+ :attributes,
3912
+ :found_by_items)
3824
3913
  SENSITIVE = []
3825
3914
  include Aws::Structure
3826
3915
  end
@@ -4445,6 +4534,13 @@ module Aws::CustomerProfiles
4445
4534
  # domain_name: "name", # required
4446
4535
  # key_name: "name", # required
4447
4536
  # values: ["string1To255"], # required
4537
+ # additional_search_keys: [
4538
+ # {
4539
+ # key_name: "name", # required
4540
+ # values: ["string1To255"], # required
4541
+ # },
4542
+ # ],
4543
+ # logical_operator: "AND", # accepts AND, OR
4448
4544
  # }
4449
4545
  #
4450
4546
  # @!attribute [rw] next_token
@@ -4453,6 +4549,8 @@ module Aws::CustomerProfiles
4453
4549
  #
4454
4550
  # @!attribute [rw] max_results
4455
4551
  # The maximum number of objects returned per page.
4552
+ #
4553
+ # The default is 20 if this parameter is not included in the request.
4456
4554
  # @return [Integer]
4457
4555
  #
4458
4556
  # @!attribute [rw] domain_name
@@ -4473,6 +4571,35 @@ module Aws::CustomerProfiles
4473
4571
  # A list of key values.
4474
4572
  # @return [Array<String>]
4475
4573
  #
4574
+ # @!attribute [rw] additional_search_keys
4575
+ # A list of `AdditionalSearchKey` objects that are each searchable
4576
+ # identifiers of a profile. Each `AdditionalSearchKey` object contains
4577
+ # a `KeyName` and a list of `Values` associated with that specific key
4578
+ # (i.e., a key-value(s) pair). These additional search keys will be
4579
+ # used in conjunction with the `LogicalOperator` and the required
4580
+ # `KeyName` and `Values` parameters to search for profiles that
4581
+ # satisfy the search criteria.
4582
+ # @return [Array<Types::AdditionalSearchKey>]
4583
+ #
4584
+ # @!attribute [rw] logical_operator
4585
+ # Relationship between all specified search keys that will be used to
4586
+ # search for profiles. This includes the required `KeyName` and
4587
+ # `Values` parameters as well as any key-value(s) pairs specified in
4588
+ # the `AdditionalSearchKeys` list.
4589
+ #
4590
+ # This parameter influences which profiles will be returned in the
4591
+ # response in the following manner:
4592
+ #
4593
+ # * `AND` - The response only includes profiles that match all of the
4594
+ # search keys.
4595
+ #
4596
+ # * `OR` - The response includes profiles that match at least one of
4597
+ # the search keys.
4598
+ #
4599
+ # The `OR` relationship is the default behavior if this parameter is
4600
+ # not included in the request.
4601
+ # @return [String]
4602
+ #
4476
4603
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchProfilesRequest AWS API Documentation
4477
4604
  #
4478
4605
  class SearchProfilesRequest < Struct.new(
@@ -4480,13 +4607,15 @@ module Aws::CustomerProfiles
4480
4607
  :max_results,
4481
4608
  :domain_name,
4482
4609
  :key_name,
4483
- :values)
4610
+ :values,
4611
+ :additional_search_keys,
4612
+ :logical_operator)
4484
4613
  SENSITIVE = []
4485
4614
  include Aws::Structure
4486
4615
  end
4487
4616
 
4488
4617
  # @!attribute [rw] items
4489
- # The list of SearchProfiles instances.
4618
+ # The list of Profiles matching the search criteria.
4490
4619
  # @return [Array<Types::Profile>]
4491
4620
  #
4492
4621
  # @!attribute [rw] next_token
@@ -13,9 +13,13 @@ require 'aws-sigv4'
13
13
 
14
14
  require_relative 'aws-sdk-customerprofiles/types'
15
15
  require_relative 'aws-sdk-customerprofiles/client_api'
16
+ require_relative 'aws-sdk-customerprofiles/plugins/endpoints.rb'
16
17
  require_relative 'aws-sdk-customerprofiles/client'
17
18
  require_relative 'aws-sdk-customerprofiles/errors'
18
19
  require_relative 'aws-sdk-customerprofiles/resource'
20
+ require_relative 'aws-sdk-customerprofiles/endpoint_parameters'
21
+ require_relative 'aws-sdk-customerprofiles/endpoint_provider'
22
+ require_relative 'aws-sdk-customerprofiles/endpoints'
19
23
  require_relative 'aws-sdk-customerprofiles/customizations'
20
24
 
21
25
  # This module provides support for Amazon Connect Customer Profiles. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-customerprofiles/customizations'
48
52
  # @!group service
49
53
  module Aws::CustomerProfiles
50
54
 
51
- GEM_VERSION = '1.22.0'
55
+ GEM_VERSION = '1.24.0'
52
56
 
53
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-customerprofiles
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.22.0
4
+ version: 1.24.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-09-13 00:00:00.000000000 Z
11
+ date: 2022-11-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.127.0
22
+ version: 3.165.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.127.0
32
+ version: 3.165.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
59
59
  - lib/aws-sdk-customerprofiles/client.rb
60
60
  - lib/aws-sdk-customerprofiles/client_api.rb
61
61
  - lib/aws-sdk-customerprofiles/customizations.rb
62
+ - lib/aws-sdk-customerprofiles/endpoint_parameters.rb
63
+ - lib/aws-sdk-customerprofiles/endpoint_provider.rb
64
+ - lib/aws-sdk-customerprofiles/endpoints.rb
62
65
  - lib/aws-sdk-customerprofiles/errors.rb
66
+ - lib/aws-sdk-customerprofiles/plugins/endpoints.rb
63
67
  - lib/aws-sdk-customerprofiles/resource.rb
64
68
  - lib/aws-sdk-customerprofiles/types.rb
65
69
  homepage: https://github.com/aws/aws-sdk-ruby