aws_sdk_s3vectors/client/
get_vectors.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetVectors`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`vector_bucket_name(impl Into<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::vector_bucket_name) / [`set_vector_bucket_name(Option<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_vector_bucket_name):<br>required: **false**<br><p>The name of the vector bucket that contains the vector index.</p><br>
7    ///   - [`index_name(impl Into<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_index_name):<br>required: **false**<br><p>The name of the vector index.</p><br>
8    ///   - [`index_arn(impl Into<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::index_arn) / [`set_index_arn(Option<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_index_arn):<br>required: **false**<br><p>The ARN of the vector index.</p><br>
9    ///   - [`keys(impl Into<String>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::keys) / [`set_keys(Option<Vec::<String>>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_keys):<br>required: **true**<br><p>The names of the vectors you want to return attributes for.</p><br>
10    ///   - [`return_data(bool)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::return_data) / [`set_return_data(Option<bool>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_return_data):<br>required: **false**<br><p>Indicates whether to include the vector data in the response. The default value is <code>false</code>.</p><br>
11    ///   - [`return_metadata(bool)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::return_metadata) / [`set_return_metadata(Option<bool>)`](crate::operation::get_vectors::builders::GetVectorsFluentBuilder::set_return_metadata):<br>required: **false**<br><p>Indicates whether to include metadata in the response. The default value is <code>false</code>.</p><br>
12    /// - On success, responds with [`GetVectorsOutput`](crate::operation::get_vectors::GetVectorsOutput) with field(s):
13    ///   - [`vectors(Vec::<GetOutputVector>)`](crate::operation::get_vectors::GetVectorsOutput::vectors): <p>The attributes of the vectors.</p>
14    /// - On failure, responds with [`SdkError<GetVectorsError>`](crate::operation::get_vectors::GetVectorsError)
15    pub fn get_vectors(&self) -> crate::operation::get_vectors::builders::GetVectorsFluentBuilder {
16        crate::operation::get_vectors::builders::GetVectorsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_s3vectors/client/get_vectors.rs

aws_sdk_s3vectors/client/
get_vectors.rs
