@aws-sdk/client-s3vectors 3.845.0

package/dist-types/commands/GetIndexCommand.d.ts

@@ -0,0 +1,108 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetIndexInput, GetIndexOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetIndexCommand}.
+ */
+export interface GetIndexCommandInput extends GetIndexInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetIndexCommand}.
+ */
+export interface GetIndexCommandOutput extends GetIndexOutput, __MetadataBearer {
+}
+declare const GetIndexCommand_base: {
+    new (input: GetIndexCommandInput): import("@smithy/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetIndexCommandInput]): import("@smithy/smithy-client").CommandImpl<GetIndexCommandInput, GetIndexCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, GetIndexCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, GetIndexCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // GetIndexInput
+ *   vectorBucketName: "STRING_VALUE",
+ *   indexName: "STRING_VALUE",
+ *   indexArn: "STRING_VALUE",
+ * };
+ * const command = new GetIndexCommand(input);
+ * const response = await client.send(command);
+ * // { // GetIndexOutput
+ * //   index: { // Index
+ * //     vectorBucketName: "STRING_VALUE", // required
+ * //     indexName: "STRING_VALUE", // required
+ * //     indexArn: "STRING_VALUE", // required
+ * //     creationTime: new Date("TIMESTAMP"), // required
+ * //     dataType: "float32", // required
+ * //     dimension: Number("int"), // required
+ * //     distanceMetric: "euclidean" || "cosine", // required
+ * //     metadataConfiguration: { // MetadataConfiguration
+ * //       nonFilterableMetadataKeys: [ // NonFilterableMetadataKeys // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetIndexCommandInput - {@link GetIndexCommandInput}
+ * @returns {@link GetIndexCommandOutput}
+ * @see {@link GetIndexCommandInput} for command's `input` shape.
+ * @see {@link GetIndexCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource can't be found.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetIndexCommand extends GetIndexCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetIndexInput;
+            output: GetIndexOutput;
+        };
+        sdk: {
+            input: GetIndexCommandInput;
+            output: GetIndexCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetVectorBucketCommand.d.ts

@@ -0,0 +1,102 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetVectorBucketInput, GetVectorBucketOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVectorBucketCommand}.
+ */
+export interface GetVectorBucketCommandInput extends GetVectorBucketInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetVectorBucketCommand}.
+ */
+export interface GetVectorBucketCommandOutput extends GetVectorBucketOutput, __MetadataBearer {
+}
+declare const GetVectorBucketCommand_base: {
+    new (input: GetVectorBucketCommandInput): import("@smithy/smithy-client").CommandImpl<GetVectorBucketCommandInput, GetVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetVectorBucketCommandInput]): import("@smithy/smithy-client").CommandImpl<GetVectorBucketCommandInput, GetVectorBucketCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, GetVectorBucketCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, GetVectorBucketCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // GetVectorBucketInput
+ *   vectorBucketName: "STRING_VALUE",
+ *   vectorBucketArn: "STRING_VALUE",
+ * };
+ * const command = new GetVectorBucketCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVectorBucketOutput
+ * //   vectorBucket: { // VectorBucket
+ * //     vectorBucketName: "STRING_VALUE", // required
+ * //     vectorBucketArn: "STRING_VALUE", // required
+ * //     creationTime: new Date("TIMESTAMP"), // required
+ * //     encryptionConfiguration: { // EncryptionConfiguration
+ * //       sseType: "AES256" || "aws:kms",
+ * //       kmsKeyArn: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetVectorBucketCommandInput - {@link GetVectorBucketCommandInput}
+ * @returns {@link GetVectorBucketCommandOutput}
+ * @see {@link GetVectorBucketCommandInput} for command's `input` shape.
+ * @see {@link GetVectorBucketCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource can't be found.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetVectorBucketCommand extends GetVectorBucketCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetVectorBucketInput;
+            output: GetVectorBucketOutput;
+        };
+        sdk: {
+            input: GetVectorBucketCommandInput;
+            output: GetVectorBucketCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetVectorBucketPolicyCommand.d.ts

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetVectorBucketPolicyInput, GetVectorBucketPolicyOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVectorBucketPolicyCommand}.
+ */
+export interface GetVectorBucketPolicyCommandInput extends GetVectorBucketPolicyInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetVectorBucketPolicyCommand}.
+ */
+export interface GetVectorBucketPolicyCommandOutput extends GetVectorBucketPolicyOutput, __MetadataBearer {
+}
+declare const GetVectorBucketPolicyCommand_base: {
+    new (input: GetVectorBucketPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetVectorBucketPolicyCommandInput, GetVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetVectorBucketPolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<GetVectorBucketPolicyCommandInput, GetVectorBucketPolicyCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, GetVectorBucketPolicyCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, GetVectorBucketPolicyCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // GetVectorBucketPolicyInput
+ *   vectorBucketName: "STRING_VALUE",
+ *   vectorBucketArn: "STRING_VALUE",
+ * };
+ * const command = new GetVectorBucketPolicyCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVectorBucketPolicyOutput
+ * //   policy: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetVectorBucketPolicyCommandInput - {@link GetVectorBucketPolicyCommandInput}
+ * @returns {@link GetVectorBucketPolicyCommandOutput}
+ * @see {@link GetVectorBucketPolicyCommandInput} for command's `input` shape.
+ * @see {@link GetVectorBucketPolicyCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource can't be found.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetVectorBucketPolicyCommand extends GetVectorBucketPolicyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetVectorBucketPolicyInput;
+            output: GetVectorBucketPolicyOutput;
+        };
+        sdk: {
+            input: GetVectorBucketPolicyCommandInput;
+            output: GetVectorBucketPolicyCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetVectorsCommand.d.ts

@@ -0,0 +1,122 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetVectorsInput, GetVectorsOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVectorsCommand}.
+ */
+export interface GetVectorsCommandInput extends GetVectorsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetVectorsCommand}.
+ */
+export interface GetVectorsCommandOutput extends GetVectorsOutput, __MetadataBearer {
+}
+declare const GetVectorsCommand_base: {
+    new (input: GetVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<GetVectorsCommandInput, GetVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: GetVectorsCommandInput): import("@smithy/smithy-client").CommandImpl<GetVectorsCommandInput, GetVectorsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, GetVectorsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, GetVectorsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // GetVectorsInput
+ *   vectorBucketName: "STRING_VALUE",
+ *   indexName: "STRING_VALUE",
+ *   indexArn: "STRING_VALUE",
+ *   keys: [ // GetVectorsInputList // required
+ *     "STRING_VALUE",
+ *   ],
+ *   returnData: true || false,
+ *   returnMetadata: true || false,
+ * };
+ * const command = new GetVectorsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVectorsOutput
+ * //   vectors: [ // GetVectorsOutputList // required
+ * //     { // GetOutputVector
+ * //       key: "STRING_VALUE", // required
+ * //       data: { // VectorData Union: only one key present
+ * //         float32: [ // Float32VectorData
+ * //           Number("float"),
+ * //         ],
+ * //       },
+ * //       metadata: "DOCUMENT_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetVectorsCommandInput - {@link GetVectorsCommandInput}
+ * @returns {@link GetVectorsCommandOutput}
+ * @see {@link GetVectorsCommandInput} for command's `input` shape.
+ * @see {@link GetVectorsCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link KmsDisabledException} (client fault)
+ *  <p>The specified Amazon Web Services KMS key isn't enabled.</p>
+ *
+ * @throws {@link KmsInvalidKeyUsageException} (client fault)
+ *  <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>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <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>
+ *
+ * @throws {@link KmsNotFoundException} (client fault)
+ *  <p>The KMS key can't be found.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource can't be found.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetVectorsCommand extends GetVectorsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetVectorsInput;
+            output: GetVectorsOutput;
+        };
+        sdk: {
+            input: GetVectorsCommandInput;
+            output: GetVectorsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListIndexesCommand.d.ts

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListIndexesInput, ListIndexesOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListIndexesCommand}.
+ */
+export interface ListIndexesCommandInput extends ListIndexesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListIndexesCommand}.
+ */
+export interface ListIndexesCommandOutput extends ListIndexesOutput, __MetadataBearer {
+}
+declare const ListIndexesCommand_base: {
+    new (input: ListIndexesCommandInput): import("@smithy/smithy-client").CommandImpl<ListIndexesCommandInput, ListIndexesCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListIndexesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListIndexesCommandInput, ListIndexesCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, ListIndexesCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, ListIndexesCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // ListIndexesInput
+ *   vectorBucketName: "STRING_VALUE",
+ *   vectorBucketArn: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ *   prefix: "STRING_VALUE",
+ * };
+ * const command = new ListIndexesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListIndexesOutput
+ * //   nextToken: "STRING_VALUE",
+ * //   indexes: [ // ListIndexesOutputList // required
+ * //     { // IndexSummary
+ * //       vectorBucketName: "STRING_VALUE", // required
+ * //       indexName: "STRING_VALUE", // required
+ * //       indexArn: "STRING_VALUE", // required
+ * //       creationTime: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListIndexesCommandInput - {@link ListIndexesCommandInput}
+ * @returns {@link ListIndexesCommandOutput}
+ * @see {@link ListIndexesCommandInput} for command's `input` shape.
+ * @see {@link ListIndexesCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource can't be found.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListIndexesCommand extends ListIndexesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListIndexesInput;
+            output: ListIndexesOutput;
+        };
+        sdk: {
+            input: ListIndexesCommandInput;
+            output: ListIndexesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListVectorBucketsCommand.d.ts

@@ -0,0 +1,99 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListVectorBucketsInput, ListVectorBucketsOutput } from "../models/models_0";
+import { S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3VectorsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListVectorBucketsCommand}.
+ */
+export interface ListVectorBucketsCommandInput extends ListVectorBucketsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListVectorBucketsCommand}.
+ */
+export interface ListVectorBucketsCommandOutput extends ListVectorBucketsOutput, __MetadataBearer {
+}
+declare const ListVectorBucketsCommand_base: {
+    new (input: ListVectorBucketsCommandInput): import("@smithy/smithy-client").CommandImpl<ListVectorBucketsCommandInput, ListVectorBucketsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListVectorBucketsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListVectorBucketsCommandInput, ListVectorBucketsCommandOutput, S3VectorsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <note> <p>Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.</p> </note> <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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3VectorsClient, ListVectorBucketsCommand } from "@aws-sdk/client-s3vectors"; // ES Modules import
+ * // const { S3VectorsClient, ListVectorBucketsCommand } = require("@aws-sdk/client-s3vectors"); // CommonJS import
+ * const client = new S3VectorsClient(config);
+ * const input = { // ListVectorBucketsInput
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ *   prefix: "STRING_VALUE",
+ * };
+ * const command = new ListVectorBucketsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListVectorBucketsOutput
+ * //   nextToken: "STRING_VALUE",
+ * //   vectorBuckets: [ // ListVectorBucketsOutputList // required
+ * //     { // VectorBucketSummary
+ * //       vectorBucketName: "STRING_VALUE", // required
+ * //       vectorBucketArn: "STRING_VALUE", // required
+ * //       creationTime: new Date("TIMESTAMP"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListVectorBucketsCommandInput - {@link ListVectorBucketsCommandInput}
+ * @returns {@link ListVectorBucketsCommandOutput}
+ * @see {@link ListVectorBucketsCommandInput} for command's `input` shape.
+ * @see {@link ListVectorBucketsCommandOutput} for command's `response` shape.
+ * @see {@link S3VectorsClientResolvedConfig | config} for S3VectorsClient's `config` shape.
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.</p>
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access denied.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The requested action isn't valid.</p>
+ *
+ * @throws {@link S3VectorsServiceException}
+ * <p>Base exception class for all service exceptions from S3Vectors service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListVectorBucketsCommand extends ListVectorBucketsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListVectorBucketsInput;
+            output: ListVectorBucketsOutput;
+        };
+        sdk: {
+            input: ListVectorBucketsCommandInput;
+            output: ListVectorBucketsCommandOutput;
+        };
+    };
+}