Skip to content

/AWS1/IF_QQB=>UPDATEPLUGIN()

About UpdatePlugin

Updates an Amazon Q Business plugin.

Method Signature

METHODS /AWS1/IF_QQB~UPDATEPLUGIN
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_PLUGINID TYPE /AWS1/QQBPLUGINID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBPLUGINNAME OPTIONAL
    !IV_STATE TYPE /AWS1/QQBPLUGINSTATE OPTIONAL
    !IV_SERVERURL TYPE /AWS1/QQBURL OPTIONAL
    !IO_CUSTOMPLUGINCONFIGURATION TYPE REF TO /AWS1/CL_QQBCUSTOMPLUGINCONF OPTIONAL
    !IO_AUTHCONFIGURATION TYPE REF TO /AWS1/CL_QQBPLUGINAUTHCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbupdatepluginrsp
  RAISING
    /AWS1/CX_QQBACCESSDENIEDEX
    /AWS1/CX_QQBCONFLICTEXCEPTION
    /AWS1/CX_QQBINTERNALSERVEREX
    /AWS1/CX_QQBRESOURCENOTFOUNDEX
    /AWS1/CX_QQBSERVICEQUOTAEXCDEX
    /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 application the plugin is attached to.

iv_pluginid TYPE /AWS1/QQBPLUGINID /AWS1/QQBPLUGINID

The identifier of the plugin.

Optional arguments:

iv_displayname TYPE /AWS1/QQBPLUGINNAME /AWS1/QQBPLUGINNAME

The name of the plugin.

iv_state TYPE /AWS1/QQBPLUGINSTATE /AWS1/QQBPLUGINSTATE

The status of the plugin.

iv_serverurl TYPE /AWS1/QQBURL /AWS1/QQBURL

The source URL used for plugin configuration.

io_custompluginconfiguration TYPE REF TO /AWS1/CL_QQBCUSTOMPLUGINCONF /AWS1/CL_QQBCUSTOMPLUGINCONF

The configuration for a custom plugin.

io_authconfiguration TYPE REF TO /AWS1/CL_QQBPLUGINAUTHCONF /AWS1/CL_QQBPLUGINAUTHCONF

The authentication configuration the plugin is using.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbupdatepluginrsp /AWS1/CL_QQBUPDATEPLUGINRSP

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->updateplugin(
  io_authconfiguration = new /aws1/cl_qqbpluginauthconf(
    io_basicauthconfiguration = new /aws1/cl_qqbbasicauthconf(
      iv_rolearn = |string|
      iv_secretarn = |string|
    )
    io_idcauthconfiguration = new /aws1/cl_qqbidcauthconf(
      iv_idcapplicationarn = |string|
      iv_rolearn = |string|
    )
    io_noauthconfiguration = new /aws1/cl_qqbnoauthconf( )
    io_oauth2clientcredconf = new /aws1/cl_qqboauth2clicredconf(
      iv_authorizationurl = |string|
      iv_rolearn = |string|
      iv_secretarn = |string|
      iv_tokenurl = |string|
    )
  )
  io_custompluginconfiguration = new /aws1/cl_qqbcustompluginconf(
    io_apischema = new /aws1/cl_qqbapischema(
      io_s3 = new /aws1/cl_qqbs3(
        iv_bucket = |string|
        iv_key = |string|
      )
      iv_payload = |string|
    )
    iv_apischematype = |string|
    iv_description = |string|
  )
  iv_applicationid = |string|
  iv_displayname = |string|
  iv_pluginid = |string|
  iv_serverurl = |string|
  iv_state = |string|
).

This is an example of reading all possible response values

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