vector_bucket_policies

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

Overview

Name	vector_bucket_policies
Type	Resource
Id	aws.s3vectors.vector_bucket_policies

Fields

The following fields are returned by SELECT queries:

get_vector_bucket_policy

Name	Datatype	Description
policy	string	The JSON that defines the policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vector_bucket_policy	select	region		Gets 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). Permissions You must have the s3vectors:GetVectorBucketPolicy permission to use this operation.
put_vector_bucket_policy	replace	region, policy		Creates 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 (ARN). Permissions You must have the s3vectors:PutVectorBucketPolicy permission to use this operation.
delete_vector_bucket_policy	delete	region		Deletes 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 You must have the s3vectors:DeleteVectorBucketPolicy 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_policy

Gets 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). Permissions You must have the s3vectors:GetVectorBucketPolicy permission to use this operation.

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

REPLACE examples

put_vector_bucket_policy

Creates 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 (ARN). Permissions You must have the s3vectors:PutVectorBucketPolicy permission to use this operation.

REPLACE aws.s3vectors.vector_bucket_policies
SET 
vectorBucketName = '{{ vectorBucketName }}',
vectorBucketArn = '{{ vectorBucketArn }}',
policy = '{{ policy }}'
WHERE 
region = '{{ region }}' --required
AND policy = '{{ policy }}' --required;

DELETE examples

delete_vector_bucket_policy

Deletes 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 You must have the s3vectors:DeleteVectorBucketPolicy permission to use this operation.

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