vector_buckets

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

Overview

Name	vector_buckets
Type	Resource
Id	aws.s3vectors.vector_buckets

Fields

The following fields are returned by SELECT queries:

get_vector_bucket

Name	Datatype	Description
creation_time	string (date-time)	Date and time when the vector bucket was created.
encryption_configuration	object	The encryption configuration for a vector bucket or index. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.
vector_bucket_arn	string	The Amazon Resource Name (ARN) of the vector bucket. (pattern: <code>arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]</code>)
vector_bucket_name	string	The name of the vector bucket.

list_vector_buckets

Name	Datatype	Description
creation_time	string (date-time)	Date and time when the vector bucket was created.
vector_bucket_arn	string	The Amazon Resource Name (ARN) of the vector bucket. (pattern: <code>arn:aws[-a-z0-9]*:s3vectors:[a-z0-9-]+:[0-9]{12}:bucket/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]</code>)
vector_bucket_name	string	The name of the vector bucket.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vector_bucket	select	region		Returns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). Permissions You must have the s3vectors:GetVectorBucket permission to use this operation.
list_vector_buckets	select	region		Returns a list of all the vector buckets that are owned by the authenticated sender of the request. Permissions You must have the s3vectors:ListVectorBuckets permission to use this operation.
create_vector_bucket	insert	region, vectorBucketName		Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. Permissions You must have the s3vectors:CreateVectorBucket permission to use this operation. You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.
delete_vector_bucket	delete	region		Deletes 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 use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). Permissions You must have the s3vectors:DeleteVectorBucket permission to use this operation.

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_vector_bucket

Returns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN). Permissions You must have the s3vectors:GetVectorBucket permission to use this operation.

SELECT
creation_time,
encryption_configuration,
vector_bucket_arn,
vector_bucket_name
FROM aws.s3vectors.vector_buckets
WHERE region = '{{ region }}' -- required
;

list_vector_buckets

Returns a list of all the vector buckets that are owned by the authenticated sender of the request. Permissions You must have the s3vectors:ListVectorBuckets permission to use this operation.

SELECT
creation_time,
vector_bucket_arn,
vector_bucket_name
FROM aws.s3vectors.vector_buckets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_vector_bucket

Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. Permissions You must have the s3vectors:CreateVectorBucket permission to use this operation. You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.

INSERT INTO aws.s3vectors.vector_buckets (
vectorBucketName,
encryptionConfiguration,
tags,
region
)
SELECT 
'{{ vectorBucketName }}' /* required */,
'{{ encryptionConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
vector_bucket_arn
;

Manifest

# Description fields are for documentation purposes
- name: vector_buckets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the vector_buckets resource.
  - name: vectorBucketName
    value: "{{ vectorBucketName }}"
  - name: encryptionConfiguration
    description: |
      The encryption configuration for a vector bucket or index. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256. You can optionally override bucket level encryption settings, and set a specific encryption configuration for a vector index at the time of index creation.
    value:
      sseType: "{{ sseType }}"
      kmsKeyArn: "{{ kmsKeyArn }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_vector_bucket

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

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