aws_sdk_lexmodelsv2/client/

list_bots.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListBots`](crate::operation::list_bots::builders::ListBotsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_bots::builders::ListBotsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`sort_by(BotSortBy)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::sort_by) / [`set_sort_by(Option<BotSortBy>)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.</p><br>
    ///   - [`filters(BotFilter)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::filters) / [`set_filters(Option<Vec::<BotFilter>>)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::set_filters):<br>required: **false**<br><p>Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_bots::builders::ListBotsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response from the <code>ListBots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response.</p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListBots</code> request to return the next page of results. For a complete set of results, call the <code>ListBots</code> operation until the <code>nextToken</code> returned in the response is null.</p><br>
    /// - On success, responds with [`ListBotsOutput`](crate::operation::list_bots::ListBotsOutput) with field(s):
    ///   - [`bot_summaries(Option<Vec::<BotSummary>>)`](crate::operation::list_bots::ListBotsOutput::bot_summaries): <p>Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more bots available, the <code>nextToken</code> field contains a token to the next page of results.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_bots::ListBotsOutput::next_token): <p>A token that indicates whether there are more results to return in a response to the <code>ListBots</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListBots</code> operation request to get the next page of results.</p>
    /// - On failure, responds with [`SdkError<ListBotsError>`](crate::operation::list_bots::ListBotsError)
    pub fn list_bots(&self) -> crate::operation::list_bots::builders::ListBotsFluentBuilder {
        crate::operation::list_bots::builders::ListBotsFluentBuilder::new(self.handle.clone())
    }
}