/AWS1/IF_QQB=>UPDATEWEBEXPERIENCE()

About UpdateWebExperience

Updates an Amazon Q Business web experience.

Method Signature

METHODS /AWS1/IF_QQB~UPDATEWEBEXPERIENCE
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_WEBEXPERIENCEID TYPE /AWS1/QQBWEBEXPERIENCEID OPTIONAL
    !IV_ROLEARN TYPE /AWS1/QQBROLEARN OPTIONAL
    !IO_AUTHNTCTNCONFIGURATION TYPE REF TO /AWS1/CL_QQBWEBEXPERIENCEAUT00 OPTIONAL
    !IV_TITLE TYPE /AWS1/QQBWEBEXPERIENCETITLE OPTIONAL
    !IV_SUBTITLE TYPE /AWS1/QQBWEBEXPERIENCESUBTITLE OPTIONAL
    !IV_WELCOMEMESSAGE TYPE /AWS1/QQBWEBEXPERIENCEWELCOM00 OPTIONAL
    !IV_SAMPLEPROMPTSCONTROLMODE TYPE /AWS1/QQBWEBEXPERIENCESAMPLE00 OPTIONAL
    !IO_IDENTITYPROVIDERCONF TYPE REF TO /AWS1/CL_QQBIDENTITYPVDRCONF OPTIONAL
    !IT_ORIGINS TYPE /AWS1/CL_QQBWEBEXPERIENCEORI00=>TT_WEBEXPERIENCEORIGINS OPTIONAL
    !IO_BROWSEREXTENSIONCONF TYPE REF TO /AWS1/CL_QQBBROWSEREXTENSION00 OPTIONAL
    !IO_CUSTOMIZATIONCONF TYPE REF TO /AWS1/CL_QQBCUSTOMIZATIONCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbupwebexperiencersp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBTHROTTLINGEX
    /AWS1/CX_QQBVALIDATIONEX
    /AWS1/CX_QQBCLIENTEXC
    /AWS1/CX_QQBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

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

iv_webexperienceid TYPE /AWS1/QQBWEBEXPERIENCEID /AWS1/QQBWEBEXPERIENCEID

The identifier of the Amazon Q Business web experience.

Optional arguments:

iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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

io_authntctnconfiguration TYPE REF TO /AWS1/CL_QQBWEBEXPERIENCEAUT00 /AWS1/CL_QQBWEBEXPERIENCEAUT00

The authentication configuration of the Amazon Q Business web experience.

iv_title TYPE /AWS1/QQBWEBEXPERIENCETITLE /AWS1/QQBWEBEXPERIENCETITLE

The title of the Amazon Q Business web experience.

iv_subtitle TYPE /AWS1/QQBWEBEXPERIENCESUBTITLE /AWS1/QQBWEBEXPERIENCESUBTITLE

The subtitle of the Amazon Q Business web experience.

iv_welcomemessage TYPE /AWS1/QQBWEBEXPERIENCEWELCOM00 /AWS1/QQBWEBEXPERIENCEWELCOM00

A customized welcome message for an end user in 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.

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.

it_origins TYPE /AWS1/CL_QQBWEBEXPERIENCEORI00=>TT_WEBEXPERIENCEORIGINS TT_WEBEXPERIENCEORIGINS

Updates 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).

• Any values except null submitted as part of this update will replace all previous values.

• You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

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

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

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbupwebexperiencersp /AWS1/CL_QQBUPWEBEXPERIENCERSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatewebexperience(
  io_authntctnconfiguration = new /aws1/cl_qqbwebexperienceaut00(
    io_samlconfiguration = new /aws1/cl_qqbsamlconfiguration(
      iv_metadataxml = |string|
      iv_rolearn = |string|
      iv_usergroupattribute = |string|
      iv_useridattribute = |string|
    )
  )
  io_browserextensionconf = new /aws1/cl_qqbbrowserextension00(
    it_enabledbrowserextensions = VALUE /aws1/cl_qqbbrowserextension01=>tt_browserextensionlist(
      ( new /aws1/cl_qqbbrowserextension01( |string| ) )
    )
  )
  io_customizationconf = new /aws1/cl_qqbcustomizationconf(
    iv_customcssurl = |string|
    iv_faviconurl = |string|
    iv_fonturl = |string|
    iv_logourl = |string|
  )
  io_identityproviderconf = new /aws1/cl_qqbidentitypvdrconf(
    io_openidconnectconf = new /aws1/cl_qqbopenidcpconf(
      iv_secretsarn = |string|
      iv_secretsrole = |string|
    )
    io_samlconfiguration = new /aws1/cl_qqbsamlproviderconf( |string| )
  )
  it_origins = VALUE /aws1/cl_qqbwebexperienceori00=>tt_webexperienceorigins(
    ( new /aws1/cl_qqbwebexperienceori00( |string| ) )
  )
  iv_applicationid = |string|
  iv_rolearn = |string|
  iv_samplepromptscontrolmode = |string|
  iv_subtitle = |string|
  iv_title = |string|
  iv_webexperienceid = |string|
  iv_welcomemessage = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.