@aws-sdk/client-personalize-runtime 3.42.0 → 3.43.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.43.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.42.0...v3.43.0) (2021-11-29)
+
+
+### Features
+
+* **clients:** update clients as of 11/28/2021 ([#3072](https://github.com/aws/aws-sdk-js-v3/issues/3072)) ([2ad1622](https://github.com/aws/aws-sdk-js-v3/commit/2ad1622ba8586b926fe508055211803bb29e3976))
+
+
+
+
+
 # [3.42.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.41.0...v3.42.0) (2021-11-19)
 
 **Note:** Version bump only for package @aws-sdk/client-personalize-runtime

package/dist-cjs/protocols/Aws_restJson1.js

@@ -48,6 +48,8 @@ const serializeAws_restJson1GetRecommendationsCommand = async (input, context) =
             input.filterValues !== null && { filterValues: serializeAws_restJson1FilterValues(input.filterValues, context) }),
         ...(input.itemId !== undefined && input.itemId !== null && { itemId: input.itemId }),
         ...(input.numResults !== undefined && input.numResults !== null && { numResults: input.numResults }),
+        ...(input.recommenderArn !== undefined &&
+            input.recommenderArn !== null && { recommenderArn: input.recommenderArn }),
         ...(input.userId !== undefined && input.userId !== null && { userId: input.userId }),
     });
     return new protocol_http_1.HttpRequest({

package/dist-es/protocols/Aws_restJson1.js

@@ -39,9 +39,10 @@ export var serializeAws_restJson1GetRecommendationsCommand = function (input, co
                     "content-type": "application/json",
                 };
                 resolvedPath = "" + ((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({}, (input.campaignArn !== undefined && input.campaignArn !== null && { campaignArn: input.campaignArn })), (input.context !== undefined &&
+                body = JSON.stringify(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.campaignArn !== undefined && input.campaignArn !== null && { campaignArn: input.campaignArn })), (input.context !== undefined &&
                     input.context !== null && { context: serializeAws_restJson1Context(input.context, context) })), (input.filterArn !== undefined && input.filterArn !== null && { filterArn: input.filterArn })), (input.filterValues !== undefined &&
-                    input.filterValues !== null && { filterValues: serializeAws_restJson1FilterValues(input.filterValues, context) })), (input.itemId !== undefined && input.itemId !== null && { itemId: input.itemId })), (input.numResults !== undefined && input.numResults !== null && { numResults: input.numResults })), (input.userId !== undefined && input.userId !== null && { userId: input.userId })));
+                    input.filterValues !== null && { filterValues: serializeAws_restJson1FilterValues(input.filterValues, context) })), (input.itemId !== undefined && input.itemId !== null && { itemId: input.itemId })), (input.numResults !== undefined && input.numResults !== null && { numResults: input.numResults })), (input.recommenderArn !== undefined &&
+                    input.recommenderArn !== null && { recommenderArn: input.recommenderArn })), (input.userId !== undefined && input.userId !== null && { userId: input.userId })));
                 return [2, new __HttpRequest({
                         protocol: protocol,
                         hostname: hostname,

package/dist-types/PersonalizeRuntime.d.ts

@@ -18,21 +18,24 @@ export declare class PersonalizeRuntime extends PersonalizeRuntimeClient {
     getPersonalizedRanking(args: GetPersonalizedRankingCommandInput, cb: (err: any, data?: GetPersonalizedRankingCommandOutput) => void): void;
     getPersonalizedRanking(args: GetPersonalizedRankingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonalizedRankingCommandOutput) => void): void;
     /**
-     * <p>Returns a list of recommended items. The required input depends on the recipe type used to
-     *       create the solution backing the campaign, as follows:</p>
+     * <p>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:</p>
      *          <ul>
      *             <li>
-     *                <p>RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used</p>
+     *                <p>USER_PERSONALIZATION - <code>userId</code> required, <code>itemId</code> not used</p>
      *             </li>
      *             <li>
-     *                <p>USER_PERSONALIZATION - <code>itemId</code> optional, <code>userId</code>
-     *           required</p>
+     *                <p>RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used</p>
      *             </li>
      *          </ul>
      *          <note>
      *             <p>Campaigns that are backed by a solution created using a recipe of type
      *         PERSONALIZED_RANKING use the  API.</p>
      *          </note>
+     *          <p>
+     *       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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.
+     *     </p>
      */
     getRecommendations(args: GetRecommendationsCommandInput, options?: __HttpHandlerOptions): Promise<GetRecommendationsCommandOutput>;
     getRecommendations(args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void): void;

package/dist-types/commands/GetRecommendationsCommand.d.ts

@@ -7,21 +7,24 @@ export interface GetRecommendationsCommandInput extends GetRecommendationsReques
 export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {
 }
 /**
- * <p>Returns a list of recommended items. The required input depends on the recipe type used to
- *       create the solution backing the campaign, as follows:</p>
+ * <p>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:</p>
  *          <ul>
  *             <li>
- *                <p>RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used</p>
+ *                <p>USER_PERSONALIZATION - <code>userId</code> required, <code>itemId</code> not used</p>
  *             </li>
  *             <li>
- *                <p>USER_PERSONALIZATION - <code>itemId</code> optional, <code>userId</code>
- *           required</p>
+ *                <p>RELATED_ITEMS - <code>itemId</code> required, <code>userId</code> not used</p>
  *             </li>
  *          </ul>
  *          <note>
  *             <p>Campaigns that are backed by a solution created using a recipe of type
  *         PERSONALIZED_RANKING use the  API.</p>
  *          </note>
+ *          <p>
+ *       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 <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -120,7 +120,7 @@ export interface GetRecommendationsRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
      */
-    campaignArn: string | undefined;
+    campaignArn?: string;
     /**
      * <p>The item ID to provide recommendations for.</p>
      *          <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
@@ -164,6 +164,11 @@ export interface GetRecommendationsRequest {
     filterValues?: {
         [key: string]: string;
     };
+    /**
+     * <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>
+     */
+    recommenderArn?: string;
 }
 export declare namespace GetRecommendationsRequest {
     /**
@@ -173,7 +178,7 @@ export declare namespace GetRecommendationsRequest {
 }
 export interface GetRecommendationsResponse {
     /**
-     * <p>A list of recommendations sorted in ascending order by prediction score. There can be a
+     * <p>A list of recommendations sorted in descending order by prediction score. There can be a
      *       maximum of 500 items in the list.</p>
      */
     itemList?: PredictedItem[];

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

@@ -64,7 +64,7 @@ export declare namespace ResourceNotFoundException {
 }
 export interface GetRecommendationsRequest {
     
-    campaignArn: string | undefined;
+    campaignArn?: string;
     
     itemId?: string;
     
@@ -81,6 +81,8 @@ export interface GetRecommendationsRequest {
     filterValues?: {
         [key: string]: string;
     };
+    
+    recommenderArn?: string;
 }
 export declare namespace GetRecommendationsRequest {
     

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.42.0",
+  "version": "3.43.0",
   "scripts": {
     "build": "yarn build:cjs && yarn build:es && yarn build:types",
     "build:cjs": "tsc -p tsconfig.json",
@@ -21,7 +21,7 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.42.0",
+    "@aws-sdk/client-sts": "3.43.0",
     "@aws-sdk/config-resolver": "3.40.0",
     "@aws-sdk/credential-provider-node": "3.41.0",
     "@aws-sdk/fetch-http-handler": "3.40.0",