@aws-sdk/client-s3vectors 3.845.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 (163) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +333 -0
  3. package/dist-cjs/S3Vectors.js +43 -0
  4. package/dist-cjs/S3VectorsClient.js +52 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/CreateIndexCommand.js +26 -0
  8. package/dist-cjs/commands/CreateVectorBucketCommand.js +26 -0
  9. package/dist-cjs/commands/DeleteIndexCommand.js +26 -0
  10. package/dist-cjs/commands/DeleteVectorBucketCommand.js +26 -0
  11. package/dist-cjs/commands/DeleteVectorBucketPolicyCommand.js +26 -0
  12. package/dist-cjs/commands/DeleteVectorsCommand.js +26 -0
  13. package/dist-cjs/commands/GetIndexCommand.js +26 -0
  14. package/dist-cjs/commands/GetVectorBucketCommand.js +26 -0
  15. package/dist-cjs/commands/GetVectorBucketPolicyCommand.js +26 -0
  16. package/dist-cjs/commands/GetVectorsCommand.js +26 -0
  17. package/dist-cjs/commands/ListIndexesCommand.js +26 -0
  18. package/dist-cjs/commands/ListVectorBucketsCommand.js +26 -0
  19. package/dist-cjs/commands/ListVectorsCommand.js +26 -0
  20. package/dist-cjs/commands/PutVectorBucketPolicyCommand.js +26 -0
  21. package/dist-cjs/commands/PutVectorsCommand.js +26 -0
  22. package/dist-cjs/commands/QueryVectorsCommand.js +26 -0
  23. package/dist-cjs/commands/index.js +19 -0
  24. package/dist-cjs/endpoint/EndpointParameters.js +15 -0
  25. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  26. package/dist-cjs/endpoint/ruleset.js +7 -0
  27. package/dist-cjs/extensionConfiguration.js +2 -0
  28. package/dist-cjs/index.js +11 -0
  29. package/dist-cjs/models/S3VectorsServiceException.js +12 -0
  30. package/dist-cjs/models/index.js +4 -0
  31. package/dist-cjs/models/models_0.js +186 -0
  32. package/dist-cjs/pagination/Interfaces.js +2 -0
  33. package/dist-cjs/pagination/ListIndexesPaginator.js +7 -0
  34. package/dist-cjs/pagination/ListVectorBucketsPaginator.js +7 -0
  35. package/dist-cjs/pagination/ListVectorsPaginator.js +7 -0
  36. package/dist-cjs/pagination/index.js +7 -0
  37. package/dist-cjs/protocols/Aws_restJson1.js +858 -0
  38. package/dist-cjs/runtimeConfig.browser.js +39 -0
  39. package/dist-cjs/runtimeConfig.js +56 -0
  40. package/dist-cjs/runtimeConfig.native.js +15 -0
  41. package/dist-cjs/runtimeConfig.shared.js +34 -0
  42. package/dist-cjs/runtimeExtensions.js +13 -0
  43. package/dist-es/S3Vectors.js +39 -0
  44. package/dist-es/S3VectorsClient.js +48 -0
  45. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  46. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  47. package/dist-es/commands/CreateIndexCommand.js +22 -0
  48. package/dist-es/commands/CreateVectorBucketCommand.js +22 -0
  49. package/dist-es/commands/DeleteIndexCommand.js +22 -0
  50. package/dist-es/commands/DeleteVectorBucketCommand.js +22 -0
  51. package/dist-es/commands/DeleteVectorBucketPolicyCommand.js +22 -0
  52. package/dist-es/commands/DeleteVectorsCommand.js +22 -0
  53. package/dist-es/commands/GetIndexCommand.js +22 -0
  54. package/dist-es/commands/GetVectorBucketCommand.js +22 -0
  55. package/dist-es/commands/GetVectorBucketPolicyCommand.js +22 -0
  56. package/dist-es/commands/GetVectorsCommand.js +22 -0
  57. package/dist-es/commands/ListIndexesCommand.js +22 -0
  58. package/dist-es/commands/ListVectorBucketsCommand.js +22 -0
  59. package/dist-es/commands/ListVectorsCommand.js +22 -0
  60. package/dist-es/commands/PutVectorBucketPolicyCommand.js +22 -0
  61. package/dist-es/commands/PutVectorsCommand.js +22 -0
  62. package/dist-es/commands/QueryVectorsCommand.js +22 -0
  63. package/dist-es/commands/index.js +16 -0
  64. package/dist-es/endpoint/EndpointParameters.js +11 -0
  65. package/dist-es/endpoint/endpointResolver.js +14 -0
  66. package/dist-es/endpoint/ruleset.js +4 -0
  67. package/dist-es/extensionConfiguration.js +1 -0
  68. package/dist-es/index.js +6 -0
  69. package/dist-es/models/S3VectorsServiceException.js +8 -0
  70. package/dist-es/models/index.js +1 -0
  71. package/dist-es/models/models_0.js +171 -0
  72. package/dist-es/pagination/Interfaces.js +1 -0
  73. package/dist-es/pagination/ListIndexesPaginator.js +4 -0
  74. package/dist-es/pagination/ListVectorBucketsPaginator.js +4 -0
  75. package/dist-es/pagination/ListVectorsPaginator.js +4 -0
  76. package/dist-es/pagination/index.js +4 -0
  77. package/dist-es/protocols/Aws_restJson1.js +823 -0
  78. package/dist-es/runtimeConfig.browser.js +34 -0
  79. package/dist-es/runtimeConfig.js +51 -0
  80. package/dist-es/runtimeConfig.native.js +11 -0
  81. package/dist-es/runtimeConfig.shared.js +30 -0
  82. package/dist-es/runtimeExtensions.js +9 -0
  83. package/dist-types/S3Vectors.d.ts +131 -0
  84. package/dist-types/S3VectorsClient.d.ts +203 -0
  85. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  86. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  87. package/dist-types/commands/CreateIndexCommand.d.ts +104 -0
  88. package/dist-types/commands/CreateVectorBucketCommand.d.ts +95 -0
  89. package/dist-types/commands/DeleteIndexCommand.d.ts +90 -0
  90. package/dist-types/commands/DeleteVectorBucketCommand.d.ts +92 -0
  91. package/dist-types/commands/DeleteVectorBucketPolicyCommand.d.ts +92 -0
  92. package/dist-types/commands/DeleteVectorsCommand.d.ts +108 -0
  93. package/dist-types/commands/GetIndexCommand.d.ts +108 -0
  94. package/dist-types/commands/GetVectorBucketCommand.d.ts +102 -0
  95. package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts +94 -0
  96. package/dist-types/commands/GetVectorsCommand.d.ts +122 -0
  97. package/dist-types/commands/ListIndexesCommand.d.ts +105 -0
  98. package/dist-types/commands/ListVectorBucketsCommand.d.ts +99 -0
  99. package/dist-types/commands/ListVectorsCommand.d.ts +112 -0
  100. package/dist-types/commands/PutVectorBucketPolicyCommand.d.ts +93 -0
  101. package/dist-types/commands/PutVectorsCommand.d.ts +116 -0
  102. package/dist-types/commands/QueryVectorsCommand.d.ts +127 -0
  103. package/dist-types/commands/index.d.ts +16 -0
  104. package/dist-types/endpoint/EndpointParameters.d.ts +32 -0
  105. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  106. package/dist-types/endpoint/ruleset.d.ts +2 -0
  107. package/dist-types/extensionConfiguration.d.ts +9 -0
  108. package/dist-types/index.d.ts +14 -0
  109. package/dist-types/models/S3VectorsServiceException.d.ts +14 -0
  110. package/dist-types/models/index.d.ts +1 -0
  111. package/dist-types/models/models_0.d.ts +1013 -0
  112. package/dist-types/pagination/Interfaces.d.ts +8 -0
  113. package/dist-types/pagination/ListIndexesPaginator.d.ts +7 -0
  114. package/dist-types/pagination/ListVectorBucketsPaginator.d.ts +7 -0
  115. package/dist-types/pagination/ListVectorsPaginator.d.ts +7 -0
  116. package/dist-types/pagination/index.d.ts +4 -0
  117. package/dist-types/protocols/Aws_restJson1.d.ts +146 -0
  118. package/dist-types/runtimeConfig.browser.d.ts +50 -0
  119. package/dist-types/runtimeConfig.d.ts +50 -0
  120. package/dist-types/runtimeConfig.native.d.ts +49 -0
  121. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  122. package/dist-types/runtimeExtensions.d.ts +17 -0
  123. package/dist-types/ts3.4/S3Vectors.d.ts +286 -0
  124. package/dist-types/ts3.4/S3VectorsClient.d.ts +215 -0
  125. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  126. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  127. package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +47 -0
  128. package/dist-types/ts3.4/commands/CreateVectorBucketCommand.d.ts +51 -0
  129. package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +47 -0
  130. package/dist-types/ts3.4/commands/DeleteVectorBucketCommand.d.ts +51 -0
  131. package/dist-types/ts3.4/commands/DeleteVectorBucketPolicyCommand.d.ts +51 -0
  132. package/dist-types/ts3.4/commands/DeleteVectorsCommand.d.ts +47 -0
  133. package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +47 -0
  134. package/dist-types/ts3.4/commands/GetVectorBucketCommand.d.ts +50 -0
  135. package/dist-types/ts3.4/commands/GetVectorBucketPolicyCommand.d.ts +51 -0
  136. package/dist-types/ts3.4/commands/GetVectorsCommand.d.ts +47 -0
  137. package/dist-types/ts3.4/commands/ListIndexesCommand.d.ts +47 -0
  138. package/dist-types/ts3.4/commands/ListVectorBucketsCommand.d.ts +50 -0
  139. package/dist-types/ts3.4/commands/ListVectorsCommand.d.ts +47 -0
  140. package/dist-types/ts3.4/commands/PutVectorBucketPolicyCommand.d.ts +51 -0
  141. package/dist-types/ts3.4/commands/PutVectorsCommand.d.ts +47 -0
  142. package/dist-types/ts3.4/commands/QueryVectorsCommand.d.ts +47 -0
  143. package/dist-types/ts3.4/commands/index.d.ts +16 -0
  144. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  145. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  146. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  147. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  148. package/dist-types/ts3.4/index.d.ts +9 -0
  149. package/dist-types/ts3.4/models/S3VectorsServiceException.d.ts +9 -0
  150. package/dist-types/ts3.4/models/index.d.ts +1 -0
  151. package/dist-types/ts3.4/models/models_0.d.ts +311 -0
  152. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  153. package/dist-types/ts3.4/pagination/ListIndexesPaginator.d.ts +11 -0
  154. package/dist-types/ts3.4/pagination/ListVectorBucketsPaginator.d.ts +11 -0
  155. package/dist-types/ts3.4/pagination/ListVectorsPaginator.d.ts +11 -0
  156. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  157. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +197 -0
  158. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
  159. package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
  160. package/dist-types/ts3.4/runtimeConfig.native.d.ts +95 -0
  161. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  162. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  163. package/package.json +99 -0
@@ -0,0 +1,16 @@
1
+ export * from "./CreateIndexCommand";
2
+ export * from "./CreateVectorBucketCommand";
3
+ export * from "./DeleteIndexCommand";
4
+ export * from "./DeleteVectorBucketCommand";
5
+ export * from "./DeleteVectorBucketPolicyCommand";
6
+ export * from "./DeleteVectorsCommand";
7
+ export * from "./GetIndexCommand";
8
+ export * from "./GetVectorBucketCommand";
9
+ export * from "./GetVectorBucketPolicyCommand";
10
+ export * from "./GetVectorsCommand";
11
+ export * from "./ListIndexesCommand";
12
+ export * from "./ListVectorBucketsCommand";
13
+ export * from "./ListVectorsCommand";
14
+ export * from "./PutVectorBucketPolicyCommand";
15
+ export * from "./PutVectorsCommand";
16
+ export * from "./QueryVectorsCommand";
@@ -0,0 +1,45 @@
1
+ import {
2
+ Endpoint,
3
+ EndpointParameters as __EndpointParameters,
4
+ EndpointV2,
5
+ Provider,
6
+ } from "@smithy/types";
7
+ export interface ClientInputEndpointParameters {
8
+ useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
9
+ endpoint?:
10
+ | string
11
+ | Provider<string>
12
+ | Endpoint
13
+ | Provider<Endpoint>
14
+ | EndpointV2
15
+ | Provider<EndpointV2>;
16
+ region?: string | undefined | Provider<string | undefined>;
17
+ }
18
+ export type ClientResolvedEndpointParameters = Pick<
19
+ ClientInputEndpointParameters,
20
+ Exclude<keyof ClientInputEndpointParameters, "endpoint">
21
+ > & {
22
+ defaultSigningName: string;
23
+ };
24
+ export declare const resolveClientEndpointParameters: <T>(
25
+ options: T & ClientInputEndpointParameters
26
+ ) => T & ClientResolvedEndpointParameters;
27
+ export declare const commonParams: {
28
+ readonly UseFIPS: {
29
+ readonly type: "builtInParams";
30
+ readonly name: "useFipsEndpoint";
31
+ };
32
+ readonly Endpoint: {
33
+ readonly type: "builtInParams";
34
+ readonly name: "endpoint";
35
+ };
36
+ readonly Region: {
37
+ readonly type: "builtInParams";
38
+ readonly name: "region";
39
+ };
40
+ };
41
+ export interface EndpointParameters extends __EndpointParameters {
42
+ UseFIPS?: boolean | undefined;
43
+ Endpoint?: string | undefined;
44
+ Region?: string | undefined;
45
+ }
@@ -0,0 +1,8 @@
1
+ import { EndpointV2, Logger } from "@smithy/types";
2
+ import { EndpointParameters } from "./EndpointParameters";
3
+ export declare const defaultEndpointResolver: (
4
+ endpointParams: EndpointParameters,
5
+ context?: {
6
+ logger?: Logger;
7
+ }
8
+ ) => EndpointV2;
@@ -0,0 +1,2 @@
1
+ import { RuleSetObject } from "@smithy/types";
2
+ export declare const ruleSet: RuleSetObject;
@@ -0,0 +1,9 @@
1
+ import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
+ import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
+ import { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
5
+ export interface S3VectorsExtensionConfiguration
6
+ extends HttpHandlerExtensionConfiguration,
7
+ DefaultExtensionConfiguration,
8
+ AwsRegionExtensionConfiguration,
9
+ HttpAuthExtensionConfiguration {}
@@ -0,0 +1,9 @@
1
+ export * from "./S3VectorsClient";
2
+ export * from "./S3Vectors";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
4
+ export { RuntimeExtension } from "./runtimeExtensions";
5
+ export { S3VectorsExtensionConfiguration } from "./extensionConfiguration";
6
+ export * from "./commands";
7
+ export * from "./pagination";
8
+ export * from "./models";
9
+ export { S3VectorsServiceException } from "./models/S3VectorsServiceException";
@@ -0,0 +1,9 @@
1
+ import {
2
+ ServiceException as __ServiceException,
3
+ ServiceExceptionOptions as __ServiceExceptionOptions,
4
+ } from "@smithy/smithy-client";
5
+ export { __ServiceExceptionOptions };
6
+ export { __ServiceException };
7
+ export declare class S3VectorsServiceException extends __ServiceException {
8
+ constructor(options: __ServiceExceptionOptions);
9
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";
@@ -0,0 +1,311 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { DocumentType as __DocumentType } from "@smithy/types";
3
+ import { S3VectorsServiceException as __BaseException } from "./S3VectorsServiceException";
4
+ export declare class AccessDeniedException extends __BaseException {
5
+ readonly name: "AccessDeniedException";
6
+ readonly $fault: "client";
7
+ constructor(
8
+ opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
9
+ );
10
+ }
11
+ export declare class ConflictException extends __BaseException {
12
+ readonly name: "ConflictException";
13
+ readonly $fault: "client";
14
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
15
+ }
16
+ export declare const DataType: {
17
+ readonly FLOAT32: "float32";
18
+ };
19
+ export type DataType = (typeof DataType)[keyof typeof DataType];
20
+ export declare const DistanceMetric: {
21
+ readonly COSINE: "cosine";
22
+ readonly EUCLIDEAN: "euclidean";
23
+ };
24
+ export type DistanceMetric =
25
+ (typeof DistanceMetric)[keyof typeof DistanceMetric];
26
+ export interface MetadataConfiguration {
27
+ nonFilterableMetadataKeys: string[] | undefined;
28
+ }
29
+ export interface CreateIndexInput {
30
+ vectorBucketName?: string | undefined;
31
+ vectorBucketArn?: string | undefined;
32
+ indexName: string | undefined;
33
+ dataType: DataType | undefined;
34
+ dimension: number | undefined;
35
+ distanceMetric: DistanceMetric | undefined;
36
+ metadataConfiguration?: MetadataConfiguration | undefined;
37
+ }
38
+ export interface CreateIndexOutput {}
39
+ export declare class InternalServerException extends __BaseException {
40
+ readonly name: "InternalServerException";
41
+ readonly $fault: "server";
42
+ $retryable: {};
43
+ constructor(
44
+ opts: __ExceptionOptionType<InternalServerException, __BaseException>
45
+ );
46
+ }
47
+ export declare class NotFoundException extends __BaseException {
48
+ readonly name: "NotFoundException";
49
+ readonly $fault: "client";
50
+ constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
51
+ }
52
+ export declare class ServiceQuotaExceededException extends __BaseException {
53
+ readonly name: "ServiceQuotaExceededException";
54
+ readonly $fault: "client";
55
+ constructor(
56
+ opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
57
+ );
58
+ }
59
+ export declare class ServiceUnavailableException extends __BaseException {
60
+ readonly name: "ServiceUnavailableException";
61
+ readonly $fault: "server";
62
+ $retryable: {};
63
+ constructor(
64
+ opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>
65
+ );
66
+ }
67
+ export declare class TooManyRequestsException extends __BaseException {
68
+ readonly name: "TooManyRequestsException";
69
+ readonly $fault: "client";
70
+ $retryable: {
71
+ throttling: boolean;
72
+ };
73
+ constructor(
74
+ opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>
75
+ );
76
+ }
77
+ export interface ValidationExceptionField {
78
+ path: string | undefined;
79
+ message: string | undefined;
80
+ }
81
+ export declare class ValidationException extends __BaseException {
82
+ readonly name: "ValidationException";
83
+ readonly $fault: "client";
84
+ fieldList?: ValidationExceptionField[] | undefined;
85
+ constructor(
86
+ opts: __ExceptionOptionType<ValidationException, __BaseException>
87
+ );
88
+ }
89
+ export declare const SseType: {
90
+ readonly AES256: "AES256";
91
+ readonly AWS_KMS: "aws:kms";
92
+ };
93
+ export type SseType = (typeof SseType)[keyof typeof SseType];
94
+ export interface EncryptionConfiguration {
95
+ sseType?: SseType | undefined;
96
+ kmsKeyArn?: string | undefined;
97
+ }
98
+ export interface CreateVectorBucketInput {
99
+ vectorBucketName: string | undefined;
100
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
101
+ }
102
+ export interface CreateVectorBucketOutput {}
103
+ export interface DeleteIndexInput {
104
+ vectorBucketName?: string | undefined;
105
+ indexName?: string | undefined;
106
+ indexArn?: string | undefined;
107
+ }
108
+ export interface DeleteIndexOutput {}
109
+ export interface DeleteVectorBucketInput {
110
+ vectorBucketName?: string | undefined;
111
+ vectorBucketArn?: string | undefined;
112
+ }
113
+ export interface DeleteVectorBucketOutput {}
114
+ export interface DeleteVectorBucketPolicyInput {
115
+ vectorBucketName?: string | undefined;
116
+ vectorBucketArn?: string | undefined;
117
+ }
118
+ export interface DeleteVectorBucketPolicyOutput {}
119
+ export interface DeleteVectorsInput {
120
+ vectorBucketName?: string | undefined;
121
+ indexName?: string | undefined;
122
+ indexArn?: string | undefined;
123
+ keys: string[] | undefined;
124
+ }
125
+ export interface DeleteVectorsOutput {}
126
+ export declare class KmsDisabledException extends __BaseException {
127
+ readonly name: "KmsDisabledException";
128
+ readonly $fault: "client";
129
+ constructor(
130
+ opts: __ExceptionOptionType<KmsDisabledException, __BaseException>
131
+ );
132
+ }
133
+ export declare class KmsInvalidKeyUsageException extends __BaseException {
134
+ readonly name: "KmsInvalidKeyUsageException";
135
+ readonly $fault: "client";
136
+ constructor(
137
+ opts: __ExceptionOptionType<KmsInvalidKeyUsageException, __BaseException>
138
+ );
139
+ }
140
+ export declare class KmsInvalidStateException extends __BaseException {
141
+ readonly name: "KmsInvalidStateException";
142
+ readonly $fault: "client";
143
+ constructor(
144
+ opts: __ExceptionOptionType<KmsInvalidStateException, __BaseException>
145
+ );
146
+ }
147
+ export declare class KmsNotFoundException extends __BaseException {
148
+ readonly name: "KmsNotFoundException";
149
+ readonly $fault: "client";
150
+ constructor(
151
+ opts: __ExceptionOptionType<KmsNotFoundException, __BaseException>
152
+ );
153
+ }
154
+ export interface GetIndexInput {
155
+ vectorBucketName?: string | undefined;
156
+ indexName?: string | undefined;
157
+ indexArn?: string | undefined;
158
+ }
159
+ export interface Index {
160
+ vectorBucketName: string | undefined;
161
+ indexName: string | undefined;
162
+ indexArn: string | undefined;
163
+ creationTime: Date | undefined;
164
+ dataType: DataType | undefined;
165
+ dimension: number | undefined;
166
+ distanceMetric: DistanceMetric | undefined;
167
+ metadataConfiguration?: MetadataConfiguration | undefined;
168
+ }
169
+ export interface GetIndexOutput {
170
+ index: Index | undefined;
171
+ }
172
+ export type VectorData = VectorData.Float32Member | VectorData.$UnknownMember;
173
+ export declare namespace VectorData {
174
+ interface Float32Member {
175
+ float32: number[];
176
+ $unknown?: never;
177
+ }
178
+ interface $UnknownMember {
179
+ float32?: never;
180
+ $unknown: [string, any];
181
+ }
182
+ interface Visitor<T> {
183
+ float32: (value: number[]) => T;
184
+ _: (name: string, value: any) => T;
185
+ }
186
+ const visit: <T>(value: VectorData, visitor: Visitor<T>) => T;
187
+ }
188
+ export interface GetOutputVector {
189
+ key: string | undefined;
190
+ data?: VectorData | undefined;
191
+ metadata?: __DocumentType | undefined;
192
+ }
193
+ export interface GetVectorBucketInput {
194
+ vectorBucketName?: string | undefined;
195
+ vectorBucketArn?: string | undefined;
196
+ }
197
+ export interface VectorBucket {
198
+ vectorBucketName: string | undefined;
199
+ vectorBucketArn: string | undefined;
200
+ creationTime: Date | undefined;
201
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
202
+ }
203
+ export interface GetVectorBucketOutput {
204
+ vectorBucket: VectorBucket | undefined;
205
+ }
206
+ export interface GetVectorBucketPolicyInput {
207
+ vectorBucketName?: string | undefined;
208
+ vectorBucketArn?: string | undefined;
209
+ }
210
+ export interface GetVectorBucketPolicyOutput {
211
+ policy?: string | undefined;
212
+ }
213
+ export interface GetVectorsInput {
214
+ vectorBucketName?: string | undefined;
215
+ indexName?: string | undefined;
216
+ indexArn?: string | undefined;
217
+ keys: string[] | undefined;
218
+ returnData?: boolean | undefined;
219
+ returnMetadata?: boolean | undefined;
220
+ }
221
+ export interface GetVectorsOutput {
222
+ vectors: GetOutputVector[] | undefined;
223
+ }
224
+ export interface ListIndexesInput {
225
+ vectorBucketName?: string | undefined;
226
+ vectorBucketArn?: string | undefined;
227
+ maxResults?: number | undefined;
228
+ nextToken?: string | undefined;
229
+ prefix?: string | undefined;
230
+ }
231
+ export interface IndexSummary {
232
+ vectorBucketName: string | undefined;
233
+ indexName: string | undefined;
234
+ indexArn: string | undefined;
235
+ creationTime: Date | undefined;
236
+ }
237
+ export interface ListIndexesOutput {
238
+ nextToken?: string | undefined;
239
+ indexes: IndexSummary[] | undefined;
240
+ }
241
+ export interface ListVectorsInput {
242
+ vectorBucketName?: string | undefined;
243
+ indexName?: string | undefined;
244
+ indexArn?: string | undefined;
245
+ maxResults?: number | undefined;
246
+ nextToken?: string | undefined;
247
+ segmentCount?: number | undefined;
248
+ segmentIndex?: number | undefined;
249
+ returnData?: boolean | undefined;
250
+ returnMetadata?: boolean | undefined;
251
+ }
252
+ export interface ListOutputVector {
253
+ key: string | undefined;
254
+ data?: VectorData | undefined;
255
+ metadata?: __DocumentType | undefined;
256
+ }
257
+ export interface ListVectorsOutput {
258
+ nextToken?: string | undefined;
259
+ vectors: ListOutputVector[] | undefined;
260
+ }
261
+ export interface PutInputVector {
262
+ key: string | undefined;
263
+ data: VectorData | undefined;
264
+ metadata?: __DocumentType | undefined;
265
+ }
266
+ export interface PutVectorsInput {
267
+ vectorBucketName?: string | undefined;
268
+ indexName?: string | undefined;
269
+ indexArn?: string | undefined;
270
+ vectors: PutInputVector[] | undefined;
271
+ }
272
+ export interface PutVectorsOutput {}
273
+ export interface QueryVectorsInput {
274
+ vectorBucketName?: string | undefined;
275
+ indexName?: string | undefined;
276
+ indexArn?: string | undefined;
277
+ topK: number | undefined;
278
+ queryVector: VectorData | undefined;
279
+ filter?: __DocumentType | undefined;
280
+ returnMetadata?: boolean | undefined;
281
+ returnDistance?: boolean | undefined;
282
+ }
283
+ export interface QueryOutputVector {
284
+ key: string | undefined;
285
+ data?: VectorData | undefined;
286
+ metadata?: __DocumentType | undefined;
287
+ distance?: number | undefined;
288
+ }
289
+ export interface QueryVectorsOutput {
290
+ vectors: QueryOutputVector[] | undefined;
291
+ }
292
+ export interface ListVectorBucketsInput {
293
+ maxResults?: number | undefined;
294
+ nextToken?: string | undefined;
295
+ prefix?: string | undefined;
296
+ }
297
+ export interface VectorBucketSummary {
298
+ vectorBucketName: string | undefined;
299
+ vectorBucketArn: string | undefined;
300
+ creationTime: Date | undefined;
301
+ }
302
+ export interface ListVectorBucketsOutput {
303
+ nextToken?: string | undefined;
304
+ vectorBuckets: VectorBucketSummary[] | undefined;
305
+ }
306
+ export interface PutVectorBucketPolicyInput {
307
+ vectorBucketName?: string | undefined;
308
+ vectorBucketArn?: string | undefined;
309
+ policy: string | undefined;
310
+ }
311
+ export interface PutVectorBucketPolicyOutput {}
@@ -0,0 +1,6 @@
1
+ import { PaginationConfiguration } from "@smithy/types";
2
+ import { S3VectorsClient } from "../S3VectorsClient";
3
+ export interface S3VectorsPaginationConfiguration
4
+ extends PaginationConfiguration {
5
+ client: S3VectorsClient;
6
+ }
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListIndexesCommandInput,
4
+ ListIndexesCommandOutput,
5
+ } from "../commands/ListIndexesCommand";
6
+ import { S3VectorsPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListIndexes: (
8
+ config: S3VectorsPaginationConfiguration,
9
+ input: ListIndexesCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListIndexesCommandOutput>;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListVectorBucketsCommandInput,
4
+ ListVectorBucketsCommandOutput,
5
+ } from "../commands/ListVectorBucketsCommand";
6
+ import { S3VectorsPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListVectorBuckets: (
8
+ config: S3VectorsPaginationConfiguration,
9
+ input: ListVectorBucketsCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListVectorBucketsCommandOutput>;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListVectorsCommandInput,
4
+ ListVectorsCommandOutput,
5
+ } from "../commands/ListVectorsCommand";
6
+ import { S3VectorsPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListVectors: (
8
+ config: S3VectorsPaginationConfiguration,
9
+ input: ListVectorsCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListVectorsCommandOutput>;
@@ -0,0 +1,4 @@
1
+ export * from "./Interfaces";
2
+ export * from "./ListIndexesPaginator";
3
+ export * from "./ListVectorBucketsPaginator";
4
+ export * from "./ListVectorsPaginator";
@@ -0,0 +1,197 @@
1
+ import {
2
+ HttpRequest as __HttpRequest,
3
+ HttpResponse as __HttpResponse,
4
+ } from "@smithy/protocol-http";
5
+ import { SerdeContext as __SerdeContext } from "@smithy/types";
6
+ import {
7
+ CreateIndexCommandInput,
8
+ CreateIndexCommandOutput,
9
+ } from "../commands/CreateIndexCommand";
10
+ import {
11
+ CreateVectorBucketCommandInput,
12
+ CreateVectorBucketCommandOutput,
13
+ } from "../commands/CreateVectorBucketCommand";
14
+ import {
15
+ DeleteIndexCommandInput,
16
+ DeleteIndexCommandOutput,
17
+ } from "../commands/DeleteIndexCommand";
18
+ import {
19
+ DeleteVectorBucketCommandInput,
20
+ DeleteVectorBucketCommandOutput,
21
+ } from "../commands/DeleteVectorBucketCommand";
22
+ import {
23
+ DeleteVectorBucketPolicyCommandInput,
24
+ DeleteVectorBucketPolicyCommandOutput,
25
+ } from "../commands/DeleteVectorBucketPolicyCommand";
26
+ import {
27
+ DeleteVectorsCommandInput,
28
+ DeleteVectorsCommandOutput,
29
+ } from "../commands/DeleteVectorsCommand";
30
+ import {
31
+ GetIndexCommandInput,
32
+ GetIndexCommandOutput,
33
+ } from "../commands/GetIndexCommand";
34
+ import {
35
+ GetVectorBucketCommandInput,
36
+ GetVectorBucketCommandOutput,
37
+ } from "../commands/GetVectorBucketCommand";
38
+ import {
39
+ GetVectorBucketPolicyCommandInput,
40
+ GetVectorBucketPolicyCommandOutput,
41
+ } from "../commands/GetVectorBucketPolicyCommand";
42
+ import {
43
+ GetVectorsCommandInput,
44
+ GetVectorsCommandOutput,
45
+ } from "../commands/GetVectorsCommand";
46
+ import {
47
+ ListIndexesCommandInput,
48
+ ListIndexesCommandOutput,
49
+ } from "../commands/ListIndexesCommand";
50
+ import {
51
+ ListVectorBucketsCommandInput,
52
+ ListVectorBucketsCommandOutput,
53
+ } from "../commands/ListVectorBucketsCommand";
54
+ import {
55
+ ListVectorsCommandInput,
56
+ ListVectorsCommandOutput,
57
+ } from "../commands/ListVectorsCommand";
58
+ import {
59
+ PutVectorBucketPolicyCommandInput,
60
+ PutVectorBucketPolicyCommandOutput,
61
+ } from "../commands/PutVectorBucketPolicyCommand";
62
+ import {
63
+ PutVectorsCommandInput,
64
+ PutVectorsCommandOutput,
65
+ } from "../commands/PutVectorsCommand";
66
+ import {
67
+ QueryVectorsCommandInput,
68
+ QueryVectorsCommandOutput,
69
+ } from "../commands/QueryVectorsCommand";
70
+ export declare const se_CreateIndexCommand: (
71
+ input: CreateIndexCommandInput,
72
+ context: __SerdeContext
73
+ ) => Promise<__HttpRequest>;
74
+ export declare const se_CreateVectorBucketCommand: (
75
+ input: CreateVectorBucketCommandInput,
76
+ context: __SerdeContext
77
+ ) => Promise<__HttpRequest>;
78
+ export declare const se_DeleteIndexCommand: (
79
+ input: DeleteIndexCommandInput,
80
+ context: __SerdeContext
81
+ ) => Promise<__HttpRequest>;
82
+ export declare const se_DeleteVectorBucketCommand: (
83
+ input: DeleteVectorBucketCommandInput,
84
+ context: __SerdeContext
85
+ ) => Promise<__HttpRequest>;
86
+ export declare const se_DeleteVectorBucketPolicyCommand: (
87
+ input: DeleteVectorBucketPolicyCommandInput,
88
+ context: __SerdeContext
89
+ ) => Promise<__HttpRequest>;
90
+ export declare const se_DeleteVectorsCommand: (
91
+ input: DeleteVectorsCommandInput,
92
+ context: __SerdeContext
93
+ ) => Promise<__HttpRequest>;
94
+ export declare const se_GetIndexCommand: (
95
+ input: GetIndexCommandInput,
96
+ context: __SerdeContext
97
+ ) => Promise<__HttpRequest>;
98
+ export declare const se_GetVectorBucketCommand: (
99
+ input: GetVectorBucketCommandInput,
100
+ context: __SerdeContext
101
+ ) => Promise<__HttpRequest>;
102
+ export declare const se_GetVectorBucketPolicyCommand: (
103
+ input: GetVectorBucketPolicyCommandInput,
104
+ context: __SerdeContext
105
+ ) => Promise<__HttpRequest>;
106
+ export declare const se_GetVectorsCommand: (
107
+ input: GetVectorsCommandInput,
108
+ context: __SerdeContext
109
+ ) => Promise<__HttpRequest>;
110
+ export declare const se_ListIndexesCommand: (
111
+ input: ListIndexesCommandInput,
112
+ context: __SerdeContext
113
+ ) => Promise<__HttpRequest>;
114
+ export declare const se_ListVectorBucketsCommand: (
115
+ input: ListVectorBucketsCommandInput,
116
+ context: __SerdeContext
117
+ ) => Promise<__HttpRequest>;
118
+ export declare const se_ListVectorsCommand: (
119
+ input: ListVectorsCommandInput,
120
+ context: __SerdeContext
121
+ ) => Promise<__HttpRequest>;
122
+ export declare const se_PutVectorBucketPolicyCommand: (
123
+ input: PutVectorBucketPolicyCommandInput,
124
+ context: __SerdeContext
125
+ ) => Promise<__HttpRequest>;
126
+ export declare const se_PutVectorsCommand: (
127
+ input: PutVectorsCommandInput,
128
+ context: __SerdeContext
129
+ ) => Promise<__HttpRequest>;
130
+ export declare const se_QueryVectorsCommand: (
131
+ input: QueryVectorsCommandInput,
132
+ context: __SerdeContext
133
+ ) => Promise<__HttpRequest>;
134
+ export declare const de_CreateIndexCommand: (
135
+ output: __HttpResponse,
136
+ context: __SerdeContext
137
+ ) => Promise<CreateIndexCommandOutput>;
138
+ export declare const de_CreateVectorBucketCommand: (
139
+ output: __HttpResponse,
140
+ context: __SerdeContext
141
+ ) => Promise<CreateVectorBucketCommandOutput>;
142
+ export declare const de_DeleteIndexCommand: (
143
+ output: __HttpResponse,
144
+ context: __SerdeContext
145
+ ) => Promise<DeleteIndexCommandOutput>;
146
+ export declare const de_DeleteVectorBucketCommand: (
147
+ output: __HttpResponse,
148
+ context: __SerdeContext
149
+ ) => Promise<DeleteVectorBucketCommandOutput>;
150
+ export declare const de_DeleteVectorBucketPolicyCommand: (
151
+ output: __HttpResponse,
152
+ context: __SerdeContext
153
+ ) => Promise<DeleteVectorBucketPolicyCommandOutput>;
154
+ export declare const de_DeleteVectorsCommand: (
155
+ output: __HttpResponse,
156
+ context: __SerdeContext
157
+ ) => Promise<DeleteVectorsCommandOutput>;
158
+ export declare const de_GetIndexCommand: (
159
+ output: __HttpResponse,
160
+ context: __SerdeContext
161
+ ) => Promise<GetIndexCommandOutput>;
162
+ export declare const de_GetVectorBucketCommand: (
163
+ output: __HttpResponse,
164
+ context: __SerdeContext
165
+ ) => Promise<GetVectorBucketCommandOutput>;
166
+ export declare const de_GetVectorBucketPolicyCommand: (
167
+ output: __HttpResponse,
168
+ context: __SerdeContext
169
+ ) => Promise<GetVectorBucketPolicyCommandOutput>;
170
+ export declare const de_GetVectorsCommand: (
171
+ output: __HttpResponse,
172
+ context: __SerdeContext
173
+ ) => Promise<GetVectorsCommandOutput>;
174
+ export declare const de_ListIndexesCommand: (
175
+ output: __HttpResponse,
176
+ context: __SerdeContext
177
+ ) => Promise<ListIndexesCommandOutput>;
178
+ export declare const de_ListVectorBucketsCommand: (
179
+ output: __HttpResponse,
180
+ context: __SerdeContext
181
+ ) => Promise<ListVectorBucketsCommandOutput>;
182
+ export declare const de_ListVectorsCommand: (
183
+ output: __HttpResponse,
184
+ context: __SerdeContext
185
+ ) => Promise<ListVectorsCommandOutput>;
186
+ export declare const de_PutVectorBucketPolicyCommand: (
187
+ output: __HttpResponse,
188
+ context: __SerdeContext
189
+ ) => Promise<PutVectorBucketPolicyCommandOutput>;
190
+ export declare const de_PutVectorsCommand: (
191
+ output: __HttpResponse,
192
+ context: __SerdeContext
193
+ ) => Promise<PutVectorsCommandOutput>;
194
+ export declare const de_QueryVectorsCommand: (
195
+ output: __HttpResponse,
196
+ context: __SerdeContext
197
+ ) => Promise<QueryVectorsCommandOutput>;