aws-sdk-personalizeruntime 1.43.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602d6cf29a8e124b68a0991d1b73f26318f1f72449b76346bbd58186c1fa1f86
-  data.tar.gz: b47f0b335e2a05a25359250991f6e38a30ad7a7646cff69578ee0da7d1f3f7ea
+  metadata.gz: 95fdb2eea021c7bd6a7db99aba515cd5e520d5d56fec875b413edb8e1c17339e
+  data.tar.gz: 66d62d7249fcf83927c0dafda1191aa5a50f54f89ccc4b026fb787a327be4003
 SHA512:
-  metadata.gz: 76ab9daa37967b71745067e403ebed4b3833ee9f6e48308abb757cdd651eb9539190d45abb919b9e46fd68687c01a489b05ff62a8a06a677e6c125677d77fb43
-  data.tar.gz: c67027ee9b98665bc2cd82cea61dbf089440869b3f2f1ab8da5594e127bce5a4baa33d5af038b7328364809a4efd40788209452c1668ac9187f1dcd603a396d1
+  metadata.gz: 8f88660b729e63fdf72e6edf0558d7e37c3a195338aed18aa6263c1cdd77f59e40a32caac88617b41277de53ade8378607f5df1af73333b747108ef3c15b0779
+  data.tar.gz: 166fbaec04411d3e60e5aaa17ca153a9592404b3c005a0b83c26a4c002aaab9eb6352639b45c31f84b31b6e05055bd30172874a50a34d7129206e2040aecff2b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.44.0 (2023-11-27)
+------------------
+
+* Feature - Enables metadata in recommendations and next best action recommendations
+
 1.43.0 (2023-11-22)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.43.0
+1.44.0

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

@@ -388,6 +388,94 @@ module Aws::PersonalizeRuntime
 
     # @!group API Operations
 
+    # Returns a list of recommended actions in sorted in descending order by
+    # prediction score. Use the `GetActionRecommendations` API if you have a
+    # custom campaign that deploys a solution version trained with a
+    # PERSONALIZED\_ACTIONS recipe.
+    #
+    # For more information about PERSONALIZED\_ACTIONS recipes, see
+    # [PERSONALIZED\_ACTIONS recipes][1]. For more information about getting
+    # action recommendations, see [Getting action recommendations][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html
+    # [2]: https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html
+    #
+    # @option params [String] :campaign_arn
+    #   The Amazon Resource Name (ARN) of the campaign to use for getting
+    #   action recommendations. This campaign must deploy a solution version
+    #   trained with a PERSONALIZED\_ACTIONS recipe.
+    #
+    # @option params [String] :user_id
+    #   The user ID of the user to provide action recommendations for.
+    #
+    # @option params [Integer] :num_results
+    #   The number of results to return. The default is 5. The maximum is 100.
+    #
+    # @option params [String] :filter_arn
+    #   The ARN of the filter to apply to the returned recommendations. For
+    #   more information, see [Filtering Recommendations][1].
+    #
+    #   When using this parameter, be sure the filter resource is `ACTIVE`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #
+    # @option params [Hash<String,String>] :filter_values
+    #   The values to use when filtering recommendations. For each placeholder
+    #   parameter in your filter expression, provide the parameter name (in
+    #   matching case) as a key and the filter value(s) as the corresponding
+    #   value. Separate multiple values for one parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include
+    #   actions, you must provide values for all parameters that are defined
+    #   in the expression. For filters with expressions that use an `EXCLUDE`
+    #   element to exclude actions, you can omit the `filter-values`. In this
+    #   case, Amazon Personalize doesn't use that portion of the expression
+    #   to filter recommendations.
+    #
+    #   For more information, see [Filtering recommendations and user
+    #   segments][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #
+    # @return [Types::GetActionRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetActionRecommendationsResponse#action_list #action_list} => Array&lt;Types::PredictedAction&gt;
+    #   * {Types::GetActionRecommendationsResponse#recommendation_id #recommendation_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_action_recommendations({
+    #     campaign_arn: "Arn",
+    #     user_id: "UserID",
+    #     num_results: 1,
+    #     filter_arn: "Arn",
+    #     filter_values: {
+    #       "FilterAttributeName" => "FilterAttributeValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.action_list #=> Array
+    #   resp.action_list[0].action_id #=> String
+    #   resp.action_list[0].score #=> Float
+    #   resp.recommendation_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetActionRecommendations AWS API Documentation
+    #
+    # @overload get_action_recommendations(params = {})
+    # @param [Hash] params ({})
+    def get_action_recommendations(params = {}, options = {})
+      req = build_request(:get_action_recommendations, params)
+      req.send_request(options)
+    end
+
     # Re-ranks a list of recommended items for the given user. The first
     # item in the list is deemed the most likely item to be of interest to
     # the user.
@@ -404,7 +492,8 @@ module Aws::PersonalizeRuntime
     # @option params [required, Array<String>] :input_list
     #   A list of items (by `itemId`) to rank. If an item was not included in
     #   the training dataset, the item is appended to the end of the reranked
-    #   list. The maximum is 500.
+    #   list. If you are including metadata in recommendations, the maximum is
+    #   50. Otherwise, the maximum is 500.
     #
     # @option params [required, String] :user_id
     #   The user for which you want the campaign to provide a personalized
@@ -444,6 +533,20 @@ module Aws::PersonalizeRuntime
     #
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #
+    # @option params [Hash<String,Array>] :metadata_columns
+    #   If you enabled metadata in recommendations when you created or updated
+    #   the campaign, specify metadata columns from your Items dataset to
+    #   include in the personalized ranking. The map key is `ITEMS` and the
+    #   value is a list of column names from your Items dataset. The maximum
+    #   number of columns you can provide is 10.
+    #
+    #   For information about enabling metadata for a campaign, see [Enabling
+    #   metadata in recommendations for a campaign][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html
+    #
     # @return [Types::GetPersonalizedRankingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetPersonalizedRankingResponse#personalized_ranking #personalized_ranking} => Array&lt;Types::PredictedItem&gt;
@@ -462,6 +565,9 @@ module Aws::PersonalizeRuntime
     #     filter_values: {
     #       "FilterAttributeName" => "FilterAttributeValue",
     #     },
+    #     metadata_columns: {
+    #       "DatasetType" => ["ColumnName"],
+    #     },
     #   })
     #
     # @example Response structure
@@ -470,6 +576,8 @@ module Aws::PersonalizeRuntime
     #   resp.personalized_ranking[0].item_id #=> String
     #   resp.personalized_ranking[0].score #=> Float
     #   resp.personalized_ranking[0].promotion_name #=> String
+    #   resp.personalized_ranking[0].metadata #=> Hash
+    #   resp.personalized_ranking[0].metadata["ColumnName"] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
@@ -519,8 +627,9 @@ module Aws::PersonalizeRuntime
     #   Required for `USER_PERSONALIZATION` recipe type.
     #
     # @option params [Integer] :num_results
-    #   The number of results to return. The default is 25. The maximum is
-    #   500.
+    #   The number of results to return. The default is 25. If you are
+    #   including metadata in recommendations, the maximum is 50. Otherwise,
+    #   the maximum is 500.
     #
     # @option params [Hash<String,String>] :context
     #   The contextual metadata to use when getting recommendations.
@@ -568,6 +677,23 @@ module Aws::PersonalizeRuntime
     #   defines additional business rules that apply to a configurable subset
     #   of recommended items.
     #
+    # @option params [Hash<String,Array>] :metadata_columns
+    #   If you enabled metadata in recommendations when you created or updated
+    #   the campaign or recommender, specify the metadata columns from your
+    #   Items dataset to include in item recommendations. The map key is
+    #   `ITEMS` and the value is a list of column names from your Items
+    #   dataset. The maximum number of columns you can provide is 10.
+    #
+    #   For information about enabling metadata for a campaign, see [Enabling
+    #   metadata in recommendations for a campaign][1]. For information about
+    #   enabling metadata for a recommender, see [Enabling metadata in
+    #   recommendations for a recommender][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/create-recommender-return-metadata.html
+    #
     # @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;
@@ -598,6 +724,9 @@ module Aws::PersonalizeRuntime
     #         },
     #       },
     #     ],
+    #     metadata_columns: {
+    #       "DatasetType" => ["ColumnName"],
+    #     },
     #   })
     #
     # @example Response structure
@@ -606,6 +735,8 @@ module Aws::PersonalizeRuntime
     #   resp.item_list[0].item_id #=> String
     #   resp.item_list[0].score #=> Float
     #   resp.item_list[0].promotion_name #=> String
+    #   resp.item_list[0].metadata #=> Hash
+    #   resp.item_list[0].metadata["ColumnName"] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
@@ -630,7 +761,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.43.0'
+      context[:gem_version] = '1.44.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -13,14 +13,22 @@ module Aws::PersonalizeRuntime
 
     include Seahorse::Model
 
+    ActionID = Shapes::StringShape.new(name: 'ActionID')
+    ActionList = Shapes::ListShape.new(name: 'ActionList')
     Arn = Shapes::StringShape.new(name: 'Arn')
     AttributeName = Shapes::StringShape.new(name: 'AttributeName')
     AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
+    ColumnName = Shapes::StringShape.new(name: 'ColumnName')
+    ColumnNamesList = Shapes::ListShape.new(name: 'ColumnNamesList')
+    ColumnValue = Shapes::StringShape.new(name: 'ColumnValue')
     Context = Shapes::MapShape.new(name: 'Context')
+    DatasetType = Shapes::StringShape.new(name: 'DatasetType')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     FilterAttributeName = Shapes::StringShape.new(name: 'FilterAttributeName')
     FilterAttributeValue = Shapes::StringShape.new(name: 'FilterAttributeValue')
     FilterValues = Shapes::MapShape.new(name: 'FilterValues')
+    GetActionRecommendationsRequest = Shapes::StructureShape.new(name: 'GetActionRecommendationsRequest')
+    GetActionRecommendationsResponse = Shapes::StructureShape.new(name: 'GetActionRecommendationsResponse')
     GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
     GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
     GetRecommendationsRequest = Shapes::StructureShape.new(name: 'GetRecommendationsRequest')
@@ -29,9 +37,12 @@ module Aws::PersonalizeRuntime
     InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
     ItemID = Shapes::StringShape.new(name: 'ItemID')
     ItemList = Shapes::ListShape.new(name: 'ItemList')
+    Metadata = Shapes::MapShape.new(name: 'Metadata')
+    MetadataColumns = Shapes::MapShape.new(name: 'MetadataColumns')
     Name = Shapes::StringShape.new(name: 'Name')
     NumResults = Shapes::IntegerShape.new(name: 'NumResults')
     PercentPromotedItems = Shapes::IntegerShape.new(name: 'PercentPromotedItems')
+    PredictedAction = Shapes::StructureShape.new(name: 'PredictedAction')
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
     Promotion = Shapes::StructureShape.new(name: 'Promotion')
     PromotionList = Shapes::ListShape.new(name: 'PromotionList')
@@ -40,18 +51,34 @@ module Aws::PersonalizeRuntime
     Score = Shapes::FloatShape.new(name: 'Score')
     UserID = Shapes::StringShape.new(name: 'UserID')
 
+    ActionList.member = Shapes::ShapeRef.new(shape: PredictedAction)
+
+    ColumnNamesList.member = Shapes::ShapeRef.new(shape: ColumnName)
+
     Context.key = Shapes::ShapeRef.new(shape: AttributeName)
     Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
 
     FilterValues.key = Shapes::ShapeRef.new(shape: FilterAttributeName)
     FilterValues.value = Shapes::ShapeRef.new(shape: FilterAttributeValue)
 
+    GetActionRecommendationsRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "campaignArn"))
+    GetActionRecommendationsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, location_name: "userId"))
+    GetActionRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
+    GetActionRecommendationsRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
+    GetActionRecommendationsRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
+    GetActionRecommendationsRequest.struct_class = Types::GetActionRecommendationsRequest
+
+    GetActionRecommendationsResponse.add_member(:action_list, Shapes::ShapeRef.new(shape: ActionList, location_name: "actionList"))
+    GetActionRecommendationsResponse.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationID, location_name: "recommendationId"))
+    GetActionRecommendationsResponse.struct_class = Types::GetActionRecommendationsResponse
+
     GetPersonalizedRankingRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
     GetPersonalizedRankingRequest.add_member(:input_list, Shapes::ShapeRef.new(shape: InputList, required: true, location_name: "inputList"))
     GetPersonalizedRankingRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, required: true, location_name: "userId"))
     GetPersonalizedRankingRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
     GetPersonalizedRankingRequest.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
     GetPersonalizedRankingRequest.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
+    GetPersonalizedRankingRequest.add_member(:metadata_columns, Shapes::ShapeRef.new(shape: MetadataColumns, location_name: "metadataColumns"))
     GetPersonalizedRankingRequest.struct_class = Types::GetPersonalizedRankingRequest
 
     GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
@@ -67,6 +94,7 @@ module Aws::PersonalizeRuntime
     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.add_member(:promotions, Shapes::ShapeRef.new(shape: PromotionList, location_name: "promotions"))
+    GetRecommendationsRequest.add_member(:metadata_columns, Shapes::ShapeRef.new(shape: MetadataColumns, location_name: "metadataColumns"))
     GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
@@ -80,9 +108,20 @@ module Aws::PersonalizeRuntime
 
     ItemList.member = Shapes::ShapeRef.new(shape: PredictedItem)
 
+    Metadata.key = Shapes::ShapeRef.new(shape: ColumnName)
+    Metadata.value = Shapes::ShapeRef.new(shape: ColumnValue)
+
+    MetadataColumns.key = Shapes::ShapeRef.new(shape: DatasetType)
+    MetadataColumns.value = Shapes::ShapeRef.new(shape: ColumnNamesList)
+
+    PredictedAction.add_member(:action_id, Shapes::ShapeRef.new(shape: ActionID, location_name: "actionId"))
+    PredictedAction.add_member(:score, Shapes::ShapeRef.new(shape: Score, location_name: "score"))
+    PredictedAction.struct_class = Types::PredictedAction
+
     PredictedItem.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
     PredictedItem.add_member(:score, Shapes::ShapeRef.new(shape: Score, location_name: "score"))
     PredictedItem.add_member(:promotion_name, Shapes::ShapeRef.new(shape: Name, location_name: "promotionName"))
+    PredictedItem.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "metadata"))
     PredictedItem.struct_class = Types::PredictedItem
 
     Promotion.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -114,6 +153,16 @@ module Aws::PersonalizeRuntime
         "uid" => "personalize-runtime-2018-05-22",
       }
 
+      api.add_operation(:get_action_recommendations, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetActionRecommendations"
+        o.http_method = "POST"
+        o.http_request_uri = "/action-recommendations"
+        o.input = Shapes::ShapeRef.new(shape: GetActionRecommendationsRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetActionRecommendationsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:get_personalized_ranking, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetPersonalizedRanking"
         o.http_method = "POST"

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

@@ -32,7 +32,7 @@ module Aws::PersonalizeRuntime
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://personalize-runtime-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

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

@@ -12,6 +12,20 @@ module Aws::PersonalizeRuntime
   # @api private
   module Endpoints
 
+    class GetActionRecommendations
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::PersonalizeRuntime::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class GetPersonalizedRanking
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-personalizeruntime/plugins/endpoints.rb

@@ -56,6 +56,8 @@ module Aws::PersonalizeRuntime
 
         def parameters_for_operation(context)
           case context.operation_name
+          when :get_action_recommendations
+            Aws::PersonalizeRuntime::Endpoints::GetActionRecommendations.build(context)
           when :get_personalized_ranking
             Aws::PersonalizeRuntime::Endpoints::GetPersonalizedRanking.build(context)
           when :get_recommendations

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

@@ -10,6 +10,90 @@
 module Aws::PersonalizeRuntime
   module Types
 
+    # @!attribute [rw] campaign_arn
+    #   The Amazon Resource Name (ARN) of the campaign to use for getting
+    #   action recommendations. This campaign must deploy a solution version
+    #   trained with a PERSONALIZED\_ACTIONS recipe.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_id
+    #   The user ID of the user to provide action recommendations for.
+    #   @return [String]
+    #
+    # @!attribute [rw] num_results
+    #   The number of results to return. The default is 5. The maximum is
+    #   100.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] filter_arn
+    #   The ARN of the filter to apply to the returned recommendations. For
+    #   more information, see [Filtering Recommendations][1].
+    #
+    #   When using this parameter, be sure the filter resource is `ACTIVE`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_values
+    #   The values to use when filtering recommendations. For each
+    #   placeholder parameter in your filter expression, provide the
+    #   parameter name (in matching case) as a key and the filter value(s)
+    #   as the corresponding value. Separate multiple values for one
+    #   parameter with a comma.
+    #
+    #   For filter expressions that use an `INCLUDE` element to include
+    #   actions, you must provide values for all parameters that are defined
+    #   in the expression. For filters with expressions that use an
+    #   `EXCLUDE` element to exclude actions, you can omit the
+    #   `filter-values`. In this case, Amazon Personalize doesn't use that
+    #   portion of the expression to filter recommendations.
+    #
+    #   For more information, see [Filtering recommendations and user
+    #   segments][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetActionRecommendationsRequest AWS API Documentation
+    #
+    class GetActionRecommendationsRequest < Struct.new(
+      :campaign_arn,
+      :user_id,
+      :num_results,
+      :filter_arn,
+      :filter_values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] action_list
+    #   A list of action recommendations sorted in descending order by
+    #   prediction score. There can be a maximum of 100 actions in the list.
+    #   For information about action scores, see [How action recommendation
+    #   scoring works][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html
+    #   @return [Array<Types::PredictedAction>]
+    #
+    # @!attribute [rw] recommendation_id
+    #   The ID of the recommendation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetActionRecommendationsResponse AWS API Documentation
+    #
+    class GetActionRecommendationsResponse < Struct.new(
+      :action_list,
+      :recommendation_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] campaign_arn
     #   The Amazon Resource Name (ARN) of the campaign to use for generating
     #   the personalized ranking.
@@ -18,7 +102,8 @@ module Aws::PersonalizeRuntime
     # @!attribute [rw] input_list
     #   A list of items (by `itemId`) to rank. If an item was not included
     #   in the training dataset, the item is appended to the end of the
-    #   reranked list. The maximum is 500.
+    #   reranked list. If you are including metadata in recommendations, the
+    #   maximum is 50. Otherwise, the maximum is 500.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_id
@@ -64,6 +149,21 @@ module Aws::PersonalizeRuntime
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] metadata_columns
+    #   If you enabled metadata in recommendations when you created or
+    #   updated the campaign, specify metadata columns from your Items
+    #   dataset to include in the personalized ranking. The map key is
+    #   `ITEMS` and the value is a list of column names from your Items
+    #   dataset. The maximum number of columns you can provide is 10.
+    #
+    #   For information about enabling metadata for a campaign, see
+    #   [Enabling metadata in recommendations for a campaign][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html
+    #   @return [Hash<String,Array<String>>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
     #
     class GetPersonalizedRankingRequest < Struct.new(
@@ -72,7 +172,8 @@ module Aws::PersonalizeRuntime
       :user_id,
       :context,
       :filter_arn,
-      :filter_values)
+      :filter_values,
+      :metadata_columns)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -113,8 +214,9 @@ module Aws::PersonalizeRuntime
     #   @return [String]
     #
     # @!attribute [rw] num_results
-    #   The number of results to return. The default is 25. The maximum is
-    #   500.
+    #   The number of results to return. The default is 25. If you are
+    #   including metadata in recommendations, the maximum is 50. Otherwise,
+    #   the maximum is 500.
     #   @return [Integer]
     #
     # @!attribute [rw] context
@@ -169,6 +271,24 @@ module Aws::PersonalizeRuntime
     #   subset of recommended items.
     #   @return [Array<Types::Promotion>]
     #
+    # @!attribute [rw] metadata_columns
+    #   If you enabled metadata in recommendations when you created or
+    #   updated the campaign or recommender, specify the metadata columns
+    #   from your Items dataset to include in item recommendations. The map
+    #   key is `ITEMS` and the value is a list of column names from your
+    #   Items dataset. The maximum number of columns you can provide is 10.
+    #
+    #   For information about enabling metadata for a campaign, see
+    #   [Enabling metadata in recommendations for a campaign][1]. For
+    #   information about enabling metadata for a recommender, see [Enabling
+    #   metadata in recommendations for a recommender][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/create-campaign-return-metadata.html
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/create-recommender-return-metadata.html
+    #   @return [Hash<String,Array<String>>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -180,7 +300,8 @@ module Aws::PersonalizeRuntime
       :filter_arn,
       :filter_values,
       :recommender_arn,
-      :promotions)
+      :promotions,
+      :metadata_columns)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -216,6 +337,32 @@ module Aws::PersonalizeRuntime
       include Aws::Structure
     end
 
+    # An object that identifies an action.
+    #
+    # The API returns a list of `PredictedAction`s.
+    #
+    # @!attribute [rw] action_id
+    #   The ID of the recommended action.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   The score of the recommended action. For information about action
+    #   scores, see [How action recommendation scoring works][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedAction AWS API Documentation
+    #
+    class PredictedAction < Struct.new(
+      :action_id,
+      :score)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # An object that identifies an item.
     #
     # The and APIs return a list of `PredictedItem`s.
@@ -234,12 +381,17 @@ module Aws::PersonalizeRuntime
     #   The name of the promotion that included the predicted item.
     #   @return [String]
     #
+    # @!attribute [rw] metadata
+    #   Metadata about the item from your Items dataset.
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedItem AWS API Documentation
     #
     class PredictedItem < Struct.new(
       :item_id,
       :score,
-      :promotion_name)
+      :promotion_name,
+      :metadata)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-personalizeruntime.rb

@@ -32,7 +32,7 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # structure.
 #
 #     personalize_runtime = Aws::PersonalizeRuntime::Client.new
-#     resp = personalize_runtime.get_personalized_ranking(params)
+#     resp = personalize_runtime.get_action_recommendations(params)
 #
 # See {Client} for more information.
 #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.43.0'
+  GEM_VERSION = '1.44.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.43.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core