@aws-sdk/client-sagemaker-featurestore-runtime 3.378.0 → 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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -31,6 +31,7 @@
31
31
  */
32
32
  export * from "./SageMakerFeatureStoreRuntimeClient";
33
33
  export * from "./SageMakerFeatureStoreRuntime";
34
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
34
35
  export * from "./commands";
35
36
  export * from "./models";
36
37
  export { SageMakerFeatureStoreRuntimeServiceException } from "./models/SageMakerFeatureStoreRuntimeServiceException";
@@ -32,15 +32,18 @@ export type ExpirationTimeResponse = (typeof ExpirationTimeResponse)[keyof typeo
32
32
  */
33
33
  export interface BatchGetRecordIdentifier {
34
34
  /**
35
+ * @public
35
36
  * <p>The name or Amazon Resource Name (ARN) of the <code>FeatureGroup</code> containing the
36
37
  * records you are retrieving in a batch.</p>
37
38
  */
38
39
  FeatureGroupName: string | undefined;
39
40
  /**
41
+ * @public
40
42
  * <p>The value for a list of record identifiers in string format.</p>
41
43
  */
42
44
  RecordIdentifiersValueAsString: string[] | undefined;
43
45
  /**
46
+ * @public
44
47
  * <p>List of names of Features to be retrieved. If not specified, the latest value for all
45
48
  * the Features are returned.</p>
46
49
  */
@@ -51,12 +54,14 @@ export interface BatchGetRecordIdentifier {
51
54
  */
52
55
  export interface BatchGetRecordRequest {
53
56
  /**
57
+ * @public
54
58
  * <p>A list containing the name or Amazon Resource Name (ARN) of the
55
59
  * <code>FeatureGroup</code>, the list of names of <code>Feature</code>s to be retrieved,
56
60
  * and the corresponding <code>RecordIdentifier</code> values as strings.</p>
57
61
  */
58
62
  Identifiers: BatchGetRecordIdentifier[] | undefined;
59
63
  /**
64
+ * @public
60
65
  * <p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>,
61
66
  * <code>BatchGetRecord</code> will return the value of <code>ExpiresAt</code>, if it is
62
67
  * not null. If <code>Disabled</code> and null, <code>BatchGetRecord</code> will return
@@ -70,21 +75,25 @@ export interface BatchGetRecordRequest {
70
75
  */
71
76
  export interface BatchGetRecordError {
72
77
  /**
78
+ * @public
73
79
  * <p>The name of the feature group that the record belongs to.</p>
74
80
  */
75
81
  FeatureGroupName: string | undefined;
76
82
  /**
83
+ * @public
77
84
  * <p>The value for the <code>RecordIdentifier</code> in string format of a Record from a
78
85
  * <code>FeatureGroup</code> that is causing an error when attempting to be
79
86
  * retrieved.</p>
80
87
  */
81
88
  RecordIdentifierValueAsString: string | undefined;
82
89
  /**
90
+ * @public
83
91
  * <p>The error code of an error that has occurred when attempting to retrieve a batch of
84
92
  * Records. For more information on errors, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors">Errors</a>.</p>
85
93
  */
86
94
  ErrorCode: string | undefined;
87
95
  /**
96
+ * @public
88
97
  * <p>The error message of an error that has occurred when attempting to retrieve a record in
89
98
  * the batch.</p>
90
99
  */
@@ -96,10 +105,12 @@ export interface BatchGetRecordError {
96
105
  */
97
106
  export interface FeatureValue {
98
107
  /**
108
+ * @public
99
109
  * <p>The name of a feature that a feature value corresponds to.</p>
100
110
  */
101
111
  FeatureName: string | undefined;
102
112
  /**
113
+ * @public
103
114
  * <p>The value associated with a feature, in string format. Note that features types can be
104
115
  * String, Integral, or Fractional. This value represents all three types as a string.</p>
105
116
  */
@@ -111,18 +122,22 @@ export interface FeatureValue {
111
122
  */
112
123
  export interface BatchGetRecordResultDetail {
113
124
  /**
125
+ * @public
114
126
  * <p>The <code>FeatureGroupName</code> containing Records you retrieved in a batch.</p>
115
127
  */
116
128
  FeatureGroupName: string | undefined;
117
129
  /**
130
+ * @public
118
131
  * <p>The value of the record identifier in string format.</p>
119
132
  */
120
133
  RecordIdentifierValueAsString: string | undefined;
121
134
  /**
135
+ * @public
122
136
  * <p>The <code>Record</code> retrieved.</p>
123
137
  */
124
138
  Record: FeatureValue[] | undefined;
125
139
  /**
140
+ * @public
126
141
  * <p>The <code>ExpiresAt</code> ISO string of the requested record.</p>
127
142
  */
128
143
  ExpiresAt?: string;
@@ -132,14 +147,17 @@ export interface BatchGetRecordResultDetail {
132
147
  */
133
148
  export interface BatchGetRecordResponse {
134
149
  /**
150
+ * @public
135
151
  * <p>A list of Records you requested to be retrieved in batch.</p>
136
152
  */
137
153
  Records: BatchGetRecordResultDetail[] | undefined;
138
154
  /**
155
+ * @public
139
156
  * <p>A list of errors that have occurred when retrieving a batch of Records.</p>
140
157
  */
141
158
  Errors: BatchGetRecordError[] | undefined;
142
159
  /**
160
+ * @public
143
161
  * <p>A unprocessed list of <code>FeatureGroup</code> names, with their corresponding
144
162
  * <code>RecordIdentifier</code> value, and Feature name.</p>
145
163
  */
@@ -214,27 +232,32 @@ export type TargetStore = (typeof TargetStore)[keyof typeof TargetStore];
214
232
  */
215
233
  export interface DeleteRecordRequest {
216
234
  /**
235
+ * @public
217
236
  * <p>The name or Amazon Resource Name (ARN) of the feature group to delete the record from.
218
237
  * </p>
219
238
  */
220
239
  FeatureGroupName: string | undefined;
221
240
  /**
241
+ * @public
222
242
  * <p>The value for the <code>RecordIdentifier</code> that uniquely identifies the record, in
223
243
  * string format. </p>
224
244
  */
225
245
  RecordIdentifierValueAsString: string | undefined;
226
246
  /**
247
+ * @public
227
248
  * <p>Timestamp indicating when the deletion event occurred. <code>EventTime</code> can be
228
249
  * used to query data at a certain point in time.</p>
229
250
  */
230
251
  EventTime: string | undefined;
231
252
  /**
253
+ * @public
232
254
  * <p>A list of stores from which you're deleting the record. By default, Feature Store
233
255
  * deletes the record from all of the stores that you're using for the
234
256
  * <code>FeatureGroup</code>.</p>
235
257
  */
236
258
  TargetStores?: (TargetStore | string)[];
237
259
  /**
260
+ * @public
238
261
  * <p>The name of the deletion mode for deleting the record. By default, the deletion mode is
239
262
  * set to <code>SoftDelete</code>.</p>
240
263
  */
@@ -245,21 +268,25 @@ export interface DeleteRecordRequest {
245
268
  */
246
269
  export interface GetRecordRequest {
247
270
  /**
271
+ * @public
248
272
  * <p>The name or Amazon Resource Name (ARN) of the feature group from which you want to
249
273
  * retrieve a record.</p>
250
274
  */
251
275
  FeatureGroupName: string | undefined;
252
276
  /**
277
+ * @public
253
278
  * <p>The value that corresponds to <code>RecordIdentifier</code> type and uniquely identifies
254
279
  * the record in the <code>FeatureGroup</code>. </p>
255
280
  */
256
281
  RecordIdentifierValueAsString: string | undefined;
257
282
  /**
283
+ * @public
258
284
  * <p>List of names of Features to be retrieved. If not specified, the latest value for all
259
285
  * the Features are returned.</p>
260
286
  */
261
287
  FeatureNames?: string[];
262
288
  /**
289
+ * @public
263
290
  * <p>Parameter to request <code>ExpiresAt</code> in response. If <code>Enabled</code>,
264
291
  * <code>GetRecord</code> will return the value of <code>ExpiresAt</code>, if it is not
265
292
  * null. If <code>Disabled</code> and null, <code>GetRecord</code> will return null.</p>
@@ -271,10 +298,12 @@ export interface GetRecordRequest {
271
298
  */
272
299
  export interface GetRecordResponse {
273
300
  /**
301
+ * @public
274
302
  * <p>The record you requested. A list of <code>FeatureValues</code>.</p>
275
303
  */
276
304
  Record?: FeatureValue[];
277
305
  /**
306
+ * @public
278
307
  * <p>The <code>ExpiresAt</code> ISO string of the requested record.</p>
279
308
  */
280
309
  ExpiresAt?: string;
@@ -315,11 +344,13 @@ export type TtlDurationUnit = (typeof TtlDurationUnit)[keyof typeof TtlDurationU
315
344
  */
316
345
  export interface TtlDuration {
317
346
  /**
347
+ * @public
318
348
  * <p>
319
349
  * <code>TtlDuration</code> time unit.</p>
320
350
  */
321
351
  Unit: TtlDurationUnit | string | undefined;
322
352
  /**
353
+ * @public
323
354
  * <p>
324
355
  * <code>TtlDuration</code> time value.</p>
325
356
  */
@@ -330,11 +361,13 @@ export interface TtlDuration {
330
361
  */
331
362
  export interface PutRecordRequest {
332
363
  /**
364
+ * @public
333
365
  * <p>The name or Amazon Resource Name (ARN) of the feature group that you want to insert the
334
366
  * record into.</p>
335
367
  */
336
368
  FeatureGroupName: string | undefined;
337
369
  /**
370
+ * @public
338
371
  * <p>List of FeatureValues to be inserted. This will be a full over-write. If you only want
339
372
  * to update few of the feature values, do the following:</p>
340
373
  * <ul>
@@ -351,11 +384,13 @@ export interface PutRecordRequest {
351
384
  */
352
385
  Record: FeatureValue[] | undefined;
353
386
  /**
387
+ * @public
354
388
  * <p>A list of stores to which you're adding the record. By default, Feature Store adds the
355
389
  * record to all of the stores that you're using for the <code>FeatureGroup</code>.</p>
356
390
  */
357
391
  TargetStores?: (TargetStore | string)[];
358
392
  /**
393
+ * @public
359
394
  * <p>Time to live duration, where the record is hard deleted after the expiration time is
360
395
  * reached; <code>ExpiresAt</code> = <code>EventTime</code> + <code>TtlDuration</code>. For
361
396
  * information on HardDelete, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html">DeleteRecord</a> API in the Amazon SageMaker API Reference guide.</p>
@@ -1,5 +1,6 @@
1
1
  export * from "./SageMakerFeatureStoreRuntimeClient";
2
2
  export * from "./SageMakerFeatureStoreRuntime";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./models";
5
6
  export { SageMakerFeatureStoreRuntimeServiceException } from "./models/SageMakerFeatureStoreRuntimeServiceException";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sagemaker-featurestore-runtime",
3
3
  "description": "AWS SDK for JavaScript Sagemaker Featurestore Runtime Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
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
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "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",