Interface S3VectorsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface S3VectorsAsyncClient extends AwsClient
Service client for accessing Amazon S3 Vectors asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(CreateIndexRequest createIndexRequest)

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

      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.

      Parameters:
      createIndexRequest -
      Returns:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIndex

      default CompletableFuture<CreateIndexResponse> createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest)

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

      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.


      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:
      A Java Future containing the result of the CreateIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVectorBucket

      default CompletableFuture<CreateVectorBucketResponse> createVectorBucket(CreateVectorBucketRequest createVectorBucketRequest)

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

      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.

      Parameters:
      createVectorBucketRequest -
      Returns:
      A Java Future containing the result of the CreateVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVectorBucket

      default CompletableFuture<CreateVectorBucketResponse> createVectorBucket(Consumer<CreateVectorBucketRequest.Builder> createVectorBucketRequest)

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

      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.


      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:
      A Java Future containing the result of the CreateVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIndex

      default CompletableFuture<DeleteIndexResponse> deleteIndex(DeleteIndexRequest deleteIndexRequest)

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

      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:
      A Java Future containing the result of the DeleteIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIndex

      default CompletableFuture<DeleteIndexResponse> deleteIndex(Consumer<DeleteIndexRequest.Builder> deleteIndexRequest)

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

      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:
      A Java Future containing the result of the DeleteIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectorBucket

      default CompletableFuture<DeleteVectorBucketResponse> deleteVectorBucket(DeleteVectorBucketRequest deleteVectorBucketRequest)

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

      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:
      A Java Future containing the result of the DeleteVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectorBucket

      default CompletableFuture<DeleteVectorBucketResponse> deleteVectorBucket(Consumer<DeleteVectorBucketRequest.Builder> deleteVectorBucketRequest)

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

      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:
      A Java Future containing the result of the DeleteVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ConflictException The request failed because a vector bucket name or a vector index name already exists. Vector bucket names must be unique within your Amazon Web Services account for each Amazon Web Services Region. Vector index names must be unique within your vector bucket. Choose a different vector bucket name or vector index name, and try again.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectorBucketPolicy

      default CompletableFuture<DeleteVectorBucketPolicyResponse> deleteVectorBucketPolicy(DeleteVectorBucketPolicyRequest deleteVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the DeleteVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectorBucketPolicy

      default CompletableFuture<DeleteVectorBucketPolicyResponse> deleteVectorBucketPolicy(Consumer<DeleteVectorBucketPolicyRequest.Builder> deleteVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the DeleteVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectors

      default CompletableFuture<DeleteVectorsResponse> deleteVectors(DeleteVectorsRequest deleteVectorsRequest)

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

      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:
      A Java Future containing the result of the DeleteVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVectors

      default CompletableFuture<DeleteVectorsResponse> deleteVectors(Consumer<DeleteVectorsRequest.Builder> deleteVectorsRequest)

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

      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:
      A Java Future containing the result of the DeleteVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndex

      default CompletableFuture<GetIndexResponse> getIndex(GetIndexRequest getIndexRequest)

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

      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:
      A Java Future containing the result of the GetIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndex

      default CompletableFuture<GetIndexResponse> getIndex(Consumer<GetIndexRequest.Builder> getIndexRequest)

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

      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:
      A Java Future containing the result of the GetIndex operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectorBucket

      default CompletableFuture<GetVectorBucketResponse> getVectorBucket(GetVectorBucketRequest getVectorBucketRequest)

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

      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:
      A Java Future containing the result of the GetVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectorBucket

      default CompletableFuture<GetVectorBucketResponse> getVectorBucket(Consumer<GetVectorBucketRequest.Builder> getVectorBucketRequest)

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

      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:
      A Java Future containing the result of the GetVectorBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectorBucketPolicy

      default CompletableFuture<GetVectorBucketPolicyResponse> getVectorBucketPolicy(GetVectorBucketPolicyRequest getVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the GetVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectorBucketPolicy

      default CompletableFuture<GetVectorBucketPolicyResponse> getVectorBucketPolicy(Consumer<GetVectorBucketPolicyRequest.Builder> getVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the GetVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectors

      default CompletableFuture<GetVectorsResponse> getVectors(GetVectorsRequest getVectorsRequest)

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

      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:
      A Java Future containing the result of the GetVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getVectors

      default CompletableFuture<GetVectorsResponse> getVectors(Consumer<GetVectorsRequest.Builder> getVectorsRequest)

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

      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:
      A Java Future containing the result of the GetVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexes

      default CompletableFuture<ListIndexesResponse> listIndexes(ListIndexesRequest listIndexesRequest)

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

      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:
      A Java Future containing the result of the ListIndexes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexes

      default CompletableFuture<ListIndexesResponse> listIndexes(Consumer<ListIndexesRequest.Builder> listIndexesRequest)

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

      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:
      A Java Future containing the result of the ListIndexes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexesPaginator

      default ListIndexesPublisher listIndexesPaginator(ListIndexesRequest listIndexesRequest)

      This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIndexesPaginator

      default ListIndexesPublisher listIndexesPaginator(Consumer<ListIndexesRequest.Builder> listIndexesRequest)

      This is a variant of listIndexes(software.amazon.awssdk.services.s3vectors.model.ListIndexesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListIndexesPublisher publisher = client.listIndexesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListIndexesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorBuckets

      default CompletableFuture<ListVectorBucketsResponse> listVectorBuckets(ListVectorBucketsRequest listVectorBucketsRequest)

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

      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:
      A Java Future containing the result of the ListVectorBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorBuckets

      default CompletableFuture<ListVectorBucketsResponse> listVectorBuckets(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)

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

      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:
      A Java Future containing the result of the ListVectorBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorBucketsPaginator

      default ListVectorBucketsPublisher listVectorBucketsPaginator(ListVectorBucketsRequest listVectorBucketsRequest)

      This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsPublisher publisher = client.listVectorBucketsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsPublisher publisher = client.listVectorBucketsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorBucketsPaginator

      default ListVectorBucketsPublisher listVectorBucketsPaginator(Consumer<ListVectorBucketsRequest.Builder> listVectorBucketsRequest)

      This is a variant of listVectorBuckets(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsPublisher publisher = client.listVectorBucketsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorBucketsPublisher publisher = client.listVectorBucketsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListVectorBucketsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectors

      default CompletableFuture<ListVectorsResponse> listVectors(ListVectorsRequest listVectorsRequest)

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

      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:
      A Java Future containing the result of the ListVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectors

      default CompletableFuture<ListVectorsResponse> listVectors(Consumer<ListVectorsRequest.Builder> listVectorsRequest)

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

      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:
      A Java Future containing the result of the ListVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorsPaginator

      default ListVectorsPublisher listVectorsPaginator(ListVectorsRequest listVectorsRequest)

      This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsPublisher publisher = client.listVectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsPublisher publisher = client.listVectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listVectorsPaginator

      default ListVectorsPublisher listVectorsPaginator(Consumer<ListVectorsRequest.Builder> listVectorsRequest)

      This is a variant of listVectors(software.amazon.awssdk.services.s3vectors.model.ListVectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsPublisher publisher = client.listVectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.s3vectors.paginators.ListVectorsPublisher publisher = client.listVectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.s3vectors.model.ListVectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putVectorBucketPolicy

      default CompletableFuture<PutVectorBucketPolicyResponse> putVectorBucketPolicy(PutVectorBucketPolicyRequest putVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the PutVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putVectorBucketPolicy

      default CompletableFuture<PutVectorBucketPolicyResponse> putVectorBucketPolicy(Consumer<PutVectorBucketPolicyRequest.Builder> putVectorBucketPolicyRequest)

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

      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:
      A Java Future containing the result of the PutVectorBucketPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • InternalServerException The request failed due to an internal server error.
      • AccessDeniedException Access denied.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putVectors

      default CompletableFuture<PutVectorsResponse> putVectors(PutVectorsRequest putVectorsRequest)

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

      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:
      A Java Future containing the result of the PutVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putVectors

      default CompletableFuture<PutVectorsResponse> putVectors(Consumer<PutVectorsRequest.Builder> putVectorsRequest)

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

      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:
      A Java Future containing the result of the PutVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryVectors

      default CompletableFuture<QueryVectorsResponse> queryVectors(QueryVectorsRequest queryVectorsRequest)

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

      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:
      A Java Future containing the result of the QueryVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryVectors

      default CompletableFuture<QueryVectorsResponse> queryVectors(Consumer<QueryVectorsRequest.Builder> queryVectorsRequest)

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

      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:
      A Java Future containing the result of the QueryVectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The requested action isn't valid.
      • ServiceUnavailableException The service is unavailable. Wait briefly and retry your request. If it continues to fail, increase your waiting time between retries.
      • TooManyRequestsException The request was denied due to request throttling.
      • KmsInvalidKeyUsageException The request was rejected for one of the following reasons:

        • The KeyUsage value of the KMS key is incompatible with the API operation.

        • The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key (KeySpec).

        For more information, see InvalidKeyUsageException in the Amazon Web Services Key Management Service API Reference.

      • InternalServerException The request failed due to an internal server error.
      • KmsInvalidStateException The key state of the KMS key isn't compatible with the operation.

        For more information, see KMSInvalidStateException in the Amazon Web Services Key Management Service API Reference.

      • AccessDeniedException Access denied.
      • KmsNotFoundException The KMS key can't be found.
      • NotFoundException The request was rejected because the specified resource can't be found.
      • ServiceQuotaExceededException Your request exceeds a service quota.
      • KmsDisabledException The specified Amazon Web Services KMS key isn't enabled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • S3VectorsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static S3VectorsAsyncClient create()
      Create a S3VectorsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static S3VectorsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a S3VectorsAsyncClient.