@aws-sdk/client-dynamodb 3.1101.0 → 3.1103.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.
Files changed (56) hide show
  1. package/README.md +7 -0
  2. package/dist-cjs/index.js +329 -146
  3. package/dist-es/DynamoDB.js +2 -0
  4. package/dist-es/commandBuilder.js +5 -1
  5. package/dist-es/commands/SearchVectorsCommand.js +4 -0
  6. package/dist-es/commands/TransactGetItemsCommand.js +2 -2
  7. package/dist-es/commands/TransactWriteItemsCommand.js +2 -2
  8. package/dist-es/commands/index.js +1 -0
  9. package/dist-es/endpoint/bdd.js +136 -108
  10. package/dist-es/endpoint/endpointResolver.js +1 -0
  11. package/dist-es/models/enums.js +9 -0
  12. package/dist-es/runtimeConfig.shared.js +2 -2
  13. package/dist-es/schemas/schemas_0.js +153 -32
  14. package/dist-types/DynamoDB.d.ts +7 -0
  15. package/dist-types/DynamoDBClient.d.ts +3 -2
  16. package/dist-types/commandBuilder.d.ts +4 -0
  17. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +6 -0
  18. package/dist-types/commands/BatchGetItemCommand.d.ts +6 -0
  19. package/dist-types/commands/BatchWriteItemCommand.d.ts +12 -7
  20. package/dist-types/commands/CreateTableCommand.d.ts +49 -0
  21. package/dist-types/commands/DeleteBackupCommand.d.ts +22 -0
  22. package/dist-types/commands/DeleteItemCommand.d.ts +6 -0
  23. package/dist-types/commands/DeleteTableCommand.d.ts +27 -0
  24. package/dist-types/commands/DescribeBackupCommand.d.ts +22 -0
  25. package/dist-types/commands/DescribeImportCommand.d.ts +22 -0
  26. package/dist-types/commands/DescribeTableCommand.d.ts +27 -0
  27. package/dist-types/commands/ExecuteStatementCommand.d.ts +6 -0
  28. package/dist-types/commands/ExecuteTransactionCommand.d.ts +10 -1
  29. package/dist-types/commands/GetItemCommand.d.ts +6 -0
  30. package/dist-types/commands/ImportTableCommand.d.ts +44 -0
  31. package/dist-types/commands/PutItemCommand.d.ts +6 -0
  32. package/dist-types/commands/QueryCommand.d.ts +6 -0
  33. package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +49 -0
  34. package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +49 -0
  35. package/dist-types/commands/ScanCommand.d.ts +6 -0
  36. package/dist-types/commands/SearchVectorsCommand.d.ts +295 -0
  37. package/dist-types/commands/TransactGetItemsCommand.d.ts +10 -1
  38. package/dist-types/commands/TransactWriteItemsCommand.d.ts +10 -1
  39. package/dist-types/commands/UpdateItemCommand.d.ts +6 -0
  40. package/dist-types/commands/UpdateTableCommand.d.ts +54 -0
  41. package/dist-types/commands/index.d.ts +1 -0
  42. package/dist-types/endpoint/EndpointParameters.d.ts +1 -0
  43. package/dist-types/models/enums.d.ts +25 -0
  44. package/dist-types/models/errors.d.ts +4 -1
  45. package/dist-types/models/models_0.d.ts +631 -4
  46. package/dist-types/schemas/schemas_0.d.ts +13 -0
  47. package/dist-types/ts3.4/DynamoDB.d.ts +17 -0
  48. package/dist-types/ts3.4/DynamoDBClient.d.ts +6 -0
  49. package/dist-types/ts3.4/commandBuilder.d.ts +1 -0
  50. package/dist-types/ts3.4/commands/SearchVectorsCommand.d.ts +38 -0
  51. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  52. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -0
  53. package/dist-types/ts3.4/models/enums.d.ts +13 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +84 -0
  55. package/dist-types/ts3.4/schemas/schemas_0.d.ts +13 -0
  56. package/package.json +4 -4
@@ -235,6 +235,33 @@ declare const DeleteTableCommand_base: {
235
235
  * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
236
236
  * // },
237
237
  * // MultiRegionConsistency: "EVENTUAL" || "STRONG",
238
+ * // VectorIndexes: [ // VectorIndexDescriptionList
239
+ * // { // VectorIndexDescription
240
+ * // IndexName: "STRING_VALUE",
241
+ * // SearchSchema: [ // SearchSchema
242
+ * // { // SearchSchemaElement
243
+ * // AttributeName: "STRING_VALUE", // required
244
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
245
+ * // },
246
+ * // ],
247
+ * // Projection: {
248
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
249
+ * // NonKeyAttributes: [
250
+ * // "STRING_VALUE",
251
+ * // ],
252
+ * // },
253
+ * // VectorAttribute: { // VectorAttributeDefinition
254
+ * // AttributeName: "STRING_VALUE", // required
255
+ * // },
256
+ * // Dimensions: Number("long"),
257
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN",
258
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
259
+ * // Backfilling: true || false,
260
+ * // IndexSizeBytes: Number("long"),
261
+ * // ItemCount: Number("long"),
262
+ * // IndexArn: "STRING_VALUE",
263
+ * // },
264
+ * // ],
238
265
  * // },
239
266
  * // };
240
267
  *
@@ -131,6 +131,28 @@ declare const DescribeBackupCommand_base: {
131
131
  * // KMSMasterKeyArn: "STRING_VALUE",
132
132
  * // InaccessibleEncryptionDateTime: new Date("TIMESTAMP"),
133
133
  * // },
134
+ * // VectorIndexes: [ // VectorIndexes
135
+ * // { // VectorIndexInfo
136
+ * // IndexName: "STRING_VALUE",
137
+ * // VectorAttribute: { // VectorAttributeDefinition
138
+ * // AttributeName: "STRING_VALUE", // required
139
+ * // },
140
+ * // SearchSchema: [ // SearchSchema
141
+ * // { // SearchSchemaElement
142
+ * // AttributeName: "STRING_VALUE", // required
143
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
144
+ * // },
145
+ * // ],
146
+ * // Projection: {
147
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
148
+ * // NonKeyAttributes: [
149
+ * // "STRING_VALUE",
150
+ * // ],
151
+ * // },
152
+ * // Dimensions: Number("long"),
153
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN",
154
+ * // },
155
+ * // ],
134
156
  * // },
135
157
  * // },
136
158
  * // };
@@ -119,6 +119,28 @@ declare const DescribeImportCommand_base: {
119
119
  * // },
120
120
  * // },
121
121
  * // ],
122
+ * // VectorIndexes: [ // VectorIndexList
123
+ * // { // VectorIndex
124
+ * // IndexName: "STRING_VALUE", // required
125
+ * // VectorAttribute: { // VectorAttributeDefinition
126
+ * // AttributeName: "STRING_VALUE", // required
127
+ * // },
128
+ * // SearchSchema: [ // SearchSchema
129
+ * // { // SearchSchemaElement
130
+ * // AttributeName: "STRING_VALUE", // required
131
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
132
+ * // },
133
+ * // ],
134
+ * // Projection: {
135
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
136
+ * // NonKeyAttributes: [
137
+ * // "STRING_VALUE",
138
+ * // ],
139
+ * // },
140
+ * // Dimensions: Number("long"), // required
141
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN", // required
142
+ * // },
143
+ * // ],
122
144
  * // },
123
145
  * // StartTime: new Date("TIMESTAMP"),
124
146
  * // EndTime: new Date("TIMESTAMP"),
@@ -226,6 +226,33 @@ declare const DescribeTableCommand_base: {
226
226
  * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
227
227
  * // },
228
228
  * // MultiRegionConsistency: "EVENTUAL" || "STRONG",
229
+ * // VectorIndexes: [ // VectorIndexDescriptionList
230
+ * // { // VectorIndexDescription
231
+ * // IndexName: "STRING_VALUE",
232
+ * // SearchSchema: [ // SearchSchema
233
+ * // { // SearchSchemaElement
234
+ * // AttributeName: "STRING_VALUE", // required
235
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
236
+ * // },
237
+ * // ],
238
+ * // Projection: {
239
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
240
+ * // NonKeyAttributes: [
241
+ * // "STRING_VALUE",
242
+ * // ],
243
+ * // },
244
+ * // VectorAttribute: { // VectorAttributeDefinition
245
+ * // AttributeName: "STRING_VALUE", // required
246
+ * // },
247
+ * // Dimensions: Number("long"),
248
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN",
249
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
250
+ * // Backfilling: true || false,
251
+ * // IndexSizeBytes: Number("long"),
252
+ * // ItemCount: Number("long"),
253
+ * // IndexArn: "STRING_VALUE",
254
+ * // },
255
+ * // ],
229
256
  * // },
230
257
  * // };
231
258
  *
@@ -173,6 +173,12 @@ declare const ExecuteStatementCommand_base: {
173
173
  * // CapacityUnits: Number("double"),
174
174
  * // },
175
175
  * // },
176
+ * // VectorIndexes: { // VectorIndexesCapacityMap
177
+ * // "<keys>": { // VectorCapacity
178
+ * // VectorSearchRequestBytes: Number("double"),
179
+ * // VectorWriteRequestBytes: Number("double"),
180
+ * // },
181
+ * // },
176
182
  * // },
177
183
  * // LastEvaluatedKey: { // Key
178
184
  * // "<keys>": "<AttributeValue>",
@@ -172,6 +172,12 @@ declare const ExecuteTransactionCommand_base: {
172
172
  * // CapacityUnits: Number("double"),
173
173
  * // },
174
174
  * // },
175
+ * // VectorIndexes: { // VectorIndexesCapacityMap
176
+ * // "<keys>": { // VectorCapacity
177
+ * // VectorSearchRequestBytes: Number("double"),
178
+ * // VectorWriteRequestBytes: Number("double"),
179
+ * // },
180
+ * // },
175
181
  * // },
176
182
  * // ],
177
183
  * // };
@@ -274,7 +280,10 @@ declare const ExecuteTransactionCommand_base: {
274
280
  * <p>DynamoDB lists the cancellation reasons on the
275
281
  * <code>CancellationReasons</code> property. Transaction cancellation reasons are ordered in the order of requested
276
282
  * items, if an item has no error it will have <code>None</code> code and
277
- * <code>Null</code> message.</p>
283
+ * <code>Null</code> message. The <code>None</code> code is returned as the literal
284
+ * string <code>"None"</code>, not a null or absent value; the message field is omitted
285
+ * entirely for an item that has no error. This is important to note when using an SDK
286
+ * that surfaces the code as an optional or nullable type.</p>
278
287
  * </note>
279
288
  * <p>Cancellation reason codes and possible error messages:</p>
280
289
  * <ul>
@@ -169,6 +169,12 @@ declare const GetItemCommand_base: {
169
169
  * // CapacityUnits: Number("double"),
170
170
  * // },
171
171
  * // },
172
+ * // VectorIndexes: { // VectorIndexesCapacityMap
173
+ * // "<keys>": { // VectorCapacity
174
+ * // VectorSearchRequestBytes: Number("double"),
175
+ * // VectorWriteRequestBytes: Number("double"),
176
+ * // },
177
+ * // },
172
178
  * // },
173
179
  * // };
174
180
  *
@@ -107,6 +107,28 @@ declare const ImportTableCommand_base: {
107
107
  * },
108
108
  * },
109
109
  * ],
110
+ * VectorIndexes: [ // VectorIndexList
111
+ * { // VectorIndex
112
+ * IndexName: "STRING_VALUE", // required
113
+ * VectorAttribute: { // VectorAttributeDefinition
114
+ * AttributeName: "STRING_VALUE", // required
115
+ * },
116
+ * SearchSchema: [ // SearchSchema
117
+ * { // SearchSchemaElement
118
+ * AttributeName: "STRING_VALUE", // required
119
+ * SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
120
+ * },
121
+ * ],
122
+ * Projection: {
123
+ * ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
124
+ * NonKeyAttributes: [
125
+ * "STRING_VALUE",
126
+ * ],
127
+ * },
128
+ * Dimensions: Number("long"), // required
129
+ * DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN", // required
130
+ * },
131
+ * ],
110
132
  * },
111
133
  * };
112
134
  * const command = new ImportTableCommand(input);
@@ -192,6 +214,28 @@ declare const ImportTableCommand_base: {
192
214
  * // },
193
215
  * // },
194
216
  * // ],
217
+ * // VectorIndexes: [ // VectorIndexList
218
+ * // { // VectorIndex
219
+ * // IndexName: "STRING_VALUE", // required
220
+ * // VectorAttribute: { // VectorAttributeDefinition
221
+ * // AttributeName: "STRING_VALUE", // required
222
+ * // },
223
+ * // SearchSchema: [ // SearchSchema
224
+ * // { // SearchSchemaElement
225
+ * // AttributeName: "STRING_VALUE", // required
226
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
227
+ * // },
228
+ * // ],
229
+ * // Projection: {
230
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
231
+ * // NonKeyAttributes: [
232
+ * // "STRING_VALUE",
233
+ * // ],
234
+ * // },
235
+ * // Dimensions: Number("long"), // required
236
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN", // required
237
+ * // },
238
+ * // ],
195
239
  * // },
196
240
  * // StartTime: new Date("TIMESTAMP"),
197
241
  * // EndTime: new Date("TIMESTAMP"),
@@ -200,6 +200,12 @@ declare const PutItemCommand_base: {
200
200
  * // CapacityUnits: Number("double"),
201
201
  * // },
202
202
  * // },
203
+ * // VectorIndexes: { // VectorIndexesCapacityMap
204
+ * // "<keys>": { // VectorCapacity
205
+ * // VectorSearchRequestBytes: Number("double"),
206
+ * // VectorWriteRequestBytes: Number("double"),
207
+ * // },
208
+ * // },
203
209
  * // },
204
210
  * // ItemCollectionMetrics: { // ItemCollectionMetrics
205
211
  * // ItemCollectionKey: { // ItemCollectionKeyAttributeMap
@@ -245,6 +245,12 @@ declare const QueryCommand_base: {
245
245
  * // CapacityUnits: Number("double"),
246
246
  * // },
247
247
  * // },
248
+ * // VectorIndexes: { // VectorIndexesCapacityMap
249
+ * // "<keys>": { // VectorCapacity
250
+ * // VectorSearchRequestBytes: Number("double"),
251
+ * // VectorWriteRequestBytes: Number("double"),
252
+ * // },
253
+ * // },
248
254
  * // },
249
255
  * // };
250
256
  *
@@ -120,6 +120,28 @@ declare const RestoreTableFromBackupCommand_base: {
120
120
  * SSEType: "AES256" || "KMS",
121
121
  * KMSMasterKeyId: "STRING_VALUE",
122
122
  * },
123
+ * VectorIndexOverride: [ // VectorIndexList
124
+ * { // VectorIndex
125
+ * IndexName: "STRING_VALUE", // required
126
+ * VectorAttribute: { // VectorAttributeDefinition
127
+ * AttributeName: "STRING_VALUE", // required
128
+ * },
129
+ * SearchSchema: [ // SearchSchema
130
+ * { // SearchSchemaElement
131
+ * AttributeName: "STRING_VALUE", // required
132
+ * SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
133
+ * },
134
+ * ],
135
+ * Projection: {
136
+ * ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
137
+ * NonKeyAttributes: [
138
+ * "STRING_VALUE",
139
+ * ],
140
+ * },
141
+ * Dimensions: Number("long"), // required
142
+ * DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN", // required
143
+ * },
144
+ * ],
123
145
  * };
124
146
  * const command = new RestoreTableFromBackupCommand(input);
125
147
  * const response = await client.send(command);
@@ -302,6 +324,33 @@ declare const RestoreTableFromBackupCommand_base: {
302
324
  * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
303
325
  * // },
304
326
  * // MultiRegionConsistency: "EVENTUAL" || "STRONG",
327
+ * // VectorIndexes: [ // VectorIndexDescriptionList
328
+ * // { // VectorIndexDescription
329
+ * // IndexName: "STRING_VALUE",
330
+ * // SearchSchema: [ // SearchSchema
331
+ * // { // SearchSchemaElement
332
+ * // AttributeName: "STRING_VALUE", // required
333
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
334
+ * // },
335
+ * // ],
336
+ * // Projection: {
337
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
338
+ * // NonKeyAttributes: [
339
+ * // "STRING_VALUE",
340
+ * // ],
341
+ * // },
342
+ * // VectorAttribute: { // VectorAttributeDefinition
343
+ * // AttributeName: "STRING_VALUE", // required
344
+ * // },
345
+ * // Dimensions: Number("long"),
346
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN",
347
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
348
+ * // Backfilling: true || false,
349
+ * // IndexSizeBytes: Number("long"),
350
+ * // ItemCount: Number("long"),
351
+ * // IndexArn: "STRING_VALUE",
352
+ * // },
353
+ * // ],
305
354
  * // },
306
355
  * // };
307
356
  *
@@ -149,6 +149,28 @@ declare const RestoreTableToPointInTimeCommand_base: {
149
149
  * SSEType: "AES256" || "KMS",
150
150
  * KMSMasterKeyId: "STRING_VALUE",
151
151
  * },
152
+ * VectorIndexOverride: [ // VectorIndexList
153
+ * { // VectorIndex
154
+ * IndexName: "STRING_VALUE", // required
155
+ * VectorAttribute: { // VectorAttributeDefinition
156
+ * AttributeName: "STRING_VALUE", // required
157
+ * },
158
+ * SearchSchema: [ // SearchSchema
159
+ * { // SearchSchemaElement
160
+ * AttributeName: "STRING_VALUE", // required
161
+ * SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
162
+ * },
163
+ * ],
164
+ * Projection: {
165
+ * ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
166
+ * NonKeyAttributes: [
167
+ * "STRING_VALUE",
168
+ * ],
169
+ * },
170
+ * Dimensions: Number("long"), // required
171
+ * DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN", // required
172
+ * },
173
+ * ],
152
174
  * };
153
175
  * const command = new RestoreTableToPointInTimeCommand(input);
154
176
  * const response = await client.send(command);
@@ -331,6 +353,33 @@ declare const RestoreTableToPointInTimeCommand_base: {
331
353
  * // Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED",
332
354
  * // },
333
355
  * // MultiRegionConsistency: "EVENTUAL" || "STRONG",
356
+ * // VectorIndexes: [ // VectorIndexDescriptionList
357
+ * // { // VectorIndexDescription
358
+ * // IndexName: "STRING_VALUE",
359
+ * // SearchSchema: [ // SearchSchema
360
+ * // { // SearchSchemaElement
361
+ * // AttributeName: "STRING_VALUE", // required
362
+ * // SearchSchemaElementType: "HASH" || "INLINE_FILTER", // required
363
+ * // },
364
+ * // ],
365
+ * // Projection: {
366
+ * // ProjectionType: "ALL" || "KEYS_ONLY" || "INCLUDE",
367
+ * // NonKeyAttributes: [
368
+ * // "STRING_VALUE",
369
+ * // ],
370
+ * // },
371
+ * // VectorAttribute: { // VectorAttributeDefinition
372
+ * // AttributeName: "STRING_VALUE", // required
373
+ * // },
374
+ * // Dimensions: Number("long"),
375
+ * // DistanceFunction: "COSINE" || "DOT_PRODUCT" || "EUCLIDEAN",
376
+ * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
377
+ * // Backfilling: true || false,
378
+ * // IndexSizeBytes: Number("long"),
379
+ * // ItemCount: Number("long"),
380
+ * // IndexArn: "STRING_VALUE",
381
+ * // },
382
+ * // ],
334
383
  * // },
335
384
  * // };
336
385
  *
@@ -229,6 +229,12 @@ declare const ScanCommand_base: {
229
229
  * // CapacityUnits: Number("double"),
230
230
  * // },
231
231
  * // },
232
+ * // VectorIndexes: { // VectorIndexesCapacityMap
233
+ * // "<keys>": { // VectorCapacity
234
+ * // VectorSearchRequestBytes: Number("double"),
235
+ * // VectorWriteRequestBytes: Number("double"),
236
+ * // },
237
+ * // },
232
238
  * // },
233
239
  * // };
234
240
  *