---
title: "PUT /applications/{applicationId}/experiences/{webExperienceId}"
method: PUT
path: "/applications/{applicationId}/experiences/{webExperienceId}"
---

# PUT /applications/{applicationId}/experiences/{webExperienceId}

`PUT /applications/{applicationId}/experiences/{webExperienceId}`

Updates an Amazon Q Business web experience.

## Path parameters

- `applicationId` string, required
- `webExperienceId` string, required

## Request body

- object
  - `roleArn` string — The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
  - `authenticationConfiguration` object — Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
    - `samlConfiguration` SamlConfiguration — Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
      - `metadataXML` string, required — The metadata XML that your IdP generated.
      - `roleArn` string, required — The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
      - `userIdAttribute` string, required — The user attribute name in your IdP that maps to the user email.
      - `userGroupAttribute` string — The group attribute name in your IdP that maps to user groups.
  - `title` string — The title of the Amazon Q Business web experience.
  - `subtitle` string — The subtitle of the Amazon Q Business web experience.
  - `welcomeMessage` string — A customized welcome message for an end user in an Amazon Q Business web experience.
  - `samplePromptsControlMode` 'ENABLED' | 'DISABLED' — Determines whether sample prompts are enabled in the web experience for an end user.
  - `identityProviderConfiguration` object — Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
    - `samlConfiguration` SamlProviderConfiguration — Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
      - `authenticationUrl` string, required — The URL where Amazon Q Business end users will be redirected for authentication.
    - `openIDConnectConfiguration` OpenIDConnectProviderConfiguration — Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
      - `secretsArn` string, required — The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
      - `secretsRole` string, required — An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
  - `origins` Origin[] — <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>
  - `browserExtensionConfiguration` object — The container for browser extension configuration for an Amazon Q Business web experience.
    - `enabledBrowserExtensions` BrowserExtension[] — <p>Specify the browser extensions allowed for your Amazon Q web experience.</p> <ul> <li> <p> <code>CHROME</code> — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).</p> </li> <li> <p> <code>FIREFOX</code> — Enables the extension for Mozilla Firefox.</p> </li> <li> <p> <code>CHROME</code> and <code>FIREFOX</code> — Enable the extension for Chromium-based browsers and Mozilla Firefox.</p> </li> </ul>
  - `customizationConfiguration` object — Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
    - `customCSSUrl` string — Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
    - `logoUrl` string — Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
    - `fontUrl` string — Provides the URL where the custom font file is hosted for an Amazon Q web experience.
    - `faviconUrl` string — Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.

## Response `200`

Success

- UpdateWebExperienceResponse

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)