QBusiness / Client / update_web_experience

update_web_experience#

QBusiness.Client.update_web_experience(**kwargs)#

Updates an Amazon Q web experience.

See also: AWS API Documentation

Request Syntax

response = client.update_web_experience(
    applicationId='string',
    authenticationConfiguration={
        'samlConfiguration': {
            'metadataXML': 'string',
            'roleArn': 'string',
            'userGroupAttribute': 'string',
            'userIdAttribute': 'string'
        }
    },
    samplePromptsControlMode='ENABLED'|'DISABLED',
    subtitle='string',
    title='string',
    webExperienceId='string',
    welcomeMessage='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

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

  • authenticationConfiguration (dict) –

    The authentication configuration of the Amazon Q 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 needs to deploy a Amazon Q 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 web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.

      • userGroupAttribute (string) –

        The group attribute name in your IdP that maps to user groups.

      • userIdAttribute (string) – [REQUIRED]

        The user attribute name in your IdP that maps to the user email.

  • samplePromptsControlMode (string) – Determines whether sample prompts are enabled in the web experience for an end user.

  • subtitle (string) – The subtitle of the Amazon Q web experience.

  • title (string) – The title of the Amazon Q web experience.

  • webExperienceId (string) –

    [REQUIRED]

    The identifier of the Amazon Q web experience.

  • welcomeMessage (string) – A customized welcome message for an end user in an Amazon Q web experience.

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