aws_sdk_qapps/client/
start_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 [`StartQAppSession`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier of the Amazon Q Business application environment instance.</p><br>
7    ///   - [`app_id(impl Into<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique identifier of the Q App to start a session for.</p><br>
8    ///   - [`app_version(i32)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::app_version) / [`set_app_version(Option<i32>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_app_version):<br>required: **true**<br><p>The version of the Q App to use for the session.</p><br>
9    ///   - [`initial_values(CardValue)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::initial_values) / [`set_initial_values(Option<Vec::<CardValue>>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_initial_values):<br>required: **false**<br><p>Optional initial input values to provide for the Q App session.</p><br>
10    ///   - [`session_id(impl Into<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_session_id):<br>required: **false**<br><p>The unique identifier of the a Q App session.</p><br>
11    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::set_tags):<br>required: **false**<br><p>Optional tags to associate with the new Q App session.</p><br>
12    /// - On success, responds with [`StartQAppSessionOutput`](crate::operation::start_q_app_session::StartQAppSessionOutput) with field(s):
13    ///   - [`session_id(String)`](crate::operation::start_q_app_session::StartQAppSessionOutput::session_id): <p>The unique identifier of the new or retrieved Q App session.</p>
14    ///   - [`session_arn(String)`](crate::operation::start_q_app_session::StartQAppSessionOutput::session_arn): <p>The Amazon Resource Name (ARN) of the new Q App session.</p>
15    /// - On failure, responds with [`SdkError<StartQAppSessionError>`](crate::operation::start_q_app_session::StartQAppSessionError)
16    pub fn start_q_app_session(&self) -> crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder {
17        crate::operation::start_q_app_session::builders::StartQAppSessionFluentBuilder::new(self.handle.clone())
18    }
19}