create_web_experience¶
Operation¶
async
¶
create_web_experience(input: CreateWebExperienceInput, plugins: list[Plugin] | None = None) -> CreateWebExperienceOutput
Creates an Amazon Q Business web experience.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateWebExperienceInput
|
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 |
|---|---|
CreateWebExperienceOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateWebExperienceInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the 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.
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..
class-attribute
instance-attribute
¶
client_token: str | None = None
A token you provide to identify a request to create an Amazon Q Business web experience.
class-attribute
instance-attribute
¶
customization_configuration: CustomizationConfiguration | None = None
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
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
Sets 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).
Note
You must only submit a base URL and not a full path. For example,
https://docs.aws.amazon.com.
class-attribute
instance-attribute
¶
role_arn: str | None = None
The Amazon Resource Name (ARN) of the service role attached to your web experience.
Note
The roleArn parameter is required when your Amazon Q Business
application is created with IAM Identity Center. It is not required for
SAML-based applications.
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
¶
subtitle: str | None = None
A subtitle to personalize your Amazon Q Business web experience.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = None
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: _ . : / = + - @.
class-attribute
instance-attribute
¶
title: str | None = None
The title for your 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.
Output¶
dataclass
¶
Dataclass for CreateWebExperienceOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
web_experience_arn: str | None = None
The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
class-attribute
instance-attribute
¶
web_experience_id: str | None = None
The identifier of the Amazon Q Business web experience.