aws_sdk_lexruntimev2/client/get_session.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 [`GetSession`](crate::operation::get_session::builders::GetSessionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`bot_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_bot_id):<br>required: **true**<br><p>The identifier of the bot that contains the session data.</p><br>
7 /// - [`bot_alias_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::bot_alias_id) / [`set_bot_alias_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_bot_alias_id):<br>required: **true**<br><p>The alias identifier in use for the bot that contains the session data.</p><br>
8 /// - [`locale_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::locale_id) / [`set_locale_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_locale_id):<br>required: **true**<br><p>The locale where the session is in use.</p><br>
9 /// - [`session_id(impl Into<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_session::builders::GetSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The identifier of the session to return.</p><br>
10 /// - On success, responds with [`GetSessionOutput`](crate::operation::get_session::GetSessionOutput) with field(s):
11 /// - [`session_id(Option<String>)`](crate::operation::get_session::GetSessionOutput::session_id): <p>The identifier of the returned session.</p>
12 /// - [`messages(Option<Vec::<Message>>)`](crate::operation::get_session::GetSessionOutput::messages): <p>A list of messages that were last sent to the user. The messages are ordered based on the order that your returned the messages from your Lambda function or the order that messages are defined in the bot.</p>
13 /// - [`interpretations(Option<Vec::<Interpretation>>)`](crate::operation::get_session::GetSessionOutput::interpretations): <p>A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.</p> <p>Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.</p>
14 /// - [`session_state(Option<SessionState>)`](crate::operation::get_session::GetSessionOutput::session_state): <p>Represents the current state of the dialog between the user and the bot.</p> <p>You can use this to determine the progress of the conversation and what the next action might be.</p>
15 /// - On failure, responds with [`SdkError<GetSessionError>`](crate::operation::get_session::GetSessionError)
16 pub fn get_session(&self) -> crate::operation::get_session::builders::GetSessionFluentBuilder {
17 crate::operation::get_session::builders::GetSessionFluentBuilder::new(self.handle.clone())
18 }
19}