aws-sdk-personalizeruntime 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d37062ec0844aada93968f70c2c60553aa9509935e9a8d5f0c31479b189497d
-  data.tar.gz: faba2dc8de83c2d84e989544e605979a475568657ba12e3c84b3a6bc417606cb
+  metadata.gz: c1ff0e79035ce7cd754ad93d085afa19a58e5df26876fe9ba8b81db9f310798e
+  data.tar.gz: 3efd4c5807b810f0ff4597ac215c04539587e5203e6cd3bb74793933e8e88217
 SHA512:
-  metadata.gz: 92a9afa36b54d1496605d1a8f8e27f176c18f64aceff3d14daef77c26804f78689da3cb09b12899b28e252734ad911cb619e4f0935eb95fd253d3d1f85e6e52d
-  data.tar.gz: 1c88a4ecfc91624b3a8d0077f0fdb102cde29915810be7de62ff4f12f6b5ff8916b445ae2266662709b68da320ec771d3d4e2770504bce7853f2ea16fcb54bb3
+  metadata.gz: 2e218678d0636afa2b7270d36bc43f857bcc0ab0e264f9a3d44c421248c609935b5747482628d28848b33b3fe509ee15e68934bc79d1b6b22be1fb175bc668ea
+  data.tar.gz: 24b40e8ca0c8ec71d4a31a814e390284a3e3517d78dfc7943b99afebd7401210c53740e9d76a70f934bef8e6d9b7c540ebc91553a570711521807a30cd5b3981

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.28.0 (2021-11-29)
+------------------
+
+* Feature - This release adds inference support for Recommenders.
+
 1.27.0 (2021-11-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.27.0
+1.28.0

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

@@ -428,20 +428,30 @@ module Aws::PersonalizeRuntime
       req.send_request(options)
     end
 
-    # Returns a list of recommended items. The required input depends on the
-    # recipe type used to create the solution backing the campaign, as
-    # follows:
+    # Returns a list of recommended items. For campaigns, the campaign's
+    # Amazon Resource Name (ARN) is required and the required user and item
+    # input depends on the recipe type used to create the solution backing
+    # the campaign as follows:
     #
-    # * RELATED\_ITEMS - `itemId` required, `userId` not used
+    # * USER\_PERSONALIZATION - `userId` required, `itemId` not used
     #
-    # * USER\_PERSONALIZATION - `itemId` optional, `userId` required
+    # * RELATED\_ITEMS - `itemId` required, `userId` not used
     #
     # <note markdown="1"> Campaigns that are backed by a solution created using a recipe of type
     # PERSONALIZED\_RANKING use the API.
     #
     #  </note>
     #
-    # @option params [required, String] :campaign_arn
+    # For recommenders, the recommender's ARN is required and the required
+    # item and user input depends on the use case (domain-based recipe)
+    # backing the recommender. For information on use case requirements see
+    # [Choosing recommender use cases][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html
+    #
+    # @option params [String] :campaign_arn
     #   The Amazon Resource Name (ARN) of the campaign to use for getting
     #   recommendations.
     #
@@ -494,6 +504,11 @@ module Aws::PersonalizeRuntime
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #
+    # @option params [String] :recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to use to get
+    #   recommendations. Provide a recommender ARN if you created a Domain
+    #   dataset group with a recommender for a domain use case.
+    #
     # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetRecommendationsResponse#item_list #item_list} => Array&lt;Types::PredictedItem&gt;
@@ -502,7 +517,7 @@ module Aws::PersonalizeRuntime
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_recommendations({
-    #     campaign_arn: "Arn", # required
+    #     campaign_arn: "Arn",
     #     item_id: "ItemID",
     #     user_id: "UserID",
     #     num_results: 1,
@@ -513,6 +528,7 @@ module Aws::PersonalizeRuntime
     #     filter_values: {
     #       "FilterAttributeName" => "FilterAttributeValue",
     #     },
+    #     recommender_arn: "Arn",
     #   })
     #
     # @example Response structure
@@ -544,7 +560,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.27.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -54,13 +54,14 @@ module Aws::PersonalizeRuntime
     GetPersonalizedRankingResponse.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationID, location_name: "recommendationId"))
     GetPersonalizedRankingResponse.struct_class = Types::GetPersonalizedRankingResponse
 
-    GetRecommendationsRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
+    GetRecommendationsRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
     GetRecommendationsRequest.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
     GetRecommendationsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, location_name: "userId"))
     GetRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
     GetRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
     GetRecommendationsRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     GetRecommendationsRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
+    GetRecommendationsRequest.add_member(:recommender_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recommenderArn"))
     GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))

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

@@ -115,7 +115,7 @@ module Aws::PersonalizeRuntime
     #   data as a hash:
     #
     #       {
-    #         campaign_arn: "Arn", # required
+    #         campaign_arn: "Arn",
     #         item_id: "ItemID",
     #         user_id: "UserID",
     #         num_results: 1,
@@ -126,6 +126,7 @@ module Aws::PersonalizeRuntime
     #         filter_values: {
     #           "FilterAttributeName" => "FilterAttributeValue",
     #         },
+    #         recommender_arn: "Arn",
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -189,6 +190,12 @@ module Aws::PersonalizeRuntime
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] recommender_arn
+    #   The Amazon Resource Name (ARN) of the recommender to use to get
+    #   recommendations. Provide a recommender ARN if you created a Domain
+    #   dataset group with a recommender for a domain use case.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -198,13 +205,14 @@ module Aws::PersonalizeRuntime
       :num_results,
       :context,
       :filter_arn,
-      :filter_values)
+      :filter_values,
+      :recommender_arn)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] item_list
-    #   A list of recommendations sorted in ascending order by prediction
+    #   A list of recommendations sorted in descending order by prediction
     #   score. There can be a maximum of 500 items in the list.
     #   @return [Array<Types::PredictedItem>]
     #

data/lib/aws-sdk-personalizeruntime.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.27.0'
+  GEM_VERSION = '1.28.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core