s3vectors/aws.sdk.kotlin.services.s3vectors

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createIndex

inline suspend fun S3VectorsClient.createIndex(crossinline block: CreateIndexRequest.Builder.() -> Unit): CreateIndexResponse

Creates 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 Name (ARN).

createVectorBucket

inline suspend fun S3VectorsClient.createVectorBucket(crossinline block: CreateVectorBucketRequest.Builder.() -> Unit): CreateVectorBucketResponse

Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in.

deleteIndex

inline suspend fun S3VectorsClient.deleteIndex(crossinline block: DeleteIndexRequest.Builder.() -> Unit): DeleteIndexResponse

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

deleteVectorBucket

inline suspend fun S3VectorsClient.deleteVectorBucket(crossinline block: DeleteVectorBucketRequest.Builder.() -> Unit): DeleteVectorBucketResponse

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

deleteVectorBucketPolicy

inline suspend fun S3VectorsClient.deleteVectorBucketPolicy(crossinline block: DeleteVectorBucketPolicyRequest.Builder.() -> Unit): DeleteVectorBucketPolicyResponse

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

deleteVectors

inline suspend fun S3VectorsClient.deleteVectors(crossinline block: DeleteVectorsRequest.Builder.() -> Unit): DeleteVectorsResponse

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

getIndex

inline suspend fun S3VectorsClient.getIndex(crossinline block: GetIndexRequest.Builder.() -> Unit): GetIndexResponse

Returns 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 index Amazon Resource Name (ARN).

getVectorBucket

inline suspend fun S3VectorsClient.getVectorBucket(crossinline block: GetVectorBucketRequest.Builder.() -> Unit): GetVectorBucketResponse

Returns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

getVectorBucketPolicy

inline suspend fun S3VectorsClient.getVectorBucketPolicy(crossinline block: GetVectorBucketPolicyRequest.Builder.() -> Unit): GetVectorBucketPolicyResponse

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

getVectors

inline suspend fun S3VectorsClient.getVectors(crossinline block: GetVectorsRequest.Builder.() -> Unit): GetVectorsResponse

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

listIndexes

inline suspend fun S3VectorsClient.listIndexes(crossinline block: ListIndexesRequest.Builder.() -> Unit): ListIndexesResponse

Returns 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 bucket Amazon Resource Name (ARN).

listTagsForResource

inline suspend fun S3VectorsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists 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, track costs for, and control access to resources.

listVectorBuckets

inline suspend fun S3VectorsClient.listVectorBuckets(crossinline block: ListVectorBucketsRequest.Builder.() -> Unit): ListVectorBucketsResponse

Returns a list of all the vector buckets that are owned by the authenticated sender of the request.

listVectors

inline suspend fun S3VectorsClient.listVectors(crossinline block: ListVectorsRequest.Builder.() -> Unit): ListVectorsResponse

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

putVectorBucketPolicy

inline suspend fun S3VectorsClient.putVectorBucketPolicy(crossinline block: PutVectorBucketPolicyRequest.Builder.() -> Unit): PutVectorBucketPolicyResponse

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

putVectors

inline suspend fun S3VectorsClient.putVectors(crossinline block: PutVectorsRequest.Builder.() -> Unit): PutVectorsResponse

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

queryVectors

inline suspend fun S3VectorsClient.queryVectors(crossinline block: QueryVectorsRequest.Builder.() -> Unit): QueryVectorsResponse

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), the vector data, and metadata of each vector in the response.

tagResource

inline suspend fun S3VectorsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies 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 can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each resource.

untagResource

inline suspend fun S3VectorsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified user-defined tags from an Amazon S3 Vectors resource. You can pass one or more tag keys.

withConfig

fun S3VectorsClient.withConfig(block: S3VectorsClient.Config.Builder.() -> Unit): S3VectorsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.