S3VectorsClient

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

Link copied to clipboard
abstract override val config: S3VectorsClient.Config

S3VectorsClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createIndex(input: CreateIndexRequest): CreateIndexResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun deleteIndex(input: DeleteIndexRequest = DeleteIndexRequest { }): DeleteIndexResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun deleteVectorBucket(input: DeleteVectorBucketRequest = DeleteVectorBucketRequest { }): DeleteVectorBucketResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun deleteVectorBucketPolicy(input: DeleteVectorBucketPolicyRequest = DeleteVectorBucketPolicyRequest { }): DeleteVectorBucketPolicyResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun getIndex(input: GetIndexRequest = GetIndexRequest { }): GetIndexResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun getVectorBucket(input: GetVectorBucketRequest = GetVectorBucketRequest { }): GetVectorBucketResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun getVectorBucketPolicy(input: GetVectorBucketPolicyRequest = GetVectorBucketPolicyRequest { }): GetVectorBucketPolicyResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun getVectors(input: GetVectorsRequest): GetVectorsResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun listIndexes(input: ListIndexesRequest = ListIndexesRequest { }): ListIndexesResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun listVectorBuckets(input: ListVectorBucketsRequest = ListVectorBucketsRequest { }): ListVectorBucketsResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun listVectors(input: ListVectorsRequest = ListVectorsRequest { }): ListVectorsResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
abstract suspend fun putVectors(input: PutVectorsRequest): PutVectorsResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun S3VectorsClient.createIndex(crossinline block: CreateIndexRequest.Builder.() -> Unit): CreateIndexResponse

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard
Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

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

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

Link copied to clipboard

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.