aws_sdk_lexmodelsv2/client/
describe_bot_alias.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 [`DescribeBotAlias`](crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`bot_alias_id(impl Into<String>)`](crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder::bot_alias_id) / [`set_bot_alias_id(Option<String>)`](crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder::set_bot_alias_id):<br>required: **true**<br><p>The identifier of the bot alias to describe.</p><br>
7    ///   - [`bot_id(impl Into<String>)`](crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier of the bot associated with the bot alias to describe.</p><br>
8    /// - On success, responds with [`DescribeBotAliasOutput`](crate::operation::describe_bot_alias::DescribeBotAliasOutput) with field(s):
9    ///   - [`bot_alias_id(Option<String>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_alias_id): <p>The identifier of the bot alias.</p>
10    ///   - [`bot_alias_name(Option<String>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_alias_name): <p>The name of the bot alias.</p>
11    ///   - [`description(Option<String>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::description): <p>The description of the bot alias.</p>
12    ///   - [`bot_version(Option<String>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_version): <p>The version of the bot associated with the bot alias.</p>
13    ///   - [`bot_alias_locale_settings(Option<HashMap::<String, BotAliasLocaleSettings>>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_alias_locale_settings): <p>The locale settings that are unique to the alias.</p>
14    ///   - [`conversation_log_settings(Option<ConversationLogSettings>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::conversation_log_settings): <p>Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.</p>
15    ///   - [`sentiment_analysis_settings(Option<SentimentAnalysisSettings>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::sentiment_analysis_settings): <p>Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.</p>
16    ///   - [`bot_alias_history_events(Option<Vec::<BotAliasHistoryEvent>>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_alias_history_events): <p>A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.</p>
17    ///   - [`bot_alias_status(Option<BotAliasStatus>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_alias_status): <p>The current status of the alias. When the alias is <code>Available</code>, the alias is ready for use with your bot.</p>
18    ///   - [`bot_id(Option<String>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::bot_id): <p>The identifier of the bot associated with the bot alias.</p>
19    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::creation_date_time): <p>A timestamp of the date and time that the alias was created.</p>
20    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::last_updated_date_time): <p>A timestamp of the date and time that the alias was last updated.</p>
21    ///   - [`parent_bot_networks(Option<Vec::<ParentBotNetwork>>)`](crate::operation::describe_bot_alias::DescribeBotAliasOutput::parent_bot_networks): <p>A list of the networks to which the bot alias you described belongs.</p>
22    /// - On failure, responds with [`SdkError<DescribeBotAliasError>`](crate::operation::describe_bot_alias::DescribeBotAliasError)
23    pub fn describe_bot_alias(&self) -> crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder {
24        crate::operation::describe_bot_alias::builders::DescribeBotAliasFluentBuilder::new(self.handle.clone())
25    }
26}