Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419110105.3 KB

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

Permissions

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

post/GetVectors

Request body

vectorBucketNamestring

The name of the vector bucket that contains the vector index.

indexNamestring

The name of the vector index.

indexArnstring

The ARN of the vector index.

keysVectorKey[] required

The names of the vectors you want to return attributes for.

returnDataboolean

Indicates whether to include the vector data in the response. The default value is <code>false</code>.

returnMetadataboolean

Indicates whether to include metadata in the response. The default value is <code>false</code>.

Response

Success