s3vectors/aws.sdk.kotlin.services.s3vectors

Package-level declarations

Types

S3VectorsClient

interface S3VectorsClient : SdkClient

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

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Inherited functions

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.

createVectorBucket

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

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

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.

deleteVectorBucket

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

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

deleteVectorBucketPolicy

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

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

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

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

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.

getVectorBucket

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

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

getVectorBucketPolicy

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

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

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.

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.

listVectorBuckets

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

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

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.

putVectorBucketPolicy

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

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

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.

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

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

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.