aws_sdk_lexmodelsv2/client/describe_bot_locale.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 [`DescribeBotLocale`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`bot_id(impl Into<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier of the bot associated with the locale.</p><br>
7 /// - [`bot_version(impl Into<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::bot_version) / [`set_bot_version(Option<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::set_bot_version):<br>required: **true**<br><p>The version of the bot associated with the locale.</p><br>
8 /// - [`locale_id(impl Into<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::locale_id) / [`set_locale_id(Option<String>)`](crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::set_locale_id):<br>required: **true**<br><p>The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p><br>
9 /// - On success, responds with [`DescribeBotLocaleOutput`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput) with field(s):
10 /// - [`bot_id(Option<String>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::bot_id): <p>The identifier of the bot associated with the locale.</p>
11 /// - [`bot_version(Option<String>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::bot_version): <p>The version of the bot associated with the locale.</p>
12 /// - [`locale_id(Option<String>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::locale_id): <p>The unique identifier of the described locale.</p>
13 /// - [`locale_name(Option<String>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::locale_name): <p>The name of the locale.</p>
14 /// - [`description(Option<String>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::description): <p>The description of the locale.</p>
15 /// - [`nlu_intent_confidence_threshold(Option<f64>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::nlu_intent_confidence_threshold): <p>The confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.</p>
16 /// - [`voice_settings(Option<VoiceSettings>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::voice_settings): <p>The Amazon Polly voice Amazon Lex uses for voice interaction with the user.</p>
17 /// - [`intents_count(Option<i32>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::intents_count): <p>The number of intents defined for the locale.</p>
18 /// - [`slot_types_count(Option<i32>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::slot_types_count): <p>The number of slot types defined for the locale.</p>
19 /// - [`bot_locale_status(Option<BotLocaleStatus>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::bot_locale_status): <p>The status of the bot. If the status is <code>Failed</code>, the reasons for the failure are listed in the <code>failureReasons</code> field.</p>
20 /// - [`failure_reasons(Option<Vec::<String>>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::failure_reasons): <p>if <code>botLocaleStatus</code> is <code>Failed</code>, Amazon Lex explains why it failed to build the bot.</p>
21 /// - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::creation_date_time): <p>The date and time that the locale was created.</p>
22 /// - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::last_updated_date_time): <p>The date and time that the locale was last updated.</p>
23 /// - [`last_build_submitted_date_time(Option<DateTime>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::last_build_submitted_date_time): <p>The date and time that the locale was last submitted for building.</p>
24 /// - [`bot_locale_history_events(Option<Vec::<BotLocaleHistoryEvent>>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::bot_locale_history_events): <p>History of changes, such as when a locale is used in an alias, that have taken place for the locale.</p>
25 /// - [`recommended_actions(Option<Vec::<String>>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::recommended_actions): <p>Recommended actions to take to resolve an error in the <code>failureReasons</code> field.</p>
26 /// - [`generative_ai_settings(Option<GenerativeAiSettings>)`](crate::operation::describe_bot_locale::DescribeBotLocaleOutput::generative_ai_settings): <p>Contains settings for Amazon Bedrock's generative AI features for your bot locale.</p>
27 /// - On failure, responds with [`SdkError<DescribeBotLocaleError>`](crate::operation::describe_bot_locale::DescribeBotLocaleError)
28 pub fn describe_bot_locale(&self) -> crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder {
29 crate::operation::describe_bot_locale::builders::DescribeBotLocaleFluentBuilder::new(self.handle.clone())
30 }
31}