aws_sdk_s3vectors/client/
get_index.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 [`GetIndex`](crate::operation::get_index::builders::GetIndexFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`vector_bucket_name(impl Into<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::vector_bucket_name) / [`set_vector_bucket_name(Option<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::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_index::builders::GetIndexFluentBuilder::index_name) / [`set_index_name(Option<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::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_index::builders::GetIndexFluentBuilder::index_arn) / [`set_index_arn(Option<String>)`](crate::operation::get_index::builders::GetIndexFluentBuilder::set_index_arn):<br>required: **false**<br><p>The ARN of the vector index.</p><br>
9    /// - On success, responds with [`GetIndexOutput`](crate::operation::get_index::GetIndexOutput) with field(s):
10    ///   - [`index(Option<Index>)`](crate::operation::get_index::GetIndexOutput::index): <p>The attributes of the vector index.</p>
11    /// - On failure, responds with [`SdkError<GetIndexError>`](crate::operation::get_index::GetIndexError)
12    pub fn get_index(&self) -> crate::operation::get_index::builders::GetIndexFluentBuilder {
13        crate::operation::get_index::builders::GetIndexFluentBuilder::new(self.handle.clone())
14    }
15}