aws_sdk_qapps/client/
get_q_app_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 [`GetQAppSession`](crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier of the Amazon Q Business application environment instance.</p><br>
7    ///   - [`session_id(impl Into<String>)`](crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The unique identifier of the Q App session to retrieve.</p><br>
8    /// - On success, responds with [`GetQAppSessionOutput`](crate::operation::get_q_app_session::GetQAppSessionOutput) with field(s):
9    ///   - [`session_id(String)`](crate::operation::get_q_app_session::GetQAppSessionOutput::session_id): <p>The unique identifier of the Q App session.</p>
10    ///   - [`session_arn(String)`](crate::operation::get_q_app_session::GetQAppSessionOutput::session_arn): <p>The Amazon Resource Name (ARN) of the Q App session.</p>
11    ///   - [`session_name(Option<String>)`](crate::operation::get_q_app_session::GetQAppSessionOutput::session_name): <p>The name of the Q App session.</p>
12    ///   - [`app_version(Option<i32>)`](crate::operation::get_q_app_session::GetQAppSessionOutput::app_version): <p>The version of the Q App used for the session.</p>
13    ///   - [`latest_published_app_version(Option<i32>)`](crate::operation::get_q_app_session::GetQAppSessionOutput::latest_published_app_version): <p>The latest published version of the Q App used for the session.</p>
14    ///   - [`status(ExecutionStatus)`](crate::operation::get_q_app_session::GetQAppSessionOutput::status): <p>The current status of the Q App session.</p>
15    ///   - [`card_status(HashMap::<String, CardStatus>)`](crate::operation::get_q_app_session::GetQAppSessionOutput::card_status): <p>The current status for each card in the Q App session.</p>
16    ///   - [`user_is_host(Option<bool>)`](crate::operation::get_q_app_session::GetQAppSessionOutput::user_is_host): <p>Indicates whether the current user is the owner of the Q App data collection session.</p>
17    /// - On failure, responds with [`SdkError<GetQAppSessionError>`](crate::operation::get_q_app_session::GetQAppSessionError)
18    pub fn get_q_app_session(&self) -> crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder {
19        crate::operation::get_q_app_session::builders::GetQAppSessionFluentBuilder::new(self.handle.clone())
20    }
21}