@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.
- package/LICENSE +201 -0
- package/README.md +333 -0
- package/dist-cjs/S3Vectors.js +43 -0
- package/dist-cjs/S3VectorsClient.js +52 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateIndexCommand.js +26 -0
- package/dist-cjs/commands/CreateVectorBucketCommand.js +26 -0
- package/dist-cjs/commands/DeleteIndexCommand.js +26 -0
- package/dist-cjs/commands/DeleteVectorBucketCommand.js +26 -0
- package/dist-cjs/commands/DeleteVectorBucketPolicyCommand.js +26 -0
- package/dist-cjs/commands/DeleteVectorsCommand.js +26 -0
- package/dist-cjs/commands/GetIndexCommand.js +26 -0
- package/dist-cjs/commands/GetVectorBucketCommand.js +26 -0
- package/dist-cjs/commands/GetVectorBucketPolicyCommand.js +26 -0
- package/dist-cjs/commands/GetVectorsCommand.js +26 -0
- package/dist-cjs/commands/ListIndexesCommand.js +26 -0
- package/dist-cjs/commands/ListVectorBucketsCommand.js +26 -0
- package/dist-cjs/commands/ListVectorsCommand.js +26 -0
- package/dist-cjs/commands/PutVectorBucketPolicyCommand.js +26 -0
- package/dist-cjs/commands/PutVectorsCommand.js +26 -0
- package/dist-cjs/commands/QueryVectorsCommand.js +26 -0
- package/dist-cjs/commands/index.js +19 -0
- package/dist-cjs/endpoint/EndpointParameters.js +15 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/S3VectorsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +186 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListIndexesPaginator.js +7 -0
- package/dist-cjs/pagination/ListVectorBucketsPaginator.js +7 -0
- package/dist-cjs/pagination/ListVectorsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +858 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +13 -0
- package/dist-es/S3Vectors.js +39 -0
- package/dist-es/S3VectorsClient.js +48 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateIndexCommand.js +22 -0
- package/dist-es/commands/CreateVectorBucketCommand.js +22 -0
- package/dist-es/commands/DeleteIndexCommand.js +22 -0
- package/dist-es/commands/DeleteVectorBucketCommand.js +22 -0
- package/dist-es/commands/DeleteVectorBucketPolicyCommand.js +22 -0
- package/dist-es/commands/DeleteVectorsCommand.js +22 -0
- package/dist-es/commands/GetIndexCommand.js +22 -0
- package/dist-es/commands/GetVectorBucketCommand.js +22 -0
- package/dist-es/commands/GetVectorBucketPolicyCommand.js +22 -0
- package/dist-es/commands/GetVectorsCommand.js +22 -0
- package/dist-es/commands/ListIndexesCommand.js +22 -0
- package/dist-es/commands/ListVectorBucketsCommand.js +22 -0
- package/dist-es/commands/ListVectorsCommand.js +22 -0
- package/dist-es/commands/PutVectorBucketPolicyCommand.js +22 -0
- package/dist-es/commands/PutVectorsCommand.js +22 -0
- package/dist-es/commands/QueryVectorsCommand.js +22 -0
- package/dist-es/commands/index.js +16 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/S3VectorsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +171 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListIndexesPaginator.js +4 -0
- package/dist-es/pagination/ListVectorBucketsPaginator.js +4 -0
- package/dist-es/pagination/ListVectorsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +823 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-types/S3Vectors.d.ts +131 -0
- package/dist-types/S3VectorsClient.d.ts +203 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +104 -0
- package/dist-types/commands/CreateVectorBucketCommand.d.ts +95 -0
- package/dist-types/commands/DeleteIndexCommand.d.ts +90 -0
- package/dist-types/commands/DeleteVectorBucketCommand.d.ts +92 -0
- package/dist-types/commands/DeleteVectorBucketPolicyCommand.d.ts +92 -0
- package/dist-types/commands/DeleteVectorsCommand.d.ts +108 -0
- package/dist-types/commands/GetIndexCommand.d.ts +108 -0
- package/dist-types/commands/GetVectorBucketCommand.d.ts +102 -0
- package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts +94 -0
- package/dist-types/commands/GetVectorsCommand.d.ts +122 -0
- package/dist-types/commands/ListIndexesCommand.d.ts +105 -0
- package/dist-types/commands/ListVectorBucketsCommand.d.ts +99 -0
- package/dist-types/commands/ListVectorsCommand.d.ts +112 -0
- package/dist-types/commands/PutVectorBucketPolicyCommand.d.ts +93 -0
- package/dist-types/commands/PutVectorsCommand.d.ts +116 -0
- package/dist-types/commands/QueryVectorsCommand.d.ts +127 -0
- package/dist-types/commands/index.d.ts +16 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/S3VectorsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1013 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListIndexesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListVectorBucketsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListVectorsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +146 -0
- package/dist-types/runtimeConfig.browser.d.ts +50 -0
- package/dist-types/runtimeConfig.d.ts +50 -0
- package/dist-types/runtimeConfig.native.d.ts +49 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/S3Vectors.d.ts +286 -0
- package/dist-types/ts3.4/S3VectorsClient.d.ts +215 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateVectorBucketCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteVectorBucketCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteVectorBucketPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteVectorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetIndexCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetVectorBucketCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetVectorBucketPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetVectorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListIndexesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListVectorBucketsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListVectorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/PutVectorBucketPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutVectorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/QueryVectorsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +16 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/S3VectorsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +311 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListIndexesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListVectorBucketsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListVectorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +197 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +99 -0
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateIndexInput, CreateIndexOutput } 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 CreateIndexCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateIndexCommandInput extends CreateIndexInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateIndexCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateIndexCommand_base: {
|
|
25
|
+
new (input: CreateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIndexCommandInput, CreateIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateIndexCommandInput): import("@smithy/smithy-client").CommandImpl<CreateIndexCommandInput, CreateIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Creates a 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> </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, CreateIndexCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, CreateIndexCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // CreateIndexInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE",
|
|
39
|
+
* vectorBucketArn: "STRING_VALUE",
|
|
40
|
+
* indexName: "STRING_VALUE", // required
|
|
41
|
+
* dataType: "float32", // required
|
|
42
|
+
* dimension: Number("int"), // required
|
|
43
|
+
* distanceMetric: "euclidean" || "cosine", // required
|
|
44
|
+
* metadataConfiguration: { // MetadataConfiguration
|
|
45
|
+
* nonFilterableMetadataKeys: [ // NonFilterableMetadataKeys // required
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* },
|
|
49
|
+
* };
|
|
50
|
+
* const command = new CreateIndexCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // {};
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param CreateIndexCommandInput - {@link CreateIndexCommandInput}
|
|
57
|
+
* @returns {@link CreateIndexCommandOutput}
|
|
58
|
+
* @see {@link CreateIndexCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link CreateIndexCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ConflictException} (client fault)
|
|
63
|
+
* <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>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link NotFoundException} (client fault)
|
|
66
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
69
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
72
|
+
* <p>Access denied.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalServerException} (server fault)
|
|
75
|
+
* <p>The request failed due to an internal server error.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
+
* <p>Your request exceeds a service quota. </p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ValidationException} (client fault)
|
|
84
|
+
* <p>The requested action isn't valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link S3VectorsServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class CreateIndexCommand extends CreateIndexCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: CreateIndexInput;
|
|
97
|
+
output: {};
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: CreateIndexCommandInput;
|
|
101
|
+
output: CreateIndexCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CreateVectorBucketInput, CreateVectorBucketOutput } 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 CreateVectorBucketCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateVectorBucketCommandInput extends CreateVectorBucketInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateVectorBucketCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateVectorBucketCommandOutput extends CreateVectorBucketOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateVectorBucketCommand_base: {
|
|
25
|
+
new (input: CreateVectorBucketCommandInput): import("@smithy/smithy-client").CommandImpl<CreateVectorBucketCommandInput, CreateVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: CreateVectorBucketCommandInput): import("@smithy/smithy-client").CommandImpl<CreateVectorBucketCommandInput, CreateVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>Creates a 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> </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, CreateVectorBucketCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, CreateVectorBucketCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // CreateVectorBucketInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE", // required
|
|
39
|
+
* encryptionConfiguration: { // EncryptionConfiguration
|
|
40
|
+
* sseType: "AES256" || "aws:kms",
|
|
41
|
+
* kmsKeyArn: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new CreateVectorBucketCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // {};
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param CreateVectorBucketCommandInput - {@link CreateVectorBucketCommandInput}
|
|
51
|
+
* @returns {@link CreateVectorBucketCommandOutput}
|
|
52
|
+
* @see {@link CreateVectorBucketCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link CreateVectorBucketCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ConflictException} (client fault)
|
|
57
|
+
* <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>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
60
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>Access denied.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>The request failed due to an internal server error.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
69
|
+
* <p>Your request exceeds a service quota. </p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
72
|
+
* <p>The request was denied due to request throttling.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>The requested action isn't valid.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link S3VectorsServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class CreateVectorBucketCommand extends CreateVectorBucketCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: CreateVectorBucketInput;
|
|
88
|
+
output: {};
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: CreateVectorBucketCommandInput;
|
|
92
|
+
output: CreateVectorBucketCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteIndexInput, DeleteIndexOutput } 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 DeleteIndexCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteIndexCommandInput extends DeleteIndexInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteIndexCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteIndexCommand_base: {
|
|
25
|
+
new (input: DeleteIndexCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteIndexCommandInput, DeleteIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [DeleteIndexCommandInput]): import("@smithy/smithy-client").CommandImpl<DeleteIndexCommandInput, DeleteIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { S3VectorsClient, DeleteIndexCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, DeleteIndexCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // DeleteIndexInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE",
|
|
39
|
+
* indexName: "STRING_VALUE",
|
|
40
|
+
* indexArn: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeleteIndexCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteIndexCommandInput - {@link DeleteIndexCommandInput}
|
|
49
|
+
* @returns {@link DeleteIndexCommandOutput}
|
|
50
|
+
* @see {@link DeleteIndexCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteIndexCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
55
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>Access denied.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalServerException} (server fault)
|
|
61
|
+
* <p>The request failed due to an internal server error.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
64
|
+
* <p>Your request exceeds a service quota. </p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
67
|
+
* <p>The request was denied due to request throttling.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ValidationException} (client fault)
|
|
70
|
+
* <p>The requested action isn't valid.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link S3VectorsServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
74
|
+
*
|
|
75
|
+
*
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export declare class DeleteIndexCommand extends DeleteIndexCommand_base {
|
|
79
|
+
/** @internal type navigation helper, not in runtime. */
|
|
80
|
+
protected static __types: {
|
|
81
|
+
api: {
|
|
82
|
+
input: DeleteIndexInput;
|
|
83
|
+
output: {};
|
|
84
|
+
};
|
|
85
|
+
sdk: {
|
|
86
|
+
input: DeleteIndexCommandInput;
|
|
87
|
+
output: DeleteIndexCommandOutput;
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteVectorBucketInput, DeleteVectorBucketOutput } 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 DeleteVectorBucketCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteVectorBucketCommandInput extends DeleteVectorBucketInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteVectorBucketCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteVectorBucketCommandOutput extends DeleteVectorBucketOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteVectorBucketCommand_base: {
|
|
25
|
+
new (input: DeleteVectorBucketCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteVectorBucketCommandInput, DeleteVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [DeleteVectorBucketCommandInput]): import("@smithy/smithy-client").CommandImpl<DeleteVectorBucketCommandInput, DeleteVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { S3VectorsClient, DeleteVectorBucketCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, DeleteVectorBucketCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // DeleteVectorBucketInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE",
|
|
39
|
+
* vectorBucketArn: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteVectorBucketCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param DeleteVectorBucketCommandInput - {@link DeleteVectorBucketCommandInput}
|
|
48
|
+
* @returns {@link DeleteVectorBucketCommandOutput}
|
|
49
|
+
* @see {@link DeleteVectorBucketCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link DeleteVectorBucketCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ConflictException} (client fault)
|
|
54
|
+
* <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>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
57
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>Access denied.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>The request failed due to an internal server error.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
66
|
+
* <p>Your request exceeds a service quota. </p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The requested action isn't valid.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link S3VectorsServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class DeleteVectorBucketCommand extends DeleteVectorBucketCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: DeleteVectorBucketInput;
|
|
85
|
+
output: {};
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: DeleteVectorBucketCommandInput;
|
|
89
|
+
output: DeleteVectorBucketCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteVectorBucketPolicyInput, DeleteVectorBucketPolicyOutput } 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 DeleteVectorBucketPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteVectorBucketPolicyCommandInput extends DeleteVectorBucketPolicyInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteVectorBucketPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteVectorBucketPolicyCommandOutput extends DeleteVectorBucketPolicyOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteVectorBucketPolicyCommand_base: {
|
|
25
|
+
new (input: DeleteVectorBucketPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteVectorBucketPolicyCommandInput, DeleteVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [DeleteVectorBucketPolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<DeleteVectorBucketPolicyCommandInput, DeleteVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { S3VectorsClient, DeleteVectorBucketPolicyCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, DeleteVectorBucketPolicyCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // DeleteVectorBucketPolicyInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE",
|
|
39
|
+
* vectorBucketArn: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteVectorBucketPolicyCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param DeleteVectorBucketPolicyCommandInput - {@link DeleteVectorBucketPolicyCommandInput}
|
|
48
|
+
* @returns {@link DeleteVectorBucketPolicyCommandOutput}
|
|
49
|
+
* @see {@link DeleteVectorBucketPolicyCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link DeleteVectorBucketPolicyCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link NotFoundException} (client fault)
|
|
54
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
57
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>Access denied.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalServerException} (server fault)
|
|
63
|
+
* <p>The request failed due to an internal server error.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
66
|
+
* <p>Your request exceeds a service quota. </p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
69
|
+
* <p>The request was denied due to request throttling.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
* <p>The requested action isn't valid.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link S3VectorsServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class DeleteVectorBucketPolicyCommand extends DeleteVectorBucketPolicyCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: DeleteVectorBucketPolicyInput;
|
|
85
|
+
output: {};
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: DeleteVectorBucketPolicyCommandInput;
|
|
89
|
+
output: DeleteVectorBucketPolicyCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DeleteVectorsInput, DeleteVectorsOutput } 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 DeleteVectorsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteVectorsCommandInput extends DeleteVectorsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteVectorsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteVectorsCommandOutput extends DeleteVectorsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteVectorsCommand_base: {
|
|
25
|
+
new (input: DeleteVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteVectorsCommandInput, DeleteVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteVectorsCommandInput, DeleteVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <p>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
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { S3VectorsClient, DeleteVectorsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
|
|
35
|
+
* // const { S3VectorsClient, DeleteVectorsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
|
|
36
|
+
* const client = new S3VectorsClient(config);
|
|
37
|
+
* const input = { // DeleteVectorsInput
|
|
38
|
+
* vectorBucketName: "STRING_VALUE",
|
|
39
|
+
* indexName: "STRING_VALUE",
|
|
40
|
+
* indexArn: "STRING_VALUE",
|
|
41
|
+
* keys: [ // DeleteVectorsInputList // required
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DeleteVectorsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param DeleteVectorsCommandInput - {@link DeleteVectorsCommandInput}
|
|
52
|
+
* @returns {@link DeleteVectorsCommandOutput}
|
|
53
|
+
* @see {@link DeleteVectorsCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link DeleteVectorsCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
* <p>Access denied.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link KmsDisabledException} (client fault)
|
|
61
|
+
* <p>The specified Amazon Web Services KMS key isn't enabled.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link KmsInvalidKeyUsageException} (client fault)
|
|
64
|
+
* <p>The request was rejected for one of the following reasons: </p> <ul> <li> <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API operation.</p> </li> <li> <p>The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (<code>KeySpec</code>).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">InvalidKeyUsageException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link KmsInvalidStateException} (client fault)
|
|
67
|
+
* <p>The key state of the KMS key isn't compatible with the operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html#API_Encrypt_Errors">KMSInvalidStateException</a> in the <i>Amazon Web Services Key Management Service API Reference</i>.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link KmsNotFoundException} (client fault)
|
|
70
|
+
* <p>The KMS key can't be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link NotFoundException} (client fault)
|
|
73
|
+
* <p>The request was rejected because the specified resource can't be found.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
76
|
+
* <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerException} (server fault)
|
|
79
|
+
* <p>The request failed due to an internal server error.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
82
|
+
* <p>Your request exceeds a service quota. </p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
85
|
+
* <p>The request was denied due to request throttling.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ValidationException} (client fault)
|
|
88
|
+
* <p>The requested action isn't valid.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link S3VectorsServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from S3Vectors service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class DeleteVectorsCommand extends DeleteVectorsCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: DeleteVectorsInput;
|
|
101
|
+
output: {};
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: DeleteVectorsCommandInput;
|
|
105
|
+
output: DeleteVectorsCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|