aws_sdk_lexmodelsv2/client/
describe_intent.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 [`DescribeIntent`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`intent_id(impl Into<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::intent_id) / [`set_intent_id(Option<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::set_intent_id):<br>required: **true**<br><p>The identifier of the intent to describe.</p><br>
7    ///   - [`bot_id(impl Into<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier of the bot associated with the intent.</p><br>
8    ///   - [`bot_version(impl Into<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::bot_version) / [`set_bot_version(Option<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::set_bot_version):<br>required: **true**<br><p>The version of the bot associated with the intent.</p><br>
9    ///   - [`locale_id(impl Into<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::locale_id) / [`set_locale_id(Option<String>)`](crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::set_locale_id):<br>required: **true**<br><p>The identifier of the language and locale of the intent 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>
10    /// - On success, responds with [`DescribeIntentOutput`](crate::operation::describe_intent::DescribeIntentOutput) with field(s):
11    ///   - [`intent_id(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::intent_id): <p>The unique identifier assigned to the intent when it was created.</p>
12    ///   - [`intent_name(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::intent_name): <p>The name specified for the intent.</p>
13    ///   - [`description(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::description): <p>The description of the intent.</p>
14    ///   - [`parent_intent_signature(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::parent_intent_signature): <p>The identifier of the built-in intent that this intent is derived from, if any.</p>
15    ///   - [`sample_utterances(Option<Vec::<SampleUtterance>>)`](crate::operation::describe_intent::DescribeIntentOutput::sample_utterances): <p>User utterances that trigger this intent.</p>
16    ///   - [`dialog_code_hook(Option<DialogCodeHookSettings>)`](crate::operation::describe_intent::DescribeIntentOutput::dialog_code_hook): <p>The Lambda function called during each turn of a conversation with the intent.</p>
17    ///   - [`fulfillment_code_hook(Option<FulfillmentCodeHookSettings>)`](crate::operation::describe_intent::DescribeIntentOutput::fulfillment_code_hook): <p>The Lambda function called when the intent is complete and ready for fulfillment.</p>
18    ///   - [`slot_priorities(Option<Vec::<SlotPriority>>)`](crate::operation::describe_intent::DescribeIntentOutput::slot_priorities): <p>The list that determines the priority that slots should be elicited from the user.</p>
19    ///   - [`intent_confirmation_setting(Option<IntentConfirmationSetting>)`](crate::operation::describe_intent::DescribeIntentOutput::intent_confirmation_setting): <p>Prompts that Amazon Lex sends to the user to confirm completion of an intent.</p>
20    ///   - [`intent_closing_setting(Option<IntentClosingSetting>)`](crate::operation::describe_intent::DescribeIntentOutput::intent_closing_setting): <p>The response that Amazon Lex sends to when the intent is closed.</p>
21    ///   - [`input_contexts(Option<Vec::<InputContext>>)`](crate::operation::describe_intent::DescribeIntentOutput::input_contexts): <p>A list of contexts that must be active for the intent to be considered for sending to the user.</p>
22    ///   - [`output_contexts(Option<Vec::<OutputContext>>)`](crate::operation::describe_intent::DescribeIntentOutput::output_contexts): <p>A list of contexts that are activated when the intent is fulfilled.</p>
23    ///   - [`kendra_configuration(Option<KendraConfiguration>)`](crate::operation::describe_intent::DescribeIntentOutput::kendra_configuration): <p>Configuration information required to use the <code>AMAZON.KendraSearchIntent</code> intent.</p>
24    ///   - [`bot_id(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::bot_id): <p>The identifier of the bot associated with the intent.</p>
25    ///   - [`bot_version(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::bot_version): <p>The version of the bot associated with the intent.</p>
26    ///   - [`locale_id(Option<String>)`](crate::operation::describe_intent::DescribeIntentOutput::locale_id): <p>The language and locale specified for the intent.</p>
27    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_intent::DescribeIntentOutput::creation_date_time): <p>A timestamp of the date and time that the intent was created.</p>
28    ///   - [`last_updated_date_time(Option<DateTime>)`](crate::operation::describe_intent::DescribeIntentOutput::last_updated_date_time): <p>A timestamp of the date and time that the intent was last updated.</p>
29    ///   - [`initial_response_setting(Option<InitialResponseSetting>)`](crate::operation::describe_intent::DescribeIntentOutput::initial_response_setting): <p>Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.</p>
30    ///   - [`qn_a_intent_configuration(Option<QnAIntentConfiguration>)`](crate::operation::describe_intent::DescribeIntentOutput::qn_a_intent_configuration): <p>Details about the configuration of the built-in <code>Amazon.QnAIntent</code>.</p>
31    ///   - [`q_in_connect_intent_configuration(Option<QInConnectIntentConfiguration>)`](crate::operation::describe_intent::DescribeIntentOutput::q_in_connect_intent_configuration): <p>Qinconnect intent configuration details for the describe intent response.</p>
32    /// - On failure, responds with [`SdkError<DescribeIntentError>`](crate::operation::describe_intent::DescribeIntentError)
33    pub fn describe_intent(&self) -> crate::operation::describe_intent::builders::DescribeIntentFluentBuilder {
34        crate::operation::describe_intent::builders::DescribeIntentFluentBuilder::new(self.handle.clone())
35    }
36}
aws_sdk_lexmodelsv2/client/describe_intent.rs

aws_sdk_lexmodelsv2/client/
describe_intent.rs
