Struct Client

pub struct Client { /* private fields */ }

Client for Amazon S3 Vectors

Client for invoking operations on Amazon S3 Vectors. Each operation on Amazon S3 Vectors is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_s3vectors::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_s3vectors::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateIndex operation has a Client::create_index, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_index()
    .vector_bucket_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_index(&self) -> CreateIndexFluentBuilder

Constructs a fluent builder for the CreateIndex operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket to create the vector index in.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the vector bucket to create the vector index in.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the vector index to create.

    
    
  • data_type(DataType) / set_data_type(Option<DataType>):
    required: true
    

    The data type of the vectors to be inserted into the vector index.

    
    
  • dimension(i32) / set_dimension(Option<i32>):
    required: true
    

    The dimensions of the vectors to be inserted into the vector index.

    
    
  • distance_metric(DistanceMetric) / set_distance_metric(Option<DistanceMetric>):
    required: true
    

    The distance metric to be used for similarity search.

    
    
  • metadata_configuration(MetadataConfiguration) / set_metadata_configuration(Option<MetadataConfiguration>):
    required: false
    

    The metadata configuration for the vector index.

    
    
• On success, responds with CreateIndexOutput
• On failure, responds with SdkError<CreateIndexError>

impl Client

pub fn create_vector_bucket(&self) -> CreateVectorBucketFluentBuilder

Constructs a fluent builder for the CreateVectorBucket operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: true
    

    The name of the vector bucket to create.

    
    
  • encryption_configuration(EncryptionConfiguration) / set_encryption_configuration(Option<EncryptionConfiguration>):
    required: false
    

    The encryption configuration for the vector bucket. By default, if you don’t specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.

    
    
• On success, responds with CreateVectorBucketOutput
• On failure, responds with SdkError<CreateVectorBucketError>

impl Client

pub fn delete_index(&self) -> DeleteIndexFluentBuilder

Constructs a fluent builder for the DeleteIndex operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index to delete.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index to delete.

    
    
• On success, responds with DeleteIndexOutput
• On failure, responds with SdkError<DeleteIndexError>

impl Client

pub fn delete_vector_bucket(&self) -> DeleteVectorBucketFluentBuilder

Constructs a fluent builder for the DeleteVectorBucket operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket to delete.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The ARN of the vector bucket to delete.

    
    
• On success, responds with DeleteVectorBucketOutput
• On failure, responds with SdkError<DeleteVectorBucketError>

impl Client

pub fn delete_vector_bucket_policy( &self, ) -> DeleteVectorBucketPolicyFluentBuilder

Constructs a fluent builder for the DeleteVectorBucketPolicy operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket to delete the policy from.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The ARN of the vector bucket to delete the policy from.

    
    
• On success, responds with DeleteVectorBucketPolicyOutput
• On failure, responds with SdkError<DeleteVectorBucketPolicyError>

impl Client

pub fn delete_vectors(&self) -> DeleteVectorsFluentBuilder

Constructs a fluent builder for the DeleteVectors operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index that contains a vector you want to delete.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index that contains a vector you want to delete.

    
    
  • keys(impl Into<String>) / set_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the vectors to delete.

    
    
• On success, responds with DeleteVectorsOutput
• On failure, responds with SdkError<DeleteVectorsError>

impl Client

pub fn get_index(&self) -> GetIndexFluentBuilder

Constructs a fluent builder for the GetIndex operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index.

    
    
• On success, responds with GetIndexOutput with field(s):
  • index(Option<Index>):

    The attributes of the vector index.

• On failure, responds with SdkError<GetIndexError>

impl Client

pub fn get_vector_bucket(&self) -> GetVectorBucketFluentBuilder

Constructs a fluent builder for the GetVectorBucket operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket to retrieve information about.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The ARN of the vector bucket to retrieve information about.

    
    
• On success, responds with GetVectorBucketOutput with field(s):
  • vector_bucket(Option<VectorBucket>):

    The attributes of the vector bucket.

• On failure, responds with SdkError<GetVectorBucketError>

impl Client

pub fn get_vector_bucket_policy(&self) -> GetVectorBucketPolicyFluentBuilder

Constructs a fluent builder for the GetVectorBucketPolicy operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The ARN of the vector bucket.

    
    
• On success, responds with GetVectorBucketPolicyOutput with field(s):
  • policy(Option<String>):

    The JSON that defines the policy.

• On failure, responds with SdkError<GetVectorBucketPolicyError>

impl Client

pub fn get_vectors(&self) -> GetVectorsFluentBuilder

Constructs a fluent builder for the GetVectors operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index.

    
    
  • keys(impl Into<String>) / set_keys(Option<Vec::<String>>):
    required: true
    

    The names of the vectors you want to return attributes for.

    
    
  • return_data(bool) / set_return_data(Option<bool>):
    required: false
    

    Indicates whether to include the vector data in the response. The default value is false.

    
    
  • return_metadata(bool) / set_return_metadata(Option<bool>):
    required: false
    

    Indicates whether to include metadata in the response. The default value is false.

    
    
• On success, responds with GetVectorsOutput with field(s):
  • vectors(Vec::<GetOutputVector>):

    The attributes of the vectors.

• On failure, responds with SdkError<GetVectorsError>

impl Client

pub fn list_indexes(&self) -> ListIndexesFluentBuilder

Constructs a fluent builder for the ListIndexes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector indexes.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The ARN of the vector bucket that contains the vector indexes.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items to be returned in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The previous pagination token.

    
    
  • prefix(impl Into<String>) / set_prefix(Option<String>):
    required: false
    

    Limits the response to vector indexes that begin with the specified prefix.

    
    
• On success, responds with ListIndexesOutput with field(s):
  • next_token(Option<String>):

    The next pagination token.

  • indexes(Vec::<IndexSummary>):

    The attributes of the vector indexes

• On failure, responds with SdkError<ListIndexesError>

impl Client

pub fn list_vector_buckets(&self) -> ListVectorBucketsFluentBuilder

Constructs a fluent builder for the ListVectorBuckets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of vector buckets to be returned in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The previous pagination token.

    
    
  • prefix(impl Into<String>) / set_prefix(Option<String>):
    required: false
    

    Limits the response to vector buckets that begin with the specified prefix.

    
    
• On success, responds with ListVectorBucketsOutput with field(s):
  • next_token(Option<String>):

    The element is included in the response when there are more buckets to be listed with pagination.

  • vector_buckets(Vec::<VectorBucketSummary>):

    The list of vector buckets owned by the requester.

• On failure, responds with SdkError<ListVectorBucketsError>

impl Client

pub fn list_vectors(&self) -> ListVectorsFluentBuilder

Constructs a fluent builder for the ListVectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The Amazon resource Name (ARN) of the vector index.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of vectors to return on a page.

    If you don’t specify maxResults, the ListVectors operation uses a default value of 500.

    If the processed dataset size exceeds 1 MB before reaching the maxResults value, the operation stops and returns the vectors that are retrieved up to that point, along with a nextToken that you can use in a subsequent request to retrieve the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token from a previous request. The value of this field is empty for an initial request.

    
    
  • segment_count(i32) / set_segment_count(Option<i32>):
    required: false
    

    For a parallel ListVectors request, segmentCount represents the total number of vector segments into which the ListVectors operation will be divided. The value of segmentCount corresponds to the number of application workers that will perform the parallel ListVectors operation. For example, if you want to use four application threads to list vectors in a vector index, specify a segmentCount value of 4.

    If you specify a segmentCount value of 1, the ListVectors operation will be sequential rather than parallel.

    If you specify segmentCount, you must also specify segmentIndex.

    
    
  • segment_index(i32) / set_segment_index(Option<i32>):
    required: false
    

    For a parallel ListVectors request, segmentIndex is the index of the segment from which to list vectors in the current request. It identifies an individual segment to be listed by an application worker.

    Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to list vectors in a vector index, then the first thread specifies a segmentIndex value of 0, the second thread specifies 1, and so on.

    The value of segmentIndex must be less than the value provided for segmentCount.

    If you provide segmentIndex, you must also provide segmentCount.

    
    
  • return_data(bool) / set_return_data(Option<bool>):
    required: false
    

    If true, the vector data of each vector will be included in the response. The default value is false.

    
    
  • return_metadata(bool) / set_return_metadata(Option<bool>):
    required: false
    

    If true, the metadata associated with each vector will be included in the response. The default value is false.

    
    
• On success, responds with ListVectorsOutput with field(s):
  • next_token(Option<String>):

    Pagination token to be used in the subsequent request. The field is empty if no further pagination is required.

  • vectors(Vec::<ListOutputVector>):

    Vectors in the current segment.

• On failure, responds with SdkError<ListVectorsError>

impl Client

pub fn put_vector_bucket_policy(&self) -> PutVectorBucketPolicyFluentBuilder

Constructs a fluent builder for the PutVectorBucketPolicy operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket.

    
    
  • vector_bucket_arn(impl Into<String>) / set_vector_bucket_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the vector bucket.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The JSON that defines the policy. For more information about bucket policies for S3 Vectors, see Managing vector bucket policies in the Amazon S3 User Guide.

    
    
• On success, responds with PutVectorBucketPolicyOutput
• On failure, responds with SdkError<PutVectorBucketPolicyError>

impl Client

pub fn put_vectors(&self) -> PutVectorsFluentBuilder

Constructs a fluent builder for the PutVectors operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index where you want to write vectors.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index where you want to write vectors.

    
    
  • vectors(PutInputVector) / set_vectors(Option<Vec::<PutInputVector>>):
    required: true
    

    The vectors to add to a vector index. The number of vectors in a single request must not exceed the resource capacity, otherwise the request will be rejected with the error ServiceUnavailableException with the error message “Currently unable to handle the request”.

    
    
• On success, responds with PutVectorsOutput
• On failure, responds with SdkError<PutVectorsError>

impl Client

pub fn query_vectors(&self) -> QueryVectorsFluentBuilder

Constructs a fluent builder for the QueryVectors operation.

• The fluent builder is configurable:
  • vector_bucket_name(impl Into<String>) / set_vector_bucket_name(Option<String>):
    required: false
    

    The name of the vector bucket that contains the vector index.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the vector index that you want to query.

    
    
  • index_arn(impl Into<String>) / set_index_arn(Option<String>):
    required: false
    

    The ARN of the vector index that you want to query.

    
    
  • top_k(i32) / set_top_k(Option<i32>):
    required: true
    

    The number of results to return for each query.

    
    
  • query_vector(VectorData) / set_query_vector(Option<VectorData>):
    required: true
    

    The query vector. Ensure that the query vector has the same dimension as the dimension of the vector index that’s being queried. For example, if your vector index contains vectors with 384 dimensions, your query vector must also have 384 dimensions.

    
    
  • filter(Document) / set_filter(Option<Document>):
    required: false
    

    Metadata filter to apply during the query. For more information about metadata keys, see Metadata filtering in the Amazon S3 User Guide.

    
    
  • return_metadata(bool) / set_return_metadata(Option<bool>):
    required: false
    

    Indicates whether to include metadata in the response. The default value is false.

    
    
  • return_distance(bool) / set_return_distance(Option<bool>):
    required: false
    

    Indicates whether to include the computed distance in the response. The default value is false.

    
    
• On success, responds with QueryVectorsOutput with field(s):
  • vectors(Vec::<QueryOutputVector>):

    The vectors in the approximate nearest neighbor search.

• On failure, responds with SdkError<QueryVectorsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.