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',
    title='string',
    subtitle='string',
    welcomeMessage='string',
    samplePromptsControlMode='ENABLED'|'DISABLED',
    origins=[
        'string',
    ],
    roleArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string',
    identityProviderConfiguration={
        'samlConfiguration': {
            'authenticationUrl': 'string'
        },
        'openIDConnectConfiguration': {
            'secretsArn': 'string',
            'secretsRole': 'string'
        }
    },
    browserExtensionConfiguration={
        'enabledBrowserExtensions': [
            'FIREFOX'|'CHROME',
        ]
    },
    customizationConfiguration={
        'customCSSUrl': 'string',
        'logoUrl': 'string',
        'fontUrl': 'string',
        'faviconUrl': 'string'
    }
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business web experience.

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

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

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

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

  • origins (list) –

    Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> <note> <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> </note>

    • (string) –

  • roleArn (string) –

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

    Note

    You must provide this value if you’re using IAM Identity Center to manage end user access to your application. If you’re using legacy identity management to manage user access, you don’t need to provide this value.

  • 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.

  • 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.

  • 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.

  • browserExtensionConfiguration (dict) –

    The browser extension configuration for an Amazon Q Business web experience.

    Note

    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 Configure external OIDC identity provider for your browser extensions..

    • enabledBrowserExtensions (list) – [REQUIRED]

      Specify the browser extensions allowed for your Amazon Q web experience.

      • CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).

      • FIREFOX — Enables the extension for Mozilla Firefox.

      • CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.

      • (string) –

  • customizationConfiguration (dict) –

    Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.

    • 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • webExperienceId (string) –

      The identifier of the Amazon Q Business web experience.

    • webExperienceArn (string) –

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

Exceptions