Interface S3VectorsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface S3VectorsClient
extends AwsClient

Service client for accessing Amazon S3 Vectors. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static S3VectorsClientBuilder	builder()	Create a builder that can be used to configure and create a S3VectorsClient.
static S3VectorsClient	create()	Create a S3VectorsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateIndexResponse	createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)	Creates a vector index within a vector bucket.
default CreateIndexResponse	createIndex(CreateIndexRequest createIndexRequest)	Creates a vector index within a vector bucket.
default CreateVectorBucketResponse	createVectorBucket(Consumer<CreateVectorBucketRequest.Builder> createVectorBucketRequest)	Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in.
default CreateVectorBucketResponse	createVectorBucket(CreateVectorBucketRequest createVectorBucketRequest)	Creates a vector bucket in the Amazon Web Services Region that you want your bucket to be in.
default DeleteIndexResponse	deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)	Deletes a vector index.
default DeleteIndexResponse	deleteIndex(DeleteIndexRequest deleteIndexRequest)	Deletes a vector index.
default DeleteVectorBucketResponse	deleteVectorBucket(Consumer<DeleteVectorBucketRequest.Builder> deleteVectorBucketRequest)	Deletes a vector bucket.
default DeleteVectorBucketResponse	deleteVectorBucket(DeleteVectorBucketRequest deleteVectorBucketRequest)	Deletes a vector bucket.
default DeleteVectorBucketPolicyResponse	deleteVectorBucketPolicy(Consumer<DeleteVectorBucketPolicyRequest.Builder> deleteVectorBucketPolicyRequest)	Deletes a vector bucket policy.
default DeleteVectorBucketPolicyResponse	deleteVectorBucketPolicy(DeleteVectorBucketPolicyRequest deleteVectorBucketPolicyRequest)	Deletes a vector bucket policy.
default DeleteVectorsResponse	deleteVectors(Consumer<DeleteVectorsRequest.Builder> deleteVectorsRequest)	Deletes one or more vectors in a vector index.
default DeleteVectorsResponse	deleteVectors(DeleteVectorsRequest deleteVectorsRequest)	Deletes one or more vectors in a vector index.
default GetIndexResponse	getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest)	Returns vector index attributes.
default GetIndexResponse	getIndex(GetIndexRequest getIndexRequest)	Returns vector index attributes.
default GetVectorBucketResponse	getVectorBucket(Consumer<GetVectorBucketRequest.Builder> getVectorBucketRequest)	Returns vector bucket attributes.
default GetVectorBucketResponse	getVectorBucket(GetVectorBucketRequest getVectorBucketRequest)	Returns vector bucket attributes.
default GetVectorBucketPolicyResponse	getVectorBucketPolicy(Consumer<GetVectorBucketPolicyRequest.Builder> getVectorBucketPolicyRequest)	Gets details about a vector bucket policy.
default GetVectorBucketPolicyResponse	getVectorBucketPolicy(GetVectorBucketPolicyRequest getVectorBucketPolicyRequest)	Gets details about a vector bucket policy.
default GetVectorsResponse	getVectors(Consumer<GetVectorsRequest.Builder> getVectorsRequest)	Returns vector attributes.
default GetVectorsResponse	getVectors(GetVectorsRequest getVectorsRequest)	Returns vector attributes.
default ListIndexesResponse	listIndexes(Consumer<ListIndexesRequest.Builder> listIndexesRequest)	Returns a list of all the vector indexes within the specified vector bucket.
default ListIndexesResponse	listIndexes(ListIndexesRequest listIndexesRequest)	Returns a list of all the vector indexes within the specified vector bucket.
default ListIndexesIterable	listIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest)	This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation.
default ListIndexesIterable	listIndexesPaginator(ListIndexesRequest listIndexesRequest)	This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags applied to a specified Amazon S3 Vectors resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags applied to a specified Amazon S3 Vectors resource.
default ListVectorBucketsResponse	listVectorBuckets(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)	Returns a list of all the vector buckets that are owned by the authenticated sender of the request.
default ListVectorBucketsResponse	listVectorBuckets(ListVectorBucketsRequest listVectorBucketsRequest)	Returns a list of all the vector buckets that are owned by the authenticated sender of the request.
default ListVectorBucketsIterable	listVectorBucketsPaginator(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)	This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation.
default ListVectorBucketsIterable	listVectorBucketsPaginator(ListVectorBucketsRequest listVectorBucketsRequest)	This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation.
default ListVectorsResponse	listVectors(Consumer<ListVectorsRequest.Builder> listVectorsRequest)	List vectors in the specified vector index.
default ListVectorsResponse	listVectors(ListVectorsRequest listVectorsRequest)	List vectors in the specified vector index.
default ListVectorsIterable	listVectorsPaginator(Consumer<ListVectorsRequest.Builder> listVectorsRequest)	This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation.
default ListVectorsIterable	listVectorsPaginator(ListVectorsRequest listVectorsRequest)	This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation.
default PutVectorBucketPolicyResponse	putVectorBucketPolicy(Consumer<PutVectorBucketPolicyRequest.Builder> putVectorBucketPolicyRequest)	Creates a bucket policy for a vector bucket.
default PutVectorBucketPolicyResponse	putVectorBucketPolicy(PutVectorBucketPolicyRequest putVectorBucketPolicyRequest)	Creates a bucket policy for a vector bucket.
default PutVectorsResponse	putVectors(Consumer<PutVectorsRequest.Builder> putVectorsRequest)	Adds one or more vectors to a vector index.
default PutVectorsResponse	putVectors(PutVectorsRequest putVectorsRequest)	Adds one or more vectors to a vector index.
default QueryVectorsResponse	queryVectors(Consumer<QueryVectorsRequest.Builder> queryVectorsRequest)	Performs an approximate nearest neighbor search query in a vector index using a query vector.
default QueryVectorsResponse	queryVectors(QueryVectorsRequest queryVectorsRequest)	Performs an approximate nearest neighbor search query in a vector index using a query vector.
default S3VectorsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Applies one or more user-defined tags to an Amazon S3 Vectors resource or updates existing tags.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Applies one or more user-defined tags to an Amazon S3 Vectors resource or updates existing tags.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified user-defined tags from an Amazon S3 Vectors resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified user-defined tags from an Amazon S3 Vectors resource.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createIndex

default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
NotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:CreateIndex permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

Parameters:

createIndexRequest -

Returns:

Result of the CreateIndex operation returned by the service.

See Also:

• AWS API Documentation

createIndex

default CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
NotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:CreateIndex permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.

This is a convenience which creates an instance of the CreateIndexRequest.Builder avoiding the need to create one manually via CreateIndexRequest.builder()

Parameters:

createIndexRequest - A Consumer that will call methods on CreateIndexRequest.Builder to create a request.

Returns:

Result of the CreateIndex operation returned by the service.

See Also:

• AWS API Documentation

createVectorBucket

default CreateVectorBucketResponse createVectorBucket(CreateVectorBucketRequest createVectorBucketRequest)
                                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:CreateVectorBucket permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.

Parameters:

createVectorBucketRequest -

Returns:

Result of the CreateVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

createVectorBucket

default CreateVectorBucketResponse createVectorBucket(Consumer<CreateVectorBucketRequest.Builder> createVectorBucketRequest)
                                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:CreateVectorBucket permission to use this operation.

You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.

This is a convenience which creates an instance of the CreateVectorBucketRequest.Builder avoiding the need to create one manually via CreateVectorBucketRequest.builder()

Parameters:

createVectorBucketRequest - A Consumer that will call methods on CreateVectorBucketRequest.Builder to create a request.

Returns:

Result of the CreateVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

deleteIndex

default DeleteIndexResponse deleteIndex(DeleteIndexRequest deleteIndexRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteIndex permission to use this operation.

Parameters:

deleteIndexRequest -

Returns:

Result of the DeleteIndex operation returned by the service.

See Also:

• AWS API Documentation

deleteIndex

default DeleteIndexResponse deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteIndex permission to use this operation.

This is a convenience which creates an instance of the DeleteIndexRequest.Builder avoiding the need to create one manually via DeleteIndexRequest.builder()

Parameters:

deleteIndexRequest - A Consumer that will call methods on DeleteIndexRequest.Builder to create a request.

Returns:

Result of the DeleteIndex operation returned by the service.

See Also:

• AWS API Documentation

deleteVectorBucket

default DeleteVectorBucketResponse deleteVectorBucket(DeleteVectorBucketRequest deleteVectorBucketRequest)
                                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteVectorBucket permission to use this operation.

Parameters:

deleteVectorBucketRequest -

Returns:

Result of the DeleteVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

deleteVectorBucket

default DeleteVectorBucketResponse deleteVectorBucket(Consumer<DeleteVectorBucketRequest.Builder> deleteVectorBucketRequest)
                                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
ConflictException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteVectorBucket permission to use this operation.

This is a convenience which creates an instance of the DeleteVectorBucketRequest.Builder avoiding the need to create one manually via DeleteVectorBucketRequest.builder()

Parameters:

deleteVectorBucketRequest - A Consumer that will call methods on DeleteVectorBucketRequest.Builder to create a request.

Returns:

Result of the DeleteVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

deleteVectorBucketPolicy

default DeleteVectorBucketPolicyResponse deleteVectorBucketPolicy(DeleteVectorBucketPolicyRequest deleteVectorBucketPolicyRequest)
                                                           throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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:

deleteVectorBucketPolicyRequest -

Returns:

Result of the DeleteVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteVectorBucketPolicy

default DeleteVectorBucketPolicyResponse deleteVectorBucketPolicy(Consumer<DeleteVectorBucketPolicyRequest.Builder> deleteVectorBucketPolicyRequest)
                                                           throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

This is a convenience which creates an instance of the DeleteVectorBucketPolicyRequest.Builder avoiding the need to create one manually via DeleteVectorBucketPolicyRequest.builder()

Parameters:

deleteVectorBucketPolicyRequest - A Consumer that will call methods on DeleteVectorBucketPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteVectors

default DeleteVectorsResponse deleteVectors(DeleteVectorsRequest deleteVectorsRequest)
                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteVectors permission to use this operation.

Parameters:

deleteVectorsRequest -

Returns:

Result of the DeleteVectors operation returned by the service.

See Also:

• AWS API Documentation

deleteVectors

default DeleteVectorsResponse deleteVectors(Consumer<DeleteVectorsRequest.Builder> deleteVectorsRequest)
                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:DeleteVectors permission to use this operation.

This is a convenience which creates an instance of the DeleteVectorsRequest.Builder avoiding the need to create one manually via DeleteVectorsRequest.builder()

Parameters:

deleteVectorsRequest - A Consumer that will call methods on DeleteVectorsRequest.Builder to create a request.

Returns:

Result of the DeleteVectors operation returned by the service.

See Also:

• AWS API Documentation

getIndex

default GetIndexResponse getIndex(GetIndexRequest getIndexRequest)
                           throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:GetIndex permission to use this operation.

Parameters:

getIndexRequest -

Returns:

Result of the GetIndex operation returned by the service.

See Also:

• AWS API Documentation

getIndex

default GetIndexResponse getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest)
                           throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:GetIndex permission to use this operation.

This is a convenience which creates an instance of the GetIndexRequest.Builder avoiding the need to create one manually via GetIndexRequest.builder()

Parameters:

getIndexRequest - A Consumer that will call methods on GetIndexRequest.Builder to create a request.

Returns:

Result of the GetIndex operation returned by the service.

See Also:

• AWS API Documentation

getVectorBucket

default GetVectorBucketResponse getVectorBucket(GetVectorBucketRequest getVectorBucketRequest)
                                         throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

Returns vector bucket attributes. 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:GetVectorBucket permission to use this operation.

Parameters:

getVectorBucketRequest -

Returns:

Result of the GetVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

getVectorBucket

default GetVectorBucketResponse getVectorBucket(Consumer<GetVectorBucketRequest.Builder> getVectorBucketRequest)
                                         throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

Returns vector bucket attributes. 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:GetVectorBucket permission to use this operation.

This is a convenience which creates an instance of the GetVectorBucketRequest.Builder avoiding the need to create one manually via GetVectorBucketRequest.builder()

Parameters:

getVectorBucketRequest - A Consumer that will call methods on GetVectorBucketRequest.Builder to create a request.

Returns:

Result of the GetVectorBucket operation returned by the service.

See Also:

• AWS API Documentation

getVectorBucketPolicy

default GetVectorBucketPolicyResponse getVectorBucketPolicy(GetVectorBucketPolicyRequest getVectorBucketPolicyRequest)
                                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

Parameters:

getVectorBucketPolicyRequest -

Returns:

Result of the GetVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

getVectorBucketPolicy

default GetVectorBucketPolicyResponse getVectorBucketPolicy(Consumer<GetVectorBucketPolicyRequest.Builder> getVectorBucketPolicyRequest)
                                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

This is a convenience which creates an instance of the GetVectorBucketPolicyRequest.Builder avoiding the need to create one manually via GetVectorBucketPolicyRequest.builder()

Parameters:

getVectorBucketPolicyRequest - A Consumer that will call methods on GetVectorBucketPolicyRequest.Builder to create a request.

Returns:

Result of the GetVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

getVectors

default GetVectorsResponse getVectors(GetVectorsRequest getVectorsRequest)
                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:GetVectors permission to use this operation.

Parameters:

getVectorsRequest -

Returns:

Result of the GetVectors operation returned by the service.

See Also:

• AWS API Documentation

getVectors

default GetVectorsResponse getVectors(Consumer<GetVectorsRequest.Builder> getVectorsRequest)
                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:GetVectors permission to use this operation.

This is a convenience which creates an instance of the GetVectorsRequest.Builder avoiding the need to create one manually via GetVectorsRequest.builder()

Parameters:

getVectorsRequest - A Consumer that will call methods on GetVectorsRequest.Builder to create a request.

Returns:

Result of the GetVectors operation returned by the service.

See Also:

• AWS API Documentation

listIndexes

default ListIndexesResponse listIndexes(ListIndexesRequest listIndexesRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:ListIndexes permission to use this operation.

Parameters:

listIndexesRequest -

Returns:

Result of the ListIndexes operation returned by the service.

See Also:

• AWS API Documentation

listIndexes

default ListIndexesResponse listIndexes(Consumer<ListIndexesRequest.Builder> listIndexesRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:ListIndexes permission to use this operation.

This is a convenience which creates an instance of the ListIndexesRequest.Builder avoiding the need to create one manually via ListIndexesRequest.builder()

Parameters:

listIndexesRequest - A Consumer that will call methods on ListIndexesRequest.Builder to create a request.

Returns:

Result of the ListIndexes operation returned by the service.

See Also:

• AWS API Documentation

listIndexesPaginator

default ListIndexesIterable listIndexesPaginator(ListIndexesRequest listIndexesRequest)
                                          throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation.

Parameters:

listIndexesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIndexesPaginator

default ListIndexesIterable listIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest)
                                          throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesIterable responses = client.listIndexesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation.

This is a convenience which creates an instance of the ListIndexesRequest.Builder avoiding the need to create one manually via ListIndexesRequest.builder()

Parameters:

listIndexesRequest - A Consumer that will call methods on ListIndexesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:ListTagsForResource permission to use this operation.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:ListTagsForResource permission to use this operation.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listVectorBuckets

default ListVectorBucketsResponse listVectorBuckets(ListVectorBucketsRequest listVectorBucketsRequest)
                                             throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:ListVectorBuckets permission to use this operation.

Parameters:

listVectorBucketsRequest -

Returns:

Result of the ListVectorBuckets operation returned by the service.

See Also:

• AWS API Documentation

listVectorBuckets

default ListVectorBucketsResponse listVectorBuckets(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)
                                             throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

Permissions

You must have the s3vectors:ListVectorBuckets permission to use this operation.

This is a convenience which creates an instance of the ListVectorBucketsRequest.Builder avoiding the need to create one manually via ListVectorBucketsRequest.builder()

Parameters:

listVectorBucketsRequest - A Consumer that will call methods on ListVectorBucketsRequest.Builder to create a request.

Returns:

Result of the ListVectorBuckets operation returned by the service.

See Also:

• AWS API Documentation

listVectorBucketsPaginator

default ListVectorBucketsIterable listVectorBucketsPaginator(ListVectorBucketsRequest listVectorBucketsRequest)
                                                      throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client.listVectorBucketsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client
             .listVectorBucketsPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client.listVectorBucketsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation.

Parameters:

listVectorBucketsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVectorBucketsPaginator

default ListVectorBucketsIterable listVectorBucketsPaginator(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)
                                                      throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client.listVectorBucketsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client
             .listVectorBucketsPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsIterable responses = client.listVectorBucketsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation.

This is a convenience which creates an instance of the ListVectorBucketsRequest.Builder avoiding the need to create one manually via ListVectorBucketsRequest.builder()

Parameters:

listVectorBucketsRequest - A Consumer that will call methods on ListVectorBucketsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVectors

default ListVectorsResponse listVectors(ListVectorsRequest listVectorsRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

ListVectors operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel ListVectors operation by providing the segmentCount and segmentIndex parameters.

Permissions

You must have the s3vectors:ListVectors permission to use this operation. Additional permissions are required based on the request parameters you specify:

• With only s3vectors:ListVectors permission, you can list vector keys when returnData and returnMetadata are both set to false or not specified..

• If you set returnData or returnMetadata to true, you must have both s3vectors:ListVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request vector data or metadata without the s3vectors:GetVectors permission.

Parameters:

listVectorsRequest -

Returns:

Result of the ListVectors operation returned by the service.

See Also:

• AWS API Documentation

listVectors

default ListVectorsResponse listVectors(Consumer<ListVectorsRequest.Builder> listVectorsRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

ListVectors operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel ListVectors operation by providing the segmentCount and segmentIndex parameters.

Permissions

You must have the s3vectors:ListVectors permission to use this operation. Additional permissions are required based on the request parameters you specify:

• With only s3vectors:ListVectors permission, you can list vector keys when returnData and returnMetadata are both set to false or not specified..

• If you set returnData or returnMetadata to true, you must have both s3vectors:ListVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request vector data or metadata without the s3vectors:GetVectors permission.

This is a convenience which creates an instance of the ListVectorsRequest.Builder avoiding the need to create one manually via ListVectorsRequest.builder()

Parameters:

listVectorsRequest - A Consumer that will call methods on ListVectorsRequest.Builder to create a request.

Returns:

Result of the ListVectors operation returned by the service.

See Also:

• AWS API Documentation

listVectorsPaginator

default ListVectorsIterable listVectorsPaginator(ListVectorsRequest listVectorsRequest)
                                          throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation.

Parameters:

listVectorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVectorsPaginator

default ListVectorsIterable listVectorsPaginator(Consumer<ListVectorsRequest.Builder> listVectorsRequest)
                                          throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
     for (software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsIterable responses = client.listVectorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation.

This is a convenience which creates an instance of the ListVectorsRequest.Builder avoiding the need to create one manually via ListVectorsRequest.builder()

Parameters:

listVectorsRequest - A Consumer that will call methods on ListVectorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putVectorBucketPolicy

default PutVectorBucketPolicyResponse putVectorBucketPolicy(PutVectorBucketPolicyRequest putVectorBucketPolicyRequest)
                                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

Parameters:

putVectorBucketPolicyRequest -

Returns:

Result of the PutVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

putVectorBucketPolicy

default PutVectorBucketPolicyResponse putVectorBucketPolicy(Consumer<PutVectorBucketPolicyRequest.Builder> putVectorBucketPolicyRequest)
                                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

This is a convenience which creates an instance of the PutVectorBucketPolicyRequest.Builder avoiding the need to create one manually via PutVectorBucketPolicyRequest.builder()

Parameters:

putVectorBucketPolicyRequest - A Consumer that will call methods on PutVectorBucketPolicyRequest.Builder to create a request.

Returns:

Result of the PutVectorBucketPolicy operation returned by the service.

See Also:

• AWS API Documentation

putVectors

default PutVectorsResponse putVectors(PutVectorsRequest putVectorsRequest)
                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
ServiceQuotaExceededException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

For more information about limits, see Limitations and restrictions in the Amazon S3 User Guide.

When inserting vector data into your vector index, you must provide the vector data as float32 (32-bit floating point) values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors converts the values to 32-bit floating point before storing them, and GetVectors, ListVectors, and QueryVectors operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as float32 values regardless of which SDK you're using. For example, in Python, use numpy.float32 or explicitly cast your values.

Permissions

You must have the s3vectors:PutVectors permission to use this operation.

Parameters:

putVectorsRequest -

Returns:

Result of the PutVectors operation returned by the service.

See Also:

• AWS API Documentation

putVectors

default PutVectorsResponse putVectors(Consumer<PutVectorsRequest.Builder> putVectorsRequest)
                               throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
ServiceQuotaExceededException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

For more information about limits, see Limitations and restrictions in the Amazon S3 User Guide.

When inserting vector data into your vector index, you must provide the vector data as float32 (32-bit floating point) values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors converts the values to 32-bit floating point before storing them, and GetVectors, ListVectors, and QueryVectors operations return the float32 values. Different Amazon Web Services SDKs may have different default numeric types, so ensure your vectors are properly formatted as float32 values regardless of which SDK you're using. For example, in Python, use numpy.float32 or explicitly cast your values.

Permissions

You must have the s3vectors:PutVectors permission to use this operation.

This is a convenience which creates an instance of the PutVectorsRequest.Builder avoiding the need to create one manually via PutVectorsRequest.builder()

Parameters:

putVectorsRequest - A Consumer that will call methods on PutVectorsRequest.Builder to create a request.

Returns:

Result of the PutVectors operation returned by the service.

See Also:

• AWS API Documentation

queryVectors

default QueryVectorsResponse queryVectors(QueryVectorsRequest queryVectorsRequest)
                                   throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

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

Permissions

You must have the s3vectors:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify:

• With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request vector data or metadata (by keeping the returnMetadata parameter set to false or not specified).

• If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering, vector data, or metadata without the s3vectors:GetVectors permission.

Parameters:

queryVectorsRequest -

Returns:

Result of the QueryVectors operation returned by the service.

See Also:

• AWS API Documentation

queryVectors

default QueryVectorsResponse queryVectors(Consumer<QueryVectorsRequest.Builder> queryVectorsRequest)
                                   throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
KmsInvalidKeyUsageException,
InternalServerException,
KmsInvalidStateException,
AccessDeniedException,
KmsNotFoundException,
RequestTimeoutException,
NotFoundException,
KmsDisabledException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

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

Permissions

You must have the s3vectors:QueryVectors permission to use this operation. Additional permissions are required based on the request parameters you specify:

• With only s3vectors:QueryVectors permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request vector data or metadata (by keeping the returnMetadata parameter set to false or not specified).

• If you specify a metadata filter or set returnMetadata to true, you must have both s3vectors:QueryVectors and s3vectors:GetVectors permissions. The request fails with a 403 Forbidden error if you request metadata filtering, vector data, or metadata without the s3vectors:GetVectors permission.

This is a convenience which creates an instance of the QueryVectorsRequest.Builder avoiding the need to create one manually via QueryVectorsRequest.builder()

Parameters:

queryVectorsRequest - A Consumer that will call methods on QueryVectorsRequest.Builder to create a request.

Returns:

Result of the QueryVectors operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:TagResource permission to use this operation.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
S3VectorsException

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.

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:TagResource permission to use this operation.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:UntagResource permission to use this operation.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ServiceUnavailableException,
TooManyRequestsException,
InternalServerException,
AccessDeniedException,
RequestTimeoutException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
S3VectorsException

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

For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources.

Permissions

For vector buckets and vector indexes, you must have the s3vectors:UntagResource permission to use this operation.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static S3VectorsClient create()

Create a S3VectorsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static S3VectorsClientBuilder builder()

Create a builder that can be used to configure and create a S3VectorsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default S3VectorsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration