@aws-sdk/client-sagemaker-metrics 3.296.0 → 3.298.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,6 @@ exports.BatchPutMetricsCommand = void 0;
4
4
  const middleware_endpoint_1 = require("@aws-sdk/middleware-endpoint");
5
5
  const middleware_serde_1 = require("@aws-sdk/middleware-serde");
6
6
  const smithy_client_1 = require("@aws-sdk/smithy-client");
7
- const models_0_1 = require("../models/models_0");
8
7
  const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
9
8
  class BatchPutMetricsCommand extends smithy_client_1.Command {
10
9
  static getEndpointParameterInstructions() {
@@ -30,8 +29,8 @@ class BatchPutMetricsCommand extends smithy_client_1.Command {
30
29
  logger,
31
30
  clientName,
32
31
  commandName,
33
- inputFilterSensitiveLog: models_0_1.BatchPutMetricsRequestFilterSensitiveLog,
34
- outputFilterSensitiveLog: models_0_1.BatchPutMetricsResponseFilterSensitiveLog,
32
+ inputFilterSensitiveLog: (_) => _,
33
+ outputFilterSensitiveLog: (_) => _,
35
34
  };
36
35
  const { requestHandler } = configuration;
37
36
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BatchPutMetricsResponseFilterSensitiveLog = exports.BatchPutMetricsErrorFilterSensitiveLog = exports.BatchPutMetricsRequestFilterSensitiveLog = exports.RawMetricDataFilterSensitiveLog = exports.PutMetricsErrorCode = void 0;
3
+ exports.PutMetricsErrorCode = void 0;
4
4
  var PutMetricsErrorCode;
5
5
  (function (PutMetricsErrorCode) {
6
6
  PutMetricsErrorCode["CONFLICT_ERROR"] = "CONFLICT_ERROR";
@@ -8,19 +8,3 @@ var PutMetricsErrorCode;
8
8
  PutMetricsErrorCode["METRIC_LIMIT_EXCEEDED"] = "METRIC_LIMIT_EXCEEDED";
9
9
  PutMetricsErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
10
10
  })(PutMetricsErrorCode = exports.PutMetricsErrorCode || (exports.PutMetricsErrorCode = {}));
11
- const RawMetricDataFilterSensitiveLog = (obj) => ({
12
- ...obj,
13
- });
14
- exports.RawMetricDataFilterSensitiveLog = RawMetricDataFilterSensitiveLog;
15
- const BatchPutMetricsRequestFilterSensitiveLog = (obj) => ({
16
- ...obj,
17
- });
18
- exports.BatchPutMetricsRequestFilterSensitiveLog = BatchPutMetricsRequestFilterSensitiveLog;
19
- const BatchPutMetricsErrorFilterSensitiveLog = (obj) => ({
20
- ...obj,
21
- });
22
- exports.BatchPutMetricsErrorFilterSensitiveLog = BatchPutMetricsErrorFilterSensitiveLog;
23
- const BatchPutMetricsResponseFilterSensitiveLog = (obj) => ({
24
- ...obj,
25
- });
26
- exports.BatchPutMetricsResponseFilterSensitiveLog = BatchPutMetricsResponseFilterSensitiveLog;
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { BatchPutMetricsRequestFilterSensitiveLog, BatchPutMetricsResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1BatchPutMetricsCommand, serializeAws_restJson1BatchPutMetricsCommand, } from "../protocols/Aws_restJson1";
6
5
  export class BatchPutMetricsCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class BatchPutMetricsCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: BatchPutMetricsRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: BatchPutMetricsResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -5,15 +5,3 @@ export var PutMetricsErrorCode;
5
5
  PutMetricsErrorCode["METRIC_LIMIT_EXCEEDED"] = "METRIC_LIMIT_EXCEEDED";
6
6
  PutMetricsErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
7
7
  })(PutMetricsErrorCode || (PutMetricsErrorCode = {}));
8
- export const RawMetricDataFilterSensitiveLog = (obj) => ({
9
- ...obj,
10
- });
11
- export const BatchPutMetricsRequestFilterSensitiveLog = (obj) => ({
12
- ...obj,
13
- });
14
- export const BatchPutMetricsErrorFilterSensitiveLog = (obj) => ({
15
- ...obj,
16
- });
17
- export const BatchPutMetricsResponseFilterSensitiveLog = (obj) => ({
18
- ...obj,
19
- });
@@ -2,6 +2,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput } from "./commands/BatchPutMetricsCommand";
3
3
  import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
4
4
  /**
5
+ * @public
5
6
  * <p>Contains all data plane API operations and data types for Amazon SageMaker Metrics.
6
7
  * Use these APIs to put and retrieve (get) features related to your training run.</p>
7
8
  * <ul>
@@ -14,6 +15,7 @@ import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
14
15
  */
15
16
  export declare class SageMakerMetrics extends SageMakerMetricsClient {
16
17
  /**
18
+ * @public
17
19
  * <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and
18
20
  * retrieved with the <code>GetMetrics</code> API.
19
21
  * </p>
@@ -9,15 +9,24 @@ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration
9
9
  import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Credentials as __Credentials, 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 "@aws-sdk/types";
10
10
  import { BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput } from "./commands/BatchPutMetricsCommand";
11
11
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
12
+ /**
13
+ * @public
14
+ */
12
15
  export type ServiceInputTypes = BatchPutMetricsCommandInput;
16
+ /**
17
+ * @public
18
+ */
13
19
  export type ServiceOutputTypes = BatchPutMetricsCommandOutput;
20
+ /**
21
+ * @public
22
+ */
14
23
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
15
24
  /**
16
25
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
17
26
  */
18
27
  requestHandler?: __HttpHandler;
19
28
  /**
20
- * A constructor for a class implementing the {@link __Checksum} interface
29
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
21
30
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
22
31
  * @internal
23
32
  */
@@ -107,23 +116,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
107
116
  */
108
117
  logger?: __Logger;
109
118
  /**
110
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
119
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
111
120
  */
112
121
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
113
122
  }
123
+ /**
124
+ * @public
125
+ */
114
126
  type SageMakerMetricsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
115
127
  /**
116
- * The configuration interface of SageMakerMetricsClient class constructor that set the region, credentials and other options.
128
+ * @public
129
+ *
130
+ * The configuration interface of SageMakerMetricsClient class constructor that set the region, credentials and other options.
117
131
  */
118
132
  export interface SageMakerMetricsClientConfig extends SageMakerMetricsClientConfigType {
119
133
  }
134
+ /**
135
+ * @public
136
+ */
120
137
  type SageMakerMetricsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
121
138
  /**
122
- * The resolved configuration interface of SageMakerMetricsClient class. This is resolved and normalized from the {@link SageMakerMetricsClientConfig | constructor configuration interface}.
139
+ * @public
140
+ *
141
+ * The resolved configuration interface of SageMakerMetricsClient class. This is resolved and normalized from the {@link SageMakerMetricsClientConfig | constructor configuration interface}.
123
142
  */
124
143
  export interface SageMakerMetricsClientResolvedConfig extends SageMakerMetricsClientResolvedConfigType {
125
144
  }
126
145
  /**
146
+ * @public
127
147
  * <p>Contains all data plane API operations and data types for Amazon SageMaker Metrics.
128
148
  * Use these APIs to put and retrieve (get) features related to your training run.</p>
129
149
  * <ul>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BatchPutMetricsRequest, BatchPutMetricsResponse } from "../models/models_0";
5
5
  import { SageMakerMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerMetricsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchPutMetricsCommand}.
8
10
  */
9
11
  export interface BatchPutMetricsCommandInput extends BatchPutMetricsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchPutMetricsCommand}.
13
17
  */
14
18
  export interface BatchPutMetricsCommandOutput extends BatchPutMetricsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and
18
23
  * retrieved with the <code>GetMetrics</code> API.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface BatchPutMetricsCommandOutput extends BatchPutMetricsResponse, _
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param BatchPutMetricsCommandInput - {@link BatchPutMetricsCommandInput}
36
+ * @returns {@link BatchPutMetricsCommandOutput}
30
37
  * @see {@link BatchPutMetricsCommandInput} for command's `input` shape.
31
38
  * @see {@link BatchPutMetricsCommandOutput} for command's `response` shape.
32
39
  * @see {@link SageMakerMetricsClientResolvedConfig | config} for SageMakerMetricsClient's `config` shape.
@@ -36,11 +43,20 @@ export interface BatchPutMetricsCommandOutput extends BatchPutMetricsResponse, _
36
43
  export declare class BatchPutMetricsCommand extends $Command<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput, SageMakerMetricsClientResolvedConfig> {
37
44
  readonly input: BatchPutMetricsCommandInput;
38
45
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
46
+ /**
47
+ * @public
48
+ */
39
49
  constructor(input: BatchPutMetricsCommandInput);
40
50
  /**
41
51
  * @internal
42
52
  */
43
53
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SageMakerMetricsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutMetricsCommandInput, BatchPutMetricsCommandOutput>;
54
+ /**
55
+ * @internal
56
+ */
44
57
  private serialize;
58
+ /**
59
+ * @internal
60
+ */
45
61
  private deserialize;
46
62
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from SageMakerMetrics service.
4
6
  */
5
7
  export declare class SageMakerMetricsServiceException extends __ServiceException {
@@ -1,4 +1,5 @@
1
1
  /**
2
+ * @public
2
3
  * <p>The raw metric data to associate with the resource.</p>
3
4
  */
4
5
  export interface RawMetricData {
@@ -20,6 +21,9 @@ export interface RawMetricData {
20
21
  */
21
22
  Value: number | undefined;
22
23
  }
24
+ /**
25
+ * @public
26
+ */
23
27
  export interface BatchPutMetricsRequest {
24
28
  /**
25
29
  * <p>The name of the Trial Component to associate with the metrics.</p>
@@ -30,6 +34,9 @@ export interface BatchPutMetricsRequest {
30
34
  */
31
35
  MetricData: RawMetricData[] | undefined;
32
36
  }
37
+ /**
38
+ * @public
39
+ */
33
40
  export declare enum PutMetricsErrorCode {
34
41
  CONFLICT_ERROR = "CONFLICT_ERROR",
35
42
  INTERNAL_ERROR = "INTERNAL_ERROR",
@@ -37,6 +44,7 @@ export declare enum PutMetricsErrorCode {
37
44
  VALIDATION_ERROR = "VALIDATION_ERROR"
38
45
  }
39
46
  /**
47
+ * @public
40
48
  * <p>An error that occured when putting the metric data.</p>
41
49
  */
42
50
  export interface BatchPutMetricsError {
@@ -69,25 +77,12 @@ export interface BatchPutMetricsError {
69
77
  */
70
78
  MetricIndex?: number;
71
79
  }
80
+ /**
81
+ * @public
82
+ */
72
83
  export interface BatchPutMetricsResponse {
73
84
  /**
74
85
  * <p>Lists any errors that occur when inserting metric data.</p>
75
86
  */
76
87
  Errors?: BatchPutMetricsError[];
77
88
  }
78
- /**
79
- * @internal
80
- */
81
- export declare const RawMetricDataFilterSensitiveLog: (obj: RawMetricData) => any;
82
- /**
83
- * @internal
84
- */
85
- export declare const BatchPutMetricsRequestFilterSensitiveLog: (obj: BatchPutMetricsRequest) => any;
86
- /**
87
- * @internal
88
- */
89
- export declare const BatchPutMetricsErrorFilterSensitiveLog: (obj: BatchPutMetricsError) => any;
90
- /**
91
- * @internal
92
- */
93
- export declare const BatchPutMetricsResponseFilterSensitiveLog: (obj: BatchPutMetricsResponse) => any;
@@ -21,15 +21,3 @@ export interface BatchPutMetricsError {
21
21
  export interface BatchPutMetricsResponse {
22
22
  Errors?: BatchPutMetricsError[];
23
23
  }
24
- export declare const RawMetricDataFilterSensitiveLog: (
25
- obj: RawMetricData
26
- ) => any;
27
- export declare const BatchPutMetricsRequestFilterSensitiveLog: (
28
- obj: BatchPutMetricsRequest
29
- ) => any;
30
- export declare const BatchPutMetricsErrorFilterSensitiveLog: (
31
- obj: BatchPutMetricsError
32
- ) => any;
33
- export declare const BatchPutMetricsResponseFilterSensitiveLog: (
34
- obj: BatchPutMetricsResponse
35
- ) => any;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sagemaker-metrics",
3
3
  "description": "AWS SDK for JavaScript Sagemaker Metrics Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.298.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
11
11
  "build:types": "tsc -p tsconfig.types.json",
12
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
13
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
14
+ "extract:docs": "api-extractor run --local",
14
15
  "generate:client": "node ../../scripts/generate-clients/single-service --solo sagemaker-metrics"
15
16
  },
16
17
  "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
20
21
  "dependencies": {
21
22
  "@aws-crypto/sha256-browser": "3.0.0",
22
23
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/client-sts": "3.298.0",
24
25
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/credential-provider-node": "3.298.0",
26
27
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
28
  "@aws-sdk/hash-node": "3.296.0",
28
29
  "@aws-sdk/invalid-dependency": "3.296.0",