aws_sdk_qapps/client/
get_q_app.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 [`GetQApp`](crate::operation::get_q_app::builders::GetQAppFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::get_q_app::builders::GetQAppFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::get_q_app::builders::GetQAppFluentBuilder::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::get_q_app::builders::GetQAppFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::get_q_app::builders::GetQAppFluentBuilder::set_app_id):<br>required: **true**<br><p>The unique identifier of the Q App to retrieve.</p><br>
8    ///   - [`app_version(i32)`](crate::operation::get_q_app::builders::GetQAppFluentBuilder::app_version) / [`set_app_version(Option<i32>)`](crate::operation::get_q_app::builders::GetQAppFluentBuilder::set_app_version):<br>required: **false**<br><p>The version of the Q App.</p><br>
9    /// - On success, responds with [`GetQAppOutput`](crate::operation::get_q_app::GetQAppOutput) with field(s):
10    ///   - [`app_id(String)`](crate::operation::get_q_app::GetQAppOutput::app_id): <p>The unique identifier of the Q App.</p>
11    ///   - [`app_arn(String)`](crate::operation::get_q_app::GetQAppOutput::app_arn): <p>The Amazon Resource Name (ARN) of the Q App.</p>
12    ///   - [`title(String)`](crate::operation::get_q_app::GetQAppOutput::title): <p>The title of the Q App.</p>
13    ///   - [`description(Option<String>)`](crate::operation::get_q_app::GetQAppOutput::description): <p>The description of the Q App.</p>
14    ///   - [`initial_prompt(Option<String>)`](crate::operation::get_q_app::GetQAppOutput::initial_prompt): <p>The initial prompt displayed when the Q App is started.</p>
15    ///   - [`app_version(i32)`](crate::operation::get_q_app::GetQAppOutput::app_version): <p>The version of the Q App.</p>
16    ///   - [`status(AppStatus)`](crate::operation::get_q_app::GetQAppOutput::status): <p>The status of the Q App.</p>
17    ///   - [`created_at(DateTime)`](crate::operation::get_q_app::GetQAppOutput::created_at): <p>The date and time the Q App was created.</p>
18    ///   - [`created_by(String)`](crate::operation::get_q_app::GetQAppOutput::created_by): <p>The user who created the Q App.</p>
19    ///   - [`updated_at(DateTime)`](crate::operation::get_q_app::GetQAppOutput::updated_at): <p>The date and time the Q App was last updated.</p>
20    ///   - [`updated_by(String)`](crate::operation::get_q_app::GetQAppOutput::updated_by): <p>The user who last updated the Q App.</p>
21    ///   - [`required_capabilities(Option<Vec::<AppRequiredCapability>>)`](crate::operation::get_q_app::GetQAppOutput::required_capabilities): <p>The capabilities required to run the Q App, such as file upload or third-party integrations.</p>
22    ///   - [`app_definition(Option<AppDefinition>)`](crate::operation::get_q_app::GetQAppOutput::app_definition): <p>The full definition of the Q App, specifying the cards and flow.</p>
23    /// - On failure, responds with [`SdkError<GetQAppError>`](crate::operation::get_q_app::GetQAppError)
24    pub fn get_q_app(&self) -> crate::operation::get_q_app::builders::GetQAppFluentBuilder {
25        crate::operation::get_q_app::builders::GetQAppFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_qapps/client/get_q_app.rs

aws_sdk_qapps/client/
get_q_app.rs
