Skip to content

get_web_experience

Operation

get_web_experience

get_web_experience(request: GetWebExperienceInput | GetWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWebExperienceInputDict]) -> GetWebExperienceOutput

Gets information about an existing Amazon Q Business web experience.

Parameters:

Name Type Description Default
request GetWebExperienceInput | GetWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWebExperienceOutput

An instance of GetWebExperienceOutput.

get_web_experience async

get_web_experience(request: GetWebExperienceInput | GetWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWebExperienceInputDict]) -> GetWebExperienceOutput

Gets information about an existing Amazon Q Business web experience.

Parameters:

Name Type Description Default
request GetWebExperienceInput | GetWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWebExperienceOutput

An instance of GetWebExperienceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetWebExperienceInputDict

Bases: TypedDict

Dictionary form of GetWebExperienceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application linked to the web experience.

web_experience_id instance-attribute
web_experience_id: Required[str]

The identifier of the Amazon Q Business web experience.

GetWebExperienceInput dataclass

Bases: _SerdeShape

Dataclass for GetWebExperienceInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application linked to the web experience.

web_experience_id class-attribute instance-attribute
web_experience_id: str | None = ...

The identifier of the Amazon Q Business web experience.

Output

GetWebExperienceOutput dataclass

Bases: _SerdeShape

Dataclass for GetWebExperienceOutput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application linked to the web experience.

authentication_configuration class-attribute instance-attribute
authentication_configuration: WebExperienceAuthConfiguration | None = ...

The authentication configuration information for your Amazon Q Business web experience.

browser_extension_configuration class-attribute instance-attribute
browser_extension_configuration: BrowserExtensionConfiguration | None = ...

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

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The Unix timestamp when the Amazon Q Business web experience was last created.

customization_configuration class-attribute instance-attribute
customization_configuration: CustomizationConfiguration | None = ...

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

default_endpoint class-attribute instance-attribute
default_endpoint: str | None = ...

The endpoint of your Amazon Q Business web experience.

error class-attribute instance-attribute
error: ErrorDetail | 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.

identity_provider_configuration class-attribute instance-attribute
identity_provider_configuration: IdentityProviderConfiguration | None = ...

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

origins class-attribute instance-attribute
origins: list[str] | 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).

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

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

sample_prompts_control_mode class-attribute instance-attribute
sample_prompts_control_mode: str | None = ...

Determines whether sample prompts are enabled in the web experience for an end user.

status class-attribute instance-attribute
status: str | 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.

subtitle class-attribute instance-attribute
subtitle: str | None = ...

The subtitle for your Amazon Q Business web experience.

title class-attribute instance-attribute
title: str | None = ...

The title for your Amazon Q Business web experience.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The Unix timestamp when the Amazon Q Business web experience was last updated.

web_experience_arn class-attribute instance-attribute
web_experience_arn: str | None = ...

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

web_experience_id class-attribute instance-attribute
web_experience_id: str | None = ...

The identifier of the Amazon Q Business web experience.

welcome_message class-attribute instance-attribute
welcome_message: str | None = ...

The customized welcome message for end users of an Amazon Q Business web experience.