aws_sdk_lexmodelbuilding/client/
get_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 [`GetIntent`](crate::operation::get_intent::builders::GetIntentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::get_intent::builders::GetIntentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::get_intent::builders::GetIntentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the intent. The name is case sensitive.</p><br>
7    ///   - [`version(impl Into<String>)`](crate::operation::get_intent::builders::GetIntentFluentBuilder::version) / [`set_version(Option<String>)`](crate::operation::get_intent::builders::GetIntentFluentBuilder::set_version):<br>required: **true**<br><p>The version of the intent.</p><br>
8    /// - On success, responds with [`GetIntentOutput`](crate::operation::get_intent::GetIntentOutput) with field(s):
9    ///   - [`name(Option<String>)`](crate::operation::get_intent::GetIntentOutput::name): <p>The name of the intent.</p>
10    ///   - [`description(Option<String>)`](crate::operation::get_intent::GetIntentOutput::description): <p>A description of the intent.</p>
11    ///   - [`slots(Option<Vec::<Slot>>)`](crate::operation::get_intent::GetIntentOutput::slots): <p>An array of intent slots configured for the intent.</p>
12    ///   - [`sample_utterances(Option<Vec::<String>>)`](crate::operation::get_intent::GetIntentOutput::sample_utterances): <p>An array of sample utterances configured for the intent.</p>
13    ///   - [`confirmation_prompt(Option<Prompt>)`](crate::operation::get_intent::GetIntentOutput::confirmation_prompt): <p>If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see <code>PutIntent</code>.</p>
14    ///   - [`rejection_statement(Option<Statement>)`](crate::operation::get_intent::GetIntentOutput::rejection_statement): <p>If the user answers "no" to the question defined in <code>confirmationPrompt</code>, Amazon Lex responds with this statement to acknowledge that the intent was canceled.</p>
15    ///   - [`follow_up_prompt(Option<FollowUpPrompt>)`](crate::operation::get_intent::GetIntentOutput::follow_up_prompt): <p>If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see <code>PutIntent</code>.</p>
16    ///   - [`conclusion_statement(Option<Statement>)`](crate::operation::get_intent::GetIntentOutput::conclusion_statement): <p>After the Lambda function specified in the <code>fulfillmentActivity</code> element fulfills the intent, Amazon Lex conveys this statement to the user.</p>
17    ///   - [`dialog_code_hook(Option<CodeHook>)`](crate::operation::get_intent::GetIntentOutput::dialog_code_hook): <p>If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see <code>PutIntent</code>.</p>
18    ///   - [`fulfillment_activity(Option<FulfillmentActivity>)`](crate::operation::get_intent::GetIntentOutput::fulfillment_activity): <p>Describes how the intent is fulfilled. For more information, see <code>PutIntent</code>.</p>
19    ///   - [`parent_intent_signature(Option<String>)`](crate::operation::get_intent::GetIntentOutput::parent_intent_signature): <p>A unique identifier for a built-in intent.</p>
20    ///   - [`last_updated_date(Option<DateTime>)`](crate::operation::get_intent::GetIntentOutput::last_updated_date): <p>The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.</p>
21    ///   - [`created_date(Option<DateTime>)`](crate::operation::get_intent::GetIntentOutput::created_date): <p>The date that the intent was created.</p>
22    ///   - [`version(Option<String>)`](crate::operation::get_intent::GetIntentOutput::version): <p>The version of the intent.</p>
23    ///   - [`checksum(Option<String>)`](crate::operation::get_intent::GetIntentOutput::checksum): <p>Checksum of the intent.</p>
24    ///   - [`kendra_configuration(Option<KendraConfiguration>)`](crate::operation::get_intent::GetIntentOutput::kendra_configuration): <p>Configuration information, if any, to connect to an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>
25    ///   - [`input_contexts(Option<Vec::<InputContext>>)`](crate::operation::get_intent::GetIntentOutput::input_contexts): <p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>
26    ///   - [`output_contexts(Option<Vec::<OutputContext>>)`](crate::operation::get_intent::GetIntentOutput::output_contexts): <p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>
27    /// - On failure, responds with [`SdkError<GetIntentError>`](crate::operation::get_intent::GetIntentError)
28    pub fn get_intent(&self) -> crate::operation::get_intent::builders::GetIntentFluentBuilder {
29        crate::operation::get_intent::builders::GetIntentFluentBuilder::new(self.handle.clone())
30    }
31}