feat(client-s3vectors): Amazon S3 Vectors provides cost-effective, elastic, and durable vector storage for queries based on semantic meaning and similarity.

awstools · awstools · commit cb2626e6e19a · 2025-11-06T19:42:52.000Z
diff --git a/clients/client-s3vectors/src/commands/CreateIndexCommand.ts b/clients/client-s3vectors/src/commands/CreateIndexCommand.ts
@@ -52,7 +52,9 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
  * };
  * const command = new CreateIndexCommand(input);
  * const response = await client.send(command);
- * // {};
+ * // { // CreateIndexOutput
+ * //   indexArn: "STRING_VALUE", // required
+ * // };
  *
  * ```
  *
@@ -68,6 +70,9 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
  * @throws {@link NotFoundException} (client fault)
  *  <p>The request was rejected because the specified resource can't be found.</p>
  *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </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>
  *
@@ -77,8 +82,8 @@ export interface CreateIndexCommandOutput extends CreateIndexOutput, __MetadataB
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
@@ -117,7 +122,7 @@ export class CreateIndexCommand extends $Command
   protected declare static __types: {
     api: {
       input: CreateIndexInput;
-      output: {};
+      output: CreateIndexOutput;
     };
     sdk: {
       input: CreateIndexCommandInput;
diff --git a/clients/client-s3vectors/src/commands/CreateVectorBucketCommand.ts b/clients/client-s3vectors/src/commands/CreateVectorBucketCommand.ts
@@ -46,7 +46,9 @@ export interface CreateVectorBucketCommandOutput extends CreateVectorBucketOutpu
  * };
  * const command = new CreateVectorBucketCommand(input);
  * const response = await client.send(command);
- * // {};
+ * // { // CreateVectorBucketOutput
+ * //   vectorBucketArn: "STRING_VALUE", // required
+ * // };
  *
  * ```
  *
@@ -59,6 +61,9 @@ export interface CreateVectorBucketCommandOutput extends CreateVectorBucketOutpu
  * @throws {@link ConflictException} (client fault)
  *  <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>
  *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </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>
  *
@@ -68,8 +73,8 @@ export interface CreateVectorBucketCommandOutput extends CreateVectorBucketOutpu
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
@@ -108,7 +113,7 @@ export class CreateVectorBucketCommand extends $Command
   protected declare static __types: {
     api: {
       input: CreateVectorBucketInput;
-      output: {};
+      output: CreateVectorBucketOutput;
     };
     sdk: {
       input: CreateVectorBucketCommandInput;
diff --git a/clients/client-s3vectors/src/commands/DeleteIndexCommand.ts b/clients/client-s3vectors/src/commands/DeleteIndexCommand.ts
@@ -63,8 +63,8 @@ export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataB
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/DeleteVectorBucketCommand.ts b/clients/client-s3vectors/src/commands/DeleteVectorBucketCommand.ts
@@ -65,8 +65,8 @@ export interface DeleteVectorBucketCommandOutput extends DeleteVectorBucketOutpu
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/DeleteVectorBucketPolicyCommand.ts b/clients/client-s3vectors/src/commands/DeleteVectorBucketPolicyCommand.ts
@@ -65,8 +65,8 @@ export interface DeleteVectorBucketPolicyCommandOutput extends DeleteVectorBucke
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/DeleteVectorsCommand.ts b/clients/client-s3vectors/src/commands/DeleteVectorsCommand.ts
@@ -81,8 +81,8 @@ export interface DeleteVectorsCommandOutput extends DeleteVectorsOutput, __Metad
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/GetIndexCommand.ts b/clients/client-s3vectors/src/commands/GetIndexCommand.ts
@@ -81,8 +81,8 @@ export interface GetIndexCommandOutput extends GetIndexOutput, __MetadataBearer
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/GetVectorBucketCommand.ts b/clients/client-s3vectors/src/commands/GetVectorBucketCommand.ts
@@ -75,8 +75,8 @@ export interface GetVectorBucketCommandOutput extends GetVectorBucketOutput, __M
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/GetVectorBucketPolicyCommand.ts b/clients/client-s3vectors/src/commands/GetVectorBucketPolicyCommand.ts
@@ -67,8 +67,8 @@ export interface GetVectorBucketPolicyCommandOutput extends GetVectorBucketPolic
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/GetVectorsCommand.ts b/clients/client-s3vectors/src/commands/GetVectorsCommand.ts
@@ -95,8 +95,8 @@ export interface GetVectorsCommandOutput extends GetVectorsOutput, __MetadataBea
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/ListIndexesCommand.ts b/clients/client-s3vectors/src/commands/ListIndexesCommand.ts
@@ -78,8 +78,8 @@ export interface ListIndexesCommandOutput extends ListIndexesOutput, __MetadataB
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/ListVectorBucketsCommand.ts b/clients/client-s3vectors/src/commands/ListVectorBucketsCommand.ts
@@ -72,8 +72,8 @@ export interface ListVectorBucketsCommandOutput extends ListVectorBucketsOutput,
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/ListVectorsCommand.ts b/clients/client-s3vectors/src/commands/ListVectorsCommand.ts
@@ -85,8 +85,8 @@ export interface ListVectorsCommandOutput extends ListVectorsOutput, __MetadataB
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/PutVectorBucketPolicyCommand.ts b/clients/client-s3vectors/src/commands/PutVectorBucketPolicyCommand.ts
@@ -66,8 +66,8 @@ export interface PutVectorBucketPolicyCommandOutput extends PutVectorBucketPolic
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/PutVectorsCommand.ts b/clients/client-s3vectors/src/commands/PutVectorsCommand.ts
@@ -83,14 +83,17 @@ export interface PutVectorsCommandOutput extends PutVectorsOutput, __MetadataBea
  * @throws {@link NotFoundException} (client fault)
  *  <p>The request was rejected because the specified resource can't be found.</p>
  *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds a service quota. </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 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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/commands/QueryVectorsCommand.ts b/clients/client-s3vectors/src/commands/QueryVectorsCommand.ts
@@ -66,6 +66,7 @@ export interface QueryVectorsCommandOutput extends QueryVectorsOutput, __Metadat
  * //       distance: Number("float"),
  * //     },
  * //   ],
+ * //   distanceMetric: "euclidean" || "cosine", // required
  * // };
  *
  * ```
@@ -100,8 +101,8 @@ export interface QueryVectorsCommandOutput extends QueryVectorsOutput, __Metadat
  * @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 RequestTimeoutException} (client fault)
+ *  <p>The request timed out. Retry your request.</p>
  *
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
diff --git a/clients/client-s3vectors/src/models/models_0.ts b/clients/client-s3vectors/src/models/models_0.ts
@@ -134,7 +134,13 @@ export interface CreateIndexInput {
 /**
  * @public
  */
-export interface CreateIndexOutput {}
+export interface CreateIndexOutput {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the newly created vector index.</p>
+   * @public
+   */
+  indexArn: string | undefined;
+}
 
 /**
  * <p>The request failed due to an internal server error.</p>
@@ -177,6 +183,27 @@ export class NotFoundException extends __BaseException {
   }
 }
 
+/**
+ * <p>The request timed out. Retry your request.</p>
+ * @public
+ */
+export class RequestTimeoutException extends __BaseException {
+  readonly name: "RequestTimeoutException" = "RequestTimeoutException";
+  readonly $fault: "client" = "client";
+  $retryable = {};
+  /**
+   * @internal
+   */
+  constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>) {
+    super({
+      name: "RequestTimeoutException",
+      $fault: "client",
+      ...opts,
+    });
+    Object.setPrototypeOf(this, RequestTimeoutException.prototype);
+  }
+}
+
 /**
  * <p>Your request exceeds a service quota. </p>
  * @public
@@ -338,7 +365,13 @@ export interface CreateVectorBucketInput {
 /**
  * @public
  */
-export interface CreateVectorBucketOutput {}
+export interface CreateVectorBucketOutput {
+  /**
+   * <p>The Amazon Resource Name (ARN) of the newly created vector bucket.</p>
+   * @public
+   */
+  vectorBucketArn: string | undefined;
+}
 
 /**
  * @public
@@ -1146,6 +1179,12 @@ export interface QueryVectorsOutput {
    * @public
    */
   vectors: QueryOutputVector[] | undefined;
+
+  /**
+   * <p>The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.</p>
+   * @public
+   */
+  distanceMetric: DistanceMetric | undefined;
 }
 
 /**
diff --git a/clients/client-s3vectors/src/protocols/Aws_restJson1.ts b/clients/client-s3vectors/src/protocols/Aws_restJson1.ts
diff --git a/codegen/sdk-codegen/aws-models/s3vectors.json b/codegen/sdk-codegen/aws-models/s3vectors.json

Original file line number	Diff line number	Diff line change
`@@ -63,8 +63,8 @@ export interface DeleteIndexCommandOutput extends DeleteIndexOutput, __MetadataB`
`63`	`63`	`* @throws {@link InternalServerException} (server fault)`
`64`	`64`	`* <p>The request failed due to an internal server error.</p>`
`65`	`65`	`*`
`66`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`67`		`- * <p>Your request exceeds a service quota. </p>`
	`66`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`67`	`+ * <p>The request timed out. Retry your request.</p>`
`68`	`68`	`*`
`69`	`69`	`* @throws {@link TooManyRequestsException} (client fault)`
`70`	`70`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ export interface DeleteVectorBucketCommandOutput extends DeleteVectorBucketOutpu`
`65`	`65`	`* @throws {@link InternalServerException} (server fault)`
`66`	`66`	`* <p>The request failed due to an internal server error.</p>`
`67`	`67`	`*`
`68`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`69`		`- * <p>Your request exceeds a service quota. </p>`
	`68`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`69`	`+ * <p>The request timed out. Retry your request.</p>`
`70`	`70`	`*`
`71`	`71`	`* @throws {@link TooManyRequestsException} (client fault)`
`72`	`72`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -81,8 +81,8 @@ export interface DeleteVectorsCommandOutput extends DeleteVectorsOutput, __Metad`
`81`	`81`	`* @throws {@link InternalServerException} (server fault)`
`82`	`82`	`* <p>The request failed due to an internal server error.</p>`
`83`	`83`	`*`
`84`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`85`		`- * <p>Your request exceeds a service quota. </p>`
	`84`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`85`	`+ * <p>The request timed out. Retry your request.</p>`
`86`	`86`	`*`
`87`	`87`	`* @throws {@link TooManyRequestsException} (client fault)`
`88`	`88`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -81,8 +81,8 @@ export interface GetIndexCommandOutput extends GetIndexOutput, __MetadataBearer`
`81`	`81`	`* @throws {@link InternalServerException} (server fault)`
`82`	`82`	`* <p>The request failed due to an internal server error.</p>`
`83`	`83`	`*`
`84`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`85`		`- * <p>Your request exceeds a service quota. </p>`
	`84`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`85`	`+ * <p>The request timed out. Retry your request.</p>`
`86`	`86`	`*`
`87`	`87`	`* @throws {@link TooManyRequestsException} (client fault)`
`88`	`88`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,8 @@ export interface GetVectorBucketCommandOutput extends GetVectorBucketOutput, __M`
`75`	`75`	`* @throws {@link InternalServerException} (server fault)`
`76`	`76`	`* <p>The request failed due to an internal server error.</p>`
`77`	`77`	`*`
`78`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`79`		`- * <p>Your request exceeds a service quota. </p>`
	`78`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`79`	`+ * <p>The request timed out. Retry your request.</p>`
`80`	`80`	`*`
`81`	`81`	`* @throws {@link TooManyRequestsException} (client fault)`
`82`	`82`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -67,8 +67,8 @@ export interface GetVectorBucketPolicyCommandOutput extends GetVectorBucketPolic`
`67`	`67`	`* @throws {@link InternalServerException} (server fault)`
`68`	`68`	`* <p>The request failed due to an internal server error.</p>`
`69`	`69`	`*`
`70`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`71`		`- * <p>Your request exceeds a service quota. </p>`
	`70`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`71`	`+ * <p>The request timed out. Retry your request.</p>`
`72`	`72`	`*`
`73`	`73`	`* @throws {@link TooManyRequestsException} (client fault)`
`74`	`74`	`* <p>The request was denied due to request throttling.</p>`
Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@ export interface GetVectorsCommandOutput extends GetVectorsOutput, __MetadataBea`
`95`	`95`	`* @throws {@link InternalServerException} (server fault)`
`96`	`96`	`* <p>The request failed due to an internal server error.</p>`
`97`	`97`	`*`
`98`		`- * @throws {@link ServiceQuotaExceededException} (client fault)`
`99`		`- * <p>Your request exceeds a service quota. </p>`
	`98`	`+ * @throws {@link RequestTimeoutException} (client fault)`
	`99`	`+ * <p>The request timed out. Retry your request.</p>`
`100`	`100`	`*`
`101`	`101`	`* @throws {@link TooManyRequestsException} (client fault)`
`102`	`102`	`* <p>The request was denied due to request throttling.</p>`