@aws-sdk/client-sagemaker-metrics 3.651.1 → 3.656.0

package/README.md

@@ -31,16 +31,16 @@ using your favorite package manager:
 
 The AWS SDK is modulized by clients and commands.
 To send a request, you only need to import the `SageMakerMetricsClient` and
-the commands you need, for example `BatchPutMetricsCommand`:
+the commands you need, for example `BatchGetMetricsCommand`:
 
 ```js
 // ES5 example
-const { SageMakerMetricsClient, BatchPutMetricsCommand } = require("@aws-sdk/client-sagemaker-metrics");
+const { SageMakerMetricsClient, BatchGetMetricsCommand } = require("@aws-sdk/client-sagemaker-metrics");
 ```
 
 ```ts
 // ES6+ example
-import { SageMakerMetricsClient, BatchPutMetricsCommand } from "@aws-sdk/client-sagemaker-metrics";
+import { SageMakerMetricsClient, BatchGetMetricsCommand } from "@aws-sdk/client-sagemaker-metrics";
 ```
 
 ### Usage
@@ -59,7 +59,7 @@ const client = new SageMakerMetricsClient({ region: "REGION" });
 const params = {
   /** input parameters */
 };
-const command = new BatchPutMetricsCommand(params);
+const command = new BatchGetMetricsCommand(params);
 ```
 
 #### Async/await
@@ -138,7 +138,7 @@ const client = new AWS.SageMakerMetrics({ region: "REGION" });
 
 // async/await.
 try {
-  const data = await client.batchPutMetrics(params);
+  const data = await client.batchGetMetrics(params);
   // process data.
 } catch (error) {
   // error handling.
@@ -146,7 +146,7 @@ try {
 
 // Promises.
 client
-  .batchPutMetrics(params)
+  .batchGetMetrics(params)
   .then((data) => {
     // process data.
   })
@@ -155,7 +155,7 @@ client
   });
 
 // callbacks.
-client.batchPutMetrics(params, (err, data) => {
+client.batchGetMetrics(params, (err, data) => {
   // process err and data.
 });
 ```
@@ -211,6 +211,14 @@ see LICENSE for more information.
 
 ## Client Commands (Operations List)
 
+<details>
+<summary>
+BatchGetMetrics
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sagemaker-metrics/command/BatchGetMetricsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker-metrics/Interface/BatchGetMetricsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sagemaker-metrics/Interface/BatchGetMetricsCommandOutput/)
+
+</details>
 <details>
 <summary>
 BatchPutMetrics

package/dist-cjs/index.js

@@ -21,12 +21,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  $Command: () => import_smithy_client.Command,
+  BatchGetMetricsCommand: () => BatchGetMetricsCommand,
   BatchPutMetricsCommand: () => BatchPutMetricsCommand,
+  MetricQueryResultStatus: () => MetricQueryResultStatus,
+  MetricStatistic: () => MetricStatistic,
+  Period: () => Period,
   PutMetricsErrorCode: () => PutMetricsErrorCode,
   SageMakerMetrics: () => SageMakerMetrics,
   SageMakerMetricsClient: () => SageMakerMetricsClient,
   SageMakerMetricsServiceException: () => SageMakerMetricsServiceException,
+  XAxisType: () => XAxisType,
   __Client: () => import_smithy_client.Client
 });
 module.exports = __toCommonJS(src_exports);
@@ -171,7 +175,7 @@ var SageMakerMetricsClient = _SageMakerMetricsClient;
 // src/SageMakerMetrics.ts
 
 
-// src/commands/BatchPutMetricsCommand.ts
+// src/commands/BatchGetMetricsCommand.ts
 
 var import_middleware_serde = require("@smithy/middleware-serde");
 
@@ -196,6 +200,21 @@ __name(_SageMakerMetricsServiceException, "SageMakerMetricsServiceException");
 var SageMakerMetricsServiceException = _SageMakerMetricsServiceException;
 
 // src/protocols/Aws_restJson1.ts
+var se_BatchGetMetricsCommand = /* @__PURE__ */ __name(async (input, context) => {
+  const b = (0, import_core.requestBuilder)(input, context);
+  const headers = {
+    "content-type": "application/json"
+  };
+  b.bp("/BatchGetMetrics");
+  let body;
+  body = JSON.stringify(
+    (0, import_smithy_client.take)(input, {
+      MetricQueries: (_) => (0, import_smithy_client._json)(_)
+    })
+  );
+  b.m("POST").h(headers).b(body);
+  return b.build();
+}, "se_BatchGetMetricsCommand");
 var se_BatchPutMetricsCommand = /* @__PURE__ */ __name(async (input, context) => {
   const b = (0, import_core.requestBuilder)(input, context);
   const headers = {
@@ -212,6 +231,20 @@ var se_BatchPutMetricsCommand = /* @__PURE__ */ __name(async (input, context) =>
   b.m("PUT").h(headers).b(body);
   return b.build();
 }, "se_BatchPutMetricsCommand");
+var de_BatchGetMetricsCommand = /* @__PURE__ */ __name(async (output, context) => {
+  if (output.statusCode !== 200 && output.statusCode >= 300) {
+    return de_CommandError(output, context);
+  }
+  const contents = (0, import_smithy_client.map)({
+    $metadata: deserializeMetadata(output)
+  });
+  const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
+  const doc = (0, import_smithy_client.take)(data, {
+    MetricQueryResults: (_) => de_MetricQueryResultList(_, context)
+  });
+  Object.assign(contents, doc);
+  return contents;
+}, "de_BatchGetMetricsCommand");
 var de_BatchPutMetricsCommand = /* @__PURE__ */ __name(async (output, context) => {
   if (output.statusCode !== 200 && output.statusCode >= 300) {
     return de_CommandError(output, context);
@@ -253,6 +286,26 @@ var se_RawMetricDataList = /* @__PURE__ */ __name((input, context) => {
     return se_RawMetricData(entry, context);
   });
 }, "se_RawMetricDataList");
+var de_MetricQueryResult = /* @__PURE__ */ __name((output, context) => {
+  return (0, import_smithy_client.take)(output, {
+    Message: import_smithy_client.expectString,
+    MetricValues: (_) => de_MetricValues(_, context),
+    Status: import_smithy_client.expectString,
+    XAxisValues: import_smithy_client._json
+  });
+}, "de_MetricQueryResult");
+var de_MetricQueryResultList = /* @__PURE__ */ __name((output, context) => {
+  const retVal = (output || []).filter((e) => e != null).map((entry) => {
+    return de_MetricQueryResult(entry, context);
+  });
+  return retVal;
+}, "de_MetricQueryResultList");
+var de_MetricValues = /* @__PURE__ */ __name((output, context) => {
+  const retVal = (output || []).filter((e) => e != null).map((entry) => {
+    return (0, import_smithy_client.limitedParseDouble)(entry);
+  });
+  return retVal;
+}, "de_MetricValues");
 var deserializeMetadata = /* @__PURE__ */ __name((output) => ({
   httpStatusCode: output.statusCode,
   requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"] ?? output.headers["x-amz-request-id"],
@@ -260,7 +313,21 @@ var deserializeMetadata = /* @__PURE__ */ __name((output) => ({
   cfId: output.headers["x-amz-cf-id"]
 }), "deserializeMetadata");
 
+// src/commands/BatchGetMetricsCommand.ts
+var _BatchGetMetricsCommand = class _BatchGetMetricsCommand extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
+  return [
+    (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
+    (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
+  ];
+}).s("SageMakerMetricsService", "BatchGetMetrics", {}).n("SageMakerMetricsClient", "BatchGetMetricsCommand").f(void 0, void 0).ser(se_BatchGetMetricsCommand).de(de_BatchGetMetricsCommand).build() {
+};
+__name(_BatchGetMetricsCommand, "BatchGetMetricsCommand");
+var BatchGetMetricsCommand = _BatchGetMetricsCommand;
+
 // src/commands/BatchPutMetricsCommand.ts
+
+
+
 var _BatchPutMetricsCommand = class _BatchPutMetricsCommand extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
   return [
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
@@ -273,6 +340,7 @@ var BatchPutMetricsCommand = _BatchPutMetricsCommand;
 
 // src/SageMakerMetrics.ts
 var commands = {
+  BatchGetMetricsCommand,
   BatchPutMetricsCommand
 };
 var _SageMakerMetrics = class _SageMakerMetrics extends SageMakerMetricsClient {
@@ -282,6 +350,30 @@ var SageMakerMetrics = _SageMakerMetrics;
 (0, import_smithy_client.createAggregatedClient)(commands, SageMakerMetrics);
 
 // src/models/models_0.ts
+var MetricStatistic = {
+  AVG: "Avg",
+  COUNT: "Count",
+  LAST: "Last",
+  MAX: "Max",
+  MIN: "Min",
+  STD_DEV: "StdDev"
+};
+var Period = {
+  FIVE_MINUTE: "FiveMinute",
+  ITERATION_NUMBER: "IterationNumber",
+  ONE_HOUR: "OneHour",
+  ONE_MINUTE: "OneMinute"
+};
+var XAxisType = {
+  ITERATION_NUMBER: "IterationNumber",
+  TIMESTAMP: "Timestamp"
+};
+var MetricQueryResultStatus = {
+  COMPLETE: "Complete",
+  INTERNAL_ERROR: "InternalError",
+  TRUNCATED: "Truncated",
+  VALIDATION_ERROR: "ValidationError"
+};
 var PutMetricsErrorCode = {
   CONFLICT_ERROR: "CONFLICT_ERROR",
   INTERNAL_ERROR: "INTERNAL_ERROR",
@@ -296,7 +388,12 @@ var PutMetricsErrorCode = {
   SageMakerMetricsClient,
   SageMakerMetrics,
   $Command,
+  BatchGetMetricsCommand,
   BatchPutMetricsCommand,
+  MetricStatistic,
+  Period,
+  XAxisType,
+  MetricQueryResultStatus,
   PutMetricsErrorCode
 });
 

package/dist-es/SageMakerMetrics.js

@@ -1,7 +1,9 @@
 import { createAggregatedClient } from "@smithy/smithy-client";
+import { BatchGetMetricsCommand, } from "./commands/BatchGetMetricsCommand";
 import { BatchPutMetricsCommand, } from "./commands/BatchPutMetricsCommand";
 import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
 const commands = {
+    BatchGetMetricsCommand,
     BatchPutMetricsCommand,
 };
 export class SageMakerMetrics extends SageMakerMetricsClient {

package/dist-es/commands/BatchGetMetricsCommand.js

@@ -0,0 +1,22 @@
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { de_BatchGetMetricsCommand, se_BatchGetMetricsCommand } from "../protocols/Aws_restJson1";
+export { $Command };
+export class BatchGetMetricsCommand extends $Command
+    .classBuilder()
+    .ep(commonParams)
+    .m(function (Command, cs, config, o) {
+    return [
+        getSerdePlugin(config, this.serialize, this.deserialize),
+        getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+})
+    .s("SageMakerMetricsService", "BatchGetMetrics", {})
+    .n("SageMakerMetricsClient", "BatchGetMetricsCommand")
+    .f(void 0, void 0)
+    .ser(se_BatchGetMetricsCommand)
+    .de(de_BatchGetMetricsCommand)
+    .build() {
+}

package/dist-es/commands/index.js

@@ -1 +1,2 @@
+export * from "./BatchGetMetricsCommand";
 export * from "./BatchPutMetricsCommand";

package/dist-es/models/models_0.js

@@ -1,3 +1,27 @@
+export const MetricStatistic = {
+    AVG: "Avg",
+    COUNT: "Count",
+    LAST: "Last",
+    MAX: "Max",
+    MIN: "Min",
+    STD_DEV: "StdDev",
+};
+export const Period = {
+    FIVE_MINUTE: "FiveMinute",
+    ITERATION_NUMBER: "IterationNumber",
+    ONE_HOUR: "OneHour",
+    ONE_MINUTE: "OneMinute",
+};
+export const XAxisType = {
+    ITERATION_NUMBER: "IterationNumber",
+    TIMESTAMP: "Timestamp",
+};
+export const MetricQueryResultStatus = {
+    COMPLETE: "Complete",
+    INTERNAL_ERROR: "InternalError",
+    TRUNCATED: "Truncated",
+    VALIDATION_ERROR: "ValidationError",
+};
 export const PutMetricsErrorCode = {
     CONFLICT_ERROR: "CONFLICT_ERROR",
     INTERNAL_ERROR: "INTERNAL_ERROR",

package/dist-es/protocols/Aws_restJson1.js

@@ -1,7 +1,20 @@
 import { loadRestJsonErrorCode, parseJsonBody as parseBody, parseJsonErrorBody as parseErrorBody } from "@aws-sdk/core";
 import { requestBuilder as rb } from "@smithy/core";
-import { _json, collectBody, expectNonNull as __expectNonNull, expectObject as __expectObject, map, serializeFloat as __serializeFloat, take, withBaseException, } from "@smithy/smithy-client";
+import { _json, collectBody, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, limitedParseDouble as __limitedParseDouble, map, serializeFloat as __serializeFloat, take, withBaseException, } from "@smithy/smithy-client";
 import { SageMakerMetricsServiceException as __BaseException } from "../models/SageMakerMetricsServiceException";
+export const se_BatchGetMetricsCommand = async (input, context) => {
+    const b = rb(input, context);
+    const headers = {
+        "content-type": "application/json",
+    };
+    b.bp("/BatchGetMetrics");
+    let body;
+    body = JSON.stringify(take(input, {
+        MetricQueries: (_) => _json(_),
+    }));
+    b.m("POST").h(headers).b(body);
+    return b.build();
+};
 export const se_BatchPutMetricsCommand = async (input, context) => {
     const b = rb(input, context);
     const headers = {
@@ -16,6 +29,20 @@ export const se_BatchPutMetricsCommand = async (input, context) => {
     b.m("PUT").h(headers).b(body);
     return b.build();
 };
+export const de_BatchGetMetricsCommand = async (output, context) => {
+    if (output.statusCode !== 200 && output.statusCode >= 300) {
+        return de_CommandError(output, context);
+    }
+    const contents = map({
+        $metadata: deserializeMetadata(output),
+    });
+    const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
+    const doc = take(data, {
+        MetricQueryResults: (_) => de_MetricQueryResultList(_, context),
+    });
+    Object.assign(contents, doc);
+    return contents;
+};
 export const de_BatchPutMetricsCommand = async (output, context) => {
     if (output.statusCode !== 200 && output.statusCode >= 300) {
         return de_CommandError(output, context);
@@ -59,6 +86,30 @@ const se_RawMetricDataList = (input, context) => {
         return se_RawMetricData(entry, context);
     });
 };
+const de_MetricQueryResult = (output, context) => {
+    return take(output, {
+        Message: __expectString,
+        MetricValues: (_) => de_MetricValues(_, context),
+        Status: __expectString,
+        XAxisValues: _json,
+    });
+};
+const de_MetricQueryResultList = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        return de_MetricQueryResult(entry, context);
+    });
+    return retVal;
+};
+const de_MetricValues = (output, context) => {
+    const retVal = (output || [])
+        .filter((e) => e != null)
+        .map((entry) => {
+        return __limitedParseDouble(entry);
+    });
+    return retVal;
+};
 const deserializeMetadata = (output) => ({
     httpStatusCode: output.statusCode,
     requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"] ?? output.headers["x-amz-request-id"],

package/dist-types/SageMakerMetrics.d.ts

@@ -1,7 +1,14 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
+import { BatchGetMetricsCommandInput, BatchGetMetricsCommandOutput } from "./commands/BatchGetMetricsCommand";
 import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput } from "./commands/BatchPutMetricsCommand";
 import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
 export interface SageMakerMetrics {
+    /**
+     * @see {@link BatchGetMetricsCommand}
+     */
+    batchGetMetrics(args: BatchGetMetricsCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetMetricsCommandOutput>;
+    batchGetMetrics(args: BatchGetMetricsCommandInput, cb: (err: any, data?: BatchGetMetricsCommandOutput) => void): void;
+    batchGetMetrics(args: BatchGetMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetMetricsCommandOutput) => void): void;
     /**
      * @see {@link BatchPutMetricsCommand}
      */

package/dist-types/SageMakerMetricsClient.d.ts

@@ -7,6 +7,7 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
 import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
 import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
 import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
+import { BatchGetMetricsCommandInput, BatchGetMetricsCommandOutput } from "./commands/BatchGetMetricsCommand";
 import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput } from "./commands/BatchPutMetricsCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
 import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -14,11 +15,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = BatchPutMetricsCommandInput;
+export type ServiceInputTypes = BatchGetMetricsCommandInput | BatchPutMetricsCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = BatchPutMetricsCommandOutput;
+export type ServiceOutputTypes = BatchGetMetricsCommandOutput | BatchPutMetricsCommandOutput;
 /**
  * @public
  */

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

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BatchGetMetricsRequest, BatchGetMetricsResponse } from "../models/models_0";
+import { SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerMetricsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link BatchGetMetricsCommand}.
+ */
+export interface BatchGetMetricsCommandInput extends BatchGetMetricsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link BatchGetMetricsCommand}.
+ */
+export interface BatchGetMetricsCommandOutput extends BatchGetMetricsResponse, __MetadataBearer {
+}
+declare const BatchGetMetricsCommand_base: {
+    new (input: BatchGetMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetMetricsCommandInput, BatchGetMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: BatchGetMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetMetricsCommandInput, BatchGetMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Used to retrieve training metrics from SageMaker.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SageMakerMetricsClient, BatchGetMetricsCommand } from "@aws-sdk/client-sagemaker-metrics"; // ES Modules import
+ * // const { SageMakerMetricsClient, BatchGetMetricsCommand } = require("@aws-sdk/client-sagemaker-metrics"); // CommonJS import
+ * const client = new SageMakerMetricsClient(config);
+ * const input = { // BatchGetMetricsRequest
+ *   MetricQueries: [ // MetricQueryList // required
+ *     { // MetricQuery
+ *       MetricName: "STRING_VALUE", // required
+ *       ResourceArn: "STRING_VALUE", // required
+ *       MetricStat: "Min" || "Max" || "Avg" || "Count" || "StdDev" || "Last", // required
+ *       Period: "OneMinute" || "FiveMinute" || "OneHour" || "IterationNumber", // required
+ *       XAxisType: "IterationNumber" || "Timestamp", // required
+ *       Start: Number("long"),
+ *       End: Number("long"),
+ *     },
+ *   ],
+ * };
+ * const command = new BatchGetMetricsCommand(input);
+ * const response = await client.send(command);
+ * // { // BatchGetMetricsResponse
+ * //   MetricQueryResults: [ // MetricQueryResultList
+ * //     { // MetricQueryResult
+ * //       Status: "Complete" || "Truncated" || "InternalError" || "ValidationError", // required
+ * //       Message: "STRING_VALUE",
+ * //       XAxisValues: [ // XAxisValues // required
+ * //         Number("long"),
+ * //       ],
+ * //       MetricValues: [ // MetricValues // required
+ * //         Number("double"),
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param BatchGetMetricsCommandInput - {@link BatchGetMetricsCommandInput}
+ * @returns {@link BatchGetMetricsCommandOutput}
+ * @see {@link BatchGetMetricsCommandInput} for command's `input` shape.
+ * @see {@link BatchGetMetricsCommandOutput} for command's `response` shape.
+ * @see {@link SageMakerMetricsClientResolvedConfig | config} for SageMakerMetricsClient's `config` shape.
+ *
+ * @throws {@link SageMakerMetricsServiceException}
+ * <p>Base exception class for all service exceptions from SageMakerMetrics service.</p>
+ *
+ * @public
+ */
+export declare class BatchGetMetricsCommand extends BatchGetMetricsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: BatchGetMetricsRequest;
+            output: BatchGetMetricsResponse;
+        };
+        sdk: {
+            input: BatchGetMetricsCommandInput;
+            output: BatchGetMetricsCommandOutput;
+        };
+    };
+}

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { BatchPutMetricsRequest, BatchPutMetricsResponse } from "../models/models_0";
-import { SageMakerMetricsClientResolvedConfig } from "../SageMakerMetricsClient";
+import { SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerMetricsClient";
 /**
  * @public
  */
@@ -22,13 +22,12 @@ export interface BatchPutMetricsCommandInput extends BatchPutMetricsRequest {
 export interface BatchPutMetricsCommandOutput extends BatchPutMetricsResponse, __MetadataBearer {
 }
 declare const BatchPutMetricsCommand_base: {
-    new (input: BatchPutMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput>;
-    new (__0_0: BatchPutMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput>;
+    new (input: BatchPutMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: BatchPutMetricsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and
- *          retrieved with the <code>GetMetrics</code> API.
+ * <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.
  *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -72,4 +71,15 @@ declare const BatchPutMetricsCommand_base: {
  * @public
  */
 export declare class BatchPutMetricsCommand extends BatchPutMetricsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: BatchPutMetricsRequest;
+            output: BatchPutMetricsResponse;
+        };
+        sdk: {
+            input: BatchPutMetricsCommandInput;
+            output: BatchPutMetricsCommandOutput;
+        };
+    };
 }

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

@@ -1 +1,2 @@
+export * from "./BatchGetMetricsCommand";
 export * from "./BatchPutMetricsCommand";

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

@@ -1,3 +1,146 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const MetricStatistic: {
+    readonly AVG: "Avg";
+    readonly COUNT: "Count";
+    readonly LAST: "Last";
+    readonly MAX: "Max";
+    readonly MIN: "Min";
+    readonly STD_DEV: "StdDev";
+};
+/**
+ * @public
+ */
+export type MetricStatistic = (typeof MetricStatistic)[keyof typeof MetricStatistic];
+/**
+ * @public
+ * @enum
+ */
+export declare const Period: {
+    readonly FIVE_MINUTE: "FiveMinute";
+    readonly ITERATION_NUMBER: "IterationNumber";
+    readonly ONE_HOUR: "OneHour";
+    readonly ONE_MINUTE: "OneMinute";
+};
+/**
+ * @public
+ */
+export type Period = (typeof Period)[keyof typeof Period];
+/**
+ * @public
+ * @enum
+ */
+export declare const XAxisType: {
+    readonly ITERATION_NUMBER: "IterationNumber";
+    readonly TIMESTAMP: "Timestamp";
+};
+/**
+ * @public
+ */
+export type XAxisType = (typeof XAxisType)[keyof typeof XAxisType];
+/**
+ * <p>Specifies a query to retrieve training metrics from SageMaker.</p>
+ * @public
+ */
+export interface MetricQuery {
+    /**
+     * <p>The name of the metric to retrieve.</p>
+     * @public
+     */
+    MetricName: string | undefined;
+    /**
+     * <p>The ARN of the SageMaker resource to retrieve metrics for.</p>
+     * @public
+     */
+    ResourceArn: string | undefined;
+    /**
+     * <p>The metrics stat type of metrics to retrieve.</p>
+     * @public
+     */
+    MetricStat: MetricStatistic | undefined;
+    /**
+     * <p>The time period of metrics to retrieve.</p>
+     * @public
+     */
+    Period: Period | undefined;
+    /**
+     * <p>The x-axis type of metrics to retrieve.</p>
+     * @public
+     */
+    XAxisType: XAxisType | undefined;
+    /**
+     * <p>The start time of metrics to retrieve.</p>
+     * @public
+     */
+    Start?: number;
+    /**
+     * <p>The end time of metrics to retrieve.</p>
+     * @public
+     */
+    End?: number;
+}
+/**
+ * @public
+ */
+export interface BatchGetMetricsRequest {
+    /**
+     * <p>Queries made to retrieve training metrics from SageMaker.</p>
+     * @public
+     */
+    MetricQueries: MetricQuery[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const MetricQueryResultStatus: {
+    readonly COMPLETE: "Complete";
+    readonly INTERNAL_ERROR: "InternalError";
+    readonly TRUNCATED: "Truncated";
+    readonly VALIDATION_ERROR: "ValidationError";
+};
+/**
+ * @public
+ */
+export type MetricQueryResultStatus = (typeof MetricQueryResultStatus)[keyof typeof MetricQueryResultStatus];
+/**
+ * <p>The result of a query to retrieve training metrics from SageMaker.</p>
+ * @public
+ */
+export interface MetricQueryResult {
+    /**
+     * <p>The status of the metric query.</p>
+     * @public
+     */
+    Status: MetricQueryResultStatus | undefined;
+    /**
+     * <p>A message describing the status of the metric query.</p>
+     * @public
+     */
+    Message?: string;
+    /**
+     * <p>The values for the x-axis of the metrics.</p>
+     * @public
+     */
+    XAxisValues: number[] | undefined;
+    /**
+     * <p>The metric values retrieved by the query.</p>
+     * @public
+     */
+    MetricValues: number[] | undefined;
+}
+/**
+ * @public
+ */
+export interface BatchGetMetricsResponse {
+    /**
+     * <p>The results of a query to retrieve training metrics from SageMaker.</p>
+     * @public
+     */
+    MetricQueryResults?: MetricQueryResult[];
+}
 /**
  * <p>The raw metric data to associate with the resource.</p>
  * @public
@@ -30,7 +173,7 @@ export interface RawMetricData {
  */
 export interface BatchPutMetricsRequest {
     /**
-     * <p>The name of the Trial Component to associate with the metrics.</p>
+     * <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
      * @public
      */
     TrialComponentName: string | undefined;

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,10 +1,19 @@
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
+import { BatchGetMetricsCommandInput, BatchGetMetricsCommandOutput } from "../commands/BatchGetMetricsCommand";
 import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput } from "../commands/BatchPutMetricsCommand";
+/**
+ * serializeAws_restJson1BatchGetMetricsCommand
+ */
+export declare const se_BatchGetMetricsCommand: (input: BatchGetMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1BatchPutMetricsCommand
  */
 export declare const se_BatchPutMetricsCommand: (input: BatchPutMetricsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * deserializeAws_restJson1BatchGetMetricsCommand
+ */
+export declare const de_BatchGetMetricsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<BatchGetMetricsCommandOutput>;
 /**
  * deserializeAws_restJson1BatchPutMetricsCommand
  */

package/dist-types/ts3.4/SageMakerMetrics.d.ts

@@ -1,10 +1,27 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
+import {
+  BatchGetMetricsCommandInput,
+  BatchGetMetricsCommandOutput,
+} from "./commands/BatchGetMetricsCommand";
 import {
   BatchPutMetricsCommandInput,
   BatchPutMetricsCommandOutput,
 } from "./commands/BatchPutMetricsCommand";
 import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
 export interface SageMakerMetrics {
+  batchGetMetrics(
+    args: BatchGetMetricsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<BatchGetMetricsCommandOutput>;
+  batchGetMetrics(
+    args: BatchGetMetricsCommandInput,
+    cb: (err: any, data?: BatchGetMetricsCommandOutput) => void
+  ): void;
+  batchGetMetrics(
+    args: BatchGetMetricsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: BatchGetMetricsCommandOutput) => void
+  ): void;
   batchPutMetrics(
     args: BatchPutMetricsCommandInput,
     options?: __HttpHandlerOptions

package/dist-types/ts3.4/SageMakerMetricsClient.d.ts

@@ -45,6 +45,10 @@ import {
   HttpAuthSchemeInputConfig,
   HttpAuthSchemeResolvedConfig,
 } from "./auth/httpAuthSchemeProvider";
+import {
+  BatchGetMetricsCommandInput,
+  BatchGetMetricsCommandOutput,
+} from "./commands/BatchGetMetricsCommand";
 import {
   BatchPutMetricsCommandInput,
   BatchPutMetricsCommandOutput,
@@ -56,8 +60,12 @@ import {
 } from "./endpoint/EndpointParameters";
 import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
 export { __Client };
-export type ServiceInputTypes = BatchPutMetricsCommandInput;
-export type ServiceOutputTypes = BatchPutMetricsCommandOutput;
+export type ServiceInputTypes =
+  | BatchGetMetricsCommandInput
+  | BatchPutMetricsCommandInput;
+export type ServiceOutputTypes =
+  | BatchGetMetricsCommandOutput
+  | BatchPutMetricsCommandOutput;
 export interface ClientDefaults
   extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
   requestHandler?: __HttpHandlerUserInput;

package/dist-types/ts3.4/commands/BatchGetMetricsCommand.d.ts

@@ -0,0 +1,50 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import {
+  BatchGetMetricsRequest,
+  BatchGetMetricsResponse,
+} from "../models/models_0";
+import {
+  SageMakerMetricsClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../SageMakerMetricsClient";
+export { __MetadataBearer };
+export { $Command };
+export interface BatchGetMetricsCommandInput extends BatchGetMetricsRequest {}
+export interface BatchGetMetricsCommandOutput
+  extends BatchGetMetricsResponse,
+    __MetadataBearer {}
+declare const BatchGetMetricsCommand_base: {
+  new (
+    input: BatchGetMetricsCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    BatchGetMetricsCommandInput,
+    BatchGetMetricsCommandOutput,
+    SageMakerMetricsClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  new (
+    __0_0: BatchGetMetricsCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    BatchGetMetricsCommandInput,
+    BatchGetMetricsCommandOutput,
+    SageMakerMetricsClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+export declare class BatchGetMetricsCommand extends BatchGetMetricsCommand_base {
+  protected static __types: {
+    api: {
+      input: BatchGetMetricsRequest;
+      output: BatchGetMetricsResponse;
+    };
+    sdk: {
+      input: BatchGetMetricsCommandInput;
+      output: BatchGetMetricsCommandOutput;
+    };
+  };
+}

package/dist-types/ts3.4/commands/BatchPutMetricsCommand.d.ts

@@ -4,7 +4,11 @@ import {
   BatchPutMetricsRequest,
   BatchPutMetricsResponse,
 } from "../models/models_0";
-import { SageMakerMetricsClientResolvedConfig } from "../SageMakerMetricsClient";
+import {
+  SageMakerMetricsClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../SageMakerMetricsClient";
 export { __MetadataBearer };
 export { $Command };
 export interface BatchPutMetricsCommandInput extends BatchPutMetricsRequest {}
@@ -18,8 +22,8 @@ declare const BatchPutMetricsCommand_base: {
     BatchPutMetricsCommandInput,
     BatchPutMetricsCommandOutput,
     SageMakerMetricsClientResolvedConfig,
-    BatchPutMetricsCommandInput,
-    BatchPutMetricsCommandOutput
+    ServiceInputTypes,
+    ServiceOutputTypes
   >;
   new (
     __0_0: BatchPutMetricsCommandInput
@@ -27,9 +31,20 @@ declare const BatchPutMetricsCommand_base: {
     BatchPutMetricsCommandInput,
     BatchPutMetricsCommandOutput,
     SageMakerMetricsClientResolvedConfig,
-    BatchPutMetricsCommandInput,
-    BatchPutMetricsCommandOutput
+    ServiceInputTypes,
+    ServiceOutputTypes
   >;
   getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
-export declare class BatchPutMetricsCommand extends BatchPutMetricsCommand_base {}
+export declare class BatchPutMetricsCommand extends BatchPutMetricsCommand_base {
+  protected static __types: {
+    api: {
+      input: BatchPutMetricsRequest;
+      output: BatchPutMetricsResponse;
+    };
+    sdk: {
+      input: BatchPutMetricsCommandInput;
+      output: BatchPutMetricsCommandOutput;
+    };
+  };
+}

package/dist-types/ts3.4/commands/index.d.ts

@@ -1 +1,2 @@
+export * from "./BatchGetMetricsCommand";
 export * from "./BatchPutMetricsCommand";

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

@@ -1,3 +1,54 @@
+export declare const MetricStatistic: {
+  readonly AVG: "Avg";
+  readonly COUNT: "Count";
+  readonly LAST: "Last";
+  readonly MAX: "Max";
+  readonly MIN: "Min";
+  readonly STD_DEV: "StdDev";
+};
+export type MetricStatistic =
+  (typeof MetricStatistic)[keyof typeof MetricStatistic];
+export declare const Period: {
+  readonly FIVE_MINUTE: "FiveMinute";
+  readonly ITERATION_NUMBER: "IterationNumber";
+  readonly ONE_HOUR: "OneHour";
+  readonly ONE_MINUTE: "OneMinute";
+};
+export type Period = (typeof Period)[keyof typeof Period];
+export declare const XAxisType: {
+  readonly ITERATION_NUMBER: "IterationNumber";
+  readonly TIMESTAMP: "Timestamp";
+};
+export type XAxisType = (typeof XAxisType)[keyof typeof XAxisType];
+export interface MetricQuery {
+  MetricName: string | undefined;
+  ResourceArn: string | undefined;
+  MetricStat: MetricStatistic | undefined;
+  Period: Period | undefined;
+  XAxisType: XAxisType | undefined;
+  Start?: number;
+  End?: number;
+}
+export interface BatchGetMetricsRequest {
+  MetricQueries: MetricQuery[] | undefined;
+}
+export declare const MetricQueryResultStatus: {
+  readonly COMPLETE: "Complete";
+  readonly INTERNAL_ERROR: "InternalError";
+  readonly TRUNCATED: "Truncated";
+  readonly VALIDATION_ERROR: "ValidationError";
+};
+export type MetricQueryResultStatus =
+  (typeof MetricQueryResultStatus)[keyof typeof MetricQueryResultStatus];
+export interface MetricQueryResult {
+  Status: MetricQueryResultStatus | undefined;
+  Message?: string;
+  XAxisValues: number[] | undefined;
+  MetricValues: number[] | undefined;
+}
+export interface BatchGetMetricsResponse {
+  MetricQueryResults?: MetricQueryResult[];
+}
 export interface RawMetricData {
   MetricName: string | undefined;
   Timestamp: Date | undefined;

package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts

@@ -3,14 +3,26 @@ import {
   HttpResponse as __HttpResponse,
 } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
+import {
+  BatchGetMetricsCommandInput,
+  BatchGetMetricsCommandOutput,
+} from "../commands/BatchGetMetricsCommand";
 import {
   BatchPutMetricsCommandInput,
   BatchPutMetricsCommandOutput,
 } from "../commands/BatchPutMetricsCommand";
+export declare const se_BatchGetMetricsCommand: (
+  input: BatchGetMetricsCommandInput,
+  context: __SerdeContext
+) => Promise<__HttpRequest>;
 export declare const se_BatchPutMetricsCommand: (
   input: BatchPutMetricsCommandInput,
   context: __SerdeContext
 ) => Promise<__HttpRequest>;
+export declare const de_BatchGetMetricsCommand: (
+  output: __HttpResponse,
+  context: __SerdeContext
+) => Promise<BatchGetMetricsCommandOutput>;
 export declare const de_BatchPutMetricsCommand: (
   output: __HttpResponse,
   context: __SerdeContext

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sagemaker-metrics",
   "description": "AWS SDK for JavaScript Sagemaker Metrics Client for Node.js, Browser and React Native",
-  "version": "3.651.1",
+  "version": "3.656.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-sagemaker-metrics",
@@ -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.651.1",
-    "@aws-sdk/client-sts": "3.651.1",
-    "@aws-sdk/core": "3.651.1",
-    "@aws-sdk/credential-provider-node": "3.651.1",
-    "@aws-sdk/middleware-host-header": "3.649.0",
-    "@aws-sdk/middleware-logger": "3.649.0",
-    "@aws-sdk/middleware-recursion-detection": "3.649.0",
-    "@aws-sdk/middleware-user-agent": "3.649.0",
-    "@aws-sdk/region-config-resolver": "3.649.0",
-    "@aws-sdk/types": "3.649.0",
-    "@aws-sdk/util-endpoints": "3.649.0",
-    "@aws-sdk/util-user-agent-browser": "3.649.0",
-    "@aws-sdk/util-user-agent-node": "3.649.0",
-    "@smithy/config-resolver": "^3.0.6",
-    "@smithy/core": "^2.4.1",
-    "@smithy/fetch-http-handler": "^3.2.5",
-    "@smithy/hash-node": "^3.0.4",
-    "@smithy/invalid-dependency": "^3.0.4",
-    "@smithy/middleware-content-length": "^3.0.6",
-    "@smithy/middleware-endpoint": "^3.1.1",
-    "@smithy/middleware-retry": "^3.0.16",
-    "@smithy/middleware-serde": "^3.0.4",
-    "@smithy/middleware-stack": "^3.0.4",
-    "@smithy/node-config-provider": "^3.1.5",
-    "@smithy/node-http-handler": "^3.2.0",
-    "@smithy/protocol-http": "^4.1.1",
-    "@smithy/smithy-client": "^3.3.0",
-    "@smithy/types": "^3.4.0",
-    "@smithy/url-parser": "^3.0.4",
+    "@aws-sdk/client-sso-oidc": "3.654.0",
+    "@aws-sdk/client-sts": "3.654.0",
+    "@aws-sdk/core": "3.654.0",
+    "@aws-sdk/credential-provider-node": "3.654.0",
+    "@aws-sdk/middleware-host-header": "3.654.0",
+    "@aws-sdk/middleware-logger": "3.654.0",
+    "@aws-sdk/middleware-recursion-detection": "3.654.0",
+    "@aws-sdk/middleware-user-agent": "3.654.0",
+    "@aws-sdk/region-config-resolver": "3.654.0",
+    "@aws-sdk/types": "3.654.0",
+    "@aws-sdk/util-endpoints": "3.654.0",
+    "@aws-sdk/util-user-agent-browser": "3.654.0",
+    "@aws-sdk/util-user-agent-node": "3.654.0",
+    "@smithy/config-resolver": "^3.0.8",
+    "@smithy/core": "^2.4.3",
+    "@smithy/fetch-http-handler": "^3.2.7",
+    "@smithy/hash-node": "^3.0.6",
+    "@smithy/invalid-dependency": "^3.0.6",
+    "@smithy/middleware-content-length": "^3.0.8",
+    "@smithy/middleware-endpoint": "^3.1.3",
+    "@smithy/middleware-retry": "^3.0.18",
+    "@smithy/middleware-serde": "^3.0.6",
+    "@smithy/middleware-stack": "^3.0.6",
+    "@smithy/node-config-provider": "^3.1.7",
+    "@smithy/node-http-handler": "^3.2.2",
+    "@smithy/protocol-http": "^4.1.3",
+    "@smithy/smithy-client": "^3.3.2",
+    "@smithy/types": "^3.4.2",
+    "@smithy/url-parser": "^3.0.6",
     "@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.16",
-    "@smithy/util-defaults-mode-node": "^3.0.16",
-    "@smithy/util-endpoints": "^2.1.0",
-    "@smithy/util-middleware": "^3.0.4",
-    "@smithy/util-retry": "^3.0.4",
+    "@smithy/util-defaults-mode-browser": "^3.0.18",
+    "@smithy/util-defaults-mode-node": "^3.0.18",
+    "@smithy/util-endpoints": "^2.1.2",
+    "@smithy/util-middleware": "^3.0.6",
+    "@smithy/util-retry": "^3.0.6",
     "@smithy/util-utf8": "^3.0.0",
     "tslib": "^2.6.2"
   },