s3vectors/aws.sdk.kotlin.services.s3vectors/S3VectorsClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<S3VectorsClient.Config, S3VectorsClient.Config.Builder, S3VectorsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<S3VectorsClient.Config, S3VectorsClient.Config.Builder, S3VectorsClient, S3VectorsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: S3VectorsClient.Config

S3VectorsClient's configuration

Functions

createIndex

abstract suspend fun createIndex(input: CreateIndexRequest): CreateIndexResponse

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

createVectorBucket

abstract suspend fun createVectorBucket(input: CreateVectorBucketRequest): CreateVectorBucketResponse

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

deleteIndex

abstract suspend fun deleteIndex(input: DeleteIndexRequest = DeleteIndexRequest { }): DeleteIndexResponse

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

deleteVectorBucket

abstract suspend fun deleteVectorBucket(input: DeleteVectorBucketRequest = DeleteVectorBucketRequest { }): DeleteVectorBucketResponse

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

deleteVectorBucketPolicy

abstract suspend fun deleteVectorBucketPolicy(input: DeleteVectorBucketPolicyRequest = DeleteVectorBucketPolicyRequest { }): DeleteVectorBucketPolicyResponse

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

deleteVectors

abstract suspend fun deleteVectors(input: DeleteVectorsRequest): DeleteVectorsResponse

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

getIndex

abstract suspend fun getIndex(input: GetIndexRequest = GetIndexRequest { }): GetIndexResponse

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

getVectorBucket

abstract suspend fun getVectorBucket(input: GetVectorBucketRequest = GetVectorBucketRequest { }): GetVectorBucketResponse

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

getVectorBucketPolicy

abstract suspend fun getVectorBucketPolicy(input: GetVectorBucketPolicyRequest = GetVectorBucketPolicyRequest { }): GetVectorBucketPolicyResponse

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

getVectors

abstract suspend fun getVectors(input: GetVectorsRequest): GetVectorsResponse

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

listIndexes

abstract suspend fun listIndexes(input: ListIndexesRequest = ListIndexesRequest { }): ListIndexesResponse

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

listVectorBuckets

abstract suspend fun listVectorBuckets(input: ListVectorBucketsRequest = ListVectorBucketsRequest { }): ListVectorBucketsResponse

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

listVectors

abstract suspend fun listVectors(input: ListVectorsRequest = ListVectorsRequest { }): ListVectorsResponse

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

putVectorBucketPolicy

abstract suspend fun putVectorBucketPolicy(input: PutVectorBucketPolicyRequest): PutVectorBucketPolicyResponse

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

putVectors

abstract suspend fun putVectors(input: PutVectorsRequest): PutVectorsResponse

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

queryVectors

abstract suspend fun queryVectors(input: QueryVectorsRequest): QueryVectorsResponse

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

Inherited functions

expect abstract fun close()

createIndex

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.

deleteIndex

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.

deleteVectors

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.

getIndex

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.

getVectors

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.

listIndexes

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.

listIndexesPaginated

fun S3VectorsClient.listIndexesPaginated(initialRequest: ListIndexesRequest = ListIndexesRequest { }): Flow<ListIndexesResponse>

fun S3VectorsClient.listIndexesPaginated(block: ListIndexesRequest.Builder.() -> Unit): Flow<ListIndexesResponse>

Paginate over ListIndexesResponse results.

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.

listVectorBucketsPaginated

fun S3VectorsClient.listVectorBucketsPaginated(initialRequest: ListVectorBucketsRequest = ListVectorBucketsRequest { }): Flow<ListVectorBucketsResponse>

fun S3VectorsClient.listVectorBucketsPaginated(block: ListVectorBucketsRequest.Builder.() -> Unit): Flow<ListVectorBucketsResponse>

Paginate over ListVectorBucketsResponse results.

listVectors

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.

listVectorsPaginated

fun S3VectorsClient.listVectorsPaginated(initialRequest: ListVectorsRequest = ListVectorsRequest { }): Flow<ListVectorsResponse>

fun S3VectorsClient.listVectorsPaginated(block: ListVectorsRequest.Builder.() -> Unit): Flow<ListVectorsResponse>

Paginate over ListVectorsResponse results.

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.

putVectors

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.

queryVectors

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.

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.