QBusiness / Client / create_web_experience

create_web_experience#

QBusiness.Client.create_web_experience(**kwargs)#

Creates an Amazon Q Business web experience.

See also: AWS API Documentation

Request Syntax

response = client.create_web_experience(
    applicationId='string',
    clientToken='string',
    roleArn='string',
    samplePromptsControlMode='ENABLED'|'DISABLED',
    subtitle='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    title='string',
    welcomeMessage='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business web experience.

  • clientToken (string) –

    A token you provide to identify a request to create an Amazon Q Business web experience.

    This field is autopopulated if not provided.

  • roleArn (string) – The Amazon Resource Name (ARN) of the service role attached to your web experience.

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

  • subtitle (string) – A subtitle to personalize your Amazon Q Business web experience.

  • tags (list) –

    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • (dict) –

      A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      • key (string) – [REQUIRED]

        The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

      • value (string) – [REQUIRED]

        The value associated with the tag. The value may be an empty string but it can’t be null.

  • title (string) – The title for your Amazon Q Business web experience.

  • welcomeMessage (string) – The customized welcome message for end users of an Amazon Q Business web experience.

Return type:

dict

Returns:

Response Syntax

{
    'webExperienceArn': 'string',
    'webExperienceId': 'string'
}

Response Structure

  • (dict) –

    • webExperienceArn (string) –

      The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

    • webExperienceId (string) –

      The identifier of the Amazon Q Business web experience.

Exceptions