aws-sdk-customerprofiles 1.95.0 → 1.96.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 52d63cae0be3363d64f77e27a9e7cf83856233ed1713a04b573f3451e0c49830
4
- data.tar.gz: 26bfa5683f45061bc0c8f9f88d0e08b80f061d76554bd11370ac14e59ac613e5
3
+ metadata.gz: 1d8eb17eb1929e8e89a6a5d554e0a089a69ab6d191f4f778c3bd0ecc3e1cb56c
4
+ data.tar.gz: cc1ca6494a8c75d224412179b340b544e63878dd96ac06476abaec895ce535c9
5
5
  SHA512:
6
- metadata.gz: 6993fe8e52acaab7eb9528dc9cb30fd074a782afc6194f4c0e30a9b008e0bebc951ecc646699f635e35d74a2e288c0fb9cd8aebf8a91af33b3fca5377cbe5b05
7
- data.tar.gz: cc4ffcbe1703e45624661ca51b9137a5b113ca859244d3a6886bbafb747b9892754e665c34c320fad71f255a1bc97dae5ca17a165485eea555eeb8297b022d16
6
+ metadata.gz: a33edd6462e5fd94512698af2c19a8ecf03957e645fb8ac3406dc7a24ad6b5ccdbd6d659f2c5b3f15153e7b4f2467b995461fc1fa33c4289ed0f428ae16ef73f
7
+ data.tar.gz: 8f74e1f86a5ab20e64e65c92c00e742db492f73d5ddc9cbf76daad7c45621bd6e412ceedda2cc58a13a270dc1c74ad36e2fcba806128b02ec92e59878b861ee2
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.96.0 (2026-09-16)
5
+ ------------------
6
+
7
+ * Feature - This release introduces the SearchRecommendations API, which retrieves recommendations for a profile identified by a search key.
8
+
4
9
  1.95.0 (2026-09-11)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.95.0
1
+ 1.96.0
@@ -7419,6 +7419,132 @@ module Aws::CustomerProfiles
7419
7419
  req.send_request(options)
7420
7420
  end
7421
7421
 
7422
+ # Retrieves recommendations for a profile in a specific domain. The
7423
+ # profile is identified using a search key, which consists of a
7424
+ # `KeyName` and a `KeyValues` list. The `KeyName` can be a predefined
7425
+ # key (for example, `_profileId`, `_phone`, `_email`) or a
7426
+ # custom-defined key.
7427
+ #
7428
+ # The search key must match exactly one profile. If no profile matches
7429
+ # the search key, the operation returns a `ResourceNotFoundException`.
7430
+ # If more than one profile matches the search key, the operation returns
7431
+ # a `BadRequestException`. You can use the SearchProfiles API to review
7432
+ # the matching profiles.
7433
+ #
7434
+ # @option params [required, String] :domain_name
7435
+ # The unique name of the domain.
7436
+ #
7437
+ # @option params [required, String] :key_name
7438
+ # A searchable identifier of a customer profile. You can use a
7439
+ # predefined key, such as `_profileId`, `_phone`, or `_email`, or a
7440
+ # custom-defined key.
7441
+ #
7442
+ # @option params [required, Array<String>] :key_values
7443
+ # A list of key values. Provide one value for each field of the search
7444
+ # key.
7445
+ #
7446
+ # @option params [required, Types::Recommender] :recommender
7447
+ # The recommender used to generate the recommendations.
7448
+ #
7449
+ # @option params [Array<String>] :candidate_ids
7450
+ # A list of item IDs to rank for the user. Use this when you want to
7451
+ # re-rank a specific set of items rather than getting recommendations
7452
+ # from the full item catalog. Required for personalized-ranking use
7453
+ # cases.
7454
+ #
7455
+ # @option params [Hash<String,String>] :context
7456
+ # The contextual metadata used to provide dynamic runtime information to
7457
+ # tailor recommendations.
7458
+ #
7459
+ # @option params [Types::RecommendationDiversityConfig] :diversity
7460
+ # Runtime diversity configuration for this request. Enables
7461
+ # diversity-aware recommendations and optionally supplies values for
7462
+ # placeholder-based diversity caps configured on the recommender.
7463
+ #
7464
+ # @option params [Types::RecommendationMetadata] :metadata
7465
+ # Configuration for metadata to include in recommendation responses.
7466
+ #
7467
+ # @option params [Integer] :max_recommendations
7468
+ # The maximum number of recommendations to return. The default value is
7469
+ # 5.
7470
+ #
7471
+ # @return [Types::SearchRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7472
+ #
7473
+ # * {Types::SearchRecommendationsResponse#profile_id #profile_id} => String
7474
+ # * {Types::SearchRecommendationsResponse#recommendations #recommendations} => Array&lt;Types::Recommendation&gt;
7475
+ #
7476
+ # @example Request syntax with placeholder values
7477
+ #
7478
+ # resp = client.search_recommendations({
7479
+ # domain_name: "name", # required
7480
+ # key_name: "name", # required
7481
+ # key_values: ["string1To255"], # required
7482
+ # recommender: { # required
7483
+ # name: "name", # required
7484
+ # filters: [
7485
+ # {
7486
+ # name: "name",
7487
+ # values: {
7488
+ # "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
7489
+ # },
7490
+ # },
7491
+ # ],
7492
+ # promotional_filters: [
7493
+ # {
7494
+ # name: "name",
7495
+ # values: {
7496
+ # "RecommenderFilterAttributeName" => "RecommenderFilterAttributeValue",
7497
+ # },
7498
+ # promotion_name: "name",
7499
+ # percent_promoted_items: 1,
7500
+ # },
7501
+ # ],
7502
+ # },
7503
+ # candidate_ids: ["string1To255"],
7504
+ # context: {
7505
+ # "ContextKey" => "string1To255",
7506
+ # },
7507
+ # diversity: {
7508
+ # enabled: false, # required
7509
+ # values: {
7510
+ # "DiversityPlaceholderName" => 1,
7511
+ # },
7512
+ # },
7513
+ # metadata: {
7514
+ # columns: ["MetadataColumnName"],
7515
+ # },
7516
+ # max_recommendations: 1,
7517
+ # })
7518
+ #
7519
+ # @example Response structure
7520
+ #
7521
+ # resp.profile_id #=> String
7522
+ # resp.recommendations #=> Array
7523
+ # resp.recommendations[0].catalog_item.id #=> String
7524
+ # resp.recommendations[0].catalog_item.name #=> String
7525
+ # resp.recommendations[0].catalog_item.code #=> String
7526
+ # resp.recommendations[0].catalog_item.type #=> String
7527
+ # resp.recommendations[0].catalog_item.category #=> String
7528
+ # resp.recommendations[0].catalog_item.description #=> String
7529
+ # resp.recommendations[0].catalog_item.additional_information #=> String
7530
+ # resp.recommendations[0].catalog_item.image_link #=> String
7531
+ # resp.recommendations[0].catalog_item.link #=> String
7532
+ # resp.recommendations[0].catalog_item.created_at #=> Time
7533
+ # resp.recommendations[0].catalog_item.updated_at #=> Time
7534
+ # resp.recommendations[0].catalog_item.price #=> String
7535
+ # resp.recommendations[0].catalog_item.attributes #=> Hash
7536
+ # resp.recommendations[0].catalog_item.attributes["string1To255"] #=> String
7537
+ # resp.recommendations[0].score #=> Float
7538
+ #
7539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchRecommendations AWS API Documentation
7540
+ #
7541
+ # @overload search_recommendations(params = {})
7542
+ # @param [Hash] params ({})
7543
+ def search_recommendations(params = {}, options = {})
7544
+ req = build_request(:search_recommendations, params)
7545
+ req.send_request(options)
7546
+ end
7547
+
7422
7548
  # Starts a recommender that was previously stopped. Starting a
7423
7549
  # recommender resumes its ability to generate recommendations.
7424
7550
  #
@@ -8390,7 +8516,7 @@ module Aws::CustomerProfiles
8390
8516
  tracer: tracer
8391
8517
  )
8392
8518
  context[:gem_name] = 'aws-sdk-customerprofiles'
8393
- context[:gem_version] = '1.95.0'
8519
+ context[:gem_version] = '1.96.0'
8394
8520
  Seahorse::Client::Request.new(handlers, context)
8395
8521
  end
8396
8522
 
@@ -322,6 +322,7 @@ module Aws::CustomerProfiles
322
322
  JobScheduleTime = Shapes::StringShape.new(name: 'JobScheduleTime')
323
323
  JobStats = Shapes::StructureShape.new(name: 'JobStats')
324
324
  KeyMap = Shapes::MapShape.new(name: 'KeyMap')
325
+ KeyValuesList = Shapes::ListShape.new(name: 'KeyValuesList')
325
326
  KmsArn = Shapes::StringShape.new(name: 'KmsArn')
326
327
  LayoutItem = Shapes::StructureShape.new(name: 'LayoutItem')
327
328
  LayoutList = Shapes::ListShape.new(name: 'LayoutList')
@@ -474,7 +475,9 @@ module Aws::CustomerProfiles
474
475
  ReadinessStatus = Shapes::StringShape.new(name: 'ReadinessStatus')
475
476
  Recommendation = Shapes::StructureShape.new(name: 'Recommendation')
476
477
  RecommendationDiversityConfig = Shapes::StructureShape.new(name: 'RecommendationDiversityConfig')
478
+ RecommendationMetadata = Shapes::StructureShape.new(name: 'RecommendationMetadata')
477
479
  Recommendations = Shapes::ListShape.new(name: 'Recommendations')
480
+ Recommender = Shapes::StructureShape.new(name: 'Recommender')
478
481
  RecommenderConfig = Shapes::StructureShape.new(name: 'RecommenderConfig')
479
482
  RecommenderConfigTrainingFrequencyInteger = Shapes::IntegerShape.new(name: 'RecommenderConfigTrainingFrequencyInteger')
480
483
  RecommenderContext = Shapes::MapShape.new(name: 'RecommenderContext')
@@ -526,6 +529,8 @@ module Aws::CustomerProfiles
526
529
  Scope = Shapes::StringShape.new(name: 'Scope')
527
530
  SearchProfilesRequest = Shapes::StructureShape.new(name: 'SearchProfilesRequest')
528
531
  SearchProfilesResponse = Shapes::StructureShape.new(name: 'SearchProfilesResponse')
532
+ SearchRecommendationsRequest = Shapes::StructureShape.new(name: 'SearchRecommendationsRequest')
533
+ SearchRecommendationsResponse = Shapes::StructureShape.new(name: 'SearchRecommendationsResponse')
529
534
  SegmentDefinitionArn = Shapes::StringShape.new(name: 'SegmentDefinitionArn')
530
535
  SegmentDefinitionItem = Shapes::StructureShape.new(name: 'SegmentDefinitionItem')
531
536
  SegmentDefinitionsList = Shapes::ListShape.new(name: 'SegmentDefinitionsList')
@@ -1994,6 +1999,8 @@ module Aws::CustomerProfiles
1994
1999
  KeyMap.key = Shapes::ShapeRef.new(shape: name)
1995
2000
  KeyMap.value = Shapes::ShapeRef.new(shape: ObjectTypeKeyList)
1996
2001
 
2002
+ KeyValuesList.member = Shapes::ShapeRef.new(shape: string1To255)
2003
+
1997
2004
  LayoutItem.add_member(:layout_definition_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "LayoutDefinitionName"))
1998
2005
  LayoutItem.add_member(:description, Shapes::ShapeRef.new(shape: sensitiveText, required: true, location_name: "Description"))
1999
2006
  LayoutItem.add_member(:display_name, Shapes::ShapeRef.new(shape: displayName, required: true, location_name: "DisplayName"))
@@ -2647,8 +2654,16 @@ module Aws::CustomerProfiles
2647
2654
  RecommendationDiversityConfig.add_member(:values, Shapes::ShapeRef.new(shape: DiversityValuesMap, location_name: "Values"))
2648
2655
  RecommendationDiversityConfig.struct_class = Types::RecommendationDiversityConfig
2649
2656
 
2657
+ RecommendationMetadata.add_member(:columns, Shapes::ShapeRef.new(shape: MetadataColumnsList, location_name: "Columns"))
2658
+ RecommendationMetadata.struct_class = Types::RecommendationMetadata
2659
+
2650
2660
  Recommendations.member = Shapes::ShapeRef.new(shape: Recommendation)
2651
2661
 
2662
+ Recommender.add_member(:name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "Name"))
2663
+ Recommender.add_member(:filters, Shapes::ShapeRef.new(shape: RecommenderFilters, location_name: "Filters"))
2664
+ Recommender.add_member(:promotional_filters, Shapes::ShapeRef.new(shape: RecommenderPromotionalFilters, location_name: "PromotionalFilters"))
2665
+ Recommender.struct_class = Types::Recommender
2666
+
2652
2667
  RecommenderConfig.add_member(:events_config, Shapes::ShapeRef.new(shape: EventsConfig, location_name: "EventsConfig"))
2653
2668
  RecommenderConfig.add_member(:training_frequency, Shapes::ShapeRef.new(shape: RecommenderConfigTrainingFrequencyInteger, location_name: "TrainingFrequency"))
2654
2669
  RecommenderConfig.add_member(:inference_config, Shapes::ShapeRef.new(shape: InferenceConfig, location_name: "InferenceConfig"))
@@ -2810,6 +2825,21 @@ module Aws::CustomerProfiles
2810
2825
  SearchProfilesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: token, location_name: "NextToken"))
2811
2826
  SearchProfilesResponse.struct_class = Types::SearchProfilesResponse
2812
2827
 
2828
+ SearchRecommendationsRequest.add_member(:domain_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "DomainName"))
2829
+ SearchRecommendationsRequest.add_member(:key_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "KeyName"))
2830
+ SearchRecommendationsRequest.add_member(:key_values, Shapes::ShapeRef.new(shape: KeyValuesList, required: true, location_name: "KeyValues"))
2831
+ SearchRecommendationsRequest.add_member(:recommender, Shapes::ShapeRef.new(shape: Recommender, required: true, location_name: "Recommender"))
2832
+ SearchRecommendationsRequest.add_member(:candidate_ids, Shapes::ShapeRef.new(shape: CandidateIdList, location_name: "CandidateIds"))
2833
+ SearchRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: RecommenderContext, location_name: "Context"))
2834
+ SearchRecommendationsRequest.add_member(:diversity, Shapes::ShapeRef.new(shape: RecommendationDiversityConfig, location_name: "Diversity"))
2835
+ SearchRecommendationsRequest.add_member(:metadata, Shapes::ShapeRef.new(shape: RecommendationMetadata, location_name: "Metadata"))
2836
+ SearchRecommendationsRequest.add_member(:max_recommendations, Shapes::ShapeRef.new(shape: maxSize500, location_name: "MaxRecommendations"))
2837
+ SearchRecommendationsRequest.struct_class = Types::SearchRecommendationsRequest
2838
+
2839
+ SearchRecommendationsResponse.add_member(:profile_id, Shapes::ShapeRef.new(shape: uuid, location_name: "ProfileId"))
2840
+ SearchRecommendationsResponse.add_member(:recommendations, Shapes::ShapeRef.new(shape: Recommendations, location_name: "Recommendations"))
2841
+ SearchRecommendationsResponse.struct_class = Types::SearchRecommendationsResponse
2842
+
2813
2843
  SegmentDefinitionItem.add_member(:segment_definition_name, Shapes::ShapeRef.new(shape: name, location_name: "SegmentDefinitionName"))
2814
2844
  SegmentDefinitionItem.add_member(:display_name, Shapes::ShapeRef.new(shape: string1To255, location_name: "DisplayName"))
2815
2845
  SegmentDefinitionItem.add_member(:description, Shapes::ShapeRef.new(shape: sensitiveString1To4000, location_name: "Description"))
@@ -4558,6 +4588,19 @@ module Aws::CustomerProfiles
4558
4588
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
4559
4589
  end)
4560
4590
 
4591
+ api.add_operation(:search_recommendations, Seahorse::Model::Operation.new.tap do |o|
4592
+ o.name = "SearchRecommendations"
4593
+ o.http_method = "POST"
4594
+ o.http_request_uri = "/domains/{DomainName}/recommendations"
4595
+ o.input = Shapes::ShapeRef.new(shape: SearchRecommendationsRequest)
4596
+ o.output = Shapes::ShapeRef.new(shape: SearchRecommendationsResponse)
4597
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
4598
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
4599
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
4600
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
4601
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
4602
+ end)
4603
+
4561
4604
  api.add_operation(:start_recommender, Seahorse::Model::Operation.new.tap do |o|
4562
4605
  o.name = "StartRecommender"
4563
4606
  o.http_method = "PUT"
@@ -9258,6 +9258,49 @@ module Aws::CustomerProfiles
9258
9258
  include Aws::Structure
9259
9259
  end
9260
9260
 
9261
+ # Configuration for metadata to include in recommendation responses.
9262
+ #
9263
+ # @!attribute [rw] columns
9264
+ # A list of metadata column names from your Items dataset to include
9265
+ # in the recommendation response.
9266
+ # @return [Array<String>]
9267
+ #
9268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommendationMetadata AWS API Documentation
9269
+ #
9270
+ class RecommendationMetadata < Struct.new(
9271
+ :columns)
9272
+ SENSITIVE = []
9273
+ include Aws::Structure
9274
+ end
9275
+
9276
+ # The recommender used to generate the recommendations.
9277
+ #
9278
+ # @!attribute [rw] name
9279
+ # The unique name of the recommender.
9280
+ # @return [String]
9281
+ #
9282
+ # @!attribute [rw] filters
9283
+ # A list of filters to apply to the returned recommendations. Filters
9284
+ # define criteria for including or excluding items from the
9285
+ # recommendation results.
9286
+ # @return [Array<Types::RecommenderFilter>]
9287
+ #
9288
+ # @!attribute [rw] promotional_filters
9289
+ # A list of promotional filters to apply to the recommendations.
9290
+ # Promotional filters allow you to promote specific items within a
9291
+ # configurable subset of recommendation results.
9292
+ # @return [Array<Types::RecommenderPromotionalFilter>]
9293
+ #
9294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/Recommender AWS API Documentation
9295
+ #
9296
+ class Recommender < Struct.new(
9297
+ :name,
9298
+ :filters,
9299
+ :promotional_filters)
9300
+ SENSITIVE = []
9301
+ include Aws::Structure
9302
+ end
9303
+
9261
9304
  # Configuration settings that define the behavior and parameters of a
9262
9305
  # recommender.
9263
9306
  #
@@ -10088,6 +10131,86 @@ module Aws::CustomerProfiles
10088
10131
  include Aws::Structure
10089
10132
  end
10090
10133
 
10134
+ # @!attribute [rw] domain_name
10135
+ # The unique name of the domain.
10136
+ # @return [String]
10137
+ #
10138
+ # @!attribute [rw] key_name
10139
+ # A searchable identifier of a customer profile. You can use a
10140
+ # predefined key, such as `_profileId`, `_phone`, or `_email`, or a
10141
+ # custom-defined key.
10142
+ # @return [String]
10143
+ #
10144
+ # @!attribute [rw] key_values
10145
+ # A list of key values. Provide one value for each field of the search
10146
+ # key.
10147
+ # @return [Array<String>]
10148
+ #
10149
+ # @!attribute [rw] recommender
10150
+ # The recommender used to generate the recommendations.
10151
+ # @return [Types::Recommender]
10152
+ #
10153
+ # @!attribute [rw] candidate_ids
10154
+ # A list of item IDs to rank for the user. Use this when you want to
10155
+ # re-rank a specific set of items rather than getting recommendations
10156
+ # from the full item catalog. Required for personalized-ranking use
10157
+ # cases.
10158
+ # @return [Array<String>]
10159
+ #
10160
+ # @!attribute [rw] context
10161
+ # The contextual metadata used to provide dynamic runtime information
10162
+ # to tailor recommendations.
10163
+ # @return [Hash<String,String>]
10164
+ #
10165
+ # @!attribute [rw] diversity
10166
+ # Runtime diversity configuration for this request. Enables
10167
+ # diversity-aware recommendations and optionally supplies values for
10168
+ # placeholder-based diversity caps configured on the recommender.
10169
+ # @return [Types::RecommendationDiversityConfig]
10170
+ #
10171
+ # @!attribute [rw] metadata
10172
+ # Configuration for metadata to include in recommendation responses.
10173
+ # @return [Types::RecommendationMetadata]
10174
+ #
10175
+ # @!attribute [rw] max_recommendations
10176
+ # The maximum number of recommendations to return. The default value
10177
+ # is 5.
10178
+ # @return [Integer]
10179
+ #
10180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchRecommendationsRequest AWS API Documentation
10181
+ #
10182
+ class SearchRecommendationsRequest < Struct.new(
10183
+ :domain_name,
10184
+ :key_name,
10185
+ :key_values,
10186
+ :recommender,
10187
+ :candidate_ids,
10188
+ :context,
10189
+ :diversity,
10190
+ :metadata,
10191
+ :max_recommendations)
10192
+ SENSITIVE = [:key_values, :context]
10193
+ include Aws::Structure
10194
+ end
10195
+
10196
+ # @!attribute [rw] profile_id
10197
+ # The unique identifier of the profile for which to retrieve
10198
+ # recommendations.
10199
+ # @return [String]
10200
+ #
10201
+ # @!attribute [rw] recommendations
10202
+ # List of recommendations generated by the recommender.
10203
+ # @return [Array<Types::Recommendation>]
10204
+ #
10205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/SearchRecommendationsResponse AWS API Documentation
10206
+ #
10207
+ class SearchRecommendationsResponse < Struct.new(
10208
+ :profile_id,
10209
+ :recommendations)
10210
+ SENSITIVE = [:recommendations]
10211
+ include Aws::Structure
10212
+ end
10213
+
10091
10214
  # Object holding the segment definition fields.
10092
10215
  #
10093
10216
  # @!attribute [rw] segment_definition_name
@@ -54,7 +54,7 @@ module Aws::CustomerProfiles
54
54
  autoload :EndpointProvider, 'aws-sdk-customerprofiles/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-customerprofiles/endpoints'
56
56
 
57
- GEM_VERSION = '1.95.0'
57
+ GEM_VERSION = '1.96.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -1835,6 +1835,46 @@ module Aws
1835
1835
  ) -> _SearchProfilesResponseSuccess
1836
1836
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchProfilesResponseSuccess
1837
1837
 
1838
+ interface _SearchRecommendationsResponseSuccess
1839
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchRecommendationsResponse]
1840
+ def profile_id: () -> ::String
1841
+ def recommendations: () -> ::Array[Types::Recommendation]
1842
+ end
1843
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CustomerProfiles/Client.html#search_recommendations-instance_method
1844
+ def search_recommendations: (
1845
+ domain_name: ::String,
1846
+ key_name: ::String,
1847
+ key_values: Array[::String],
1848
+ recommender: {
1849
+ name: ::String,
1850
+ filters: Array[
1851
+ {
1852
+ name: ::String?,
1853
+ values: Hash[::String, ::String]?
1854
+ }
1855
+ ]?,
1856
+ promotional_filters: Array[
1857
+ {
1858
+ name: ::String?,
1859
+ values: Hash[::String, ::String]?,
1860
+ promotion_name: ::String?,
1861
+ percent_promoted_items: ::Integer?
1862
+ }
1863
+ ]?
1864
+ },
1865
+ ?candidate_ids: Array[::String],
1866
+ ?context: Hash[::String, ::String],
1867
+ ?diversity: {
1868
+ enabled: bool,
1869
+ values: Hash[::String, ::Integer]?
1870
+ },
1871
+ ?metadata: {
1872
+ columns: Array[::String]?
1873
+ },
1874
+ ?max_recommendations: ::Integer
1875
+ ) -> _SearchRecommendationsResponseSuccess
1876
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchRecommendationsResponseSuccess
1877
+
1838
1878
  interface _StartRecommenderResponseSuccess
1839
1879
  include ::Seahorse::Client::_ResponseSuccess[Types::StartRecommenderResponse]
1840
1880
  end
data/sig/types.rbs CHANGED
@@ -2427,6 +2427,18 @@ module Aws::CustomerProfiles
2427
2427
  SENSITIVE: []
2428
2428
  end
2429
2429
 
2430
+ class RecommendationMetadata
2431
+ attr_accessor columns: ::Array[::String]
2432
+ SENSITIVE: []
2433
+ end
2434
+
2435
+ class Recommender
2436
+ attr_accessor name: ::String
2437
+ attr_accessor filters: ::Array[Types::RecommenderFilter]
2438
+ attr_accessor promotional_filters: ::Array[Types::RecommenderPromotionalFilter]
2439
+ SENSITIVE: []
2440
+ end
2441
+
2430
2442
  class RecommenderConfig
2431
2443
  attr_accessor events_config: Types::EventsConfig
2432
2444
  attr_accessor training_frequency: ::Integer
@@ -2609,6 +2621,25 @@ module Aws::CustomerProfiles
2609
2621
  SENSITIVE: []
2610
2622
  end
2611
2623
 
2624
+ class SearchRecommendationsRequest
2625
+ attr_accessor domain_name: ::String
2626
+ attr_accessor key_name: ::String
2627
+ attr_accessor key_values: ::Array[::String]
2628
+ attr_accessor recommender: Types::Recommender
2629
+ attr_accessor candidate_ids: ::Array[::String]
2630
+ attr_accessor context: ::Hash[::String, ::String]
2631
+ attr_accessor diversity: Types::RecommendationDiversityConfig
2632
+ attr_accessor metadata: Types::RecommendationMetadata
2633
+ attr_accessor max_recommendations: ::Integer
2634
+ SENSITIVE: [:key_values, :context]
2635
+ end
2636
+
2637
+ class SearchRecommendationsResponse
2638
+ attr_accessor profile_id: ::String
2639
+ attr_accessor recommendations: ::Array[Types::Recommendation]
2640
+ SENSITIVE: [:recommendations]
2641
+ end
2642
+
2612
2643
  class SegmentDefinitionItem
2613
2644
  attr_accessor segment_definition_name: ::String
2614
2645
  attr_accessor display_name: ::String
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-customerprofiles
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.95.0
4
+ version: 1.96.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services