/AWS1/IF_QQB=>CREATEPLUGIN()

About CreatePlugin

Creates an Amazon Q Business plugin.

Method Signature

METHODS /AWS1/IF_QQB~CREATEPLUGIN
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBPLUGINNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/QQBPLUGINTYPE OPTIONAL
    !IO_AUTHCONFIGURATION TYPE REF TO /AWS1/CL_QQBPLUGINAUTHCONF OPTIONAL
    !IV_SERVERURL TYPE /AWS1/QQBURL OPTIONAL
    !IO_CUSTOMPLUGINCONFIGURATION TYPE REF TO /AWS1/CL_QQBCUSTOMPLUGINCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbcreatepluginrsp
  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 that will contain the plugin.

iv_displayname TYPE /AWS1/QQBPLUGINNAME /AWS1/QQBPLUGINNAME

A the name for your plugin.

iv_type TYPE /AWS1/QQBPLUGINTYPE /AWS1/QQBPLUGINTYPE

The type of plugin you want to create.

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

authConfiguration

Optional arguments:

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

Contains configuration for a custom plugin.

it_tags TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_TAGS

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. 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 that you provide to identify the request to create your Amazon Q Business plugin.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbcreatepluginrsp /AWS1/CL_QQBCREATEPLUGINRSP

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->createplugin(
  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|
  )
  it_tags = VALUE /aws1/cl_qqbtag=>tt_tags(
    (
      new /aws1/cl_qqbtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_clienttoken = |string|
  iv_displayname = |string|
  iv_serverurl = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_pluginid = lo_result->get_pluginid( ).
  lv_pluginarn = lo_result->get_pluginarn( ).
  lv_pluginbuildstatus = lo_result->get_buildstatus( ).
ENDIF.