Amazon Personalize Runtime Update: This release provides support for promotions in AWS Personalize runtime.

Author: AWS

.changes/next-release/feature-AmazonPersonalizeRuntime-a16afc9.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Personalize Runtime",
+    "contributor": "",
+    "description": "This release provides support for promotions in AWS Personalize runtime."
+}

services/personalizeruntime/src/main/resources/codegen-resources/service-2.json

@@ -158,11 +158,15 @@
         },
         "filterValues":{
           "shape":"FilterValues",
-          "documentation":"<p>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. </p> <p>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filter.html\">Filtering Recommendations</a>.</p>"
+          "documentation":"<p>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. </p> <p>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filter.html\">Filtering recommendations and user segments</a>.</p>"
         },
         "recommenderArn":{
           "shape":"Arn",
           "documentation":"<p>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.</p>"
+        },
+        "promotions":{
+          "shape":"PromotionList",
+          "documentation":"<p>The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>"
         }
       }
     },
@@ -200,10 +204,21 @@
       "type":"list",
       "member":{"shape":"PredictedItem"}
     },
+    "Name":{
+      "type":"string",
+      "max":63,
+      "min":1,
+      "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*"
+    },
     "NumResults":{
       "type":"integer",
       "min":0
     },
+    "PercentPromotedItems":{
+      "type":"integer",
+      "max":100,
+      "min":1
+    },
     "PredictedItem":{
       "type":"structure",
       "members":{
@@ -214,10 +229,41 @@
         "score":{
           "shape":"Score",
           "documentation":"<p>A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>"
+        },
+        "promotionName":{
+          "shape":"Name",
+          "documentation":"<p>The name of the promotion that included the predicted item.</p>"
         }
       },
       "documentation":"<p>An object that identifies an item.</p> <p>The and APIs return a list of <code>PredictedItem</code>s.</p>"
     },
+    "Promotion":{
+      "type":"structure",
+      "members":{
+        "name":{
+          "shape":"Name",
+          "documentation":"<p>The name of the promotion.</p>"
+        },
+        "percentPromotedItems":{
+          "shape":"PercentPromotedItems",
+          "documentation":"<p>The percentage of recommended items to apply the promotion to.</p>"
+        },
+        "filterArn":{
+          "shape":"Arn",
+          "documentation":"<p>The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters\">Promotion filters</a>.</p>"
+        },
+        "filterValues":{
+          "shape":"FilterValues",
+          "documentation":"<p>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. </p> <p>For filter expressions that use an <code>INCLUDE</code> element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an <code>EXCLUDE</code> element to exclude items, you can omit the <code>filter-values</code>. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.</p> <p>For more information on creating filters, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filter.html\">Filtering recommendations and user segments</a>.</p>"
+        }
+      },
+      "documentation":"<p>Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>"
+    },
+    "PromotionList":{
+      "type":"list",
+      "member":{"shape":"Promotion"},
+      "max":1
+    },
     "RecommendationID":{"type":"string"},
     "ResourceNotFoundException":{
       "type":"structure",