GetWebExperienceResponse ¶

class GetWebExperienceResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application linked to the web experience.</p>"""
    web_experience_id: NotRequired[
        "capo_qbusiness.types.web_experience_id.WebExperienceId"
    ]
    """<p>The identifier of the Amazon Q Business web experience.</p>"""
    web_experience_arn: NotRequired[
        "capo_qbusiness.types.web_experience_arn.WebExperienceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.</p>"""
    default_endpoint: NotRequired["capo_qbusiness.types.url.Url"]
    """<p>The endpoint of your Amazon Q Business web experience.</p>"""
    status: NotRequired[
        "capo_qbusiness.types.web_experience_status.WebExperienceStatus"
    ]
    """<p>The current status of the Amazon Q Business web experience. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail. </p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business web experience was last created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the Amazon Q Business web experience was last updated.</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>The subtitle for 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>Gets 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>"""
    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>"""
    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>"""
    authentication_configuration: NotRequired[
        "capo_qbusiness.types.web_experience_auth_configuration.WebExperienceAuthConfiguration"
    ]
    """<p>The authentication configuration information for your Amazon Q Business web experience.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.</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>"""
    customization_configuration: NotRequired[
        "capo_qbusiness.types.customization_configuration.CustomizationConfiguration"
    ]
    """<p>Gets the custom logo, favicon, font, and color used in the Amazon Q web experience. </p>"""