@aws-sdk/client-personalize-runtime 3.41.0 → 3.46.0

package/CHANGELOG.md

@@ -3,6 +3,53 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.46.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.45.0...v3.46.0) (2022-01-07)
+
+
+### Bug Fixes
+
+* **clients:** update clean:dist script to delete dist-* folder ([#3155](https://github.com/aws/aws-sdk-js-v3/issues/3155)) ([cdb1709](https://github.com/aws/aws-sdk-js-v3/commit/cdb17090f82d1fc8755811c82cbed5976ec7e60b))
+
+
+### Features
+
+* **clients:** extend typedoc.json from root ([#3136](https://github.com/aws/aws-sdk-js-v3/issues/3136)) ([f6a3ef5](https://github.com/aws/aws-sdk-js-v3/commit/f6a3ef541ae2d92872d09d8cab6727911287ebb2))
+* end support for Node.js 10.x ([#3122](https://github.com/aws/aws-sdk-js-v3/issues/3122)) ([7acf18a](https://github.com/aws/aws-sdk-js-v3/commit/7acf18abd3fb1cc461f809110cdb0d7968c2070e))
+
+
+
+
+
+# [3.45.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.44.0...v3.45.0) (2021-12-23)
+
+
+### Features
+
+* **clients:** update clients as of 2021/12/23 ([#3110](https://github.com/aws/aws-sdk-js-v3/issues/3110)) ([5d638e1](https://github.com/aws/aws-sdk-js-v3/commit/5d638e188ce64fa80fe36b8cba79ba63b80b50b7))
+
+
+
+
+
+# [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
+
+
+
+
+
 # [3.41.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.40.1...v3.41.0) (2021-11-11)
 
 

package/dist-cjs/endpoints.js

@@ -14,6 +14,7 @@ const partitionHash = {
             "ap-south-1",
             "ap-southeast-1",
             "ap-southeast-2",
+            "ap-southeast-3",
             "ca-central-1",
             "eu-central-1",
             "eu-north-1",

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-cjs/runtimeConfig.js

@@ -15,10 +15,8 @@ const util_body_length_node_1 = require("@aws-sdk/util-body-length-node");
 const util_user_agent_node_1 = require("@aws-sdk/util-user-agent-node");
 const util_utf8_node_1 = require("@aws-sdk/util-utf8-node");
 const runtimeConfig_shared_1 = require("./runtimeConfig.shared");
-const smithy_client_1 = require("@aws-sdk/smithy-client");
 const getRuntimeConfig = (config) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
-    smithy_client_1.emitWarningIfUnsupportedVersion(process.version);
     const clientSharedValues = runtimeConfig_shared_1.getRuntimeConfig(config);
     return {
         ...clientSharedValues,

package/dist-es/endpoints.js

@@ -12,6 +12,7 @@ var partitionHash = {
             "ap-south-1",
             "ap-southeast-1",
             "ap-southeast-2",
+            "ap-southeast-3",
             "ca-central-1",
             "eu-central-1",
             "eu-north-1",

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-es/runtimeConfig.js

@@ -12,10 +12,8 @@ import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
 import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
 import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
 import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
-import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
 export var getRuntimeConfig = function (config) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
-    emitWarningIfUnsupportedVersion(process.version);
     var clientSharedValues = getSharedRuntimeConfig(config);
     return __assign(__assign(__assign({}, clientSharedValues), config), { runtime: "node", base64Decoder: (_a = config === null || config === void 0 ? void 0 : config.base64Decoder) !== null && _a !== void 0 ? _a : fromBase64, base64Encoder: (_b = config === null || config === void 0 ? void 0 : config.base64Encoder) !== null && _b !== void 0 ? _b : toBase64, bodyLengthChecker: (_c = config === null || config === void 0 ? void 0 : config.bodyLengthChecker) !== null && _c !== void 0 ? _c : calculateBodyLength, credentialDefaultProvider: (_d = config === null || config === void 0 ? void 0 : config.credentialDefaultProvider) !== null && _d !== void 0 ? _d : decorateDefaultCredentialProvider(credentialDefaultProvider), defaultUserAgentProvider: (_e = config === null || config === void 0 ? void 0 : config.defaultUserAgentProvider) !== null && _e !== void 0 ? _e : defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }), maxAttempts: (_f = config === null || config === void 0 ? void 0 : config.maxAttempts) !== null && _f !== void 0 ? _f : loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS), region: (_g = config === null || config === void 0 ? void 0 : config.region) !== null && _g !== void 0 ? _g : loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS), requestHandler: (_h = config === null || config === void 0 ? void 0 : config.requestHandler) !== null && _h !== void 0 ? _h : new NodeHttpHandler(), retryMode: (_j = config === null || config === void 0 ? void 0 : config.retryMode) !== null && _j !== void 0 ? _j : loadNodeConfig(NODE_RETRY_MODE_CONFIG_OPTIONS), sha256: (_k = config === null || config === void 0 ? void 0 : config.sha256) !== null && _k !== void 0 ? _k : Hash.bind(null, "sha256"), streamCollector: (_l = config === null || config === void 0 ? void 0 : config.streamCollector) !== null && _l !== void 0 ? _l : streamCollector, useDualstackEndpoint: (_m = config === null || config === void 0 ? void 0 : config.useDualstackEndpoint) !== null && _m !== void 0 ? _m : loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS), useFipsEndpoint: (_o = config === null || config === void 0 ? void 0 : config.useFipsEndpoint) !== null && _o !== void 0 ? _o : loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS), utf8Decoder: (_p = config === null || config === void 0 ? void 0 : config.utf8Decoder) !== null && _p !== void 0 ? _p : fromUtf8, utf8Encoder: (_q = config === null || config === void 0 ? void 0 : config.utf8Encoder) !== null && _q !== void 0 ? _q : toUtf8 });
 };

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,18 +1,17 @@
 {
   "name": "@aws-sdk/client-personalize-runtime",
   "description": "AWS SDK for JavaScript Personalize Runtime Client for Node.js, Browser and React Native",
-  "version": "3.41.0",
+  "version": "3.46.0",
   "scripts": {
     "build": "yarn build:cjs && yarn build:es && yarn build:types",
     "build:cjs": "tsc -p tsconfig.json",
-    "build:docs": "yarn clean:docs && typedoc ./",
+    "build:docs": "typedoc",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "yarn clean:dist && yarn clean:docs",
-    "clean:dist": "rimraf ./dist",
-    "clean:docs": "rimraf ./docs",
-    "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4",
-    "test": "exit 0"
+    "clean:dist": "rimraf ./dist-*",
+    "clean:docs": "rimraf ./docs"
   },
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
@@ -21,48 +20,42 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.41.0",
-    "@aws-sdk/config-resolver": "3.40.0",
-    "@aws-sdk/credential-provider-node": "3.41.0",
-    "@aws-sdk/fetch-http-handler": "3.40.0",
-    "@aws-sdk/hash-node": "3.40.0",
-    "@aws-sdk/invalid-dependency": "3.40.0",
-    "@aws-sdk/middleware-content-length": "3.40.0",
-    "@aws-sdk/middleware-host-header": "3.40.0",
-    "@aws-sdk/middleware-logger": "3.40.0",
-    "@aws-sdk/middleware-retry": "3.40.0",
-    "@aws-sdk/middleware-serde": "3.40.0",
-    "@aws-sdk/middleware-signing": "3.40.0",
-    "@aws-sdk/middleware-stack": "3.40.0",
-    "@aws-sdk/middleware-user-agent": "3.40.0",
-    "@aws-sdk/node-config-provider": "3.40.0",
-    "@aws-sdk/node-http-handler": "3.40.0",
-    "@aws-sdk/protocol-http": "3.40.0",
-    "@aws-sdk/smithy-client": "3.41.0",
-    "@aws-sdk/types": "3.40.0",
-    "@aws-sdk/url-parser": "3.40.0",
-    "@aws-sdk/util-base64-browser": "3.37.0",
-    "@aws-sdk/util-base64-node": "3.37.0",
-    "@aws-sdk/util-body-length-browser": "3.37.0",
-    "@aws-sdk/util-body-length-node": "3.37.0",
-    "@aws-sdk/util-user-agent-browser": "3.40.0",
-    "@aws-sdk/util-user-agent-node": "3.40.0",
-    "@aws-sdk/util-utf8-browser": "3.37.0",
-    "@aws-sdk/util-utf8-node": "3.37.0",
+    "@aws-sdk/client-sts": "3.46.0",
+    "@aws-sdk/config-resolver": "3.46.0",
+    "@aws-sdk/credential-provider-node": "3.46.0",
+    "@aws-sdk/fetch-http-handler": "3.46.0",
+    "@aws-sdk/hash-node": "3.46.0",
+    "@aws-sdk/invalid-dependency": "3.46.0",
+    "@aws-sdk/middleware-content-length": "3.46.0",
+    "@aws-sdk/middleware-host-header": "3.46.0",
+    "@aws-sdk/middleware-logger": "3.46.0",
+    "@aws-sdk/middleware-retry": "3.46.0",
+    "@aws-sdk/middleware-serde": "3.46.0",
+    "@aws-sdk/middleware-signing": "3.46.0",
+    "@aws-sdk/middleware-stack": "3.46.0",
+    "@aws-sdk/middleware-user-agent": "3.46.0",
+    "@aws-sdk/node-config-provider": "3.46.0",
+    "@aws-sdk/node-http-handler": "3.46.0",
+    "@aws-sdk/protocol-http": "3.46.0",
+    "@aws-sdk/smithy-client": "3.46.0",
+    "@aws-sdk/types": "3.46.0",
+    "@aws-sdk/url-parser": "3.46.0",
+    "@aws-sdk/util-base64-browser": "3.46.0",
+    "@aws-sdk/util-base64-node": "3.46.0",
+    "@aws-sdk/util-body-length-browser": "3.46.0",
+    "@aws-sdk/util-body-length-node": "3.46.0",
+    "@aws-sdk/util-user-agent-browser": "3.46.0",
+    "@aws-sdk/util-user-agent-node": "3.46.0",
+    "@aws-sdk/util-utf8-browser": "3.46.0",
+    "@aws-sdk/util-utf8-node": "3.46.0",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@aws-sdk/service-client-documentation-generator": "3.38.0",
-    "@types/node": "^12.7.5",
-    "downlevel-dts": "0.7.0",
-    "jest": "^26.1.0",
-    "rimraf": "^3.0.0",
-    "ts-jest": "^26.4.1",
-    "typedoc": "^0.19.2",
-    "typescript": "~4.3.5"
+    "@aws-sdk/service-client-documentation-generator": "3.46.0",
+    "@types/node": "^12.7.5"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   },
   "typesVersions": {
     "<4.0": {