QBusiness / Client / update_web_experience

update_web_experience#

QBusiness.Client.update_web_experience(**kwargs)#

Updates an Amazon Q Business web experience.

See also: AWS API Documentation

Request Syntax

response = client.update_web_experience(
    applicationId='string',
    webExperienceId='string',
    roleArn='string',
    authenticationConfiguration={
        'samlConfiguration': {
            'metadataXML': 'string',
            'roleArn': 'string',
            'userIdAttribute': 'string',
            'userGroupAttribute': 'string'
        }
    },
    title='string',
    subtitle='string',
    welcomeMessage='string',
    samplePromptsControlMode='ENABLED'|'DISABLED',
    identityProviderConfiguration={
        'samlConfiguration': {
            'authenticationUrl': 'string'
        },
        'openIDConnectConfiguration': {
            'secretsArn': 'string',
            'secretsRole': 'string'
        }
    },
    origins=[
        'string',
    ]
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application attached to the web experience.

  • webExperienceId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business web experience.

  • roleArn (string) – The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

  • authenticationConfiguration (dict) –

    The authentication configuration of the Amazon Q Business web experience.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: samlConfiguration.

    • samlConfiguration (dict) –

      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 (string) – Determines whether sample prompts are enabled in the web experience for an end user.

  • identityProviderConfiguration (dict) –

    Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: samlConfiguration, openIDConnectConfiguration.

    • samlConfiguration (dict) –

      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 (dict) –

      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 (list) –

    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>

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • QBusiness.Client.exceptions.ResourceNotFoundException

  • QBusiness.Client.exceptions.InternalServerException

  • QBusiness.Client.exceptions.ConflictException

  • QBusiness.Client.exceptions.ThrottlingException

  • QBusiness.Client.exceptions.ValidationException

  • QBusiness.Client.exceptions.AccessDeniedException