get_web_experience¶
Operation¶
async
¶
get_web_experience(input: GetWebExperienceInput, plugins: list[Plugin] | None = None) -> GetWebExperienceOutput
Gets information about an existing Amazon Q Business web experience.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetWebExperienceInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetWebExperienceOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetWebExperienceInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to the web experience.
class-attribute
instance-attribute
¶
web_experience_id: str | None = None
The identifier of the Amazon Q Business web experience.
Output¶
dataclass
¶
Dataclass for GetWebExperienceOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to the web experience.
class-attribute
instance-attribute
¶
authentication_configuration: WebExperienceAuthConfiguration | None = None
The authentication configuration information for your Amazon Q Business web experience.
class-attribute
instance-attribute
¶
browser_extension_configuration: BrowserExtensionConfiguration | None = None
The browser extension configuration for an Amazon Q Business web experience.
class-attribute
instance-attribute
¶
created_at: datetime | None = None
The Unix timestamp when the Amazon Q Business web experience was last created.
class-attribute
instance-attribute
¶
customization_configuration: CustomizationConfiguration | None = None
Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
class-attribute
instance-attribute
¶
default_endpoint: str | None = None
The endpoint of your Amazon Q Business web experience.
class-attribute
instance-attribute
¶
error: ErrorDetail | None = None
When the Status field value is FAILED, the ErrorMessage field
contains a description of the error that caused the data source
connector to fail.
class-attribute
instance-attribute
¶
identity_provider_configuration: IdentityProviderConfiguration | None = None
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
class-attribute
instance-attribute
¶
origins: list[str] | None = None
Gets the website domain origins that are allowed to embed the Amazon Q
Business web experience. The domain origin refers to the base URL for
accessing a website including the protocol (http/https), the domain
name, and the port number (if specified).
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of the service role attached to your web experience.
class-attribute
instance-attribute
¶
sample_prompts_control_mode: WebExperienceSamplePromptsControlMode | None = None
Determines whether sample prompts are enabled in the web experience for an end user.
class-attribute
instance-attribute
¶
status: WebExperienceStatus | None = None
The current status of the Amazon Q Business web experience. When the
Status field value is FAILED, the ErrorMessage field contains a
description of the error that caused the data source connector to fail.
class-attribute
instance-attribute
¶
subtitle: str | None = None
The subtitle for your Amazon Q Business web experience.
class-attribute
instance-attribute
¶
title: str | None = None
The title for your Amazon Q Business web experience.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The Unix timestamp when the Amazon Q Business web experience was last updated.
class-attribute
instance-attribute
¶
web_experience_arn: str | None = None
The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
class-attribute
instance-attribute
¶
web_experience_id: str | None = None
The identifier of the Amazon Q Business web experience.
class-attribute
instance-attribute
¶
welcome_message: str | None = None
The customized welcome message for end users of an Amazon Q Business web experience.