Amazon S3 Vectors
Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.
Endpoints 22
Index
- POSTCreate index
/CreateIndexCreates 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… - POSTDelete index
/DeleteIndexDeletes 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… - POSTGet index
/GetIndexReturns 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… - POSTList indexes
/ListIndexesReturns 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… - POSTUpdate index mode
/UpdateIndexModeUpdates the mode for an existing vector index. You can set the mode to ENHANCED for any vector index. You can set the mode to CLASSIC only for a vector index… - POSTUpdate metadata configuration
/UpdateMetadataConfigurationAdds or deletes text search configurations on a vector index. Specify either add or delete , but not both. The vector index must be in ENHANCED mode.…
Vector bucket
- POSTCreate vector bucket
/CreateVectorBucketCreates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. Permissions You must have the s3vectors:CreateVectorBucket… - POSTDelete vector bucket
/DeleteVectorBucketDeletes 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… - POSTDelete vector bucket policy
/DeleteVectorBucketPolicyDeletes a vector bucket policy. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). Permissions… - POSTGet vector bucket
/GetVectorBucketReturns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).… - POSTGet vector bucket policy
/GetVectorBucketPolicyGets 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).… - POSTList vector buckets
/ListVectorBucketsReturns a list of all the vector buckets that are owned by the authenticated sender of the request. Permissions You must have the s3vectors:ListVectorBuckets… - POSTPut vector bucket default index mode
/PutVectorBucketDefaultIndexModeUpdates the default index mode for a vector bucket. The updated default applies to vector indexes that you create after the request succeeds. The operation… - POSTPut vector bucket policy
/PutVectorBucketPolicyCreates a bucket policy for a vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name…
Vector
- POSTDelete vectors
/DeleteVectorsDeletes 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… - POSTGet vectors
/GetVectorsReturns 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… - POSTList vectors
/ListVectorsList vectors in the specified vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the… - POSTPut vectors
/PutVectorsAdds one or more vectors to a vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the… - POSTQuery vectors
/QueryVectorsReturns matching vector keys from a vector index ranked by vector similarity, full-text relevance, or both. Specify queryVector to perform a vector search,…
- GETList tags for resource
/tags/:resourceArnLists all of the tags applied to a specified Amazon S3 Vectors resource. Each tag is a label consisting of a key and value pair. Tags can help you organize,… - POSTTag resource
/tags/:resourceArnApplies one or more user-defined tags to an Amazon S3 Vectors resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags… - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes the specified user-defined tags from an Amazon S3 Vectors resource. You can pass one or more tag keys. For a list of S3 resources that support…
API details
- Base URL
https://s3vectors.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 20 pathsPOST 20GET 1DELETE 1
- Main resources
- Vector bucket 8Index 6Vector 5
- Description format
- AWS Smithy model, API version
2025-07-15 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon S3 Vectors in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon S3 Vectors collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create index” (POST /CreateIndex), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon S3 Vectors?
Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for… It is listed under Developer tools and has 22 endpoints.
Who publishes the Amazon S3 Vectors?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon S3 Vectors?
Requests go to https://s3vectors.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon S3 Vectors?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon S3 Vectors have?
22 operations on 20 paths (20 POST, 1 GET, 1 DELETE). The largest groups are Vector bucket, Index, Vector.
Is forking the Amazon S3 Vectors free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.