aws_sdk_s3vectors/client/
list_indexes.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 [`ListIndexes`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`vector_bucket_name(impl Into<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::vector_bucket_name) / [`set_vector_bucket_name(Option<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_vector_bucket_name):<br>required: **false**<br><p>The name of the vector bucket that contains the vector indexes.</p><br>
8    ///   - [`vector_bucket_arn(impl Into<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::vector_bucket_arn) / [`set_vector_bucket_arn(Option<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_vector_bucket_arn):<br>required: **false**<br><p>The ARN of the vector bucket that contains the vector indexes.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to be returned in the response.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_next_token):<br>required: **false**<br><p>The previous pagination token.</p><br>
11    ///   - [`prefix(impl Into<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::prefix) / [`set_prefix(Option<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_prefix):<br>required: **false**<br><p>Limits the response to vector indexes that begin with the specified prefix.</p><br>
12    /// - On success, responds with [`ListIndexesOutput`](crate::operation::list_indexes::ListIndexesOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::list_indexes::ListIndexesOutput::next_token): <p>The next pagination token.</p>
14    ///   - [`indexes(Vec::<IndexSummary>)`](crate::operation::list_indexes::ListIndexesOutput::indexes): <p>The attributes of the vector indexes</p>
15    /// - On failure, responds with [`SdkError<ListIndexesError>`](crate::operation::list_indexes::ListIndexesError)
16    pub fn list_indexes(&self) -> crate::operation::list_indexes::builders::ListIndexesFluentBuilder {
17        crate::operation::list_indexes::builders::ListIndexesFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_s3vectors/client/list_indexes.rs

aws_sdk_s3vectors/client/
list_indexes.rs
