1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListIndexes`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`r#type(IndexType)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::type) / [`set_type(Option<IndexType>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_type):<br>required: **false**<br><p>If specified, limits the output to only indexes of the specified Type, either <code>LOCAL</code> or <code>AGGREGATOR</code>.</p> <p>Use this option to discover the aggregator index for your account.</p><br>
    ///   - [`regions(impl Into<String>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::regions) / [`set_regions(Option<Vec::<String>>)`](crate::operation::list_indexes::builders::ListIndexesFluentBuilder::set_regions):<br>required: **false**<br><p>If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.</p><br>
    ///   - [`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 results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results.</p><note>  <p>An API operation can return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> </note><br>
    ///   - [`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 parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p><br>
    /// - On success, responds with [`ListIndexesOutput`](crate::operation::list_indexes::ListIndexesOutput) with field(s):
    ///   - [`indexes(Option<Vec::<Index>>)`](crate::operation::list_indexes::ListIndexesOutput::indexes): <p>A structure that contains the details and status of each index.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_indexes::ListIndexesOutput::next_token): <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
    /// - On failure, responds with [`SdkError<ListIndexesError>`](crate::operation::list_indexes::ListIndexesError)
    pub fn list_indexes(&self) -> crate::operation::list_indexes::builders::ListIndexesFluentBuilder {
        crate::operation::list_indexes::builders::ListIndexesFluentBuilder::new(self.handle.clone())
    }
}