@aws-sdk/client-s3vectors 3.941.0 → 3.946.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 (64) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +130 -196
  3. package/dist-cjs/runtimeConfig.browser.js +2 -2
  4. package/dist-cjs/runtimeConfig.js +3 -4
  5. package/dist-es/S3Vectors.js +6 -0
  6. package/dist-es/S3VectorsClient.js +2 -2
  7. package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
  8. package/dist-es/commands/TagResourceCommand.js +16 -0
  9. package/dist-es/commands/UntagResourceCommand.js +16 -0
  10. package/dist-es/commands/index.js +3 -0
  11. package/dist-es/runtimeConfig.browser.js +2 -2
  12. package/dist-es/runtimeConfig.js +2 -3
  13. package/dist-es/schemas/schemas_0.js +90 -196
  14. package/dist-types/S3Vectors.d.ts +22 -1
  15. package/dist-types/S3VectorsClient.d.ts +15 -12
  16. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +2 -2
  17. package/dist-types/auth/httpAuthSchemeProvider.d.ts +2 -2
  18. package/dist-types/commands/CreateIndexCommand.d.ts +11 -4
  19. package/dist-types/commands/CreateVectorBucketCommand.d.ts +7 -4
  20. package/dist-types/commands/DeleteIndexCommand.d.ts +7 -4
  21. package/dist-types/commands/DeleteVectorBucketCommand.d.ts +7 -4
  22. package/dist-types/commands/DeleteVectorBucketPolicyCommand.d.ts +4 -4
  23. package/dist-types/commands/DeleteVectorsCommand.d.ts +4 -4
  24. package/dist-types/commands/GetIndexCommand.d.ts +8 -4
  25. package/dist-types/commands/GetVectorBucketCommand.d.ts +4 -4
  26. package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts +4 -4
  27. package/dist-types/commands/GetVectorsCommand.d.ts +4 -4
  28. package/dist-types/commands/ListIndexesCommand.d.ts +4 -4
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +97 -0
  30. package/dist-types/commands/ListVectorBucketsCommand.d.ts +4 -4
  31. package/dist-types/commands/ListVectorsCommand.d.ts +4 -4
  32. package/dist-types/commands/PutVectorBucketPolicyCommand.d.ts +4 -4
  33. package/dist-types/commands/PutVectorsCommand.d.ts +4 -4
  34. package/dist-types/commands/QueryVectorsCommand.d.ts +5 -10
  35. package/dist-types/commands/TagResourceCommand.d.ts +99 -0
  36. package/dist-types/commands/UntagResourceCommand.d.ts +99 -0
  37. package/dist-types/commands/index.d.ts +3 -0
  38. package/dist-types/endpoint/EndpointParameters.d.ts +13 -1
  39. package/dist-types/endpoint/endpointResolver.d.ts +5 -2
  40. package/dist-types/extensionConfiguration.d.ts +4 -4
  41. package/dist-types/models/S3VectorsServiceException.d.ts +1 -1
  42. package/dist-types/models/errors.d.ts +1 -1
  43. package/dist-types/models/models_0.d.ts +110 -35
  44. package/dist-types/pagination/Interfaces.d.ts +1 -1
  45. package/dist-types/pagination/ListIndexesPaginator.d.ts +1 -1
  46. package/dist-types/pagination/ListVectorBucketsPaginator.d.ts +1 -1
  47. package/dist-types/pagination/ListVectorsPaginator.d.ts +1 -1
  48. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  49. package/dist-types/runtimeConfig.d.ts +1 -1
  50. package/dist-types/runtimeConfig.native.d.ts +1 -1
  51. package/dist-types/runtimeConfig.shared.d.ts +1 -1
  52. package/dist-types/runtimeExtensions.d.ts +1 -1
  53. package/dist-types/schemas/schemas_0.d.ts +12 -1
  54. package/dist-types/ts3.4/S3Vectors.d.ts +51 -0
  55. package/dist-types/ts3.4/S3VectorsClient.d.ts +23 -5
  56. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  58. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  59. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +47 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  61. package/dist-types/ts3.4/models/S3VectorsServiceException.d.ts +1 -1
  62. package/dist-types/ts3.4/models/models_0.d.ts +25 -6
  63. package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
  64. package/package.json +13 -12
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { TagResourceInput, TagResourceOutput } from "../models/models_0";
4
+ import type { 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 TagResourceCommand}.
14
+ */
15
+ export interface TagResourceCommandInput extends TagResourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link TagResourceCommand}.
21
+ */
22
+ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
23
+ }
24
+ declare const TagResourceCommand_base: {
25
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Applies one or more user-defined tags to an Amazon S3 Vectors resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each resource.</p> <note> <p>For a list of S3 resources that support tagging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#manage-tags">Managing tags for Amazon S3 resources</a>.</p> </note> <dl> <dt>Permissions</dt> <dd> <p>For vector buckets and vector indexes, you must have the <code>s3vectors:TagResource</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, TagResourceCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, TagResourceCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * // import type { S3VectorsClientConfig } from "@aws-sdk/client-s3vectors";
37
+ * const config = {}; // type is S3VectorsClientConfig
38
+ * const client = new S3VectorsClient(config);
39
+ * const input = { // TagResourceInput
40
+ * resourceArn: "STRING_VALUE", // required
41
+ * tags: { // TagsMap // required
42
+ * "<keys>": "STRING_VALUE",
43
+ * },
44
+ * };
45
+ * const command = new TagResourceCommand(input);
46
+ * const response = await client.send(command);
47
+ * // {};
48
+ *
49
+ * ```
50
+ *
51
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
52
+ * @returns {@link TagResourceCommandOutput}
53
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
54
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
55
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.</p>
59
+ *
60
+ * @throws {@link NotFoundException} (client fault)
61
+ * <p>The request was rejected because the specified resource can't be found.</p>
62
+ *
63
+ * @throws {@link ServiceUnavailableException} (server fault)
64
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>Access denied.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>The request failed due to an internal server error.</p>
71
+ *
72
+ * @throws {@link RequestTimeoutException} (client fault)
73
+ * <p>The request timed out. Retry your request.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>The request was denied due to request throttling.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>The requested action isn't valid.</p>
80
+ *
81
+ * @throws {@link S3VectorsServiceException}
82
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class TagResourceCommand extends TagResourceCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: TagResourceInput;
92
+ output: {};
93
+ };
94
+ sdk: {
95
+ input: TagResourceCommandInput;
96
+ output: TagResourceCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
4
+ import type { 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 UntagResourceCommand}.
14
+ */
15
+ export interface UntagResourceCommandInput extends UntagResourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UntagResourceCommand}.
21
+ */
22
+ export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
23
+ }
24
+ declare const UntagResourceCommand_base: {
25
+ new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Removes the specified user-defined tags from an Amazon S3 Vectors resource. You can pass one or more tag keys. </p> <note> <p>For a list of S3 resources that support tagging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#manage-tags">Managing tags for Amazon S3 resources</a>.</p> </note> <dl> <dt>Permissions</dt> <dd> <p>For vector buckets and vector indexes, you must have the <code>s3vectors:UntagResource</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, UntagResourceCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
35
+ * // const { S3VectorsClient, UntagResourceCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
36
+ * // import type { S3VectorsClientConfig } from "@aws-sdk/client-s3vectors";
37
+ * const config = {}; // type is S3VectorsClientConfig
38
+ * const client = new S3VectorsClient(config);
39
+ * const input = { // UntagResourceInput
40
+ * resourceArn: "STRING_VALUE", // required
41
+ * tagKeys: [ // TagKeyList // required
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * };
45
+ * const command = new UntagResourceCommand(input);
46
+ * const response = await client.send(command);
47
+ * // {};
48
+ *
49
+ * ```
50
+ *
51
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
52
+ * @returns {@link UntagResourceCommandOutput}
53
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
54
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
55
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.</p>
59
+ *
60
+ * @throws {@link NotFoundException} (client fault)
61
+ * <p>The request was rejected because the specified resource can't be found.</p>
62
+ *
63
+ * @throws {@link ServiceUnavailableException} (server fault)
64
+ * <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>Access denied.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>The request failed due to an internal server error.</p>
71
+ *
72
+ * @throws {@link RequestTimeoutException} (client fault)
73
+ * <p>The request timed out. Retry your request.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>The request was denied due to request throttling.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>The requested action isn't valid.</p>
80
+ *
81
+ * @throws {@link S3VectorsServiceException}
82
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class UntagResourceCommand extends UntagResourceCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: UntagResourceInput;
92
+ output: {};
93
+ };
94
+ sdk: {
95
+ input: UntagResourceCommandInput;
96
+ output: UntagResourceCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -9,8 +9,11 @@ export * from "./GetVectorBucketCommand";
9
9
  export * from "./GetVectorBucketPolicyCommand";
10
10
  export * from "./GetVectorsCommand";
11
11
  export * from "./ListIndexesCommand";
12
+ export * from "./ListTagsForResourceCommand";
12
13
  export * from "./ListVectorBucketsCommand";
13
14
  export * from "./ListVectorsCommand";
14
15
  export * from "./PutVectorBucketPolicyCommand";
15
16
  export * from "./PutVectorsCommand";
16
17
  export * from "./QueryVectorsCommand";
18
+ export * from "./TagResourceCommand";
19
+ export * from "./UntagResourceCommand";
@@ -1,4 +1,4 @@
1
- import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
1
+ import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
2
  /**
3
3
  * @public
4
4
  */
@@ -7,10 +7,19 @@ export interface ClientInputEndpointParameters {
7
7
  endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
8
8
  region?: string | undefined | Provider<string | undefined>;
9
9
  }
10
+ /**
11
+ * @public
12
+ */
10
13
  export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
11
14
  defaultSigningName: string;
12
15
  };
16
+ /**
17
+ * @internal
18
+ */
13
19
  export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
20
+ /**
21
+ * @internal
22
+ */
14
23
  export declare const commonParams: {
15
24
  readonly UseFIPS: {
16
25
  readonly type: "builtInParams";
@@ -25,6 +34,9 @@ export declare const commonParams: {
25
34
  readonly name: "region";
26
35
  };
27
36
  };
37
+ /**
38
+ * @internal
39
+ */
28
40
  export interface EndpointParameters extends __EndpointParameters {
29
41
  UseFIPS?: boolean | undefined;
30
42
  Endpoint?: string | undefined;
@@ -1,5 +1,8 @@
1
- import { EndpointV2, Logger } from "@smithy/types";
2
- import { EndpointParameters } from "./EndpointParameters";
1
+ import type { EndpointV2, Logger } from "@smithy/types";
2
+ import type { EndpointParameters } from "./EndpointParameters";
3
+ /**
4
+ * @internal
5
+ */
3
6
  export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
4
7
  logger?: Logger;
5
8
  }) => EndpointV2;
@@ -1,7 +1,7 @@
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";
1
+ import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
+ import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
+ import type { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
5
5
  /**
6
6
  * @internal
7
7
  */
@@ -1,4 +1,4 @@
1
- import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
1
+ import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/smithy-client";
2
2
  export type { __ServiceExceptionOptions };
3
3
  export { __ServiceException };
4
4
  /**
@@ -1,4 +1,4 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
1
+ import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ValidationExceptionField } from "./models_0";
3
3
  import { S3VectorsServiceException as __BaseException } from "./S3VectorsServiceException";
4
4
  /**
@@ -1,7 +1,23 @@
1
1
  import { DocumentType as __DocumentType } from "@smithy/types";
2
2
  import { DataType, DistanceMetric, SseType } from "./enums";
3
3
  /**
4
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The metadata configuration for a vector index.</p>
4
+ * <p>The encryption configuration for a vector bucket or index. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.</p>
5
+ * @public
6
+ */
7
+ export interface EncryptionConfiguration {
8
+ /**
9
+ * <p>The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
10
+ * @public
11
+ */
12
+ sseType?: SseType | undefined;
13
+ /**
14
+ * <p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if <code>sseType</code> is set to <code>aws:kms</code>.</p> <p>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</p> <p>For example, specify Key ARN in the following format: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
15
+ * @public
16
+ */
17
+ kmsKeyArn?: string | undefined;
18
+ }
19
+ /**
20
+ * <p>The metadata configuration for a vector index.</p>
5
21
  * @public
6
22
  */
7
23
  export interface MetadataConfiguration {
@@ -50,6 +66,16 @@ export interface CreateIndexInput {
50
66
  * @public
51
67
  */
52
68
  metadataConfiguration?: MetadataConfiguration | undefined;
69
+ /**
70
+ * <p>The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.</p>
71
+ * @public
72
+ */
73
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
74
+ /**
75
+ * <p>An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateIndex</code> permission to create a vector index with tags.</p> </note>
76
+ * @public
77
+ */
78
+ tags?: Record<string, string> | undefined;
53
79
  }
54
80
  /**
55
81
  * @public
@@ -77,22 +103,6 @@ export interface ValidationExceptionField {
77
103
  */
78
104
  message: string | undefined;
79
105
  }
80
- /**
81
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The encryption configuration for a vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
82
- * @public
83
- */
84
- export interface EncryptionConfiguration {
85
- /**
86
- * <p>The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically <code>AES256</code>.</p>
87
- * @public
88
- */
89
- sseType?: SseType | undefined;
90
- /**
91
- * <p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if <code>sseType</code> is set to <code>aws:kms</code>.</p> <p>To specify the KMS key, you must use the format of the KMS key Amazon Resource Name (ARN).</p> <p>For example, specify Key ARN in the following format: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p>
92
- * @public
93
- */
94
- kmsKeyArn?: string | undefined;
95
- }
96
106
  /**
97
107
  * @public
98
108
  */
@@ -107,6 +117,11 @@ export interface CreateVectorBucketInput {
107
117
  * @public
108
118
  */
109
119
  encryptionConfiguration?: EncryptionConfiguration | undefined;
120
+ /**
121
+ * <p>An array of user-defined tags that you would like to apply to the vector bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateVectorBucket</code> permission to create a vector bucket with tags.</p> </note>
122
+ * @public
123
+ */
124
+ tags?: Record<string, string> | undefined;
110
125
  }
111
126
  /**
112
127
  * @public
@@ -234,7 +249,7 @@ export interface GetIndexInput {
234
249
  indexArn?: string | undefined;
235
250
  }
236
251
  /**
237
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector index.</p>
252
+ * <p>The attributes of a vector index.</p>
238
253
  * @public
239
254
  */
240
255
  export interface Index {
@@ -278,6 +293,11 @@ export interface Index {
278
293
  * @public
279
294
  */
280
295
  metadataConfiguration?: MetadataConfiguration | undefined;
296
+ /**
297
+ * <p>The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.</p>
298
+ * @public
299
+ */
300
+ encryptionConfiguration?: EncryptionConfiguration | undefined;
281
301
  }
282
302
  /**
283
303
  * @public
@@ -290,7 +310,7 @@ export interface GetIndexOutput {
290
310
  index: Index | undefined;
291
311
  }
292
312
  /**
293
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The vector data in different formats.</p>
313
+ * <p>The vector data in different formats.</p>
294
314
  * @public
295
315
  */
296
316
  export type VectorData = VectorData.Float32Member | VectorData.$UnknownMember;
@@ -323,7 +343,7 @@ export declare namespace VectorData {
323
343
  }
324
344
  }
325
345
  /**
326
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>GetVectors</code> operation.</p>
346
+ * <p>The attributes of a vector returned by the <code>GetVectors</code> operation.</p>
327
347
  * @public
328
348
  */
329
349
  export interface GetOutputVector {
@@ -359,7 +379,7 @@ export interface GetVectorBucketInput {
359
379
  vectorBucketArn?: string | undefined;
360
380
  }
361
381
  /**
362
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector bucket. </p>
382
+ * <p>The attributes of a vector bucket. </p>
363
383
  * @public
364
384
  */
365
385
  export interface VectorBucket {
@@ -495,7 +515,7 @@ export interface ListIndexesInput {
495
515
  prefix?: string | undefined;
496
516
  }
497
517
  /**
498
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector index.</p>
518
+ * <p>Summary information about a vector index.</p>
499
519
  * @public
500
520
  */
501
521
  export interface IndexSummary {
@@ -586,7 +606,7 @@ export interface ListVectorsInput {
586
606
  returnMetadata?: boolean | undefined;
587
607
  }
588
608
  /**
589
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector returned by the <code>ListVectors</code> operation.</p>
609
+ * <p>The attributes of a vector returned by the <code>ListVectors</code> operation.</p>
590
610
  * @public
591
611
  */
592
612
  export interface ListOutputVector {
@@ -622,7 +642,7 @@ export interface ListVectorsOutput {
622
642
  vectors: ListOutputVector[] | undefined;
623
643
  }
624
644
  /**
625
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector to add to a vector index.</p>
645
+ * <p>The attributes of a vector to add to a vector index.</p>
626
646
  * @public
627
647
  */
628
648
  export interface PutInputVector {
@@ -718,30 +738,25 @@ export interface QueryVectorsInput {
718
738
  returnDistance?: boolean | undefined;
719
739
  }
720
740
  /**
721
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>The attributes of a vector in the approximate nearest neighbor search.</p>
741
+ * <p>The attributes of a vector in the approximate nearest neighbor search.</p>
722
742
  * @public
723
743
  */
724
744
  export interface QueryOutputVector {
725
745
  /**
726
- * <p>The key of the vector in the approximate nearest neighbor search.</p>
746
+ * <p>The measure of similarity between the vector in the response and the query vector.</p>
727
747
  * @public
728
748
  */
729
- key: string | undefined;
749
+ distance?: number | undefined;
730
750
  /**
731
- * <p>The vector data associated with the vector, if requested. </p>
751
+ * <p>The key of the vector in the approximate nearest neighbor search.</p>
732
752
  * @public
733
753
  */
734
- data?: VectorData | undefined;
754
+ key: string | undefined;
735
755
  /**
736
756
  * <p>The metadata associated with the vector, if requested.</p>
737
757
  * @public
738
758
  */
739
759
  metadata?: __DocumentType | undefined;
740
- /**
741
- * <p>The measure of similarity between the vector in the response and the query vector.</p>
742
- * @public
743
- */
744
- distance?: number | undefined;
745
760
  }
746
761
  /**
747
762
  * @public
@@ -758,6 +773,26 @@ export interface QueryVectorsOutput {
758
773
  */
759
774
  distanceMetric: DistanceMetric | undefined;
760
775
  }
776
+ /**
777
+ * @public
778
+ */
779
+ export interface ListTagsForResourceInput {
780
+ /**
781
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you want to list tags for. The tagged resource can be a vector bucket or a vector index. </p>
782
+ * @public
783
+ */
784
+ resourceArn: string | undefined;
785
+ }
786
+ /**
787
+ * @public
788
+ */
789
+ export interface ListTagsForResourceOutput {
790
+ /**
791
+ * <p>The user-defined tags that are applied to the S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
792
+ * @public
793
+ */
794
+ tags: Record<string, string> | undefined;
795
+ }
761
796
  /**
762
797
  * @public
763
798
  */
@@ -779,7 +814,7 @@ export interface ListVectorBucketsInput {
779
814
  prefix?: string | undefined;
780
815
  }
781
816
  /**
782
- * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Summary information about a vector bucket.</p>
817
+ * <p>Summary information about a vector bucket.</p>
783
818
  * @public
784
819
  */
785
820
  export interface VectorBucketSummary {
@@ -839,3 +874,43 @@ export interface PutVectorBucketPolicyInput {
839
874
  */
840
875
  export interface PutVectorBucketPolicyOutput {
841
876
  }
877
+ /**
878
+ * @public
879
+ */
880
+ export interface TagResourceInput {
881
+ /**
882
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you're applying tags to. The tagged resource can be a vector bucket or a vector index. </p>
883
+ * @public
884
+ */
885
+ resourceArn: string | undefined;
886
+ /**
887
+ * <p>The user-defined tag that you want to add to the specified S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
888
+ * @public
889
+ */
890
+ tags: Record<string, string> | undefined;
891
+ }
892
+ /**
893
+ * @public
894
+ */
895
+ export interface TagResourceOutput {
896
+ }
897
+ /**
898
+ * @public
899
+ */
900
+ export interface UntagResourceInput {
901
+ /**
902
+ * <p>The Amazon Resource Name (ARN) of the Amazon S3 Vectors resource that you're removing tags from. The tagged resource can be a vector bucket or a vector index. </p>
903
+ * @public
904
+ */
905
+ resourceArn: string | undefined;
906
+ /**
907
+ * <p>The array of tag keys that you're removing from the S3 Vectors resource. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p>
908
+ * @public
909
+ */
910
+ tagKeys: string[] | undefined;
911
+ }
912
+ /**
913
+ * @public
914
+ */
915
+ export interface UntagResourceOutput {
916
+ }
@@ -1,4 +1,4 @@
1
- import { PaginationConfiguration } from "@smithy/types";
1
+ import type { PaginationConfiguration } from "@smithy/types";
2
2
  import { S3VectorsClient } from "../S3VectorsClient";
3
3
  /**
4
4
  * @public
@@ -1,4 +1,4 @@
1
- import { Paginator } from "@smithy/types";
1
+ import type { Paginator } from "@smithy/types";
2
2
  import { ListIndexesCommandInput, ListIndexesCommandOutput } from "../commands/ListIndexesCommand";
3
3
  import { S3VectorsPaginationConfiguration } from "./Interfaces";
4
4
  /**
@@ -1,4 +1,4 @@
1
- import { Paginator } from "@smithy/types";
1
+ import type { Paginator } from "@smithy/types";
2
2
  import { ListVectorBucketsCommandInput, ListVectorBucketsCommandOutput } from "../commands/ListVectorBucketsCommand";
3
3
  import { S3VectorsPaginationConfiguration } from "./Interfaces";
4
4
  /**
@@ -1,4 +1,4 @@
1
- import { Paginator } from "@smithy/types";
1
+ import type { Paginator } from "@smithy/types";
2
2
  import { ListVectorsCommandInput, ListVectorsCommandOutput } from "../commands/ListVectorsCommand";
3
3
  import { S3VectorsPaginationConfiguration } from "./Interfaces";
4
4
  /**
@@ -1,5 +1,5 @@
1
1
  import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
2
- import { S3VectorsClientConfig } from "./S3VectorsClient";
2
+ import type { S3VectorsClientConfig } from "./S3VectorsClient";
3
3
  /**
4
4
  * @internal
5
5
  */
@@ -1,5 +1,5 @@
1
1
  import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
2
- import { S3VectorsClientConfig } from "./S3VectorsClient";
2
+ import type { S3VectorsClientConfig } from "./S3VectorsClient";
3
3
  /**
4
4
  * @internal
5
5
  */
@@ -1,4 +1,4 @@
1
- import { S3VectorsClientConfig } from "./S3VectorsClient";
1
+ import type { S3VectorsClientConfig } from "./S3VectorsClient";
2
2
  /**
3
3
  * @internal
4
4
  */
@@ -1,4 +1,4 @@
1
- import { S3VectorsClientConfig } from "./S3VectorsClient";
1
+ import type { S3VectorsClientConfig } from "./S3VectorsClient";
2
2
  /**
3
3
  * @internal
4
4
  */
@@ -1,4 +1,4 @@
1
- import { S3VectorsExtensionConfiguration } from "./extensionConfiguration";
1
+ import type { S3VectorsExtensionConfiguration } from "./extensionConfiguration";
2
2
  /**
3
3
  * @public
4
4
  */