aws_sdk_qbusiness/client/
update_web_experience.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 [`UpdateWebExperience`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application attached to the web experience.</p><br>
7    ///   - [`web_experience_id(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::web_experience_id) / [`set_web_experience_id(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_web_experience_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business web experience.</p><br>
8    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.</p><br>
9    ///   - [`authentication_configuration(WebExperienceAuthConfiguration)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::authentication_configuration) / [`set_authentication_configuration(Option<WebExperienceAuthConfiguration>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_authentication_configuration):<br>required: **false**<br><p>The authentication configuration of the Amazon Q Business web experience.</p><br>
10    ///   - [`title(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_title):<br>required: **false**<br><p>The title of the Amazon Q Business web experience.</p><br>
11    ///   - [`subtitle(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::subtitle) / [`set_subtitle(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_subtitle):<br>required: **false**<br><p>The subtitle of the Amazon Q Business web experience.</p><br>
12    ///   - [`welcome_message(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::welcome_message) / [`set_welcome_message(Option<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_welcome_message):<br>required: **false**<br><p>A customized welcome message for an end user in an Amazon Q Business web experience.</p><br>
13    ///   - [`sample_prompts_control_mode(WebExperienceSamplePromptsControlMode)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::sample_prompts_control_mode) / [`set_sample_prompts_control_mode(Option<WebExperienceSamplePromptsControlMode>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_sample_prompts_control_mode):<br>required: **false**<br><p>Determines whether sample prompts are enabled in the web experience for an end user.</p><br>
14    ///   - [`identity_provider_configuration(IdentityProviderConfiguration)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::identity_provider_configuration) / [`set_identity_provider_configuration(Option<IdentityProviderConfiguration>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_identity_provider_configuration):<br>required: **false**<br><p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p><br>
15    ///   - [`origins(impl Into<String>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::origins) / [`set_origins(Option<Vec::<String>>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_origins):<br>required: **false**<br><p>Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p><note>  <ul>   <li>    <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p></li>   <li>    <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p></li>  </ul> </note><br>
16    ///   - [`browser_extension_configuration(BrowserExtensionConfiguration)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::browser_extension_configuration) / [`set_browser_extension_configuration(Option<BrowserExtensionConfiguration>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_browser_extension_configuration):<br>required: **false**<br><p>The browser extension configuration for an Amazon Q Business web experience.</p><note>  <p>For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>.</p> </note><br>
17    ///   - [`customization_configuration(CustomizationConfiguration)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::customization_configuration) / [`set_customization_configuration(Option<CustomizationConfiguration>)`](crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::set_customization_configuration):<br>required: **false**<br><p>Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.</p><br>
18    /// - On success, responds with [`UpdateWebExperienceOutput`](crate::operation::update_web_experience::UpdateWebExperienceOutput)
19    /// - On failure, responds with [`SdkError<UpdateWebExperienceError>`](crate::operation::update_web_experience::UpdateWebExperienceError)
20    pub fn update_web_experience(&self) -> crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder {
21        crate::operation::update_web_experience::builders::UpdateWebExperienceFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_qbusiness/client/update_web_experience.rs

aws_sdk_qbusiness/client/
update_web_experience.rs
