@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,112 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListVectorsInput, ListVectorsOutput } from "../models/models_0";
4
+ import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListVectorsCommand}.
14
+ */
15
+ export interface ListVectorsCommandInput extends ListVectorsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListVectorsCommand}.
21
+ */
22
+ export interface ListVectorsCommandOutput extends ListVectorsOutput, __MetadataBearer {
23
+ }
24
+ declare const ListVectorsCommand_base: {
25
+ new (input: ListVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListVectorsCommandInput, ListVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListVectorsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListVectorsCommandInput, ListVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>List vectors in the specified vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). </p> <p> <code>ListVectors</code> operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel <code>ListVectors</code> operation by providing the <code>segmentCount</code> and <code>segmentIndex</code> parameters.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:ListVectors</code> permission, you can list vector keys when <code>returnData</code> and <code>returnMetadata</code> are both set to false or not specified..</p> </li> <li> <p>If you set <code>returnData</code> or <code>returnMetadata</code> to true, you must have both <code>s3vectors:ListVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden</code> error if you request vector data or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { S3VectorsClient, ListVectorsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, ListVectorsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * const client = new S3VectorsClient(config);
37
+ * const input = { // ListVectorsInput
38
+ * vectorBucketName: "STRING_VALUE",
39
+ * indexName: "STRING_VALUE",
40
+ * indexArn: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * nextToken: "STRING_VALUE",
43
+ * segmentCount: Number("int"),
44
+ * segmentIndex: Number("int"),
45
+ * returnData: true || false,
46
+ * returnMetadata: true || false,
47
+ * };
48
+ * const command = new ListVectorsCommand(input);
49
+ * const response = await client.send(command);
50
+ * // { // ListVectorsOutput
51
+ * // nextToken: "STRING_VALUE",
52
+ * // vectors: [ // ListVectorsOutputList // required
53
+ * // { // ListOutputVector
54
+ * // key: "STRING_VALUE", // required
55
+ * // data: { // VectorData Union: only one key present
56
+ * // float32: [ // Float32VectorData
57
+ * // Number("float"),
58
+ * // ],
59
+ * // },
60
+ * // metadata: "DOCUMENT_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param ListVectorsCommandInput - {@link ListVectorsCommandInput}
68
+ * @returns {@link ListVectorsCommandOutput}
69
+ * @see {@link ListVectorsCommandInput} for command's `input` shape.
70
+ * @see {@link ListVectorsCommandOutput} for command's `response` shape.
71
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
72
+ *
73
+ * @throws {@link AccessDeniedException} (client fault)
74
+ * <p>Access denied.</p>
75
+ *
76
+ * @throws {@link NotFoundException} (client fault)
77
+ * <p>The request was rejected because the specified resource can't be found.</p>
78
+ *
79
+ * @throws {@link ServiceUnavailableException} (server fault)
80
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
81
+ *
82
+ * @throws {@link InternalServerException} (server fault)
83
+ * <p>The request failed due to an internal server error.</p>
84
+ *
85
+ * @throws {@link ServiceQuotaExceededException} (client fault)
86
+ * <p>Your request exceeds a service quota. </p>
87
+ *
88
+ * @throws {@link TooManyRequestsException} (client fault)
89
+ * <p>The request was denied due to request throttling.</p>
90
+ *
91
+ * @throws {@link ValidationException} (client fault)
92
+ * <p>The requested action isn't valid.</p>
93
+ *
94
+ * @throws {@link S3VectorsServiceException}
95
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
96
+ *
97
+ *
98
+ * @public
99
+ */
100
+ export declare class ListVectorsCommand extends ListVectorsCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: ListVectorsInput;
105
+ output: ListVectorsOutput;
106
+ };
107
+ sdk: {
108
+ input: ListVectorsCommandInput;
109
+ output: ListVectorsCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -0,0 +1,93 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { PutVectorBucketPolicyInput, PutVectorBucketPolicyOutput } from "../models/models_0";
4
+ import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PutVectorBucketPolicyCommand}.
14
+ */
15
+ export interface PutVectorBucketPolicyCommandInput extends PutVectorBucketPolicyInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutVectorBucketPolicyCommand}.
21
+ */
22
+ export interface PutVectorBucketPolicyCommandOutput extends PutVectorBucketPolicyOutput, __MetadataBearer {
23
+ }
24
+ declare const PutVectorBucketPolicyCommand_base: {
25
+ new (input: PutVectorBucketPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutVectorBucketPolicyCommandInput, PutVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: PutVectorBucketPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutVectorBucketPolicyCommandInput, PutVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Creates a bucket policy for a vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:PutVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { S3VectorsClient, PutVectorBucketPolicyCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, PutVectorBucketPolicyCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * const client = new S3VectorsClient(config);
37
+ * const input = { // PutVectorBucketPolicyInput
38
+ * vectorBucketName: "STRING_VALUE",
39
+ * vectorBucketArn: "STRING_VALUE",
40
+ * policy: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new PutVectorBucketPolicyCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param PutVectorBucketPolicyCommandInput - {@link PutVectorBucketPolicyCommandInput}
49
+ * @returns {@link PutVectorBucketPolicyCommandOutput}
50
+ * @see {@link PutVectorBucketPolicyCommandInput} for command's `input` shape.
51
+ * @see {@link PutVectorBucketPolicyCommandOutput} for command's `response` shape.
52
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
53
+ *
54
+ * @throws {@link NotFoundException} (client fault)
55
+ * <p>The request was rejected because the specified resource can't be found.</p>
56
+ *
57
+ * @throws {@link ServiceUnavailableException} (server fault)
58
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
59
+ *
60
+ * @throws {@link AccessDeniedException} (client fault)
61
+ * <p>Access denied.</p>
62
+ *
63
+ * @throws {@link InternalServerException} (server fault)
64
+ * <p>The request failed due to an internal server error.</p>
65
+ *
66
+ * @throws {@link ServiceQuotaExceededException} (client fault)
67
+ * <p>Your request exceeds a service quota. </p>
68
+ *
69
+ * @throws {@link TooManyRequestsException} (client fault)
70
+ * <p>The request was denied due to request throttling.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The requested action isn't valid.</p>
74
+ *
75
+ * @throws {@link S3VectorsServiceException}
76
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class PutVectorBucketPolicyCommand extends PutVectorBucketPolicyCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: PutVectorBucketPolicyInput;
86
+ output: {};
87
+ };
88
+ sdk: {
89
+ input: PutVectorBucketPolicyCommandInput;
90
+ output: PutVectorBucketPolicyCommandOutput;
91
+ };
92
+ };
93
+ }
@@ -0,0 +1,116 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { PutVectorsInput, PutVectorsOutput } from "../models/models_0";
4
+ import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PutVectorsCommand}.
14
+ */
15
+ export interface PutVectorsCommandInput extends PutVectorsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PutVectorsCommand}.
21
+ */
22
+ export interface PutVectorsCommandOutput extends PutVectorsOutput, __MetadataBearer {
23
+ }
24
+ declare const PutVectorsCommand_base: {
25
+ new (input: PutVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<PutVectorsCommandInput, PutVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: PutVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<PutVectorsCommandInput, PutVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Adds one or more vectors to a vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). </p> <p>For more information about limits, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors-limitations.html">Limitations and restrictions</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>When inserting vector data into your vector index, you must provide the vector data as <code>float32</code> (32-bit floating point) values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors converts the values to 32-bit floating point before storing them, and <code>GetVectors</code>, <code>ListVectors</code>, and <code>QueryVectors</code> operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as <code>float32</code> values regardless of which SDK you're using. For example, in Python, use <code>numpy.float32</code> or explicitly cast your values.</p> </note> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:PutVectors</code> permission to use this operation. </p> </dd> </dl>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { S3VectorsClient, PutVectorsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, PutVectorsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * const client = new S3VectorsClient(config);
37
+ * const input = { // PutVectorsInput
38
+ * vectorBucketName: "STRING_VALUE",
39
+ * indexName: "STRING_VALUE",
40
+ * indexArn: "STRING_VALUE",
41
+ * vectors: [ // PutVectorsInputList // required
42
+ * { // PutInputVector
43
+ * key: "STRING_VALUE", // required
44
+ * data: { // VectorData Union: only one key present
45
+ * float32: [ // Float32VectorData
46
+ * Number("float"),
47
+ * ],
48
+ * },
49
+ * metadata: "DOCUMENT_VALUE",
50
+ * },
51
+ * ],
52
+ * };
53
+ * const command = new PutVectorsCommand(input);
54
+ * const response = await client.send(command);
55
+ * // {};
56
+ *
57
+ * ```
58
+ *
59
+ * @param PutVectorsCommandInput - {@link PutVectorsCommandInput}
60
+ * @returns {@link PutVectorsCommandOutput}
61
+ * @see {@link PutVectorsCommandInput} for command's `input` shape.
62
+ * @see {@link PutVectorsCommandOutput} for command's `response` shape.
63
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
64
+ *
65
+ * @throws {@link AccessDeniedException} (client fault)
66
+ * <p>Access denied.</p>
67
+ *
68
+ * @throws {@link KmsDisabledException} (client fault)
69
+ * <p>The specified Amazon Web Services KMS key isn't enabled.</p>
70
+ *
71
+ * @throws {@link KmsInvalidKeyUsageException} (client fault)
72
+ * <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (<code>KeySpec</code>).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">InvalidKeyUsageException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
73
+ *
74
+ * @throws {@link KmsInvalidStateException} (client fault)
75
+ * <p>The key state of the KMS key isn't compatible with the operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">KMSInvalidStateException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
76
+ *
77
+ * @throws {@link KmsNotFoundException} (client fault)
78
+ * <p>The KMS key can't be found.</p>
79
+ *
80
+ * @throws {@link NotFoundException} (client fault)
81
+ * <p>The request was rejected because the specified resource can't be found.</p>
82
+ *
83
+ * @throws {@link ServiceUnavailableException} (server fault)
84
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
85
+ *
86
+ * @throws {@link InternalServerException} (server fault)
87
+ * <p>The request failed due to an internal server error.</p>
88
+ *
89
+ * @throws {@link ServiceQuotaExceededException} (client fault)
90
+ * <p>Your request exceeds a service quota. </p>
91
+ *
92
+ * @throws {@link TooManyRequestsException} (client fault)
93
+ * <p>The request was denied due to request throttling.</p>
94
+ *
95
+ * @throws {@link ValidationException} (client fault)
96
+ * <p>The requested action isn't valid.</p>
97
+ *
98
+ * @throws {@link S3VectorsServiceException}
99
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
100
+ *
101
+ *
102
+ * @public
103
+ */
104
+ export declare class PutVectorsCommand extends PutVectorsCommand_base {
105
+ /** @internal type navigation helper, not in runtime. */
106
+ protected static __types: {
107
+ api: {
108
+ input: PutVectorsInput;
109
+ output: {};
110
+ };
111
+ sdk: {
112
+ input: PutVectorsCommandInput;
113
+ output: PutVectorsCommandOutput;
114
+ };
115
+ };
116
+ }
@@ -0,0 +1,127 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { QueryVectorsInput, QueryVectorsOutput } from "../models/models_0";
4
+ import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link QueryVectorsCommand}.
14
+ */
15
+ export interface QueryVectorsCommandInput extends QueryVectorsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link QueryVectorsCommand}.
21
+ */
22
+ export interface QueryVectorsCommandOutput extends QueryVectorsOutput, __MetadataBearer {
23
+ }
24
+ declare const QueryVectorsCommand_base: {
25
+ new (input: QueryVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<QueryVectorsCommandInput, QueryVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: QueryVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<QueryVectorsCommandInput, QueryVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response), the vector data, and metadata of each vector in the response. </p> <p>To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:QueryVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:QueryVectors</code> permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request vector data or metadata (by keeping the <code>returnMetadata</code> parameter set to <code>false</code> or not specified).</p> </li> <li> <p>If you specify a metadata filter or set <code>returnMetadata</code> to true, you must have both <code>s3vectors:QueryVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden error</code> if you request metadata filtering, vector data, or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { S3VectorsClient, QueryVectorsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, QueryVectorsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * const client = new S3VectorsClient(config);
37
+ * const input = { // QueryVectorsInput
38
+ * vectorBucketName: "STRING_VALUE",
39
+ * indexName: "STRING_VALUE",
40
+ * indexArn: "STRING_VALUE",
41
+ * topK: Number("int"), // required
42
+ * queryVector: { // VectorData Union: only one key present
43
+ * float32: [ // Float32VectorData
44
+ * Number("float"),
45
+ * ],
46
+ * },
47
+ * filter: "DOCUMENT_VALUE",
48
+ * returnMetadata: true || false,
49
+ * returnDistance: true || false,
50
+ * };
51
+ * const command = new QueryVectorsCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // QueryVectorsOutput
54
+ * // vectors: [ // QueryVectorsOutputList // required
55
+ * // { // QueryOutputVector
56
+ * // key: "STRING_VALUE", // required
57
+ * // data: { // VectorData Union: only one key present
58
+ * // float32: [ // Float32VectorData
59
+ * // Number("float"),
60
+ * // ],
61
+ * // },
62
+ * // metadata: "DOCUMENT_VALUE",
63
+ * // distance: Number("float"),
64
+ * // },
65
+ * // ],
66
+ * // };
67
+ *
68
+ * ```
69
+ *
70
+ * @param QueryVectorsCommandInput - {@link QueryVectorsCommandInput}
71
+ * @returns {@link QueryVectorsCommandOutput}
72
+ * @see {@link QueryVectorsCommandInput} for command's `input` shape.
73
+ * @see {@link QueryVectorsCommandOutput} for command's `response` shape.
74
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
75
+ *
76
+ * @throws {@link KmsDisabledException} (client fault)
77
+ * <p>The specified Amazon Web Services KMS key isn't enabled.</p>
78
+ *
79
+ * @throws {@link KmsInvalidKeyUsageException} (client fault)
80
+ * <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (<code>KeySpec</code>).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">InvalidKeyUsageException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
81
+ *
82
+ * @throws {@link KmsInvalidStateException} (client fault)
83
+ * <p>The key state of the KMS key isn't compatible with the operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">KMSInvalidStateException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
84
+ *
85
+ * @throws {@link KmsNotFoundException} (client fault)
86
+ * <p>The KMS key can't be found.</p>
87
+ *
88
+ * @throws {@link NotFoundException} (client fault)
89
+ * <p>The request was rejected because the specified resource can't be found.</p>
90
+ *
91
+ * @throws {@link ServiceUnavailableException} (server fault)
92
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
93
+ *
94
+ * @throws {@link AccessDeniedException} (client fault)
95
+ * <p>Access denied.</p>
96
+ *
97
+ * @throws {@link InternalServerException} (server fault)
98
+ * <p>The request failed due to an internal server error.</p>
99
+ *
100
+ * @throws {@link ServiceQuotaExceededException} (client fault)
101
+ * <p>Your request exceeds a service quota. </p>
102
+ *
103
+ * @throws {@link TooManyRequestsException} (client fault)
104
+ * <p>The request was denied due to request throttling.</p>
105
+ *
106
+ * @throws {@link ValidationException} (client fault)
107
+ * <p>The requested action isn't valid.</p>
108
+ *
109
+ * @throws {@link S3VectorsServiceException}
110
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
111
+ *
112
+ *
113
+ * @public
114
+ */
115
+ export declare class QueryVectorsCommand extends QueryVectorsCommand_base {
116
+ /** @internal type navigation helper, not in runtime. */
117
+ protected static __types: {
118
+ api: {
119
+ input: QueryVectorsInput;
120
+ output: QueryVectorsOutput;
121
+ };
122
+ sdk: {
123
+ input: QueryVectorsCommandInput;
124
+ output: QueryVectorsCommandOutput;
125
+ };
126
+ };
127
+ }
@@ -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,32 @@
1
+ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface ClientInputEndpointParameters {
6
+ useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
7
+ endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
8
+ region?: string | undefined | Provider<string | undefined>;
9
+ }
10
+ export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
11
+ defaultSigningName: string;
12
+ };
13
+ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
14
+ export declare const commonParams: {
15
+ readonly UseFIPS: {
16
+ readonly type: "builtInParams";
17
+ readonly name: "useFipsEndpoint";
18
+ };
19
+ readonly Endpoint: {
20
+ readonly type: "builtInParams";
21
+ readonly name: "endpoint";
22
+ };
23
+ readonly Region: {
24
+ readonly type: "builtInParams";
25
+ readonly name: "region";
26
+ };
27
+ };
28
+ export interface EndpointParameters extends __EndpointParameters {
29
+ UseFIPS?: boolean | undefined;
30
+ Endpoint?: string | undefined;
31
+ Region?: string | undefined;
32
+ }
@@ -0,0 +1,5 @@
1
+ import { EndpointV2, Logger } from "@smithy/types";
2
+ import { EndpointParameters } from "./EndpointParameters";
3
+ export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
4
+ logger?: Logger;
5
+ }) => 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
+ /**
6
+ * @internal
7
+ */
8
+ export interface S3VectorsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
9
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * <p>Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.</p>
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ export * from "./S3VectorsClient";
7
+ export * from "./S3Vectors";
8
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
9
+ export type { RuntimeExtension } from "./runtimeExtensions";
10
+ export type { S3VectorsExtensionConfiguration } from "./extensionConfiguration";
11
+ export * from "./commands";
12
+ export * from "./pagination";
13
+ export * from "./models";
14
+ export { S3VectorsServiceException } from "./models/S3VectorsServiceException";
@@ -0,0 +1,14 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
2
+ export type { __ServiceExceptionOptions };
3
+ export { __ServiceException };
4
+ /**
5
+ * @public
6
+ *
7
+ * Base exception class for all service exceptions from S3Vectors service.
8
+ */
9
+ export declare class S3VectorsServiceException extends __ServiceException {
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(options: __ServiceExceptionOptions);
14
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";