Skip to content

/AWS1/IF_QST=>UPDATEKNOWLEDGEBASE()

About UpdateKnowledgeBase

Updates the properties of an existing knowledge base.

Method Signature

METHODS /AWS1/IF_QST~UPDATEKNOWLEDGEBASE
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTKBAWSACCOUNTID OPTIONAL
    !IV_KNOWLEDGEBASEID TYPE /AWS1/QSTKNOWLEDGEBASEID OPTIONAL
    !IV_NAME TYPE /AWS1/QSTKNOWLEDGEBASENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QSTKNOWLEDGEBASEDESC OPTIONAL
    !IO_KNOWLEDGEBASECONF TYPE REF TO /AWS1/CL_QSTKNOWLEDGEBASECONF OPTIONAL
    !IO_MEDIAEXTRACTIONCONF TYPE REF TO /AWS1/CL_QSTMEDIAEXTCONF OPTIONAL
    !IV_ISMAILNOTIFOPTDFORINGSTFL TYPE /AWS1/QSTBOOLEAN OPTIONAL
    !IO_ACCESSCONTROLCONF TYPE REF TO /AWS1/CL_QSTACCESSCONTROLCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstupdknwldgbasersp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTINVALIDREQUESTEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTKBAWSACCOUNTID /AWS1/QSTKBAWSACCOUNTID

The ID of the Amazon Web Services account that contains the knowledge base.

iv_knowledgebaseid TYPE /AWS1/QSTKNOWLEDGEBASEID /AWS1/QSTKNOWLEDGEBASEID

The unique identifier for the knowledge base.

Optional arguments:

iv_name TYPE /AWS1/QSTKNOWLEDGEBASENAME /AWS1/QSTKNOWLEDGEBASENAME

The name of the knowledge base. If you don't specify a name, the existing name is retained.

iv_description TYPE /AWS1/QSTKNOWLEDGEBASEDESC /AWS1/QSTKNOWLEDGEBASEDESC

A description for the knowledge base. If you don't specify a description, the existing description is retained.

io_knowledgebaseconf TYPE REF TO /AWS1/CL_QSTKNOWLEDGEBASECONF /AWS1/CL_QSTKNOWLEDGEBASECONF

The configuration settings for a knowledge base.

io_mediaextractionconf TYPE REF TO /AWS1/CL_QSTMEDIAEXTCONF /AWS1/CL_QSTMEDIAEXTCONF

The configuration for media extraction from knowledge base documents.

iv_ismailnotifoptdforingstfl TYPE /AWS1/QSTBOOLEAN /AWS1/QSTBOOLEAN

Specifies whether email notifications are enabled for ingestion failures.

io_accesscontrolconf TYPE REF TO /AWS1/CL_QSTACCESSCONTROLCONF /AWS1/CL_QSTACCESSCONTROLCONF

The access control configuration for the knowledge base. If you don't specify this parameter, the existing setting is retained.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstupdknwldgbasersp /AWS1/CL_QSTUPDKNWLDGBASERSP

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->updateknowledgebase(
  io_accesscontrolconf = new /aws1/cl_qstaccesscontrolconf( ABAP_TRUE )
  io_knowledgebaseconf = new /aws1/cl_qstknowledgebaseconf(
    io_templateconfiguration = new /aws1/cl_qstkbtemplateconf(
      io_template = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
    )
  )
  io_mediaextractionconf = new /aws1/cl_qstmediaextconf(
    io_audioextractionconf = new /aws1/cl_qstaudioextconf( |string| )
    io_imageextractionconf = new /aws1/cl_qstimageextconf( |string| )
    io_videoextractionconf = new /aws1/cl_qstvideoextconf(
      iv_videoextractionstatus = |string|
      iv_videoextractiontype = |string|
    )
  )
  iv_awsaccountid = |string|
  iv_description = |string|
  iv_ismailnotifoptdforingstfl = ABAP_TRUE
  iv_knowledgebaseid = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_knowledgebasearn = lo_result->get_knowledgebasearn( ).
  lv_knowledgebaseid = lo_result->get_knowledgebaseid( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.