@aws-sdk/client-personalize-runtime 3.296.0 → 3.298.0

package/dist-cjs/commands/GetPersonalizedRankingCommand.js

@@ -31,7 +31,7 @@ class GetPersonalizedRankingCommand extends smithy_client_1.Command {
             clientName,
             commandName,
             inputFilterSensitiveLog: models_0_1.GetPersonalizedRankingRequestFilterSensitiveLog,
-            outputFilterSensitiveLog: models_0_1.GetPersonalizedRankingResponseFilterSensitiveLog,
+            outputFilterSensitiveLog: (_) => _,
         };
         const { requestHandler } = configuration;
         return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);

package/dist-cjs/commands/GetRecommendationsCommand.js

@@ -31,7 +31,7 @@ class GetRecommendationsCommand extends smithy_client_1.Command {
             clientName,
             commandName,
             inputFilterSensitiveLog: models_0_1.GetRecommendationsRequestFilterSensitiveLog,
-            outputFilterSensitiveLog: models_0_1.GetRecommendationsResponseFilterSensitiveLog,
+            outputFilterSensitiveLog: (_) => _,
         };
         const { requestHandler } = configuration;
         return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetRecommendationsResponseFilterSensitiveLog = exports.GetRecommendationsRequestFilterSensitiveLog = exports.PromotionFilterSensitiveLog = exports.GetPersonalizedRankingResponseFilterSensitiveLog = exports.PredictedItemFilterSensitiveLog = exports.GetPersonalizedRankingRequestFilterSensitiveLog = exports.ResourceNotFoundException = exports.InvalidInputException = void 0;
+exports.GetRecommendationsRequestFilterSensitiveLog = exports.PromotionFilterSensitiveLog = 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 {
@@ -35,14 +35,6 @@ const GetPersonalizedRankingRequestFilterSensitiveLog = (obj) => ({
     ...(obj.filterValues && { filterValues: smithy_client_1.SENSITIVE_STRING }),
 });
 exports.GetPersonalizedRankingRequestFilterSensitiveLog = GetPersonalizedRankingRequestFilterSensitiveLog;
-const PredictedItemFilterSensitiveLog = (obj) => ({
-    ...obj,
-});
-exports.PredictedItemFilterSensitiveLog = PredictedItemFilterSensitiveLog;
-const GetPersonalizedRankingResponseFilterSensitiveLog = (obj) => ({
-    ...obj,
-});
-exports.GetPersonalizedRankingResponseFilterSensitiveLog = GetPersonalizedRankingResponseFilterSensitiveLog;
 const PromotionFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.filterValues && { filterValues: smithy_client_1.SENSITIVE_STRING }),
@@ -55,7 +47,3 @@ const GetRecommendationsRequestFilterSensitiveLog = (obj) => ({
     ...(obj.promotions && { promotions: obj.promotions.map((item) => (0, exports.PromotionFilterSensitiveLog)(item)) }),
 });
 exports.GetRecommendationsRequestFilterSensitiveLog = GetRecommendationsRequestFilterSensitiveLog;
-const GetRecommendationsResponseFilterSensitiveLog = (obj) => ({
-    ...obj,
-});
-exports.GetRecommendationsResponseFilterSensitiveLog = GetRecommendationsResponseFilterSensitiveLog;

package/dist-es/commands/GetPersonalizedRankingCommand.js

@@ -1,7 +1,7 @@
 import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
 import { getSerdePlugin } from "@aws-sdk/middleware-serde";
 import { Command as $Command } from "@aws-sdk/smithy-client";
-import { GetPersonalizedRankingRequestFilterSensitiveLog, GetPersonalizedRankingResponseFilterSensitiveLog, } from "../models/models_0";
+import { GetPersonalizedRankingRequestFilterSensitiveLog, } from "../models/models_0";
 import { deserializeAws_restJson1GetPersonalizedRankingCommand, serializeAws_restJson1GetPersonalizedRankingCommand, } from "../protocols/Aws_restJson1";
 export class GetPersonalizedRankingCommand extends $Command {
     static getEndpointParameterInstructions() {
@@ -28,7 +28,7 @@ export class GetPersonalizedRankingCommand extends $Command {
             clientName,
             commandName,
             inputFilterSensitiveLog: GetPersonalizedRankingRequestFilterSensitiveLog,
-            outputFilterSensitiveLog: GetPersonalizedRankingResponseFilterSensitiveLog,
+            outputFilterSensitiveLog: (_) => _,
         };
         const { requestHandler } = configuration;
         return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);

package/dist-es/commands/GetRecommendationsCommand.js

@@ -1,7 +1,7 @@
 import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
 import { getSerdePlugin } from "@aws-sdk/middleware-serde";
 import { Command as $Command } from "@aws-sdk/smithy-client";
-import { GetRecommendationsRequestFilterSensitiveLog, GetRecommendationsResponseFilterSensitiveLog, } from "../models/models_0";
+import { GetRecommendationsRequestFilterSensitiveLog, } from "../models/models_0";
 import { deserializeAws_restJson1GetRecommendationsCommand, serializeAws_restJson1GetRecommendationsCommand, } from "../protocols/Aws_restJson1";
 export class GetRecommendationsCommand extends $Command {
     static getEndpointParameterInstructions() {
@@ -28,7 +28,7 @@ export class GetRecommendationsCommand extends $Command {
             clientName,
             commandName,
             inputFilterSensitiveLog: GetRecommendationsRequestFilterSensitiveLog,
-            outputFilterSensitiveLog: GetRecommendationsResponseFilterSensitiveLog,
+            outputFilterSensitiveLog: (_) => _,
         };
         const { requestHandler } = configuration;
         return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);

package/dist-es/models/models_0.js

@@ -29,12 +29,6 @@ export const GetPersonalizedRankingRequestFilterSensitiveLog = (obj) => ({
     ...(obj.context && { context: SENSITIVE_STRING }),
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
 });
-export const PredictedItemFilterSensitiveLog = (obj) => ({
-    ...obj,
-});
-export const GetPersonalizedRankingResponseFilterSensitiveLog = (obj) => ({
-    ...obj,
-});
 export const PromotionFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
@@ -45,6 +39,3 @@ export const GetRecommendationsRequestFilterSensitiveLog = (obj) => ({
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
     ...(obj.promotions && { promotions: obj.promotions.map((item) => PromotionFilterSensitiveLog(item)) }),
 });
-export const GetRecommendationsResponseFilterSensitiveLog = (obj) => ({
-    ...obj,
-});

package/dist-types/PersonalizeRuntime.d.ts

@@ -3,10 +3,12 @@ import { GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput
 import { GetRecommendationsCommandInput, GetRecommendationsCommandOutput } from "./commands/GetRecommendationsCommand";
 import { PersonalizeRuntimeClient } from "./PersonalizeRuntimeClient";
 /**
+ * @public
  * <p></p>
  */
 export declare class PersonalizeRuntime extends PersonalizeRuntimeClient {
     /**
+     * @public
      * <p>Re-ranks a list of recommended items for the given user. The first item in the list is
      *       deemed the most likely item to be of interest to the user.</p>
      *          <note>
@@ -18,6 +20,7 @@ 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;
     /**
+     * @public
      * <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>

package/dist-types/PersonalizeRuntimeClient.d.ts

@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
 import { GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput } from "./commands/GetPersonalizedRankingCommand";
 import { GetRecommendationsCommandInput, GetRecommendationsCommandOutput } from "./commands/GetRecommendationsCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GetPersonalizedRankingCommandInput | GetRecommendationsCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GetPersonalizedRankingCommandOutput | GetRecommendationsCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -108,23 +117,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type PersonalizeRuntimeClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of PersonalizeRuntimeClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of PersonalizeRuntimeClient class constructor that set the region, credentials and other options.
  */
 export interface PersonalizeRuntimeClientConfig extends PersonalizeRuntimeClientConfigType {
 }
+/**
+ * @public
+ */
 type PersonalizeRuntimeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of PersonalizeRuntimeClient class. This is resolved and normalized from the {@link PersonalizeRuntimeClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of PersonalizeRuntimeClient class. This is resolved and normalized from the {@link PersonalizeRuntimeClientConfig | constructor configuration interface}.
  */
 export interface PersonalizeRuntimeClientResolvedConfig extends PersonalizeRuntimeClientResolvedConfigType {
 }
 /**
+ * @public
  * <p></p>
  */
 export declare class PersonalizeRuntimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeRuntimeClientResolvedConfig> {

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetPersonalizedRankingRequest, GetPersonalizedRankingResponse } from "../models/models_0";
 import { PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeRuntimeClient";
 /**
+ * @public
+ *
  * The input for {@link GetPersonalizedRankingCommand}.
  */
 export interface GetPersonalizedRankingCommandInput extends GetPersonalizedRankingRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetPersonalizedRankingCommand}.
  */
 export interface GetPersonalizedRankingCommandOutput extends GetPersonalizedRankingResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Re-ranks a list of recommended items for the given user. The first item in the list is
  *       deemed the most likely item to be of interest to the user.</p>
  *          <note>
@@ -30,6 +35,8 @@ export interface GetPersonalizedRankingCommandOutput extends GetPersonalizedRank
  * const response = await client.send(command);
  * ```
  *
+ * @param GetPersonalizedRankingCommandInput - {@link GetPersonalizedRankingCommandInput}
+ * @returns {@link GetPersonalizedRankingCommandOutput}
  * @see {@link GetPersonalizedRankingCommandInput} for command's `input` shape.
  * @see {@link GetPersonalizedRankingCommandOutput} for command's `response` shape.
  * @see {@link PersonalizeRuntimeClientResolvedConfig | config} for PersonalizeRuntimeClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetPersonalizedRankingCommandOutput extends GetPersonalizedRank
 export declare class GetPersonalizedRankingCommand extends $Command<GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput, PersonalizeRuntimeClientResolvedConfig> {
     readonly input: GetPersonalizedRankingCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetPersonalizedRankingCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeRuntimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { GetRecommendationsRequest, GetRecommendationsResponse } from "../models/models_0";
 import { PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PersonalizeRuntimeClient";
 /**
+ * @public
+ *
  * The input for {@link GetRecommendationsCommand}.
  */
 export interface GetRecommendationsCommandInput extends GetRecommendationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetRecommendationsCommand}.
  */
 export interface GetRecommendationsCommandOutput extends GetRecommendationsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -42,6 +47,8 @@ export interface GetRecommendationsCommandOutput extends GetRecommendationsRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param GetRecommendationsCommandInput - {@link GetRecommendationsCommandInput}
+ * @returns {@link GetRecommendationsCommandOutput}
  * @see {@link GetRecommendationsCommandInput} for command's `input` shape.
  * @see {@link GetRecommendationsCommandOutput} for command's `response` shape.
  * @see {@link PersonalizeRuntimeClientResolvedConfig | config} for PersonalizeRuntimeClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetRecommendationsCommandOutput extends GetRecommendationsRespo
 export declare class GetRecommendationsCommand extends $Command<GetRecommendationsCommandInput, GetRecommendationsCommandOutput, PersonalizeRuntimeClientResolvedConfig> {
     readonly input: GetRecommendationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetRecommendationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PersonalizeRuntimeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetRecommendationsCommandInput, GetRecommendationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from PersonalizeRuntime service.
  */
 export declare class PersonalizeRuntimeServiceException extends __ServiceException {

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { PersonalizeRuntimeServiceException as __BaseException } from "./PersonalizeRuntimeServiceException";
+/**
+ * @public
+ */
 export interface GetPersonalizedRankingRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized
@@ -42,6 +45,7 @@ export interface GetPersonalizedRankingRequest {
     filterValues?: Record<string, string>;
 }
 /**
+ * @public
  * <p>An object that identifies an item.</p>
  *          <p>The  and  APIs return a list of
  *       <code>PredictedItem</code>s.</p>
@@ -61,6 +65,9 @@ export interface PredictedItem {
      */
     promotionName?: string;
 }
+/**
+ * @public
+ */
 export interface GetPersonalizedRankingResponse {
     /**
      * <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
@@ -72,6 +79,7 @@ export interface GetPersonalizedRankingResponse {
     recommendationId?: string;
 }
 /**
+ * @public
  * <p>Provide a valid value for the field or parameter.</p>
  */
 export declare class InvalidInputException extends __BaseException {
@@ -83,6 +91,7 @@ export declare class InvalidInputException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified resource does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -94,6 +103,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <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 {
@@ -124,6 +134,9 @@ export interface Promotion {
      */
     filterValues?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetRecommendationsRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
@@ -179,6 +192,9 @@ export interface GetRecommendationsRequest {
      */
     promotions?: Promotion[];
 }
+/**
+ * @public
+ */
 export interface GetRecommendationsResponse {
     /**
      * <p>A list of recommendations sorted in descending order by prediction score. There can be a
@@ -194,14 +210,6 @@ export interface GetRecommendationsResponse {
  * @internal
  */
 export declare const GetPersonalizedRankingRequestFilterSensitiveLog: (obj: GetPersonalizedRankingRequest) => any;
-/**
- * @internal
- */
-export declare const PredictedItemFilterSensitiveLog: (obj: PredictedItem) => any;
-/**
- * @internal
- */
-export declare const GetPersonalizedRankingResponseFilterSensitiveLog: (obj: GetPersonalizedRankingResponse) => any;
 /**
  * @internal
  */
@@ -210,7 +218,3 @@ export declare const PromotionFilterSensitiveLog: (obj: Promotion) => any;
  * @internal
  */
 export declare const GetRecommendationsRequestFilterSensitiveLog: (obj: GetRecommendationsRequest) => any;
-/**
- * @internal
- */
-export declare const GetRecommendationsResponseFilterSensitiveLog: (obj: GetRecommendationsResponse) => any;

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

@@ -55,16 +55,7 @@ export interface GetRecommendationsResponse {
 export declare const GetPersonalizedRankingRequestFilterSensitiveLog: (
   obj: GetPersonalizedRankingRequest
 ) => any;
-export declare const PredictedItemFilterSensitiveLog: (
-  obj: PredictedItem
-) => any;
-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.296.0",
+  "version": "3.298.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+    "extract:docs": "api-extractor run --local",
     "generate:client": "node ../../scripts/generate-clients/single-service --solo personalize-runtime"
   },
   "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.298.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.298.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",