@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,34 @@
1
+ import packageInfo from "../package.json";
2
+ import { Sha256 } from "@aws-crypto/sha256-browser";
3
+ import { createDefaultUserAgentProvider } from "@aws-sdk/util-user-agent-browser";
4
+ import { DEFAULT_USE_DUALSTACK_ENDPOINT, DEFAULT_USE_FIPS_ENDPOINT } from "@smithy/config-resolver";
5
+ import { FetchHttpHandler as RequestHandler, streamCollector } from "@smithy/fetch-http-handler";
6
+ import { invalidProvider } from "@smithy/invalid-dependency";
7
+ import { calculateBodyLength } from "@smithy/util-body-length-browser";
8
+ import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@smithy/util-retry";
9
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
10
+ import { loadConfigsForDefaultMode } from "@smithy/smithy-client";
11
+ import { resolveDefaultsModeConfig } from "@smithy/util-defaults-mode-browser";
12
+ export const getRuntimeConfig = (config) => {
13
+ const defaultsMode = resolveDefaultsModeConfig(config);
14
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
15
+ const clientSharedValues = getSharedRuntimeConfig(config);
16
+ return {
17
+ ...clientSharedValues,
18
+ ...config,
19
+ runtime: "browser",
20
+ defaultsMode,
21
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
22
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? ((_) => () => Promise.reject(new Error("Credential is missing"))),
23
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
24
+ createDefaultUserAgentProvider({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
25
+ maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
26
+ region: config?.region ?? invalidProvider("Region is missing"),
27
+ requestHandler: RequestHandler.create(config?.requestHandler ?? defaultConfigProvider),
28
+ retryMode: config?.retryMode ?? (async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE),
29
+ sha256: config?.sha256 ?? Sha256,
30
+ streamCollector: config?.streamCollector ?? streamCollector,
31
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? (() => Promise.resolve(DEFAULT_USE_DUALSTACK_ENDPOINT)),
32
+ useFipsEndpoint: config?.useFipsEndpoint ?? (() => Promise.resolve(DEFAULT_USE_FIPS_ENDPOINT)),
33
+ };
34
+ };
@@ -0,0 +1,51 @@
1
+ import packageInfo from "../package.json";
2
+ import { NODE_AUTH_SCHEME_PREFERENCE_OPTIONS, emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
3
+ import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
4
+ import { NODE_APP_ID_CONFIG_OPTIONS, createDefaultUserAgentProvider } from "@aws-sdk/util-user-agent-node";
5
+ import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
6
+ import { Hash } from "@smithy/hash-node";
7
+ import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@smithy/middleware-retry";
8
+ import { loadConfig as loadNodeConfig } from "@smithy/node-config-provider";
9
+ import { NodeHttpHandler as RequestHandler, streamCollector } from "@smithy/node-http-handler";
10
+ import { calculateBodyLength } from "@smithy/util-body-length-node";
11
+ import { DEFAULT_RETRY_MODE } from "@smithy/util-retry";
12
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
13
+ import { loadConfigsForDefaultMode } from "@smithy/smithy-client";
14
+ import { resolveDefaultsModeConfig } from "@smithy/util-defaults-mode-node";
15
+ import { emitWarningIfUnsupportedVersion } from "@smithy/smithy-client";
16
+ export const getRuntimeConfig = (config) => {
17
+ emitWarningIfUnsupportedVersion(process.version);
18
+ const defaultsMode = resolveDefaultsModeConfig(config);
19
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
20
+ const clientSharedValues = getSharedRuntimeConfig(config);
21
+ awsCheckVersion(process.version);
22
+ const loaderConfig = {
23
+ profile: config?.profile,
24
+ logger: clientSharedValues.logger,
25
+ };
26
+ return {
27
+ ...clientSharedValues,
28
+ ...config,
29
+ runtime: "node",
30
+ defaultsMode,
31
+ authSchemePreference: config?.authSchemePreference ?? loadNodeConfig(NODE_AUTH_SCHEME_PREFERENCE_OPTIONS, loaderConfig),
32
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
33
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? credentialDefaultProvider,
34
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
35
+ createDefaultUserAgentProvider({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
36
+ maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS, config),
37
+ region: config?.region ??
38
+ loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, { ...NODE_REGION_CONFIG_FILE_OPTIONS, ...loaderConfig }),
39
+ requestHandler: RequestHandler.create(config?.requestHandler ?? defaultConfigProvider),
40
+ retryMode: config?.retryMode ??
41
+ loadNodeConfig({
42
+ ...NODE_RETRY_MODE_CONFIG_OPTIONS,
43
+ default: async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE,
44
+ }, config),
45
+ sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
46
+ streamCollector: config?.streamCollector ?? streamCollector,
47
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, loaderConfig),
48
+ useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, loaderConfig),
49
+ userAgentAppId: config?.userAgentAppId ?? loadNodeConfig(NODE_APP_ID_CONFIG_OPTIONS, loaderConfig),
50
+ };
51
+ };
@@ -0,0 +1,11 @@
1
+ import { Sha256 } from "@aws-crypto/sha256-js";
2
+ import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
3
+ export const getRuntimeConfig = (config) => {
4
+ const browserDefaults = getBrowserRuntimeConfig(config);
5
+ return {
6
+ ...browserDefaults,
7
+ ...config,
8
+ runtime: "react-native",
9
+ sha256: config?.sha256 ?? Sha256,
10
+ };
11
+ };
@@ -0,0 +1,30 @@
1
+ import { AwsSdkSigV4Signer } from "@aws-sdk/core";
2
+ import { NoOpLogger } from "@smithy/smithy-client";
3
+ import { parseUrl } from "@smithy/url-parser";
4
+ import { fromBase64, toBase64 } from "@smithy/util-base64";
5
+ import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
6
+ import { defaultS3VectorsHttpAuthSchemeProvider } from "./auth/httpAuthSchemeProvider";
7
+ import { defaultEndpointResolver } from "./endpoint/endpointResolver";
8
+ export const getRuntimeConfig = (config) => {
9
+ return {
10
+ apiVersion: "2025-07-15",
11
+ base64Decoder: config?.base64Decoder ?? fromBase64,
12
+ base64Encoder: config?.base64Encoder ?? toBase64,
13
+ disableHostPrefix: config?.disableHostPrefix ?? false,
14
+ endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
15
+ extensions: config?.extensions ?? [],
16
+ httpAuthSchemeProvider: config?.httpAuthSchemeProvider ?? defaultS3VectorsHttpAuthSchemeProvider,
17
+ httpAuthSchemes: config?.httpAuthSchemes ?? [
18
+ {
19
+ schemeId: "aws.auth#sigv4",
20
+ identityProvider: (ipc) => ipc.getIdentityProvider("aws.auth#sigv4"),
21
+ signer: new AwsSdkSigV4Signer(),
22
+ },
23
+ ],
24
+ logger: config?.logger ?? new NoOpLogger(),
25
+ serviceId: config?.serviceId ?? "S3Vectors",
26
+ urlParser: config?.urlParser ?? parseUrl,
27
+ utf8Decoder: config?.utf8Decoder ?? fromUtf8,
28
+ utf8Encoder: config?.utf8Encoder ?? toUtf8,
29
+ };
30
+ };
@@ -0,0 +1,9 @@
1
+ import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfiguration, } from "@aws-sdk/region-config-resolver";
2
+ import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
3
+ import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
4
+ import { getHttpAuthExtensionConfiguration, resolveHttpAuthRuntimeConfig } from "./auth/httpAuthExtensionConfiguration";
5
+ export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
6
+ const extensionConfiguration = Object.assign(getAwsRegionExtensionConfiguration(runtimeConfig), getDefaultExtensionConfiguration(runtimeConfig), getHttpHandlerExtensionConfiguration(runtimeConfig), getHttpAuthExtensionConfiguration(runtimeConfig));
7
+ extensions.forEach((extension) => extension.configure(extensionConfiguration));
8
+ return Object.assign(runtimeConfig, resolveAwsRegionExtensionConfiguration(extensionConfiguration), resolveDefaultRuntimeConfig(extensionConfiguration), resolveHttpHandlerRuntimeConfig(extensionConfiguration), resolveHttpAuthRuntimeConfig(extensionConfiguration));
9
+ };
@@ -0,0 +1,131 @@
1
+ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
3
+ import { CreateVectorBucketCommandInput, CreateVectorBucketCommandOutput } from "./commands/CreateVectorBucketCommand";
4
+ import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
5
+ import { DeleteVectorBucketCommandInput, DeleteVectorBucketCommandOutput } from "./commands/DeleteVectorBucketCommand";
6
+ import { DeleteVectorBucketPolicyCommandInput, DeleteVectorBucketPolicyCommandOutput } from "./commands/DeleteVectorBucketPolicyCommand";
7
+ import { DeleteVectorsCommandInput, DeleteVectorsCommandOutput } from "./commands/DeleteVectorsCommand";
8
+ import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
9
+ import { GetVectorBucketCommandInput, GetVectorBucketCommandOutput } from "./commands/GetVectorBucketCommand";
10
+ import { GetVectorBucketPolicyCommandInput, GetVectorBucketPolicyCommandOutput } from "./commands/GetVectorBucketPolicyCommand";
11
+ import { GetVectorsCommandInput, GetVectorsCommandOutput } from "./commands/GetVectorsCommand";
12
+ import { ListIndexesCommandInput, ListIndexesCommandOutput } from "./commands/ListIndexesCommand";
13
+ import { ListVectorBucketsCommandInput, ListVectorBucketsCommandOutput } from "./commands/ListVectorBucketsCommand";
14
+ import { ListVectorsCommandInput, ListVectorsCommandOutput } from "./commands/ListVectorsCommand";
15
+ import { PutVectorBucketPolicyCommandInput, PutVectorBucketPolicyCommandOutput } from "./commands/PutVectorBucketPolicyCommand";
16
+ import { PutVectorsCommandInput, PutVectorsCommandOutput } from "./commands/PutVectorsCommand";
17
+ import { QueryVectorsCommandInput, QueryVectorsCommandOutput } from "./commands/QueryVectorsCommand";
18
+ import { S3VectorsClient } from "./S3VectorsClient";
19
+ export interface S3Vectors {
20
+ /**
21
+ * @see {@link CreateIndexCommand}
22
+ */
23
+ createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
24
+ createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
25
+ createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
26
+ /**
27
+ * @see {@link CreateVectorBucketCommand}
28
+ */
29
+ createVectorBucket(args: CreateVectorBucketCommandInput, options?: __HttpHandlerOptions): Promise<CreateVectorBucketCommandOutput>;
30
+ createVectorBucket(args: CreateVectorBucketCommandInput, cb: (err: any, data?: CreateVectorBucketCommandOutput) => void): void;
31
+ createVectorBucket(args: CreateVectorBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVectorBucketCommandOutput) => void): void;
32
+ /**
33
+ * @see {@link DeleteIndexCommand}
34
+ */
35
+ deleteIndex(): Promise<DeleteIndexCommandOutput>;
36
+ deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexCommandOutput>;
37
+ deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
38
+ deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
39
+ /**
40
+ * @see {@link DeleteVectorBucketCommand}
41
+ */
42
+ deleteVectorBucket(): Promise<DeleteVectorBucketCommandOutput>;
43
+ deleteVectorBucket(args: DeleteVectorBucketCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVectorBucketCommandOutput>;
44
+ deleteVectorBucket(args: DeleteVectorBucketCommandInput, cb: (err: any, data?: DeleteVectorBucketCommandOutput) => void): void;
45
+ deleteVectorBucket(args: DeleteVectorBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVectorBucketCommandOutput) => void): void;
46
+ /**
47
+ * @see {@link DeleteVectorBucketPolicyCommand}
48
+ */
49
+ deleteVectorBucketPolicy(): Promise<DeleteVectorBucketPolicyCommandOutput>;
50
+ deleteVectorBucketPolicy(args: DeleteVectorBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVectorBucketPolicyCommandOutput>;
51
+ deleteVectorBucketPolicy(args: DeleteVectorBucketPolicyCommandInput, cb: (err: any, data?: DeleteVectorBucketPolicyCommandOutput) => void): void;
52
+ deleteVectorBucketPolicy(args: DeleteVectorBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVectorBucketPolicyCommandOutput) => void): void;
53
+ /**
54
+ * @see {@link DeleteVectorsCommand}
55
+ */
56
+ deleteVectors(args: DeleteVectorsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVectorsCommandOutput>;
57
+ deleteVectors(args: DeleteVectorsCommandInput, cb: (err: any, data?: DeleteVectorsCommandOutput) => void): void;
58
+ deleteVectors(args: DeleteVectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVectorsCommandOutput) => void): void;
59
+ /**
60
+ * @see {@link GetIndexCommand}
61
+ */
62
+ getIndex(): Promise<GetIndexCommandOutput>;
63
+ getIndex(args: GetIndexCommandInput, options?: __HttpHandlerOptions): Promise<GetIndexCommandOutput>;
64
+ getIndex(args: GetIndexCommandInput, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
65
+ getIndex(args: GetIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIndexCommandOutput) => void): void;
66
+ /**
67
+ * @see {@link GetVectorBucketCommand}
68
+ */
69
+ getVectorBucket(): Promise<GetVectorBucketCommandOutput>;
70
+ getVectorBucket(args: GetVectorBucketCommandInput, options?: __HttpHandlerOptions): Promise<GetVectorBucketCommandOutput>;
71
+ getVectorBucket(args: GetVectorBucketCommandInput, cb: (err: any, data?: GetVectorBucketCommandOutput) => void): void;
72
+ getVectorBucket(args: GetVectorBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVectorBucketCommandOutput) => void): void;
73
+ /**
74
+ * @see {@link GetVectorBucketPolicyCommand}
75
+ */
76
+ getVectorBucketPolicy(): Promise<GetVectorBucketPolicyCommandOutput>;
77
+ getVectorBucketPolicy(args: GetVectorBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetVectorBucketPolicyCommandOutput>;
78
+ getVectorBucketPolicy(args: GetVectorBucketPolicyCommandInput, cb: (err: any, data?: GetVectorBucketPolicyCommandOutput) => void): void;
79
+ getVectorBucketPolicy(args: GetVectorBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVectorBucketPolicyCommandOutput) => void): void;
80
+ /**
81
+ * @see {@link GetVectorsCommand}
82
+ */
83
+ getVectors(args: GetVectorsCommandInput, options?: __HttpHandlerOptions): Promise<GetVectorsCommandOutput>;
84
+ getVectors(args: GetVectorsCommandInput, cb: (err: any, data?: GetVectorsCommandOutput) => void): void;
85
+ getVectors(args: GetVectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVectorsCommandOutput) => void): void;
86
+ /**
87
+ * @see {@link ListIndexesCommand}
88
+ */
89
+ listIndexes(): Promise<ListIndexesCommandOutput>;
90
+ listIndexes(args: ListIndexesCommandInput, options?: __HttpHandlerOptions): Promise<ListIndexesCommandOutput>;
91
+ listIndexes(args: ListIndexesCommandInput, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
92
+ listIndexes(args: ListIndexesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndexesCommandOutput) => void): void;
93
+ /**
94
+ * @see {@link ListVectorBucketsCommand}
95
+ */
96
+ listVectorBuckets(): Promise<ListVectorBucketsCommandOutput>;
97
+ listVectorBuckets(args: ListVectorBucketsCommandInput, options?: __HttpHandlerOptions): Promise<ListVectorBucketsCommandOutput>;
98
+ listVectorBuckets(args: ListVectorBucketsCommandInput, cb: (err: any, data?: ListVectorBucketsCommandOutput) => void): void;
99
+ listVectorBuckets(args: ListVectorBucketsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVectorBucketsCommandOutput) => void): void;
100
+ /**
101
+ * @see {@link ListVectorsCommand}
102
+ */
103
+ listVectors(): Promise<ListVectorsCommandOutput>;
104
+ listVectors(args: ListVectorsCommandInput, options?: __HttpHandlerOptions): Promise<ListVectorsCommandOutput>;
105
+ listVectors(args: ListVectorsCommandInput, cb: (err: any, data?: ListVectorsCommandOutput) => void): void;
106
+ listVectors(args: ListVectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVectorsCommandOutput) => void): void;
107
+ /**
108
+ * @see {@link PutVectorBucketPolicyCommand}
109
+ */
110
+ putVectorBucketPolicy(args: PutVectorBucketPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutVectorBucketPolicyCommandOutput>;
111
+ putVectorBucketPolicy(args: PutVectorBucketPolicyCommandInput, cb: (err: any, data?: PutVectorBucketPolicyCommandOutput) => void): void;
112
+ putVectorBucketPolicy(args: PutVectorBucketPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVectorBucketPolicyCommandOutput) => void): void;
113
+ /**
114
+ * @see {@link PutVectorsCommand}
115
+ */
116
+ putVectors(args: PutVectorsCommandInput, options?: __HttpHandlerOptions): Promise<PutVectorsCommandOutput>;
117
+ putVectors(args: PutVectorsCommandInput, cb: (err: any, data?: PutVectorsCommandOutput) => void): void;
118
+ putVectors(args: PutVectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutVectorsCommandOutput) => void): void;
119
+ /**
120
+ * @see {@link QueryVectorsCommand}
121
+ */
122
+ queryVectors(args: QueryVectorsCommandInput, options?: __HttpHandlerOptions): Promise<QueryVectorsCommandOutput>;
123
+ queryVectors(args: QueryVectorsCommandInput, cb: (err: any, data?: QueryVectorsCommandOutput) => void): void;
124
+ queryVectors(args: QueryVectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryVectorsCommandOutput) => void): void;
125
+ }
126
+ /**
127
+ * <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>
128
+ * @public
129
+ */
130
+ export declare class S3Vectors extends S3VectorsClient implements S3Vectors {
131
+ }
@@ -0,0 +1,203 @@
1
+ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
+ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
3
+ import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
4
+ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
5
+ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
6
+ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
7
+ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
8
+ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
+ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
11
+ import { CreateVectorBucketCommandInput, CreateVectorBucketCommandOutput } from "./commands/CreateVectorBucketCommand";
12
+ import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
13
+ import { DeleteVectorBucketCommandInput, DeleteVectorBucketCommandOutput } from "./commands/DeleteVectorBucketCommand";
14
+ import { DeleteVectorBucketPolicyCommandInput, DeleteVectorBucketPolicyCommandOutput } from "./commands/DeleteVectorBucketPolicyCommand";
15
+ import { DeleteVectorsCommandInput, DeleteVectorsCommandOutput } from "./commands/DeleteVectorsCommand";
16
+ import { GetIndexCommandInput, GetIndexCommandOutput } from "./commands/GetIndexCommand";
17
+ import { GetVectorBucketCommandInput, GetVectorBucketCommandOutput } from "./commands/GetVectorBucketCommand";
18
+ import { GetVectorBucketPolicyCommandInput, GetVectorBucketPolicyCommandOutput } from "./commands/GetVectorBucketPolicyCommand";
19
+ import { GetVectorsCommandInput, GetVectorsCommandOutput } from "./commands/GetVectorsCommand";
20
+ import { ListIndexesCommandInput, ListIndexesCommandOutput } from "./commands/ListIndexesCommand";
21
+ import { ListVectorBucketsCommandInput, ListVectorBucketsCommandOutput } from "./commands/ListVectorBucketsCommand";
22
+ import { ListVectorsCommandInput, ListVectorsCommandOutput } from "./commands/ListVectorsCommand";
23
+ import { PutVectorBucketPolicyCommandInput, PutVectorBucketPolicyCommandOutput } from "./commands/PutVectorBucketPolicyCommand";
24
+ import { PutVectorsCommandInput, PutVectorsCommandOutput } from "./commands/PutVectorsCommand";
25
+ import { QueryVectorsCommandInput, QueryVectorsCommandOutput } from "./commands/QueryVectorsCommand";
26
+ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
27
+ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
28
+ export { __Client };
29
+ /**
30
+ * @public
31
+ */
32
+ export type ServiceInputTypes = CreateIndexCommandInput | CreateVectorBucketCommandInput | DeleteIndexCommandInput | DeleteVectorBucketCommandInput | DeleteVectorBucketPolicyCommandInput | DeleteVectorsCommandInput | GetIndexCommandInput | GetVectorBucketCommandInput | GetVectorBucketPolicyCommandInput | GetVectorsCommandInput | ListIndexesCommandInput | ListVectorBucketsCommandInput | ListVectorsCommandInput | PutVectorBucketPolicyCommandInput | PutVectorsCommandInput | QueryVectorsCommandInput;
33
+ /**
34
+ * @public
35
+ */
36
+ export type ServiceOutputTypes = CreateIndexCommandOutput | CreateVectorBucketCommandOutput | DeleteIndexCommandOutput | DeleteVectorBucketCommandOutput | DeleteVectorBucketPolicyCommandOutput | DeleteVectorsCommandOutput | GetIndexCommandOutput | GetVectorBucketCommandOutput | GetVectorBucketPolicyCommandOutput | GetVectorsCommandOutput | ListIndexesCommandOutput | ListVectorBucketsCommandOutput | ListVectorsCommandOutput | PutVectorBucketPolicyCommandOutput | PutVectorsCommandOutput | QueryVectorsCommandOutput;
37
+ /**
38
+ * @public
39
+ */
40
+ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
41
+ /**
42
+ * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
43
+ */
44
+ requestHandler?: __HttpHandlerUserInput;
45
+ /**
46
+ * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
47
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
48
+ * @internal
49
+ */
50
+ sha256?: __ChecksumConstructor | __HashConstructor;
51
+ /**
52
+ * The function that will be used to convert strings into HTTP endpoints.
53
+ * @internal
54
+ */
55
+ urlParser?: __UrlParser;
56
+ /**
57
+ * A function that can calculate the length of a request body.
58
+ * @internal
59
+ */
60
+ bodyLengthChecker?: __BodyLengthCalculator;
61
+ /**
62
+ * A function that converts a stream into an array of bytes.
63
+ * @internal
64
+ */
65
+ streamCollector?: __StreamCollector;
66
+ /**
67
+ * The function that will be used to convert a base64-encoded string to a byte array.
68
+ * @internal
69
+ */
70
+ base64Decoder?: __Decoder;
71
+ /**
72
+ * The function that will be used to convert binary data to a base64-encoded string.
73
+ * @internal
74
+ */
75
+ base64Encoder?: __Encoder;
76
+ /**
77
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
78
+ * @internal
79
+ */
80
+ utf8Decoder?: __Decoder;
81
+ /**
82
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
83
+ * @internal
84
+ */
85
+ utf8Encoder?: __Encoder;
86
+ /**
87
+ * The runtime environment.
88
+ * @internal
89
+ */
90
+ runtime?: string;
91
+ /**
92
+ * Disable dynamically changing the endpoint of the client based on the hostPrefix
93
+ * trait of an operation.
94
+ */
95
+ disableHostPrefix?: boolean;
96
+ /**
97
+ * Unique service identifier.
98
+ * @internal
99
+ */
100
+ serviceId?: string;
101
+ /**
102
+ * Enables IPv6/IPv4 dualstack endpoint.
103
+ */
104
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
105
+ /**
106
+ * Enables FIPS compatible endpoints.
107
+ */
108
+ useFipsEndpoint?: boolean | __Provider<boolean>;
109
+ /**
110
+ * The AWS region to which this client will send requests
111
+ */
112
+ region?: string | __Provider<string>;
113
+ /**
114
+ * Setting a client profile is similar to setting a value for the
115
+ * AWS_PROFILE environment variable. Setting a profile on a client
116
+ * in code only affects the single client instance, unlike AWS_PROFILE.
117
+ *
118
+ * When set, and only for environments where an AWS configuration
119
+ * file exists, fields configurable by this file will be retrieved
120
+ * from the specified profile within that file.
121
+ * Conflicting code configuration and environment variables will
122
+ * still have higher priority.
123
+ *
124
+ * For client credential resolution that involves checking the AWS
125
+ * configuration file, the client's profile (this value) will be
126
+ * used unless a different profile is set in the credential
127
+ * provider options.
128
+ *
129
+ */
130
+ profile?: string;
131
+ /**
132
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
133
+ * @internal
134
+ */
135
+ defaultUserAgentProvider?: Provider<__UserAgent>;
136
+ /**
137
+ * Default credentials provider; Not available in browser runtime.
138
+ * @deprecated
139
+ * @internal
140
+ */
141
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
142
+ /**
143
+ * Value for how many times a request will be made at most in case of retry.
144
+ */
145
+ maxAttempts?: number | __Provider<number>;
146
+ /**
147
+ * Specifies which retry algorithm to use.
148
+ * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
149
+ *
150
+ */
151
+ retryMode?: string | __Provider<string>;
152
+ /**
153
+ * Optional logger for logging debug/info/warn/error.
154
+ */
155
+ logger?: __Logger;
156
+ /**
157
+ * Optional extensions
158
+ */
159
+ extensions?: RuntimeExtension[];
160
+ /**
161
+ * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
162
+ */
163
+ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
164
+ }
165
+ /**
166
+ * @public
167
+ */
168
+ export type S3VectorsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig<EndpointParameters> & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
169
+ /**
170
+ * @public
171
+ *
172
+ * The configuration interface of S3VectorsClient class constructor that set the region, credentials and other options.
173
+ */
174
+ export interface S3VectorsClientConfig extends S3VectorsClientConfigType {
175
+ }
176
+ /**
177
+ * @public
178
+ */
179
+ export type S3VectorsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & RegionResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
180
+ /**
181
+ * @public
182
+ *
183
+ * The resolved configuration interface of S3VectorsClient class. This is resolved and normalized from the {@link S3VectorsClientConfig | constructor configuration interface}.
184
+ */
185
+ export interface S3VectorsClientResolvedConfig extends S3VectorsClientResolvedConfigType {
186
+ }
187
+ /**
188
+ * <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>
189
+ * @public
190
+ */
191
+ export declare class S3VectorsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, S3VectorsClientResolvedConfig> {
192
+ /**
193
+ * The resolved configuration of S3VectorsClient class. This is resolved and normalized from the {@link S3VectorsClientConfig | constructor configuration interface}.
194
+ */
195
+ readonly config: S3VectorsClientResolvedConfig;
196
+ constructor(...[configuration]: __CheckOptionalClientConfig<S3VectorsClientConfig>);
197
+ /**
198
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
199
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
200
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
201
+ */
202
+ destroy(): void;
203
+ }
@@ -0,0 +1,29 @@
1
+ import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
2
+ import { S3VectorsHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: S3VectorsHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): S3VectorsHttpAuthSchemeProvider;
11
+ setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
12
+ credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export type HttpAuthRuntimeConfig = Partial<{
18
+ httpAuthSchemes: HttpAuthScheme[];
19
+ httpAuthSchemeProvider: S3VectorsHttpAuthSchemeProvider;
20
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
21
+ }>;
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
26
+ /**
27
+ * @internal
28
+ */
29
+ export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;
@@ -0,0 +1,75 @@
1
+ import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
2
+ import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
3
+ import { S3VectorsClientResolvedConfig } from "../S3VectorsClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface S3VectorsHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface S3VectorsHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<S3VectorsClientResolvedConfig, HandlerExecutionContext, S3VectorsHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultS3VectorsHttpAuthSchemeParametersProvider: (config: S3VectorsClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<S3VectorsHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface S3VectorsHttpAuthSchemeProvider extends HttpAuthSchemeProvider<S3VectorsHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultS3VectorsHttpAuthSchemeProvider: S3VectorsHttpAuthSchemeProvider;
28
+ /**
29
+ * @internal
30
+ */
31
+ export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
32
+ /**
33
+ * A comma-separated list of case-sensitive auth scheme names.
34
+ * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
35
+ * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
36
+ * @public
37
+ */
38
+ authSchemePreference?: string[] | Provider<string[]>;
39
+ /**
40
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
41
+ * @internal
42
+ */
43
+ httpAuthSchemes?: HttpAuthScheme[];
44
+ /**
45
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
46
+ * @internal
47
+ */
48
+ httpAuthSchemeProvider?: S3VectorsHttpAuthSchemeProvider;
49
+ }
50
+ /**
51
+ * @internal
52
+ */
53
+ export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
54
+ /**
55
+ * A comma-separated list of case-sensitive auth scheme names.
56
+ * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
57
+ * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
58
+ * @public
59
+ */
60
+ readonly authSchemePreference: Provider<string[]>;
61
+ /**
62
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
63
+ * @internal
64
+ */
65
+ readonly httpAuthSchemes: HttpAuthScheme[];
66
+ /**
67
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
68
+ * @internal
69
+ */
70
+ readonly httpAuthSchemeProvider: S3VectorsHttpAuthSchemeProvider;
71
+ }
72
+ /**
73
+ * @internal
74
+ */
75
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;