update_web_experience ¶

def update_web_experience(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    web_experience_id: "capo_qbusiness.types.web_experience_id.WebExperienceId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    role_arn: Optional["capo_qbusiness.types.role_arn.RoleArn"] = None,
    authentication_configuration: Optional[
        "capo_qbusiness.types.web_experience_auth_configuration.WebExperienceAuthConfiguration"
    ] = None,
    title: Optional[
        "capo_qbusiness.types.web_experience_title.WebExperienceTitle"
    ] = None,
    subtitle: Optional[
        "capo_qbusiness.types.web_experience_subtitle.WebExperienceSubtitle"
    ] = None,
    welcome_message: Optional[
        "capo_qbusiness.types.web_experience_welcome_message.WebExperienceWelcomeMessage"
    ] = None,
    sample_prompts_control_mode: Optional[
        "capo_qbusiness.types.web_experience_sample_prompts_control_mode.WebExperienceSamplePromptsControlMode"
    ] = None,
    identity_provider_configuration: Optional[
        "capo_qbusiness.types.identity_provider_configuration.IdentityProviderConfiguration"
    ] = None,
    origins: Optional[
        "capo_qbusiness.types.web_experience_origins.WebExperienceOrigins"
    ] = None,
    browser_extension_configuration: Optional[
        "capo_qbusiness.types.browser_extension_configuration.BrowserExtensionConfiguration"
    ] = None,
    customization_configuration: Optional[
        "capo_qbusiness.types.customization_configuration.CustomizationConfiguration"
    ] = None,
) -> "capo_qbusiness.types.update_web_experience_response.UpdateWebExperienceResponse":
    """<p>Updates an Amazon Q Business web experience. </p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application attached to the web experience.</p>
        web_experience_id: <p>The identifier of the Amazon Q Business web experience.</p>
        role_arn: <p>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.</p>
        authentication_configuration: <p>The authentication configuration of the Amazon Q Business web experience.</p>
        title: <p>The title of the Amazon Q Business web experience.</p>
        subtitle: <p>The subtitle of the Amazon Q Business web experience.</p>
        welcome_message: <p>A customized welcome message for an end user in an Amazon Q Business web experience.</p>
        sample_prompts_control_mode: <p>Determines whether sample prompts are enabled in the web experience for an end user.</p>
        identity_provider_configuration: <p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>
        origins: <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>
        browser_extension_configuration: <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>
        customization_configuration: <p>Updates the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.update_web_experience_request.UpdateWebExperienceRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.update_web_experience_response.UpdateWebExperienceResponse"
    ]:
        import capo_qbusiness._operations.expert_q.update_web_experience

        output, http_response = (
            capo_qbusiness._operations.expert_q.update_web_experience.update_web_experience(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWebExperience")
    )
    input_: capo_qbusiness.types.update_web_experience_request.UpdateWebExperienceRequest = {
        "application_id": application_id,
        "web_experience_id": web_experience_id,
    }
    if role_arn is not None:
        input_["role_arn"] = role_arn
    if authentication_configuration is not None:
        input_["authentication_configuration"] = authentication_configuration
    if title is not None:
        input_["title"] = title
    if subtitle is not None:
        input_["subtitle"] = subtitle
    if welcome_message is not None:
        input_["welcome_message"] = welcome_message
    if sample_prompts_control_mode is not None:
        input_["sample_prompts_control_mode"] = sample_prompts_control_mode
    if identity_provider_configuration is not None:
        input_["identity_provider_configuration"] = identity_provider_configuration
    if origins is not None:
        input_["origins"] = origins
    if browser_extension_configuration is not None:
        input_["browser_extension_configuration"] = browser_extension_configuration
    if customization_configuration is not None:
        input_["customization_configuration"] = customization_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output