aws_sdk_lexmodelbuilding/client/
get_bots.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 [`GetBots`](crate::operation::get_bots::builders::GetBotsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_bots::builders::GetBotsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of bots to return in the response that the request will return. The default is 10.</p><br>
9    ///   - [`name_contains(impl Into<String>)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::get_bots::builders::GetBotsFluentBuilder::set_name_contains):<br>required: **false**<br><p>Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."</p><br>
10    /// - On success, responds with [`GetBotsOutput`](crate::operation::get_bots::GetBotsOutput) with field(s):
11    ///   - [`bots(Option<Vec::<BotMetadata>>)`](crate::operation::get_bots::GetBotsOutput::bots): <p>An array of <code>botMetadata</code> objects, with one entry for each bot.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::get_bots::GetBotsOutput::next_token): <p>If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.</p>
13    /// - On failure, responds with [`SdkError<GetBotsError>`](crate::operation::get_bots::GetBotsError)
14    pub fn get_bots(&self) -> crate::operation::get_bots::builders::GetBotsFluentBuilder {
15        crate::operation::get_bots::builders::GetBotsFluentBuilder::new(self.handle.clone())
16    }
17}