@aws-sdk/client-s3vectors 3.940.0 → 3.943.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 (41) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +113 -14
  3. package/dist-es/S3Vectors.js +6 -0
  4. package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
  5. package/dist-es/commands/TagResourceCommand.js +16 -0
  6. package/dist-es/commands/UntagResourceCommand.js +16 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/schemas/schemas_0.js +73 -14
  9. package/dist-types/S3Vectors.d.ts +21 -0
  10. package/dist-types/S3VectorsClient.d.ts +5 -2
  11. package/dist-types/commands/CreateIndexCommand.d.ts +8 -1
  12. package/dist-types/commands/CreateVectorBucketCommand.d.ts +4 -1
  13. package/dist-types/commands/DeleteIndexCommand.d.ts +4 -1
  14. package/dist-types/commands/DeleteVectorBucketCommand.d.ts +4 -1
  15. package/dist-types/commands/DeleteVectorBucketPolicyCommand.d.ts +1 -1
  16. package/dist-types/commands/DeleteVectorsCommand.d.ts +1 -1
  17. package/dist-types/commands/GetIndexCommand.d.ts +5 -1
  18. package/dist-types/commands/GetVectorBucketCommand.d.ts +1 -1
  19. package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts +1 -1
  20. package/dist-types/commands/GetVectorsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListIndexesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListTagsForResourceCommand.d.ts +97 -0
  23. package/dist-types/commands/ListVectorBucketsCommand.d.ts +1 -1
  24. package/dist-types/commands/ListVectorsCommand.d.ts +1 -1
  25. package/dist-types/commands/PutVectorBucketPolicyCommand.d.ts +1 -1
  26. package/dist-types/commands/PutVectorsCommand.d.ts +1 -1
  27. package/dist-types/commands/QueryVectorsCommand.d.ts +2 -7
  28. package/dist-types/commands/TagResourceCommand.d.ts +99 -0
  29. package/dist-types/commands/UntagResourceCommand.d.ts +99 -0
  30. package/dist-types/commands/index.d.ts +3 -0
  31. package/dist-types/models/models_0.d.ts +110 -35
  32. package/dist-types/schemas/schemas_0.d.ts +11 -0
  33. package/dist-types/ts3.4/S3Vectors.d.ts +51 -0
  34. package/dist-types/ts3.4/S3VectorsClient.d.ts +20 -2
  35. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  36. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  37. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +47 -0
  38. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  39. package/dist-types/ts3.4/models/models_0.d.ts +25 -6
  40. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  41. package/package.json +5 -5
@@ -1,7 +1,23 @@
1
1
  import { DocumentType as __DocumentType } from "@smithy/types";
2
2
  import { DataType, DistanceMetric, SseType } from "./enums";
3
3
  /**
4
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The metadata configuration for a vector index.</p>
4
+ * <p>The encryption configuration for a vector bucket or index. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.</p>
5
+ * @public
6
+ */
7
+ export interface EncryptionConfiguration {
8
+ /**
9
+ * <p>The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
10
+ * @public
11
+ */
12
+ sseType?: SseType | undefined;
13
+ /**
14
+ * <p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if <code>sseType</code> is set to <code>aws:kms</code>.</p> <p>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</p> <p>For example, specify Key ARN in the following format: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
15
+ * @public
16
+ */
17
+ kmsKeyArn?: string | undefined;
18
+ }
19
+ /**
20
+ * <p>The metadata configuration for a vector index.</p>
5
21
  * @public
6
22
  */
7
23
  export interface MetadataConfiguration {
@@ -50,6 +66,16 @@ export interface CreateIndexInput {
50
66
  * @public
51
67
  */
52
68
  metadataConfiguration?: MetadataConfiguration | undefined;
69
+ /**
70
+ * <p>The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.</p>
71
+ * @public
72
+ */
73
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
74
+ /**
75
+ * <p>An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateIndex</code> permission to create a vector index with tags.</p> </note>
76
+ * @public
77
+ */
78
+ tags?: Record<string, string> | undefined;
53
79
  }
54
80
  /**
55
81
  * @public
@@ -77,22 +103,6 @@ export interface ValidationExceptionField {
77
103
  */
78
104
  message: string | undefined;
79
105
  }
80
- /**
81
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The encryption configuration for a vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
82
- * @public
83
- */
84
- export interface EncryptionConfiguration {
85
- /**
86
- * <p>The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
87
- * @public
88
- */
89
- sseType?: SseType | undefined;
90
- /**
91
- * <p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if <code>sseType</code> is set to <code>aws:kms</code>.</p> <p>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</p> <p>For example, specify Key ARN in the following format: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
92
- * @public
93
- */
94
- kmsKeyArn?: string | undefined;
95
- }
96
106
  /**
97
107
  * @public
98
108
  */
@@ -107,6 +117,11 @@ export interface CreateVectorBucketInput {
107
117
  * @public
108
118
  */
109
119
  encryptionConfiguration?: EncryptionConfiguration | undefined;
120
+ /**
121
+ * <p>An array of user-defined tags that you would like to apply to the vector bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateVectorBucket</code> permission to create a vector bucket with tags.</p> </note>
122
+ * @public
123
+ */
124
+ tags?: Record<string, string> | undefined;
110
125
  }
111
126
  /**
112
127
  * @public
@@ -234,7 +249,7 @@ export interface GetIndexInput {
234
249
  indexArn?: string | undefined;
235
250
  }
236
251
  /**
237
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector index.</p>
252
+ * <p>The attributes of a vector index.</p>
238
253
  * @public
239
254
  */
240
255
  export interface Index {
@@ -278,6 +293,11 @@ export interface Index {
278
293
  * @public
279
294
  */
280
295
  metadataConfiguration?: MetadataConfiguration | undefined;
296
+ /**
297
+ * <p>The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.</p>
298
+ * @public
299
+ */
300
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
281
301
  }
282
302
  /**
283
303
  * @public
@@ -290,7 +310,7 @@ export interface GetIndexOutput {
290
310
  index: Index | undefined;
291
311
  }
292
312
  /**
293
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The vector data in different formats.</p>
313
+ * <p>The vector data in different formats.</p>
294
314
  * @public
295
315
  */
296
316
  export type VectorData = VectorData.Float32Member | VectorData.$UnknownMember;
@@ -323,7 +343,7 @@ export declare namespace VectorData {
323
343
  }
324
344
  }
325
345
  /**
326
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>GetVectors</code> operation.</p>
346
+ * <p>The attributes of a vector returned by the <code>GetVectors</code> operation.</p>
327
347
  * @public
328
348
  */
329
349
  export interface GetOutputVector {
@@ -359,7 +379,7 @@ export interface GetVectorBucketInput {
359
379
  vectorBucketArn?: string | undefined;
360
380
  }
361
381
  /**
362
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector bucket. </p>
382
+ * <p>The attributes of a vector bucket. </p>
363
383
  * @public
364
384
  */
365
385
  export interface VectorBucket {
@@ -495,7 +515,7 @@ export interface ListIndexesInput {
495
515
  prefix?: string | undefined;
496
516
  }
497
517
  /**
498
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector index.</p>
518
+ * <p>Summary information about a vector index.</p>
499
519
  * @public
500
520
  */
501
521
  export interface IndexSummary {
@@ -586,7 +606,7 @@ export interface ListVectorsInput {
586
606
  returnMetadata?: boolean | undefined;
587
607
  }
588
608
  /**
589
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>ListVectors</code> operation.</p>
609
+ * <p>The attributes of a vector returned by the <code>ListVectors</code> operation.</p>
590
610
  * @public
591
611
  */
592
612
  export interface ListOutputVector {
@@ -622,7 +642,7 @@ export interface ListVectorsOutput {
622
642
  vectors: ListOutputVector[] | undefined;
623
643
  }
624
644
  /**
625
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector to add to a vector index.</p>
645
+ * <p>The attributes of a vector to add to a vector index.</p>
626
646
  * @public
627
647
  */
628
648
  export interface PutInputVector {
@@ -718,30 +738,25 @@ export interface QueryVectorsInput {
718
738
  returnDistance?: boolean | undefined;
719
739
  }
720
740
  /**
721
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector in the approximate nearest neighbor search.</p>
741
+ * <p>The attributes of a vector in the approximate nearest neighbor search.</p>
722
742
  * @public
723
743
  */
724
744
  export interface QueryOutputVector {
725
745
  /**
726
- * <p>The key of the vector in the approximate nearest neighbor search.</p>
746
+ * <p>The measure of similarity between the vector in the response and the query vector.</p>
727
747
  * @public
728
748
  */
729
- key: string | undefined;
749
+ distance?: number | undefined;
730
750
  /**
731
- * <p>The vector data associated with the vector, if requested. </p>
751
+ * <p>The key of the vector in the approximate nearest neighbor search.</p>
732
752
  * @public
733
753
  */
734
- data?: VectorData | undefined;
754
+ key: string | undefined;
735
755
  /**
736
756
  * <p>The metadata associated with the vector, if requested.</p>
737
757
  * @public
738
758
  */
739
759
  metadata?: __DocumentType | undefined;
740
- /**
741
- * <p>The measure of similarity between the vector in the response and the query vector.</p>
742
- * @public
743
- */
744
- distance?: number | undefined;
745
760
  }
746
761
  /**
747
762
  * @public
@@ -758,6 +773,26 @@ export interface QueryVectorsOutput {
758
773
  */
759
774
  distanceMetric: DistanceMetric | undefined;
760
775
  }
776
+ /**
777
+ * @public
778
+ */
779
+ export interface ListTagsForResourceInput {
780
+ /**
781
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you want to list tags for. The tagged resource can be a vector bucket or a vector index. </p>
782
+ * @public
783
+ */
784
+ resourceArn: string | undefined;
785
+ }
786
+ /**
787
+ * @public
788
+ */
789
+ export interface ListTagsForResourceOutput {
790
+ /**
791
+ * <p>The user-defined tags that are applied to the S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
792
+ * @public
793
+ */
794
+ tags: Record<string, string> | undefined;
795
+ }
761
796
  /**
762
797
  * @public
763
798
  */
@@ -779,7 +814,7 @@ export interface ListVectorBucketsInput {
779
814
  prefix?: string | undefined;
780
815
  }
781
816
  /**
782
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector bucket.</p>
817
+ * <p>Summary information about a vector bucket.</p>
783
818
  * @public
784
819
  */
785
820
  export interface VectorBucketSummary {
@@ -839,3 +874,43 @@ export interface PutVectorBucketPolicyInput {
839
874
  */
840
875
  export interface PutVectorBucketPolicyOutput {
841
876
  }
877
+ /**
878
+ * @public
879
+ */
880
+ export interface TagResourceInput {
881
+ /**
882
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you're applying tags to. The tagged resource can be a vector bucket or a vector index. </p>
883
+ * @public
884
+ */
885
+ resourceArn: string | undefined;
886
+ /**
887
+ * <p>The user-defined tag that you want to add to the specified S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
888
+ * @public
889
+ */
890
+ tags: Record<string, string> | undefined;
891
+ }
892
+ /**
893
+ * @public
894
+ */
895
+ export interface TagResourceOutput {
896
+ }
897
+ /**
898
+ * @public
899
+ */
900
+ export interface UntagResourceInput {
901
+ /**
902
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you're removing tags from. The tagged resource can be a vector bucket or a vector index. </p>
903
+ * @public
904
+ */
905
+ resourceArn: string | undefined;
906
+ /**
907
+ * <p>The array of tag keys that you're removing from the S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
908
+ * @public
909
+ */
910
+ tagKeys: string[] | undefined;
911
+ }
912
+ /**
913
+ * @public
914
+ */
915
+ export interface UntagResourceOutput {
916
+ }
@@ -33,6 +33,8 @@ export declare var KmsNotFoundException: StaticErrorSchema;
33
33
  export declare var ListIndexesInput: StaticStructureSchema;
34
34
  export declare var ListIndexesOutput: StaticStructureSchema;
35
35
  export declare var ListOutputVector: StaticStructureSchema;
36
+ export declare var ListTagsForResourceInput: StaticStructureSchema;
37
+ export declare var ListTagsForResourceOutput: StaticStructureSchema;
36
38
  export declare var ListVectorBucketsInput: StaticStructureSchema;
37
39
  export declare var ListVectorBucketsOutput: StaticStructureSchema;
38
40
  export declare var ListVectorsInput: StaticStructureSchema;
@@ -50,7 +52,11 @@ export declare var QueryVectorsOutput: StaticStructureSchema;
50
52
  export declare var RequestTimeoutException: StaticErrorSchema;
51
53
  export declare var ServiceQuotaExceededException: StaticErrorSchema;
52
54
  export declare var ServiceUnavailableException: StaticErrorSchema;
55
+ export declare var TagResourceInput: StaticStructureSchema;
56
+ export declare var TagResourceOutput: StaticStructureSchema;
53
57
  export declare var TooManyRequestsException: StaticErrorSchema;
58
+ export declare var UntagResourceInput: StaticStructureSchema;
59
+ export declare var UntagResourceOutput: StaticStructureSchema;
54
60
  export declare var ValidationException: StaticErrorSchema;
55
61
  export declare var ValidationExceptionField: StaticStructureSchema;
56
62
  export declare var VectorBucket: StaticStructureSchema;
@@ -67,7 +73,9 @@ export declare var ListVectorsOutputList: StaticListSchema;
67
73
  export declare var NonFilterableMetadataKeys: number;
68
74
  export declare var PutVectorsInputList: StaticListSchema;
69
75
  export declare var QueryVectorsOutputList: StaticListSchema;
76
+ export declare var TagKeyList: number;
70
77
  export declare var ValidationExceptionFieldList: StaticListSchema;
78
+ export declare var TagsMap: number;
71
79
  export declare var VectorData: StaticStructureSchema;
72
80
  export declare var CreateIndex: StaticOperationSchema;
73
81
  export declare var CreateVectorBucket: StaticOperationSchema;
@@ -80,8 +88,11 @@ export declare var GetVectorBucket: StaticOperationSchema;
80
88
  export declare var GetVectorBucketPolicy: StaticOperationSchema;
81
89
  export declare var GetVectors: StaticOperationSchema;
82
90
  export declare var ListIndexes: StaticOperationSchema;
91
+ export declare var ListTagsForResource: StaticOperationSchema;
83
92
  export declare var ListVectorBuckets: StaticOperationSchema;
84
93
  export declare var ListVectors: StaticOperationSchema;
85
94
  export declare var PutVectorBucketPolicy: StaticOperationSchema;
86
95
  export declare var PutVectors: StaticOperationSchema;
87
96
  export declare var QueryVectors: StaticOperationSchema;
97
+ export declare var TagResource: StaticOperationSchema;
98
+ export declare var UntagResource: StaticOperationSchema;
@@ -43,6 +43,10 @@ import {
43
43
  ListIndexesCommandInput,
44
44
  ListIndexesCommandOutput,
45
45
  } from "./commands/ListIndexesCommand";
46
+ import {
47
+ ListTagsForResourceCommandInput,
48
+ ListTagsForResourceCommandOutput,
49
+ } from "./commands/ListTagsForResourceCommand";
46
50
  import {
47
51
  ListVectorBucketsCommandInput,
48
52
  ListVectorBucketsCommandOutput,
@@ -63,6 +67,14 @@ import {
63
67
  QueryVectorsCommandInput,
64
68
  QueryVectorsCommandOutput,
65
69
  } from "./commands/QueryVectorsCommand";
70
+ import {
71
+ TagResourceCommandInput,
72
+ TagResourceCommandOutput,
73
+ } from "./commands/TagResourceCommand";
74
+ import {
75
+ UntagResourceCommandInput,
76
+ UntagResourceCommandOutput,
77
+ } from "./commands/UntagResourceCommand";
66
78
  import { S3VectorsClient } from "./S3VectorsClient";
67
79
  export interface S3Vectors {
68
80
  createIndex(
@@ -215,6 +227,19 @@ export interface S3Vectors {
215
227
  options: __HttpHandlerOptions,
216
228
  cb: (err: any, data?: ListIndexesCommandOutput) => void
217
229
  ): void;
230
+ listTagsForResource(
231
+ args: ListTagsForResourceCommandInput,
232
+ options?: __HttpHandlerOptions
233
+ ): Promise<ListTagsForResourceCommandOutput>;
234
+ listTagsForResource(
235
+ args: ListTagsForResourceCommandInput,
236
+ cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
237
+ ): void;
238
+ listTagsForResource(
239
+ args: ListTagsForResourceCommandInput,
240
+ options: __HttpHandlerOptions,
241
+ cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
242
+ ): void;
218
243
  listVectorBuckets(): Promise<ListVectorBucketsCommandOutput>;
219
244
  listVectorBuckets(
220
245
  args: ListVectorBucketsCommandInput,
@@ -282,5 +307,31 @@ export interface S3Vectors {
282
307
  options: __HttpHandlerOptions,
283
308
  cb: (err: any, data?: QueryVectorsCommandOutput) => void
284
309
  ): void;
310
+ tagResource(
311
+ args: TagResourceCommandInput,
312
+ options?: __HttpHandlerOptions
313
+ ): Promise<TagResourceCommandOutput>;
314
+ tagResource(
315
+ args: TagResourceCommandInput,
316
+ cb: (err: any, data?: TagResourceCommandOutput) => void
317
+ ): void;
318
+ tagResource(
319
+ args: TagResourceCommandInput,
320
+ options: __HttpHandlerOptions,
321
+ cb: (err: any, data?: TagResourceCommandOutput) => void
322
+ ): void;
323
+ untagResource(
324
+ args: UntagResourceCommandInput,
325
+ options?: __HttpHandlerOptions
326
+ ): Promise<UntagResourceCommandOutput>;
327
+ untagResource(
328
+ args: UntagResourceCommandInput,
329
+ cb: (err: any, data?: UntagResourceCommandOutput) => void
330
+ ): void;
331
+ untagResource(
332
+ args: UntagResourceCommandInput,
333
+ options: __HttpHandlerOptions,
334
+ cb: (err: any, data?: UntagResourceCommandOutput) => void
335
+ ): void;
285
336
  }
286
337
  export declare class S3Vectors extends S3VectorsClient implements S3Vectors {}
@@ -92,6 +92,10 @@ import {
92
92
  ListIndexesCommandInput,
93
93
  ListIndexesCommandOutput,
94
94
  } from "./commands/ListIndexesCommand";
95
+ import {
96
+ ListTagsForResourceCommandInput,
97
+ ListTagsForResourceCommandOutput,
98
+ } from "./commands/ListTagsForResourceCommand";
95
99
  import {
96
100
  ListVectorBucketsCommandInput,
97
101
  ListVectorBucketsCommandOutput,
@@ -112,6 +116,14 @@ import {
112
116
  QueryVectorsCommandInput,
113
117
  QueryVectorsCommandOutput,
114
118
  } from "./commands/QueryVectorsCommand";
119
+ import {
120
+ TagResourceCommandInput,
121
+ TagResourceCommandOutput,
122
+ } from "./commands/TagResourceCommand";
123
+ import {
124
+ UntagResourceCommandInput,
125
+ UntagResourceCommandOutput,
126
+ } from "./commands/UntagResourceCommand";
115
127
  import {
116
128
  ClientInputEndpointParameters,
117
129
  ClientResolvedEndpointParameters,
@@ -131,11 +143,14 @@ export type ServiceInputTypes =
131
143
  | GetVectorBucketPolicyCommandInput
132
144
  | GetVectorsCommandInput
133
145
  | ListIndexesCommandInput
146
+ | ListTagsForResourceCommandInput
134
147
  | ListVectorBucketsCommandInput
135
148
  | ListVectorsCommandInput
136
149
  | PutVectorBucketPolicyCommandInput
137
150
  | PutVectorsCommandInput
138
- | QueryVectorsCommandInput;
151
+ | QueryVectorsCommandInput
152
+ | TagResourceCommandInput
153
+ | UntagResourceCommandInput;
139
154
  export type ServiceOutputTypes =
140
155
  | CreateIndexCommandOutput
141
156
  | CreateVectorBucketCommandOutput
@@ -148,11 +163,14 @@ export type ServiceOutputTypes =
148
163
  | GetVectorBucketPolicyCommandOutput
149
164
  | GetVectorsCommandOutput
150
165
  | ListIndexesCommandOutput
166
+ | ListTagsForResourceCommandOutput
151
167
  | ListVectorBucketsCommandOutput
152
168
  | ListVectorsCommandOutput
153
169
  | PutVectorBucketPolicyCommandOutput
154
170
  | PutVectorsCommandOutput
155
- | QueryVectorsCommandOutput;
171
+ | QueryVectorsCommandOutput
172
+ | TagResourceCommandOutput
173
+ | UntagResourceCommandOutput;
156
174
  export interface ClientDefaults
157
175
  extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
158
176
  requestHandler?: __HttpHandlerUserInput;
@@ -0,0 +1,51 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import {
4
+ ListTagsForResourceInput,
5
+ ListTagsForResourceOutput,
6
+ } from "../models/models_0";
7
+ import {
8
+ S3VectorsClientResolvedConfig,
9
+ ServiceInputTypes,
10
+ ServiceOutputTypes,
11
+ } from "../S3VectorsClient";
12
+ export { __MetadataBearer };
13
+ export { $Command };
14
+ export interface ListTagsForResourceCommandInput
15
+ extends ListTagsForResourceInput {}
16
+ export interface ListTagsForResourceCommandOutput
17
+ extends ListTagsForResourceOutput,
18
+ __MetadataBearer {}
19
+ declare const ListTagsForResourceCommand_base: {
20
+ new (
21
+ input: ListTagsForResourceCommandInput
22
+ ): import("@smithy/smithy-client").CommandImpl<
23
+ ListTagsForResourceCommandInput,
24
+ ListTagsForResourceCommandOutput,
25
+ S3VectorsClientResolvedConfig,
26
+ ServiceInputTypes,
27
+ ServiceOutputTypes
28
+ >;
29
+ new (
30
+ input: ListTagsForResourceCommandInput
31
+ ): import("@smithy/smithy-client").CommandImpl<
32
+ ListTagsForResourceCommandInput,
33
+ ListTagsForResourceCommandOutput,
34
+ S3VectorsClientResolvedConfig,
35
+ ServiceInputTypes,
36
+ ServiceOutputTypes
37
+ >;
38
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
39
+ };
40
+ export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
41
+ protected static __types: {
42
+ api: {
43
+ input: ListTagsForResourceInput;
44
+ output: ListTagsForResourceOutput;
45
+ };
46
+ sdk: {
47
+ input: ListTagsForResourceCommandInput;
48
+ output: ListTagsForResourceCommandOutput;
49
+ };
50
+ };
51
+ }
@@ -0,0 +1,47 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { TagResourceInput, TagResourceOutput } from "../models/models_0";
4
+ import {
5
+ S3VectorsClientResolvedConfig,
6
+ ServiceInputTypes,
7
+ ServiceOutputTypes,
8
+ } from "../S3VectorsClient";
9
+ export { __MetadataBearer };
10
+ export { $Command };
11
+ export interface TagResourceCommandInput extends TagResourceInput {}
12
+ export interface TagResourceCommandOutput
13
+ extends TagResourceOutput,
14
+ __MetadataBearer {}
15
+ declare const TagResourceCommand_base: {
16
+ new (
17
+ input: TagResourceCommandInput
18
+ ): import("@smithy/smithy-client").CommandImpl<
19
+ TagResourceCommandInput,
20
+ TagResourceCommandOutput,
21
+ S3VectorsClientResolvedConfig,
22
+ ServiceInputTypes,
23
+ ServiceOutputTypes
24
+ >;
25
+ new (
26
+ input: TagResourceCommandInput
27
+ ): import("@smithy/smithy-client").CommandImpl<
28
+ TagResourceCommandInput,
29
+ TagResourceCommandOutput,
30
+ S3VectorsClientResolvedConfig,
31
+ ServiceInputTypes,
32
+ ServiceOutputTypes
33
+ >;
34
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
+ };
36
+ export declare class TagResourceCommand extends TagResourceCommand_base {
37
+ protected static __types: {
38
+ api: {
39
+ input: TagResourceInput;
40
+ output: {};
41
+ };
42
+ sdk: {
43
+ input: TagResourceCommandInput;
44
+ output: TagResourceCommandOutput;
45
+ };
46
+ };
47
+ }
@@ -0,0 +1,47 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
4
+ import {
5
+ S3VectorsClientResolvedConfig,
6
+ ServiceInputTypes,
7
+ ServiceOutputTypes,
8
+ } from "../S3VectorsClient";
9
+ export { __MetadataBearer };
10
+ export { $Command };
11
+ export interface UntagResourceCommandInput extends UntagResourceInput {}
12
+ export interface UntagResourceCommandOutput
13
+ extends UntagResourceOutput,
14
+ __MetadataBearer {}
15
+ declare const UntagResourceCommand_base: {
16
+ new (
17
+ input: UntagResourceCommandInput
18
+ ): import("@smithy/smithy-client").CommandImpl<
19
+ UntagResourceCommandInput,
20
+ UntagResourceCommandOutput,
21
+ S3VectorsClientResolvedConfig,
22
+ ServiceInputTypes,
23
+ ServiceOutputTypes
24
+ >;
25
+ new (
26
+ input: UntagResourceCommandInput
27
+ ): import("@smithy/smithy-client").CommandImpl<
28
+ UntagResourceCommandInput,
29
+ UntagResourceCommandOutput,
30
+ S3VectorsClientResolvedConfig,
31
+ ServiceInputTypes,
32
+ ServiceOutputTypes
33
+ >;
34
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
+ };
36
+ export declare class UntagResourceCommand extends UntagResourceCommand_base {
37
+ protected static __types: {
38
+ api: {
39
+ input: UntagResourceInput;
40
+ output: {};
41
+ };
42
+ sdk: {
43
+ input: UntagResourceCommandInput;
44
+ output: UntagResourceCommandOutput;
45
+ };
46
+ };
47
+ }
@@ -9,8 +9,11 @@ export * from "./GetVectorBucketCommand";
9
9
  export * from "./GetVectorBucketPolicyCommand";
10
10
  export * from "./GetVectorsCommand";
11
11
  export * from "./ListIndexesCommand";
12
+ export * from "./ListTagsForResourceCommand";
12
13
  export * from "./ListVectorBucketsCommand";
13
14
  export * from "./ListVectorsCommand";
14
15
  export * from "./PutVectorBucketPolicyCommand";
15
16
  export * from "./PutVectorsCommand";
16
17
  export * from "./QueryVectorsCommand";
18
+ export * from "./TagResourceCommand";
19
+ export * from "./UntagResourceCommand";
@@ -1,5 +1,9 @@
1
1
  import { DocumentType as __DocumentType } from "@smithy/types";
2
2
  import { DataType, DistanceMetric, SseType } from "./enums";
3
+ export interface EncryptionConfiguration {
4
+ sseType?: SseType | undefined;
5
+ kmsKeyArn?: string | undefined;
6
+ }
3
7
  export interface MetadataConfiguration {
4
8
  nonFilterableMetadataKeys: string[] | undefined;
5
9
  }
@@ -11,6 +15,8 @@ export interface CreateIndexInput {
11
15
  dimension: number | undefined;
12
16
  distanceMetric: DistanceMetric | undefined;
13
17
  metadataConfiguration?: MetadataConfiguration | undefined;
18
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
19
+ tags?: Record<string, string> | undefined;
14
20
  }
15
21
  export interface CreateIndexOutput {
16
22
  indexArn: string | undefined;
@@ -19,13 +25,10 @@ export interface ValidationExceptionField {
19
25
  path: string | undefined;
20
26
  message: string | undefined;
21
27
  }
22
- export interface EncryptionConfiguration {
23
- sseType?: SseType | undefined;
24
- kmsKeyArn?: string | undefined;
25
- }
26
28
  export interface CreateVectorBucketInput {
27
29
  vectorBucketName: string | undefined;
28
30
  encryptionConfiguration?: EncryptionConfiguration | undefined;
31
+ tags?: Record<string, string> | undefined;
29
32
  }
30
33
  export interface CreateVectorBucketOutput {
31
34
  vectorBucketArn: string | undefined;
@@ -67,6 +70,7 @@ export interface Index {
67
70
  dimension: number | undefined;
68
71
  distanceMetric: DistanceMetric | undefined;
69
72
  metadataConfiguration?: MetadataConfiguration | undefined;
73
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
70
74
  }
71
75
  export interface GetIndexOutput {
72
76
  index: Index | undefined;
@@ -182,15 +186,20 @@ export interface QueryVectorsInput {
182
186
  returnDistance?: boolean | undefined;
183
187
  }
184
188
  export interface QueryOutputVector {
189
+ distance?: number | undefined;
185
190
  key: string | undefined;
186
- data?: VectorData | undefined;
187
191
  metadata?: __DocumentType | undefined;
188
- distance?: number | undefined;
189
192
  }
190
193
  export interface QueryVectorsOutput {
191
194
  vectors: QueryOutputVector[] | undefined;
192
195
  distanceMetric: DistanceMetric | undefined;
193
196
  }
197
+ export interface ListTagsForResourceInput {
198
+ resourceArn: string | undefined;
199
+ }
200
+ export interface ListTagsForResourceOutput {
201
+ tags: Record<string, string> | undefined;
202
+ }
194
203
  export interface ListVectorBucketsInput {
195
204
  maxResults?: number | undefined;
196
205
  nextToken?: string | undefined;
@@ -211,3 +220,13 @@ export interface PutVectorBucketPolicyInput {
211
220
  policy: string | undefined;
212
221
  }
213
222
  export interface PutVectorBucketPolicyOutput {}
223
+ export interface TagResourceInput {
224
+ resourceArn: string | undefined;
225
+ tags: Record<string, string> | undefined;
226
+ }
227
+ export interface TagResourceOutput {}
228
+ export interface UntagResourceInput {
229
+ resourceArn: string | undefined;
230
+ tagKeys: string[] | undefined;
231
+ }
232
+ export interface UntagResourceOutput {}