@aws-sdk/client-personalize-runtime 3.142.0 → 3.150.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.150.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.149.0...v3.150.0) (2022-08-15)
+
+**Note:** Version bump only for package @aws-sdk/client-personalize-runtime
+
+
+
+
+
+# [3.149.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.148.0...v3.149.0) (2022-08-12)
+
+
+### Features
+
+* **client-personalize-runtime:** This release provides support for promotions in AWS Personalize runtime. ([f7e4104](https://github.com/aws/aws-sdk-js-v3/commit/f7e410466be43961aec27fa05f5e0aa3eae0df8b))
+
+
+
+
+
+# [3.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
+
+**Note:** Version bump only for package @aws-sdk/client-personalize-runtime
+
+
+
+
+
 # [3.142.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.141.0...v3.142.0) (2022-08-02)
 
 

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetRecommendationsResponseFilterSensitiveLog = exports.GetRecommendationsRequestFilterSensitiveLog = exports.GetPersonalizedRankingResponseFilterSensitiveLog = exports.PredictedItemFilterSensitiveLog = exports.GetPersonalizedRankingRequestFilterSensitiveLog = exports.ResourceNotFoundException = exports.InvalidInputException = void 0;
+exports.GetRecommendationsResponseFilterSensitiveLog = exports.GetRecommendationsRequestFilterSensitiveLog = exports.PromotionFilterSensitiveLog = exports.GetPersonalizedRankingResponseFilterSensitiveLog = exports.PredictedItemFilterSensitiveLog = exports.GetPersonalizedRankingRequestFilterSensitiveLog = exports.ResourceNotFoundException = exports.InvalidInputException = void 0;
 const smithy_client_1 = require("@aws-sdk/smithy-client");
 const PersonalizeRuntimeServiceException_1 = require("./PersonalizeRuntimeServiceException");
 class InvalidInputException extends PersonalizeRuntimeServiceException_1.PersonalizeRuntimeServiceException {
@@ -43,10 +43,16 @@ const GetPersonalizedRankingResponseFilterSensitiveLog = (obj) => ({
     ...obj,
 });
 exports.GetPersonalizedRankingResponseFilterSensitiveLog = GetPersonalizedRankingResponseFilterSensitiveLog;
+const PromotionFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.filterValues && { filterValues: smithy_client_1.SENSITIVE_STRING }),
+});
+exports.PromotionFilterSensitiveLog = PromotionFilterSensitiveLog;
 const GetRecommendationsRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.context && { context: smithy_client_1.SENSITIVE_STRING }),
     ...(obj.filterValues && { filterValues: smithy_client_1.SENSITIVE_STRING }),
+    ...(obj.promotions && { promotions: obj.promotions.map((item) => (0, exports.PromotionFilterSensitiveLog)(item)) }),
 });
 exports.GetRecommendationsRequestFilterSensitiveLog = GetRecommendationsRequestFilterSensitiveLog;
 const GetRecommendationsResponseFilterSensitiveLog = (obj) => ({

package/dist-cjs/protocols/Aws_restJson1.js

@@ -49,6 +49,7 @@ const serializeAws_restJson1GetRecommendationsCommand = async (input, context) =
         }),
         ...(input.itemId != null && { itemId: input.itemId }),
         ...(input.numResults != null && { numResults: input.numResults }),
+        ...(input.promotions != null && { promotions: serializeAws_restJson1PromotionList(input.promotions, context) }),
         ...(input.recommenderArn != null && { recommenderArn: input.recommenderArn }),
         ...(input.userId != null && { userId: input.userId }),
     });
@@ -197,6 +198,23 @@ const serializeAws_restJson1InputList = (input, context) => {
         return entry;
     });
 };
+const serializeAws_restJson1Promotion = (input, context) => {
+    return {
+        ...(input.filterArn != null && { filterArn: input.filterArn }),
+        ...(input.filterValues != null && {
+            filterValues: serializeAws_restJson1FilterValues(input.filterValues, context),
+        }),
+        ...(input.name != null && { name: input.name }),
+        ...(input.percentPromotedItems != null && { percentPromotedItems: input.percentPromotedItems }),
+    };
+};
+const serializeAws_restJson1PromotionList = (input, context) => {
+    return input
+        .filter((e) => e != null)
+        .map((entry) => {
+        return serializeAws_restJson1Promotion(entry, context);
+    });
+};
 const deserializeAws_restJson1ItemList = (output, context) => {
     const retVal = (output || [])
         .filter((e) => e != null)
@@ -211,6 +229,7 @@ const deserializeAws_restJson1ItemList = (output, context) => {
 const deserializeAws_restJson1PredictedItem = (output, context) => {
     return {
         itemId: (0, smithy_client_1.expectString)(output.itemId),
+        promotionName: (0, smithy_client_1.expectString)(output.promotionName),
         score: (0, smithy_client_1.limitedParseDouble)(output.score),
     };
 };

package/dist-es/models/models_0.js

@@ -28,5 +28,6 @@ export { ResourceNotFoundException };
 export var GetPersonalizedRankingRequestFilterSensitiveLog = function (obj) { return (__assign(__assign(__assign({}, obj), (obj.context && { context: SENSITIVE_STRING })), (obj.filterValues && { filterValues: SENSITIVE_STRING }))); };
 export var PredictedItemFilterSensitiveLog = function (obj) { return (__assign({}, obj)); };
 export var GetPersonalizedRankingResponseFilterSensitiveLog = function (obj) { return (__assign({}, obj)); };
-export var GetRecommendationsRequestFilterSensitiveLog = function (obj) { return (__assign(__assign(__assign({}, obj), (obj.context && { context: SENSITIVE_STRING })), (obj.filterValues && { filterValues: SENSITIVE_STRING }))); };
+export var PromotionFilterSensitiveLog = function (obj) { return (__assign(__assign({}, obj), (obj.filterValues && { filterValues: SENSITIVE_STRING }))); };
+export var GetRecommendationsRequestFilterSensitiveLog = function (obj) { return (__assign(__assign(__assign(__assign({}, obj), (obj.context && { context: SENSITIVE_STRING })), (obj.filterValues && { filterValues: SENSITIVE_STRING })), (obj.promotions && { promotions: obj.promotions.map(function (item) { return PromotionFilterSensitiveLog(item); }) }))); };
 export var GetRecommendationsResponseFilterSensitiveLog = function (obj) { return (__assign({}, obj)); };

package/dist-es/protocols/Aws_restJson1.js

@@ -40,9 +40,9 @@ export var serializeAws_restJson1GetRecommendationsCommand = function (input, co
                     "content-type": "application/json",
                 };
                 resolvedPath = "".concat((basePath === null || basePath === void 0 ? void 0 : basePath.endsWith("/")) ? basePath.slice(0, -1) : basePath || "") + "/recommendations";
-                body = JSON.stringify(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.campaignArn != null && { campaignArn: input.campaignArn })), (input.context != null && { context: serializeAws_restJson1Context(input.context, context) })), (input.filterArn != null && { filterArn: input.filterArn })), (input.filterValues != null && {
+                body = JSON.stringify(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.campaignArn != null && { campaignArn: input.campaignArn })), (input.context != null && { context: serializeAws_restJson1Context(input.context, context) })), (input.filterArn != null && { filterArn: input.filterArn })), (input.filterValues != null && {
                     filterValues: serializeAws_restJson1FilterValues(input.filterValues, context),
-                })), (input.itemId != null && { itemId: input.itemId })), (input.numResults != null && { numResults: input.numResults })), (input.recommenderArn != null && { recommenderArn: input.recommenderArn })), (input.userId != null && { userId: input.userId })));
+                })), (input.itemId != null && { itemId: input.itemId })), (input.numResults != null && { numResults: input.numResults })), (input.promotions != null && { promotions: serializeAws_restJson1PromotionList(input.promotions, context) })), (input.recommenderArn != null && { recommenderArn: input.recommenderArn })), (input.userId != null && { userId: input.userId })));
                 return [2, new __HttpRequest({
                         protocol: protocol,
                         hostname: hostname,
@@ -233,6 +233,18 @@ var serializeAws_restJson1InputList = function (input, context) {
         return entry;
     });
 };
+var serializeAws_restJson1Promotion = function (input, context) {
+    return __assign(__assign(__assign(__assign({}, (input.filterArn != null && { filterArn: input.filterArn })), (input.filterValues != null && {
+        filterValues: serializeAws_restJson1FilterValues(input.filterValues, context),
+    })), (input.name != null && { name: input.name })), (input.percentPromotedItems != null && { percentPromotedItems: input.percentPromotedItems }));
+};
+var serializeAws_restJson1PromotionList = function (input, context) {
+    return input
+        .filter(function (e) { return e != null; })
+        .map(function (entry) {
+        return serializeAws_restJson1Promotion(entry, context);
+    });
+};
 var deserializeAws_restJson1ItemList = function (output, context) {
     var retVal = (output || [])
         .filter(function (e) { return e != null; })
@@ -247,6 +259,7 @@ var deserializeAws_restJson1ItemList = function (output, context) {
 var deserializeAws_restJson1PredictedItem = function (output, context) {
     return {
         itemId: __expectString(output.itemId),
+        promotionName: __expectString(output.promotionName),
         score: __limitedParseDouble(output.score),
     };
 };

package/dist-types/models/models_0.d.ts

@@ -56,6 +56,10 @@ export interface PredictedItem {
      *       selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>
      */
     score?: number;
+    /**
+     * <p>The name of the promotion that included the predicted item.</p>
+     */
+    promotionName?: string;
 }
 export interface GetPersonalizedRankingResponse {
     /**
@@ -89,6 +93,37 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * <p>Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
+ */
+export interface Promotion {
+    /**
+     * <p>The name of the promotion.</p>
+     */
+    name?: string;
+    /**
+     * <p>The percentage of recommended items to apply the promotion to.</p>
+     */
+    percentPromotedItems?: number;
+    /**
+     * <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>
+     */
+    filterArn?: string;
+    /**
+     * <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>
+     */
+    filterValues?: Record<string, string>;
+}
 export interface GetRecommendationsRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
@@ -130,7 +165,7 @@ export interface GetRecommendationsRequest {
      *       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>
+     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
      */
     filterValues?: Record<string, string>;
     /**
@@ -138,6 +173,11 @@ export interface GetRecommendationsRequest {
      *     created a Domain dataset group with a recommender for a domain use case.</p>
      */
     recommenderArn?: string;
+    /**
+     * <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>
+     */
+    promotions?: Promotion[];
 }
 export interface GetRecommendationsResponse {
     /**
@@ -162,6 +202,10 @@ export declare const PredictedItemFilterSensitiveLog: (obj: PredictedItem) => an
  * @internal
  */
 export declare const GetPersonalizedRankingResponseFilterSensitiveLog: (obj: GetPersonalizedRankingResponse) => any;
+/**
+ * @internal
+ */
+export declare const PromotionFilterSensitiveLog: (obj: Promotion) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/models/models_0.d.ts

@@ -20,6 +20,8 @@ export interface PredictedItem {
     itemId?: string;
     
     score?: number;
+    
+    promotionName?: string;
 }
 export interface GetPersonalizedRankingResponse {
     
@@ -41,6 +43,17 @@ export declare class ResourceNotFoundException extends __BaseException {
     
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+
+export interface Promotion {
+    
+    name?: string;
+    
+    percentPromotedItems?: number;
+    
+    filterArn?: string;
+    
+    filterValues?: Record<string, string>;
+}
 export interface GetRecommendationsRequest {
     
     campaignArn?: string;
@@ -58,6 +71,8 @@ export interface GetRecommendationsRequest {
     filterValues?: Record<string, string>;
     
     recommenderArn?: string;
+    
+    promotions?: Promotion[];
 }
 export interface GetRecommendationsResponse {
     
@@ -72,6 +87,8 @@ export declare const PredictedItemFilterSensitiveLog: (obj: PredictedItem) => an
 
 export declare const GetPersonalizedRankingResponseFilterSensitiveLog: (obj: GetPersonalizedRankingResponse) => any;
 
+export declare const PromotionFilterSensitiveLog: (obj: Promotion) => any;
+
 export declare const GetRecommendationsRequestFilterSensitiveLog: (obj: GetRecommendationsRequest) => any;
 
 export declare const GetRecommendationsResponseFilterSensitiveLog: (obj: GetRecommendationsResponse) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-personalize-runtime",
   "description": "AWS SDK for JavaScript Personalize Runtime Client for Node.js, Browser and React Native",
-  "version": "3.142.0",
+  "version": "3.150.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.142.0",
+    "@aws-sdk/client-sts": "3.150.0",
     "@aws-sdk/config-resolver": "3.130.0",
-    "@aws-sdk/credential-provider-node": "3.142.0",
+    "@aws-sdk/credential-provider-node": "3.150.0",
     "@aws-sdk/fetch-http-handler": "3.131.0",
     "@aws-sdk/hash-node": "3.127.0",
     "@aws-sdk/invalid-dependency": "3.127.0",
@@ -61,6 +61,11 @@
     "typedoc": "0.19.2",
     "typescript": "~4.6.2"
   },
+  "overrides": {
+    "typedoc": {
+      "typescript": "~4.6.2"
+    }
+  },
   "engines": {
     "node": ">=12.0.0"
   },