@aws-sdk/client-sagemaker-runtime 3.379.1 → 3.382.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.
@@ -32,11 +32,13 @@ export declare class InternalFailure extends __BaseException {
32
32
  */
33
33
  export interface InvokeEndpointInput {
34
34
  /**
35
+ * @public
35
36
  * <p>The name of the endpoint that you specified when you created the endpoint using the
36
37
  * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html">CreateEndpoint</a> API. </p>
37
38
  */
38
39
  EndpointName: string | undefined;
39
40
  /**
41
+ * @public
40
42
  * <p>Provides input data, in the format specified in the <code>ContentType</code>
41
43
  * request header. Amazon SageMaker passes all of the data in the body to the model. </p>
42
44
  * <p>For information about the format of the request body, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html">Common Data
@@ -44,14 +46,17 @@ export interface InvokeEndpointInput {
44
46
  */
45
47
  Body: Uint8Array | undefined;
46
48
  /**
49
+ * @public
47
50
  * <p>The MIME type of the input data in the request body.</p>
48
51
  */
49
52
  ContentType?: string;
50
53
  /**
54
+ * @public
51
55
  * <p>The desired MIME type of the inference in the response.</p>
52
56
  */
53
57
  Accept?: string;
54
58
  /**
59
+ * @public
55
60
  * <p>Provides additional information about a request for an inference submitted to a model
56
61
  * hosted at an Amazon SageMaker endpoint. The information is an opaque value that is
57
62
  * forwarded verbatim. You could use this value, for example, to provide an ID that you can
@@ -69,10 +74,12 @@ export interface InvokeEndpointInput {
69
74
  */
70
75
  CustomAttributes?: string;
71
76
  /**
77
+ * @public
72
78
  * <p>The model to request for inference when invoking a multi-model endpoint.</p>
73
79
  */
74
80
  TargetModel?: string;
75
81
  /**
82
+ * @public
76
83
  * <p>Specify the production variant to send the inference request to when invoking an
77
84
  * endpoint that is running two or more variants. Note that this parameter overrides the
78
85
  * default behavior for the endpoint, which is to distribute the invocation traffic based
@@ -83,17 +90,20 @@ export interface InvokeEndpointInput {
83
90
  */
84
91
  TargetVariant?: string;
85
92
  /**
93
+ * @public
86
94
  * <p>If the endpoint hosts multiple containers and is configured to use direct invocation,
87
95
  * this parameter specifies the host name of the container to invoke.</p>
88
96
  */
89
97
  TargetContainerHostname?: string;
90
98
  /**
99
+ * @public
91
100
  * <p>If you provide a value, it is added to the captured data when you enable data capture
92
101
  * on the endpoint. For information about data capture, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html">Capture
93
102
  * Data</a>.</p>
94
103
  */
95
104
  InferenceId?: string;
96
105
  /**
106
+ * @public
97
107
  * <p>An optional JMESPath expression used to override the <code>EnableExplanations</code>
98
108
  * parameter of the <code>ClarifyExplainerConfig</code> API. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable">EnableExplanations</a> section in the developer guide for more information.
99
109
  * </p>
@@ -105,6 +115,7 @@ export interface InvokeEndpointInput {
105
115
  */
106
116
  export interface InvokeEndpointOutput {
107
117
  /**
118
+ * @public
108
119
  * <p>Includes the inference provided by the model. </p>
109
120
  * <p>For information about the format of the response body, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html">Common Data
110
121
  * Formats-Inference</a>.</p>
@@ -114,14 +125,17 @@ export interface InvokeEndpointOutput {
114
125
  */
115
126
  Body: Uint8Array | undefined;
116
127
  /**
128
+ * @public
117
129
  * <p>The MIME type of the inference returned in the response body.</p>
118
130
  */
119
131
  ContentType?: string;
120
132
  /**
133
+ * @public
121
134
  * <p>Identifies the production variant that was invoked.</p>
122
135
  */
123
136
  InvokedProductionVariant?: string;
124
137
  /**
138
+ * @public
125
139
  * <p>Provides additional information in the response about the inference returned by a
126
140
  * model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is
127
141
  * forwarded verbatim. You could use this value, for example, to return an ID received in
@@ -151,14 +165,17 @@ export declare class ModelError extends __BaseException {
151
165
  readonly $fault: "client";
152
166
  Message?: string;
153
167
  /**
168
+ * @public
154
169
  * <p> Original status code. </p>
155
170
  */
156
171
  OriginalStatusCode?: number;
157
172
  /**
173
+ * @public
158
174
  * <p> Original message. </p>
159
175
  */
160
176
  OriginalMessage?: string;
161
177
  /**
178
+ * @public
162
179
  * <p> The Amazon Resource Name (ARN) of the log stream. </p>
163
180
  */
164
181
  LogStreamArn?: string;
@@ -213,6 +230,7 @@ export declare class ValidationError extends __BaseException {
213
230
  */
214
231
  export interface InvokeEndpointAsyncInput {
215
232
  /**
233
+ * @public
216
234
  * <p>The name of the endpoint that you specified when you created the endpoint using the
217
235
  * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">
218
236
  * <code>CreateEndpoint</code>
@@ -220,14 +238,17 @@ export interface InvokeEndpointAsyncInput {
220
238
  */
221
239
  EndpointName: string | undefined;
222
240
  /**
241
+ * @public
223
242
  * <p>The MIME type of the input data in the request body.</p>
224
243
  */
225
244
  ContentType?: string;
226
245
  /**
246
+ * @public
227
247
  * <p>The desired MIME type of the inference in the response.</p>
228
248
  */
229
249
  Accept?: string;
230
250
  /**
251
+ * @public
231
252
  * <p>Provides additional information about a request for an inference submitted to a model
232
253
  * hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded
233
254
  * verbatim. You could use this value, for example, to provide an ID that you can use to
@@ -245,20 +266,24 @@ export interface InvokeEndpointAsyncInput {
245
266
  */
246
267
  CustomAttributes?: string;
247
268
  /**
269
+ * @public
248
270
  * <p>The identifier for the inference request. Amazon SageMaker will generate an identifier for you if
249
271
  * none is specified. </p>
250
272
  */
251
273
  InferenceId?: string;
252
274
  /**
275
+ * @public
253
276
  * <p>The Amazon S3 URI where the inference request payload is stored.</p>
254
277
  */
255
278
  InputLocation: string | undefined;
256
279
  /**
280
+ * @public
257
281
  * <p>Maximum age in seconds a request can be in the queue before it is marked as
258
282
  * expired. The default is 6 hours, or 21,600 seconds.</p>
259
283
  */
260
284
  RequestTTLSeconds?: number;
261
285
  /**
286
+ * @public
262
287
  * <p>Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.</p>
263
288
  */
264
289
  InvocationTimeoutSeconds?: number;
@@ -268,16 +293,19 @@ export interface InvokeEndpointAsyncInput {
268
293
  */
269
294
  export interface InvokeEndpointAsyncOutput {
270
295
  /**
296
+ * @public
271
297
  * <p>Identifier for an inference request. This will be the same as the
272
298
  * <code>InferenceId</code> specified in the input. Amazon SageMaker will generate an identifier
273
299
  * for you if you do not specify one.</p>
274
300
  */
275
301
  InferenceId?: string;
276
302
  /**
303
+ * @public
277
304
  * <p>The Amazon S3 URI where the inference response payload is stored.</p>
278
305
  */
279
306
  OutputLocation?: string;
280
307
  /**
308
+ * @public
281
309
  * <p>The Amazon S3 URI where the inference failure response payload is stored.</p>
282
310
  */
283
311
  FailureLocation?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sagemaker-runtime",
3
3
  "description": "AWS SDK for JavaScript Sagemaker Runtime Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.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",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",