aws_sdk_qbusiness/client/

get_web_experience.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetWebExperience`](crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application linked to the web experience.</p><br>
    ///   - [`web_experience_id(impl Into<String>)`](crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder::web_experience_id) / [`set_web_experience_id(Option<String>)`](crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder::set_web_experience_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business web experience.</p><br>
    /// - On success, responds with [`GetWebExperienceOutput`](crate::operation::get_web_experience::GetWebExperienceOutput) with field(s):
    ///   - [`application_id(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::application_id): <p>The identifier of the Amazon Q Business application linked to the web experience.</p>
    ///   - [`web_experience_id(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::web_experience_id): <p>The identifier of the Amazon Q Business web experience.</p>
    ///   - [`web_experience_arn(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::web_experience_arn): <p>The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.</p>
    ///   - [`default_endpoint(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::default_endpoint): <p>The endpoint of your Amazon Q Business web experience.</p>
    ///   - [`status(Option<WebExperienceStatus>)`](crate::operation::get_web_experience::GetWebExperienceOutput::status): <p>The current status of the Amazon Q Business web experience. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_web_experience::GetWebExperienceOutput::created_at): <p>The Unix timestamp when the Amazon Q Business web experience was last created.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_web_experience::GetWebExperienceOutput::updated_at): <p>The Unix timestamp when the Amazon Q Business web experience was last updated.</p>
    ///   - [`title(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::title): <p>The title for your Amazon Q Business web experience.</p>
    ///   - [`subtitle(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::subtitle): <p>The subtitle for your Amazon Q Business web experience.</p>
    ///   - [`welcome_message(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::welcome_message): <p>The customized welcome message for end users of an Amazon Q Business web experience.</p>
    ///   - [`sample_prompts_control_mode(Option<WebExperienceSamplePromptsControlMode>)`](crate::operation::get_web_experience::GetWebExperienceOutput::sample_prompts_control_mode): <p>Determines whether sample prompts are enabled in the web experience for an end user.</p>
    ///   - [`origins(Option<Vec::<String>>)`](crate::operation::get_web_experience::GetWebExperienceOutput::origins): <p>Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::get_web_experience::GetWebExperienceOutput::role_arn): <p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p>
    ///   - [`identity_provider_configuration(Option<IdentityProviderConfiguration>)`](crate::operation::get_web_experience::GetWebExperienceOutput::identity_provider_configuration): <p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
    ///   - [`authentication_configuration(Option<WebExperienceAuthConfiguration>)`](crate::operation::get_web_experience::GetWebExperienceOutput::authentication_configuration): <p>The authentication configuration information for your Amazon Q Business web experience.</p>
    ///   - [`error(Option<ErrorDetail>)`](crate::operation::get_web_experience::GetWebExperienceOutput::error): <p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</p>
    ///   - [`browser_extension_configuration(Option<BrowserExtensionConfiguration>)`](crate::operation::get_web_experience::GetWebExperienceOutput::browser_extension_configuration): <p>The browser extension configuration for an Amazon Q Business web experience.</p>
    ///   - [`customization_configuration(Option<CustomizationConfiguration>)`](crate::operation::get_web_experience::GetWebExperienceOutput::customization_configuration): <p>Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.</p>
    /// - On failure, responds with [`SdkError<GetWebExperienceError>`](crate::operation::get_web_experience::GetWebExperienceError)
    pub fn get_web_experience(&self) -> crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder {
        crate::operation::get_web_experience::builders::GetWebExperienceFluentBuilder::new(self.handle.clone())
    }
}