@aws-sdk/client-personalize-runtime 3.687.0 → 3.692.0

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

@@ -11,12 +11,12 @@ export interface PredictedAction {
      * <p>The ID of the recommended action.</p>
      * @public
      */
-    actionId?: string;
+    actionId?: string | undefined;
     /**
      * <p>The score of the recommended action. For information about action scores, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html">How action recommendation scoring works</a>.</p>
      * @public
      */
-    score?: number;
+    score?: number | undefined;
 }
 /**
  * @public
@@ -26,24 +26,24 @@ export interface GetActionRecommendationsRequest {
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.</p>
      * @public
      */
-    campaignArn?: string;
+    campaignArn?: string | undefined;
     /**
      * <p>The user ID of the user to provide action recommendations for.</p>
      * @public
      */
-    userId?: string;
+    userId?: string | undefined;
     /**
      * <p>The number of results to return. The default is 5. The maximum is 100.</p>
      * @public
      */
-    numResults?: number;
+    numResults?: number | undefined;
     /**
      * <p>The ARN of the filter to apply to the returned recommendations. For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      *          <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
      * @public
      */
-    filterArn?: string;
+    filterArn?: string | undefined;
     /**
      * <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.
@@ -57,7 +57,7 @@ export interface GetActionRecommendationsRequest {
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
      * @public
      */
-    filterValues?: Record<string, string>;
+    filterValues?: Record<string, string> | undefined;
 }
 /**
  * @public
@@ -69,12 +69,12 @@ export interface GetActionRecommendationsResponse {
      *       works</a>.</p>
      * @public
      */
-    actionList?: PredictedAction[];
+    actionList?: PredictedAction[] | undefined;
     /**
      * <p>The ID of the recommendation.</p>
      * @public
      */
-    recommendationId?: string;
+    recommendationId?: string | undefined;
 }
 /**
  * <p>Provide a valid value for the field or parameter.</p>
@@ -128,14 +128,14 @@ export interface GetPersonalizedRankingRequest {
      *       as the user's current location or device type.</p>
      * @public
      */
-    context?: Record<string, string>;
+    context?: Record<string, string> | undefined;
     /**
      * <p>The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
      *       For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      * @public
      */
-    filterArn?: string;
+    filterArn?: string | undefined;
     /**
      * <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.
@@ -149,7 +149,7 @@ export interface GetPersonalizedRankingRequest {
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      * @public
      */
-    filterValues?: Record<string, string>;
+    filterValues?: Record<string, string> | undefined;
     /**
      * <p>If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include
      *       in the personalized ranking.
@@ -160,7 +160,7 @@ export interface GetPersonalizedRankingRequest {
      *     </p>
      * @public
      */
-    metadataColumns?: Record<string, string[]>;
+    metadataColumns?: Record<string, string[]> | undefined;
 }
 /**
  * <p>An object that identifies an item.</p>
@@ -173,23 +173,23 @@ export interface PredictedItem {
      * <p>The recommended item ID.</p>
      * @public
      */
-    itemId?: string;
+    itemId?: string | undefined;
     /**
      * <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>
      * @public
      */
-    score?: number;
+    score?: number | undefined;
     /**
      * <p>The name of the promotion that included the predicted item.</p>
      * @public
      */
-    promotionName?: string;
+    promotionName?: string | undefined;
     /**
      * <p>Metadata about the item from your Items dataset.</p>
      * @public
      */
-    metadata?: Record<string, string>;
+    metadata?: Record<string, string> | undefined;
     /**
      * <p>If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:</p>
      *          <ul>
@@ -214,7 +214,7 @@ export interface PredictedItem {
      *          </ul>
      * @public
      */
-    reason?: string[];
+    reason?: string[] | undefined;
 }
 /**
  * @public
@@ -224,12 +224,12 @@ export interface GetPersonalizedRankingResponse {
      * <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
      * @public
      */
-    personalizedRanking?: PredictedItem[];
+    personalizedRanking?: PredictedItem[] | undefined;
     /**
      * <p>The ID of the recommendation.</p>
      * @public
      */
-    recommendationId?: string;
+    recommendationId?: string | undefined;
 }
 /**
  * <p>Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
@@ -240,18 +240,18 @@ export interface Promotion {
      * <p>The name of the promotion.</p>
      * @public
      */
-    name?: string;
+    name?: string | undefined;
     /**
      * <p>The percentage of recommended items to apply the promotion to.</p>
      * @public
      */
-    percentPromotedItems?: number;
+    percentPromotedItems?: number | undefined;
     /**
      * <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>
      * @public
      */
-    filterArn?: string;
+    filterArn?: string | undefined;
     /**
      * <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.
@@ -265,7 +265,7 @@ export interface Promotion {
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
      * @public
      */
-    filterValues?: Record<string, string>;
+    filterValues?: Record<string, string> | undefined;
 }
 /**
  * @public
@@ -275,39 +275,39 @@ export interface GetRecommendationsRequest {
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
      * @public
      */
-    campaignArn?: string;
+    campaignArn?: string | undefined;
     /**
      * <p>The item ID to provide recommendations for.</p>
      *          <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
      * @public
      */
-    itemId?: string;
+    itemId?: string | undefined;
     /**
      * <p>The user ID to provide recommendations for.</p>
      *          <p>Required for <code>USER_PERSONALIZATION</code> recipe type.</p>
      * @public
      */
-    userId?: string;
+    userId?: string | undefined;
     /**
      * <p>The number of results to return. The default is 25. If you are including
      *       metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.</p>
      * @public
      */
-    numResults?: number;
+    numResults?: number | undefined;
     /**
      * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
      *       any interaction information that might be relevant when getting a user's recommendations, such
      *       as the user's current location or device type.</p>
      * @public
      */
-    context?: Record<string, string>;
+    context?: Record<string, string> | undefined;
     /**
      * <p>The ARN of the filter to apply to the returned recommendations. For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      *          <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
      * @public
      */
-    filterArn?: string;
+    filterArn?: string | undefined;
     /**
      * <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.
@@ -321,19 +321,19 @@ export interface GetRecommendationsRequest {
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
      * @public
      */
-    filterValues?: Record<string, string>;
+    filterValues?: Record<string, string> | undefined;
     /**
      * <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>
      * @public
      */
-    recommenderArn?: string;
+    recommenderArn?: string | undefined;
     /**
      * <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>
      * @public
      */
-    promotions?: Promotion[];
+    promotions?: Promotion[] | undefined;
     /**
      * <p>If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations.
      *       The map key is <code>ITEMS</code> and the value is a list of column names from your Items dataset.
@@ -344,7 +344,7 @@ export interface GetRecommendationsRequest {
      *     </p>
      * @public
      */
-    metadataColumns?: Record<string, string[]>;
+    metadataColumns?: Record<string, string[]> | undefined;
 }
 /**
  * @public
@@ -355,12 +355,12 @@ export interface GetRecommendationsResponse {
      *       maximum of 500 items in the list.</p>
      * @public
      */
-    itemList?: PredictedItem[];
+    itemList?: PredictedItem[] | undefined;
     /**
      * <p>The ID of the recommendation.</p>
      * @public
      */
-    recommendationId?: string;
+    recommendationId?: string | undefined;
 }
 /**
  * @internal

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

@@ -1,19 +1,19 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { PersonalizeRuntimeServiceException as __BaseException } from "./PersonalizeRuntimeServiceException";
 export interface PredictedAction {
-  actionId?: string;
-  score?: number;
+  actionId?: string | undefined;
+  score?: number | undefined;
 }
 export interface GetActionRecommendationsRequest {
-  campaignArn?: string;
-  userId?: string;
-  numResults?: number;
-  filterArn?: string;
-  filterValues?: Record<string, string>;
+  campaignArn?: string | undefined;
+  userId?: string | undefined;
+  numResults?: number | undefined;
+  filterArn?: string | undefined;
+  filterValues?: Record<string, string> | undefined;
 }
 export interface GetActionRecommendationsResponse {
-  actionList?: PredictedAction[];
-  recommendationId?: string;
+  actionList?: PredictedAction[] | undefined;
+  recommendationId?: string | undefined;
 }
 export declare class InvalidInputException extends __BaseException {
   readonly name: "InvalidInputException";
@@ -33,43 +33,43 @@ export interface GetPersonalizedRankingRequest {
   campaignArn: string | undefined;
   inputList: string[] | undefined;
   userId: string | undefined;
-  context?: Record<string, string>;
-  filterArn?: string;
-  filterValues?: Record<string, string>;
-  metadataColumns?: Record<string, string[]>;
+  context?: Record<string, string> | undefined;
+  filterArn?: string | undefined;
+  filterValues?: Record<string, string> | undefined;
+  metadataColumns?: Record<string, string[]> | undefined;
 }
 export interface PredictedItem {
-  itemId?: string;
-  score?: number;
-  promotionName?: string;
-  metadata?: Record<string, string>;
-  reason?: string[];
+  itemId?: string | undefined;
+  score?: number | undefined;
+  promotionName?: string | undefined;
+  metadata?: Record<string, string> | undefined;
+  reason?: string[] | undefined;
 }
 export interface GetPersonalizedRankingResponse {
-  personalizedRanking?: PredictedItem[];
-  recommendationId?: string;
+  personalizedRanking?: PredictedItem[] | undefined;
+  recommendationId?: string | undefined;
 }
 export interface Promotion {
-  name?: string;
-  percentPromotedItems?: number;
-  filterArn?: string;
-  filterValues?: Record<string, string>;
+  name?: string | undefined;
+  percentPromotedItems?: number | undefined;
+  filterArn?: string | undefined;
+  filterValues?: Record<string, string> | undefined;
 }
 export interface GetRecommendationsRequest {
-  campaignArn?: string;
-  itemId?: string;
-  userId?: string;
-  numResults?: number;
-  context?: Record<string, string>;
-  filterArn?: string;
-  filterValues?: Record<string, string>;
-  recommenderArn?: string;
-  promotions?: Promotion[];
-  metadataColumns?: Record<string, string[]>;
+  campaignArn?: string | undefined;
+  itemId?: string | undefined;
+  userId?: string | undefined;
+  numResults?: number | undefined;
+  context?: Record<string, string> | undefined;
+  filterArn?: string | undefined;
+  filterValues?: Record<string, string> | undefined;
+  recommenderArn?: string | undefined;
+  promotions?: Promotion[] | undefined;
+  metadataColumns?: Record<string, string[]> | undefined;
 }
 export interface GetRecommendationsResponse {
-  itemList?: PredictedItem[];
-  recommendationId?: string;
+  itemList?: PredictedItem[] | undefined;
+  recommendationId?: string | undefined;
 }
 export declare const GetActionRecommendationsRequestFilterSensitiveLog: (
   obj: GetActionRecommendationsRequest

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.687.0",
+  "version": "3.692.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-personalize-runtime",
@@ -20,43 +20,43 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.687.0",
-    "@aws-sdk/client-sts": "3.687.0",
-    "@aws-sdk/core": "3.686.0",
-    "@aws-sdk/credential-provider-node": "3.687.0",
-    "@aws-sdk/middleware-host-header": "3.686.0",
-    "@aws-sdk/middleware-logger": "3.686.0",
-    "@aws-sdk/middleware-recursion-detection": "3.686.0",
-    "@aws-sdk/middleware-user-agent": "3.687.0",
-    "@aws-sdk/region-config-resolver": "3.686.0",
-    "@aws-sdk/types": "3.686.0",
-    "@aws-sdk/util-endpoints": "3.686.0",
-    "@aws-sdk/util-user-agent-browser": "3.686.0",
-    "@aws-sdk/util-user-agent-node": "3.687.0",
-    "@smithy/config-resolver": "^3.0.10",
-    "@smithy/core": "^2.5.1",
-    "@smithy/fetch-http-handler": "^4.0.0",
-    "@smithy/hash-node": "^3.0.8",
-    "@smithy/invalid-dependency": "^3.0.8",
-    "@smithy/middleware-content-length": "^3.0.10",
-    "@smithy/middleware-endpoint": "^3.2.1",
-    "@smithy/middleware-retry": "^3.0.25",
-    "@smithy/middleware-serde": "^3.0.8",
-    "@smithy/middleware-stack": "^3.0.8",
-    "@smithy/node-config-provider": "^3.1.9",
-    "@smithy/node-http-handler": "^3.2.5",
-    "@smithy/protocol-http": "^4.1.5",
-    "@smithy/smithy-client": "^3.4.2",
-    "@smithy/types": "^3.6.0",
-    "@smithy/url-parser": "^3.0.8",
+    "@aws-sdk/client-sso-oidc": "3.692.0",
+    "@aws-sdk/client-sts": "3.692.0",
+    "@aws-sdk/core": "3.692.0",
+    "@aws-sdk/credential-provider-node": "3.692.0",
+    "@aws-sdk/middleware-host-header": "3.692.0",
+    "@aws-sdk/middleware-logger": "3.692.0",
+    "@aws-sdk/middleware-recursion-detection": "3.692.0",
+    "@aws-sdk/middleware-user-agent": "3.692.0",
+    "@aws-sdk/region-config-resolver": "3.692.0",
+    "@aws-sdk/types": "3.692.0",
+    "@aws-sdk/util-endpoints": "3.692.0",
+    "@aws-sdk/util-user-agent-browser": "3.692.0",
+    "@aws-sdk/util-user-agent-node": "3.692.0",
+    "@smithy/config-resolver": "^3.0.11",
+    "@smithy/core": "^2.5.2",
+    "@smithy/fetch-http-handler": "^4.1.0",
+    "@smithy/hash-node": "^3.0.9",
+    "@smithy/invalid-dependency": "^3.0.9",
+    "@smithy/middleware-content-length": "^3.0.11",
+    "@smithy/middleware-endpoint": "^3.2.2",
+    "@smithy/middleware-retry": "^3.0.26",
+    "@smithy/middleware-serde": "^3.0.9",
+    "@smithy/middleware-stack": "^3.0.9",
+    "@smithy/node-config-provider": "^3.1.10",
+    "@smithy/node-http-handler": "^3.3.0",
+    "@smithy/protocol-http": "^4.1.6",
+    "@smithy/smithy-client": "^3.4.3",
+    "@smithy/types": "^3.7.0",
+    "@smithy/url-parser": "^3.0.9",
     "@smithy/util-base64": "^3.0.0",
     "@smithy/util-body-length-browser": "^3.0.0",
     "@smithy/util-body-length-node": "^3.0.0",
-    "@smithy/util-defaults-mode-browser": "^3.0.25",
-    "@smithy/util-defaults-mode-node": "^3.0.25",
-    "@smithy/util-endpoints": "^2.1.4",
-    "@smithy/util-middleware": "^3.0.8",
-    "@smithy/util-retry": "^3.0.8",
+    "@smithy/util-defaults-mode-browser": "^3.0.26",
+    "@smithy/util-defaults-mode-node": "^3.0.26",
+    "@smithy/util-endpoints": "^2.1.5",
+    "@smithy/util-middleware": "^3.0.9",
+    "@smithy/util-retry": "^3.0.9",
     "@smithy/util-utf8": "^3.0.0",
     "tslib": "^2.6.2"
   },