@aws-sdk/client-s3vectors 3.940.0 → 3.943.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/dist-cjs/index.js +113 -14
- package/dist-es/S3Vectors.js +6 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
- package/dist-es/commands/TagResourceCommand.js +16 -0
- package/dist-es/commands/UntagResourceCommand.js +16 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +73 -14
- package/dist-types/S3Vectors.d.ts +21 -0
- package/dist-types/S3VectorsClient.d.ts +5 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +8 -1
- package/dist-types/commands/CreateVectorBucketCommand.d.ts +4 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +4 -1
- package/dist-types/commands/DeleteVectorBucketCommand.d.ts +4 -1
- package/dist-types/commands/DeleteVectorBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVectorsCommand.d.ts +1 -1
- package/dist-types/commands/GetIndexCommand.d.ts +5 -1
- package/dist-types/commands/GetVectorBucketCommand.d.ts +1 -1
- package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetVectorsCommand.d.ts +1 -1
- package/dist-types/commands/ListIndexesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +97 -0
- package/dist-types/commands/ListVectorBucketsCommand.d.ts +1 -1
- package/dist-types/commands/ListVectorsCommand.d.ts +1 -1
- package/dist-types/commands/PutVectorBucketPolicyCommand.d.ts +1 -1
- package/dist-types/commands/PutVectorsCommand.d.ts +1 -1
- package/dist-types/commands/QueryVectorsCommand.d.ts +2 -7
- package/dist-types/commands/TagResourceCommand.d.ts +99 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +99 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +110 -35
- package/dist-types/schemas/schemas_0.d.ts +11 -0
- package/dist-types/ts3.4/S3Vectors.d.ts +51 -0
- package/dist-types/ts3.4/S3VectorsClient.d.ts +20 -2
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +25 -6
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +11 -0
- package/package.json +5 -5
|
@@ -27,7 +27,7 @@ declare const CreateIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Creates a vector index within a vector bucket. To specify the vector 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:CreateIndex</code> permission to use this operation.</p> <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> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -48,6 +48,13 @@ declare const CreateIndexCommand_base: {
|
|
|
48
48
|
* "STRING_VALUE",
|
|
49
49
|
* ],
|
|
50
50
|
* },
|
|
51
|
+
* encryptionConfiguration: { // EncryptionConfiguration
|
|
52
|
+
* sseType: "AES256" || "aws:kms",
|
|
53
|
+
* kmsKeyArn: "STRING_VALUE",
|
|
54
|
+
* },
|
|
55
|
+
* tags: { // TagsMap
|
|
56
|
+
* "<keys>": "STRING_VALUE",
|
|
57
|
+
* },
|
|
51
58
|
* };
|
|
52
59
|
* const command = new CreateIndexCommand(input);
|
|
53
60
|
* const response = await client.send(command);
|
|
@@ -27,7 +27,7 @@ declare const CreateVectorBucketCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:CreateVectorBucket</code> permission to use this operation. </p> <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> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -42,6 +42,9 @@ declare const CreateVectorBucketCommand_base: {
|
|
|
42
42
|
* sseType: "AES256" || "aws:kms",
|
|
43
43
|
* kmsKeyArn: "STRING_VALUE",
|
|
44
44
|
* },
|
|
45
|
+
* tags: { // TagsMap
|
|
46
|
+
* "<keys>": "STRING_VALUE",
|
|
47
|
+
* },
|
|
45
48
|
* };
|
|
46
49
|
* const command = new CreateVectorBucketCommand(input);
|
|
47
50
|
* const response = await client.send(command);
|
|
@@ -27,7 +27,7 @@ declare const DeleteIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes a vector index. To specify the vector index, you can either use both the vector bucket name and 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:DeleteIndex</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -53,6 +53,9 @@ declare const DeleteIndexCommand_base: {
|
|
|
53
53
|
* @see {@link DeleteIndexCommandOutput} for command's `response` shape.
|
|
54
54
|
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
55
55
|
*
|
|
56
|
+
* @throws {@link NotFoundException} (client fault)
|
|
57
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
58
|
+
*
|
|
56
59
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
57
60
|
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
58
61
|
*
|
|
@@ -27,7 +27,7 @@ declare const DeleteVectorBucketCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes a vector bucket. All vector indexes in the vector bucket must be deleted before the vector bucket can be deleted. To perform this operation, 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:DeleteVectorBucket</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -55,6 +55,9 @@ declare const DeleteVectorBucketCommand_base: {
|
|
|
55
55
|
* @throws {@link ConflictException} (client fault)
|
|
56
56
|
* <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>
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link NotFoundException} (client fault)
|
|
59
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
60
|
+
*
|
|
58
61
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
59
62
|
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
60
63
|
*
|
|
@@ -27,7 +27,7 @@ declare const DeleteVectorBucketPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes a vector bucket policy. 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:DeleteVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteVectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes one or more vectors in a vector index. To specify the vector index, you can either use both the vector bucket name and 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:DeleteVectors</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetIndexCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns vector index attributes. 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:GetIndex</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -57,6 +57,10 @@ declare const GetIndexCommand_base: {
|
|
|
57
57
|
* // "STRING_VALUE",
|
|
58
58
|
* // ],
|
|
59
59
|
* // },
|
|
60
|
+
* // encryptionConfiguration: { // EncryptionConfiguration
|
|
61
|
+
* // sseType: "AES256" || "aws:kms",
|
|
62
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
60
64
|
* // },
|
|
61
65
|
* // };
|
|
62
66
|
*
|
|
@@ -27,7 +27,7 @@ declare const GetVectorBucketCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns vector bucket attributes. 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:GetVectorBucket</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetVectorBucketPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Gets details about a vector bucket policy. 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:GetVectorBucketPolicy</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetVectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns vector attributes. 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:GetVectors</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListIndexesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns a list of all the vector indexes within the specified 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:ListIndexes</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListTagsForResourceInput, ListTagsForResourceOutput } 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 ListTagsForResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListTagsForResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListTagsForResourceCommand_base: {
|
|
25
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListTagsForResourceCommandInput): import("@smithy/smithy-client").CommandImpl<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all of the tags applied to a specified Amazon S3 Vectors resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources. </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:ListTagsForResource</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, ListTagsForResourceCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, ListTagsForResourceCommand } = 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 = { // ListTagsForResourceInput
|
|
40
|
+
* resourceArn: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListTagsForResourceOutput
|
|
45
|
+
* // tags: { // TagsMap // required
|
|
46
|
+
* // "<keys>": "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
53
|
+
* @returns {@link ListTagsForResourceCommandOutput}
|
|
54
|
+
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link NotFoundException} (client fault)
|
|
59
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
62
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>Access denied.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerException} (server fault)
|
|
68
|
+
* <p>The request failed due to an internal server error.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link RequestTimeoutException} (client fault)
|
|
71
|
+
* <p>The request timed out. Retry your request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
74
|
+
* <p>The request was denied due to request throttling.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
* <p>The requested action isn't valid.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link S3VectorsServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: ListTagsForResourceInput;
|
|
90
|
+
output: ListTagsForResourceOutput;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: ListTagsForResourceCommandInput;
|
|
94
|
+
output: ListTagsForResourceCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|
|
@@ -27,7 +27,7 @@ declare const ListVectorBucketsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns a list of all the vector buckets that are owned by the authenticated sender of the request.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:ListVectorBuckets</code> permission to use this operation. </p> </dd> </dl>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListVectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <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
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const PutVectorBucketPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <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
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const PutVectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <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
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const QueryVectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <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
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -55,14 +55,9 @@ declare const QueryVectorsCommand_base: {
|
|
|
55
55
|
* // { // QueryVectorsOutput
|
|
56
56
|
* // vectors: [ // QueryVectorsOutputList // required
|
|
57
57
|
* // { // QueryOutputVector
|
|
58
|
+
* // distance: Number("float"),
|
|
58
59
|
* // key: "STRING_VALUE", // required
|
|
59
|
-
* // data: { // VectorData Union: only one key present
|
|
60
|
-
* // float32: [ // Float32VectorData
|
|
61
|
-
* // Number("float"),
|
|
62
|
-
* // ],
|
|
63
|
-
* // },
|
|
64
60
|
* // metadata: "DOCUMENT_VALUE",
|
|
65
|
-
* // distance: Number("float"),
|
|
66
61
|
* // },
|
|
67
62
|
* // ],
|
|
68
63
|
* // distanceMetric: "euclidean" || "cosine", // required
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { TagResourceInput, TagResourceOutput } from "../models/models_0";
|
|
4
|
+
import { 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 { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UntagResourceInput, UntagResourceOutput } 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 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";
|