Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419110105.3 KB

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).

Permissions

You must have the s3vectors:CreateIndex permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

post/CreateIndex

Request body

vectorBucketNamestring

The name of the vector bucket to create the vector index in.

vectorBucketArnstring

The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

indexNamestring required

The name of the vector index to create.

dataType'float32' required

The data type of the vectors to be inserted into the vector index.

dimensioninteger required

The dimensions of the vectors to be inserted into the vector index.

distanceMetric'euclidean' | 'cosine' required

The distance metric to be used for similarity search.

tagsobject
<p>An array of user-defined tags that you would like to apply to the vector index that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs, and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3vectors:TagResource</code> permission in addition to <code>s3vectors:CreateIndex</code> permission to create a vector index with tags.</p> </note>

Response

Success

indexArnstring required

The Amazon Resource Name (ARN) of the newly created vector index.

All 19 operations