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