vectors

Creates, updates, deletes, gets or lists a vectors resource.

Overview

Name	`vectors`
Type	Resource
Id	`aws.s3vectors.vectors`

Fields

The following fields are returned by SELECT queries:

get_vectors
list_vectors

Name	Datatype	Description
`vectors`	`array`	The attributes of the vectors.

Name	Datatype	Description
`data`	`object`	The vector data of the vector.
`key`	`string`	The name of the vector.
`metadata`	`object`	Metadata about the vector.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get_vectors`	`select`	`region`	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.
`list_vectors`	`select`	`region`	List 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 vector index Amazon Resource Name (ARN). ListVectors operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel ListVectors operation by providing the segmentCount and segmentIndex parameters. Permissions You must have the s3vectors:ListVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:ListVectors permission, you can list vector keys when returnData and returnMetadata are both set to false or not specified.. If you set returnData or returnMetadata to true, you must have both s3vectors:ListVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request vector data or metadata without the s3vectors:GetVectors permission.
`put_vectors`	`replace`	`region`, `vectors`	Adds 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 vector index Amazon Resource Name (ARN). For more information about limits, see Limitations and restrictions in the Amazon S3 User Guide. When inserting vector data into your vector index, you must provide the vector data as float32 (32-bit floating point) values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors converts the values to 32-bit floating point before storing them, and GetVectors, ListVectors, and QueryVectors operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as float32 values regardless of which SDK you're using. For example, in Python, use numpy.float32 or explicitly cast your values. Permissions You must have the s3vectors:PutVectors permission to use this operation.
`delete_vectors`	`delete`	`region`	Deletes 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 vector index Amazon Resource Name (ARN). Permissions You must have the s3vectors:DeleteVectors permission to use this operation.
`query_vectors`	`exec`	`region`, `topK`, `queryVector`	Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response) and metadata of each vector in the response. 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:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request metadata (by keeping the returnMetadata parameter set to false or not specified). If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering or metadata without the s3vectors:GetVectors permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

get_vectors
list_vectors

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.

SELECT
vectors
FROM aws.s3vectors.vectors
WHERE region = '{{ region }}' -- required
;

List 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 vector index Amazon Resource Name (ARN). ListVectors operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel ListVectors operation by providing the segmentCount and segmentIndex parameters. Permissions You must have the s3vectors:ListVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:ListVectors permission, you can list vector keys when returnData and returnMetadata are both set to false or not specified.. If you set returnData or returnMetadata to true, you must have both s3vectors:ListVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request vector data or metadata without the s3vectors:GetVectors permission.

SELECT
data,
key,
metadata
FROM aws.s3vectors.vectors
WHERE region = '{{ region }}' -- required
;

`REPLACE` examples

put_vectors

Adds 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 vector index Amazon Resource Name (ARN). For more information about limits, see Limitations and restrictions in the Amazon S3 User Guide. When inserting vector data into your vector index, you must provide the vector data as float32 (32-bit floating point) values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors converts the values to 32-bit floating point before storing them, and GetVectors, ListVectors, and QueryVectors operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as float32 values regardless of which SDK you're using. For example, in Python, use numpy.float32 or explicitly cast your values. Permissions You must have the s3vectors:PutVectors permission to use this operation.

REPLACE aws.s3vectors.vectors
SET 
vectorBucketName = '{{ vectorBucketName }}',
indexName = '{{ indexName }}',
indexArn = '{{ indexArn }}',
vectors = '{{ vectors }}'
WHERE 
region = '{{ region }}' --required
AND vectors = '{{ vectors }}' --required;

`DELETE` examples

delete_vectors

Deletes 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 vector index Amazon Resource Name (ARN). Permissions You must have the s3vectors:DeleteVectors permission to use this operation.

DELETE FROM aws.s3vectors.vectors
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

query_vectors

Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response) and metadata of each vector in the response. 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:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify: With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request metadata (by keeping the returnMetadata parameter set to false or not specified). If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering or metadata without the s3vectors:GetVectors permission.

EXEC aws.s3vectors.vectors.query_vectors 
@region='{{ region }}' --required 
@@json=
'{
"vectorBucketName": "{{ vectorBucketName }}", 
"indexName": "{{ indexName }}", 
"indexArn": "{{ indexArn }}", 
"topK": {{ topK }}, 
"queryVector": "{{ queryVector }}", 
"filter": "{{ filter }}", 
"returnMetadata": {{ returnMetadata }}, 
"returnDistance": {{ returnDistance }}, 
"nextToken": "{{ nextToken }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​