aws-sdk-personalizeruntime 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0306afef0845388d9b7fa0bd70b89dcf35739cb28ea75ab0fa011d6868050448
-  data.tar.gz: b24d006502f4660bf554e5d4642a5529b7bbed13927afbedd4e02504437ddf0f
+  metadata.gz: 5e4bb1cbe03b3cfb6f7f223f4fc588c8cd1f55fcf012c44c6264a870ede23ef2
+  data.tar.gz: 459b7560a0edd5f32276999de072f1417e45131206bb615c0a582ea2b482b8b9
 SHA512:
-  metadata.gz: 4618e904d653cd82d7c267b8b5fd6bdd33f9918290fd0573670e4eac4d8db12ff54259e844f13d6b85bfee24152591271e12b7bcfbf883e088384e42ba29c00f
-  data.tar.gz: 8bb5cb3a65216058018f7b8fe353e8b8a2ab10e85ef361e5d7ec65f4c465955714c79a51fd882d834bd09bd8eb4eeba61fa0842348823be16e2f92b58a5cc06f
+  metadata.gz: dd13d6860a764f1614619a10350d032176cb3a8ceab9ad617213520a950c2f529f47a721b03388782046c12191e9648fe3a2aa1543607350f208729e449a5f6d
+  data.tar.gz: be2fe5623922d14430c3863bdb518938f1aa2015bf090c6ccca320415a4f92273f2b97a042537cfa16221b0b3813f9202e2d22379a7024a1bf5dcd674c7e38e4

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.33.0 (2022-08-12)
+------------------
+
+* Feature - This release provides support for promotions in AWS Personalize runtime.
+
 1.32.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.32.0
+1.33.0

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

@@ -432,6 +432,7 @@ module Aws::PersonalizeRuntime
     #   resp.personalized_ranking #=> Array
     #   resp.personalized_ranking[0].item_id #=> String
     #   resp.personalized_ranking[0].score #=> Float
+    #   resp.personalized_ranking[0].promotion_name #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
@@ -513,7 +514,8 @@ module Aws::PersonalizeRuntime
     #   Amazon Personalize doesn't use that portion of the expression to
     #   filter recommendations.
     #
-    #   For more information, see [Filtering Recommendations][1].
+    #   For more information, see [Filtering recommendations and user
+    #   segments][1].
     #
     #
     #
@@ -524,6 +526,11 @@ module Aws::PersonalizeRuntime
     #   recommendations. Provide a recommender ARN if you created a Domain
     #   dataset group with a recommender for a domain use case.
     #
+    # @option params [Array<Types::Promotion>] :promotions
+    #   The promotions to apply to the recommendation request. A promotion
+    #   defines additional business rules that apply to a configurable subset
+    #   of recommended items.
+    #
     # @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;
@@ -544,6 +551,16 @@ module Aws::PersonalizeRuntime
     #       "FilterAttributeName" => "FilterAttributeValue",
     #     },
     #     recommender_arn: "Arn",
+    #     promotions: [
+    #       {
+    #         name: "Name",
+    #         percent_promoted_items: 1,
+    #         filter_arn: "Arn",
+    #         filter_values: {
+    #           "FilterAttributeName" => "FilterAttributeValue",
+    #         },
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -551,6 +568,7 @@ module Aws::PersonalizeRuntime
     #   resp.item_list #=> Array
     #   resp.item_list[0].item_id #=> String
     #   resp.item_list[0].score #=> Float
+    #   resp.item_list[0].promotion_name #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
@@ -575,7 +593,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.32.0'
+      context[:gem_version] = '1.33.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -29,8 +29,12 @@ module Aws::PersonalizeRuntime
     InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
     ItemID = Shapes::StringShape.new(name: 'ItemID')
     ItemList = Shapes::ListShape.new(name: 'ItemList')
+    Name = Shapes::StringShape.new(name: 'Name')
     NumResults = Shapes::IntegerShape.new(name: 'NumResults')
+    PercentPromotedItems = Shapes::IntegerShape.new(name: 'PercentPromotedItems')
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
+    Promotion = Shapes::StructureShape.new(name: 'Promotion')
+    PromotionList = Shapes::ListShape.new(name: 'PromotionList')
     RecommendationID = Shapes::StringShape.new(name: 'RecommendationID')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Score = Shapes::FloatShape.new(name: 'Score')
@@ -62,6 +66,7 @@ module Aws::PersonalizeRuntime
     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.add_member(:promotions, Shapes::ShapeRef.new(shape: PromotionList, location_name: "promotions"))
     GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
@@ -77,8 +82,17 @@ module Aws::PersonalizeRuntime
 
     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.struct_class = Types::PredictedItem
 
+    Promotion.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
+    Promotion.add_member(:percent_promoted_items, Shapes::ShapeRef.new(shape: PercentPromotedItems, location_name: "percentPromotedItems"))
+    Promotion.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
+    Promotion.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValues, location_name: "filterValues"))
+    Promotion.struct_class = Types::Promotion
+
+    PromotionList.member = Shapes::ShapeRef.new(shape: Promotion)
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 

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

@@ -127,6 +127,16 @@ module Aws::PersonalizeRuntime
     #           "FilterAttributeName" => "FilterAttributeValue",
     #         },
     #         recommender_arn: "Arn",
+    #         promotions: [
+    #           {
+    #             name: "Name",
+    #             percent_promoted_items: 1,
+    #             filter_arn: "Arn",
+    #             filter_values: {
+    #               "FilterAttributeName" => "FilterAttributeValue",
+    #             },
+    #           },
+    #         ],
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -183,7 +193,8 @@ module Aws::PersonalizeRuntime
     #   `filter-values`.In this case, Amazon Personalize doesn't use that
     #   portion of the expression to filter recommendations.
     #
-    #   For more information, see [Filtering Recommendations][1].
+    #   For more information, see [Filtering recommendations and user
+    #   segments][1].
     #
     #
     #
@@ -196,6 +207,12 @@ module Aws::PersonalizeRuntime
     #   dataset group with a recommender for a domain use case.
     #   @return [String]
     #
+    # @!attribute [rw] promotions
+    #   The promotions to apply to the recommendation request. A promotion
+    #   defines additional business rules that apply to a configurable
+    #   subset of recommended items.
+    #   @return [Array<Types::Promotion>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
@@ -206,7 +223,8 @@ module Aws::PersonalizeRuntime
       :context,
       :filter_arn,
       :filter_values,
-      :recommender_arn)
+      :recommender_arn,
+      :promotions)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -256,11 +274,83 @@ module Aws::PersonalizeRuntime
     #   logic, see how-scores-work.
     #   @return [Float]
     #
+    # @!attribute [rw] promotion_name
+    #   The name of the promotion that included the predicted item.
+    #   @return [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)
+      :score,
+      :promotion_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains information on a promotion. A promotion defines additional
+    # business rules that apply to a configurable subset of recommended
+    # items.
+    #
+    # @note When making an API call, you may pass Promotion
+    #   data as a hash:
+    #
+    #       {
+    #         name: "Name",
+    #         percent_promoted_items: 1,
+    #         filter_arn: "Arn",
+    #         filter_values: {
+    #           "FilterAttributeName" => "FilterAttributeValue",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The name of the promotion.
+    #   @return [String]
+    #
+    # @!attribute [rw] percent_promoted_items
+    #   The percentage of recommended items to apply the promotion to.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] filter_arn
+    #   The Amazon Resource Name (ARN) of the filter used by the promotion.
+    #   This filter defines the criteria for promoted items. For more
+    #   information, see [Promotion filters][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters
+    #   @return [String]
+    #
+    # @!attribute [rw] filter_values
+    #   The values to use when promoting items. For each placeholder
+    #   parameter in your promotion's 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
+    #   items, you must provide values for all parameters that are defined
+    #   in the expression. For filters with expressions that use an
+    #   `EXCLUDE` element to exclude items, 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 on creating filters, 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/Promotion AWS API Documentation
+    #
+    class Promotion < Struct.new(
+      :name,
+      :percent_promoted_items,
+      :filter_arn,
+      :filter_values)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-personalizeruntime.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core