CreateWebExperienceRequest ¶

class CreateWebExperienceRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business web experience.</p>"""
    title: NotRequired["capo_qbusiness.types.web_experience_title.WebExperienceTitle"]
    """<p>The title for your Amazon Q Business web experience.</p>"""
    subtitle: NotRequired[
        "capo_qbusiness.types.web_experience_subtitle.WebExperienceSubtitle"
    ]
    """<p>A subtitle to personalize your Amazon Q Business web experience.</p>"""
    welcome_message: NotRequired[
        "capo_qbusiness.types.web_experience_welcome_message.WebExperienceWelcomeMessage"
    ]
    """<p>The customized welcome message for end users of an Amazon Q Business web experience.</p>"""
    sample_prompts_control_mode: NotRequired[
        "capo_qbusiness.types.web_experience_sample_prompts_control_mode.WebExperienceSamplePromptsControlMode"
    ]
    """<p>Determines whether sample prompts are enabled in the web experience for an end user.</p>"""
    origins: NotRequired[
        "capo_qbusiness.types.web_experience_origins.WebExperienceOrigins"
    ]
    """<p>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>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p> <note> <p>The <code>roleArn</code> parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.</p> </note>"""
    tags: NotRequired["capo_qbusiness.types.tags.Tags"]
    """<p>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: _ . : / = + - @.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token you provide to identify a request to create an Amazon Q Business web experience. </p>"""
    identity_provider_configuration: NotRequired[
        "capo_qbusiness.types.identity_provider_configuration.IdentityProviderConfiguration"
    ]
    """<p>Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>"""
    browser_extension_configuration: NotRequired[
        "capo_qbusiness.types.browser_extension_configuration.BrowserExtensionConfiguration"
    ]
    """<p>The browser extension configuration for an Amazon Q Business web experience.</p> <note> <p> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html">Configure external OIDC identity provider for your browser extensions.</a>. </p> </note>"""
    customization_configuration: NotRequired[
        "capo_qbusiness.types.customization_configuration.CustomizationConfiguration"
    ]
    """<p>Sets the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>"""