@aws-sdk/client-personalize 3.95.0 → 3.97.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.97.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.96.0...v3.97.0) (2022-05-23)
+
+
+### Features
+
+* **client-personalize:** Adding modelMetrics as part of DescribeRecommender API response for Personalize. ([16f4208](https://github.com/aws/aws-sdk-js-v3/commit/16f42083d78a7680400c8d6f8586fdb2142adc70))
+
+
+
+
+
 # [3.95.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.94.0...v3.95.0) (2022-05-19)
 
 **Note:** Version bump only for package @aws-sdk/client-personalize

package/dist-cjs/protocols/Aws_json1_1.js

@@ -1089,6 +1089,9 @@ const deserializeAws_json1_1CreateRecommenderCommandError = async (output, conte
         case "ResourceAlreadyExistsException":
         case "com.amazonaws.personalize#ResourceAlreadyExistsException":
             throw await deserializeAws_json1_1ResourceAlreadyExistsExceptionResponse(parsedOutput, context);
+        case "ResourceInUseException":
+        case "com.amazonaws.personalize#ResourceInUseException":
+            throw await deserializeAws_json1_1ResourceInUseExceptionResponse(parsedOutput, context);
         case "ResourceNotFoundException":
         case "com.amazonaws.personalize#ResourceNotFoundException":
             throw await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context);
@@ -5082,6 +5085,9 @@ const deserializeAws_json1_1Recommender = (output, context) => {
         latestRecommenderUpdate: output.latestRecommenderUpdate !== undefined && output.latestRecommenderUpdate !== null
             ? deserializeAws_json1_1RecommenderUpdateSummary(output.latestRecommenderUpdate, context)
             : undefined,
+        modelMetrics: output.modelMetrics !== undefined && output.modelMetrics !== null
+            ? deserializeAws_json1_1Metrics(output.modelMetrics, context)
+            : undefined,
         name: (0, smithy_client_1.expectString)(output.name),
         recipeArn: (0, smithy_client_1.expectString)(output.recipeArn),
         recommenderArn: (0, smithy_client_1.expectString)(output.recommenderArn),

package/dist-es/protocols/Aws_json1_1.js

@@ -1320,23 +1320,27 @@ var deserializeAws_json1_1CreateRecommenderCommandError = function (output, cont
                     case "com.amazonaws.personalize#LimitExceededException": return [3, 4];
                     case "ResourceAlreadyExistsException": return [3, 6];
                     case "com.amazonaws.personalize#ResourceAlreadyExistsException": return [3, 6];
-                    case "ResourceNotFoundException": return [3, 8];
-                    case "com.amazonaws.personalize#ResourceNotFoundException": return [3, 8];
-                    case "TooManyTagsException": return [3, 10];
-                    case "com.amazonaws.personalize#TooManyTagsException": return [3, 10];
+                    case "ResourceInUseException": return [3, 8];
+                    case "com.amazonaws.personalize#ResourceInUseException": return [3, 8];
+                    case "ResourceNotFoundException": return [3, 10];
+                    case "com.amazonaws.personalize#ResourceNotFoundException": return [3, 10];
+                    case "TooManyTagsException": return [3, 12];
+                    case "com.amazonaws.personalize#TooManyTagsException": return [3, 12];
                 }
-                return [3, 12];
+                return [3, 14];
             case 2: return [4, deserializeAws_json1_1InvalidInputExceptionResponse(parsedOutput, context)];
             case 3: throw _d.sent();
             case 4: return [4, deserializeAws_json1_1LimitExceededExceptionResponse(parsedOutput, context)];
             case 5: throw _d.sent();
             case 6: return [4, deserializeAws_json1_1ResourceAlreadyExistsExceptionResponse(parsedOutput, context)];
             case 7: throw _d.sent();
-            case 8: return [4, deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)];
+            case 8: return [4, deserializeAws_json1_1ResourceInUseExceptionResponse(parsedOutput, context)];
             case 9: throw _d.sent();
-            case 10: return [4, deserializeAws_json1_1TooManyTagsExceptionResponse(parsedOutput, context)];
+            case 10: return [4, deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)];
             case 11: throw _d.sent();
-            case 12:
+            case 12: return [4, deserializeAws_json1_1TooManyTagsExceptionResponse(parsedOutput, context)];
+            case 13: throw _d.sent();
+            case 14:
                 parsedBody = parsedOutput.body;
                 response = new __BaseException({
                     name: parsedBody.code || parsedBody.Code || errorCode,
@@ -5849,6 +5853,9 @@ var deserializeAws_json1_1Recommender = function (output, context) {
         latestRecommenderUpdate: output.latestRecommenderUpdate !== undefined && output.latestRecommenderUpdate !== null
             ? deserializeAws_json1_1RecommenderUpdateSummary(output.latestRecommenderUpdate, context)
             : undefined,
+        modelMetrics: output.modelMetrics !== undefined && output.modelMetrics !== null
+            ? deserializeAws_json1_1Metrics(output.modelMetrics, context)
+            : undefined,
         name: __expectString(output.name),
         recipeArn: __expectString(output.recipeArn),
         recommenderArn: __expectString(output.recommenderArn),

package/dist-types/Personalize.d.ts

@@ -471,6 +471,9 @@ export declare class Personalize extends PersonalizeClient {
      *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
      *             </li>
      *             <li>
+     *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+     *             </li>
+     *             <li>
      *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
      *             </li>
      *          </ul>
@@ -886,11 +889,16 @@ export declare class Personalize extends PersonalizeClient {
      *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
      *             </li>
      *             <li>
+     *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+     *             </li>
+     *             <li>
      *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
      *             </li>
      *          </ul>
      *          <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
      *       <code>failureReason</code> key, which describes why.</p>
+     *          <p>The <code>modelMetrics</code> key is null when
+     *       the recommender is being created or deleted.</p>
      *          <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
      */
     describeRecommender(args: DescribeRecommenderCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRecommenderCommandOutput>;

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

@@ -47,6 +47,9 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons
  *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
  *             </li>
  *             <li>
+ *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+ *             </li>
+ *             <li>
  *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
  *             </li>
  *          </ul>

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

@@ -14,11 +14,16 @@ export interface DescribeRecommenderCommandOutput extends DescribeRecommenderRes
  *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
  *             </li>
  *             <li>
+ *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+ *             </li>
+ *             <li>
  *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
  *             </li>
  *          </ul>
  *          <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the
  *       <code>failureReason</code> key, which describes why.</p>
+ *          <p>The <code>modelMetrics</code> key is null when
+ *       the recommender is being created or deleted.</p>
  *          <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -2513,6 +2513,9 @@ export interface RecommenderUpdateSummary {
      *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
      *             </li>
      *             <li>
+     *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+     *             </li>
+     *             <li>
      *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
      *             </li>
      *          </ul>
@@ -2571,6 +2574,9 @@ export interface Recommender {
      *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
      *             </li>
      *             <li>
+     *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+     *             </li>
+     *             <li>
      *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
      *             </li>
      *          </ul>
@@ -2584,6 +2590,15 @@ export interface Recommender {
      * <p>Provides a summary of the latest updates to the recommender. </p>
      */
     latestRecommenderUpdate?: RecommenderUpdateSummary;
+    /**
+     * <p>Provides evaluation metrics that help you determine the performance
+     *     of a recommender. For more information, see
+     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html">
+     *         Evaluating a recommender</a>.</p>
+     */
+    modelMetrics?: {
+        [key: string]: number;
+    };
 }
 export declare namespace Recommender {
     /**
@@ -2993,7 +3008,10 @@ export interface GetSolutionMetricsResponse {
      */
     solutionVersionArn?: string;
     /**
-     * <p>The metrics for the solution version.</p>
+     * <p>The metrics for the solution version. For more information, see
+     *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html">
+     *         Evaluating a solution version with metrics
+     *       </a>.</p>
      */
     metrics?: {
         [key: string]: number;
@@ -3914,6 +3932,9 @@ export interface RecommenderSummary {
      *                <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
      *             </li>
      *             <li>
+     *                <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p>
+     *             </li>
+     *             <li>
      *                <p>DELETE PENDING > DELETE IN_PROGRESS</p>
      *             </li>
      *          </ul>

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

@@ -1333,6 +1333,10 @@ export interface Recommender {
     failureReason?: string;
     
     latestRecommenderUpdate?: RecommenderUpdateSummary;
+    
+    modelMetrics?: {
+        [key: string]: number;
+    };
 }
 export declare namespace Recommender {
     

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-personalize",
   "description": "AWS SDK for JavaScript Personalize Client for Node.js, Browser and React Native",
-  "version": "3.95.0",
+  "version": "3.97.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",