/AWS1/CL_QQB=>CREATEWEBEXPERIENCE()¶
About CreateWebExperience¶
Creates an Amazon Q Business web experience.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID¶
The identifier of the Amazon Q Business web experience.
Optional arguments:¶
IV_TITLE TYPE /AWS1/QQBWEBEXPERIENCETITLE /AWS1/QQBWEBEXPERIENCETITLE¶
The title for your Amazon Q Business web experience.
IV_SUBTITLE TYPE /AWS1/QQBWEBEXPERIENCESUBTITLE /AWS1/QQBWEBEXPERIENCESUBTITLE¶
A subtitle to personalize your Amazon Q Business web experience.
IV_WELCOMEMESSAGE TYPE /AWS1/QQBWEBEXPERIENCEWELCOM00 /AWS1/QQBWEBEXPERIENCEWELCOM00¶
The customized welcome message for end users of an Amazon Q Business web experience.
IV_SAMPLEPROMPTSCONTROLMODE TYPE /AWS1/QQBWEBEXPERIENCESAMPLE00 /AWS1/QQBWEBEXPERIENCESAMPLE00¶
Determines whether sample prompts are enabled in the web experience for an end user.
IT_ORIGINS TYPE /AWS1/CL_QQBWEBEXPERIENCEORI00=>TT_WEBEXPERIENCEORIGINS TT_WEBEXPERIENCEORIGINS¶
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).You must only submit a base URL and not a full path. For example,
https://docs.aws.amazon.com.
IV_ROLEARN TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN¶
The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_TAGS¶
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: _ . : / = + - @.
IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN¶
A token you provide to identify a request to create an Amazon Q Business web experience.
IO_IDENTITYPROVIDERCONF TYPE REF TO /AWS1/CL_QQBIDENTITYPVDRCONF /AWS1/CL_QQBIDENTITYPVDRCONF¶
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
IO_BROWSEREXTENSIONCONF TYPE REF TO /AWS1/CL_QQBBROWSEREXTENSION00 /AWS1/CL_QQBBROWSEREXTENSION00¶
The browser extension configuration for an Amazon Q Business web experience.
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..
IO_CUSTOMIZATIONCONF TYPE REF TO /AWS1/CL_QQBCUSTOMIZATIONCONF /AWS1/CL_QQBCUSTOMIZATIONCONF¶
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.