Skip to content

/AWS1/IF_QQB=>UPDATEDATASOURCE()

About UpdateDataSource

Updates an existing Amazon Q Business data source connector.

Method Signature

METHODS /AWS1/IF_QQB~UPDATEDATASOURCE
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_INDEXID TYPE /AWS1/QQBINDEXID OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/QQBDATASOURCEID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBDATASOURCENAME OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_RT_DOCUMENT OPTIONAL
    !IO_VPCCONFIGURATION TYPE REF TO /AWS1/CL_QQBDATASOURCEVPCCONF OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION OPTIONAL
    !IV_SYNCSCHEDULE TYPE /AWS1/QQBSYNCSCHEDULE OPTIONAL
    !IV_ROLEARN TYPE /AWS1/QQBROLEARN OPTIONAL
    !IO_DOCUMENTENRICHMENTCONF TYPE REF TO /AWS1/CL_QQBDOCENRICHMENTCONF OPTIONAL
    !IO_MEDIAEXTRACTIONCONF TYPE REF TO /AWS1/CL_QQBMEDIAEXTRACTCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbupdatedatasrcrsp
  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 the data source is attached to.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the index attached to the data source connector.

iv_datasourceid TYPE /AWS1/QQBDATASOURCEID /AWS1/QQBDATASOURCEID

The identifier of the data source connector.

Optional arguments:

iv_displayname TYPE /AWS1/QQBDATASOURCENAME /AWS1/QQBDATASOURCENAME

A name of the data source connector.

io_configuration TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

Provides the configuration information for an Amazon Q Business data source.

io_vpcconfiguration TYPE REF TO /AWS1/CL_QQBDATASOURCEVPCCONF /AWS1/CL_QQBDATASOURCEVPCCONF

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

The description of the data source connector.

iv_syncschedule TYPE /AWS1/QQBSYNCSCHEDULE /AWS1/QQBSYNCSCHEDULE

The chosen update frequency for your data source.

iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

io_documentenrichmentconf TYPE REF TO /AWS1/CL_QQBDOCENRICHMENTCONF /AWS1/CL_QQBDOCENRICHMENTCONF

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

io_mediaextractionconf TYPE REF TO /AWS1/CL_QQBMEDIAEXTRACTCONF /AWS1/CL_QQBMEDIAEXTRACTCONF

The configuration for extracting information from media in documents for your data source.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbupdatedatasrcrsp /AWS1/CL_QQBUPDATEDATASRCRSP

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->updatedatasource(
  io_configuration = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
  io_documentenrichmentconf = new /aws1/cl_qqbdocenrichmentconf(
    io_postextractionhookconf = new /aws1/cl_qqbhookconfiguration(
      io_invocationcondition = new /aws1/cl_qqbdocumentattrcond(
        io_value = new /aws1/cl_qqbdocumentattrvalue(
          it_stringlistvalue = VALUE /aws1/cl_qqbdocattrstrlstval_w=>tt_documentattrstringlistvalue(
            ( new /aws1/cl_qqbdocattrstrlstval_w( |string| ) )
          )
          iv_datevalue = '20150101000000.0000000'
          iv_longvalue = 123
          iv_stringvalue = |string|
        )
        iv_key = |string|
        iv_operator = |string|
      )
      iv_lambdaarn = |string|
      iv_rolearn = |string|
      iv_s3bucketname = |string|
    )
    io_preextractionhookconf = new /aws1/cl_qqbhookconfiguration(
      io_invocationcondition = new /aws1/cl_qqbdocumentattrcond(
        io_value = new /aws1/cl_qqbdocumentattrvalue(
          it_stringlistvalue = VALUE /aws1/cl_qqbdocattrstrlstval_w=>tt_documentattrstringlistvalue(
            ( new /aws1/cl_qqbdocattrstrlstval_w( |string| ) )
          )
          iv_datevalue = '20150101000000.0000000'
          iv_longvalue = 123
          iv_stringvalue = |string|
        )
        iv_key = |string|
        iv_operator = |string|
      )
      iv_lambdaarn = |string|
      iv_rolearn = |string|
      iv_s3bucketname = |string|
    )
    it_inlineconfigurations = VALUE /aws1/cl_qqbinlinedocenrichm00=>tt_inlinedocenrichmentconfs(
      (
        new /aws1/cl_qqbinlinedocenrichm00(
          io_condition = new /aws1/cl_qqbdocumentattrcond(
            io_value = new /aws1/cl_qqbdocumentattrvalue(
              it_stringlistvalue = VALUE /aws1/cl_qqbdocattrstrlstval_w=>tt_documentattrstringlistvalue(
                ( new /aws1/cl_qqbdocattrstrlstval_w( |string| ) )
              )
              iv_datevalue = '20150101000000.0000000'
              iv_longvalue = 123
              iv_stringvalue = |string|
            )
            iv_key = |string|
            iv_operator = |string|
          )
          io_target = new /aws1/cl_qqbdocumentattrtarget(
            io_value = new /aws1/cl_qqbdocumentattrvalue(
              it_stringlistvalue = VALUE /aws1/cl_qqbdocattrstrlstval_w=>tt_documentattrstringlistvalue(
                ( new /aws1/cl_qqbdocattrstrlstval_w( |string| ) )
              )
              iv_datevalue = '20150101000000.0000000'
              iv_longvalue = 123
              iv_stringvalue = |string|
            )
            iv_attributevalueoperator = |string|
            iv_key = |string|
          )
          iv_documentcontentoperator = |string|
        )
      )
    )
  )
  io_mediaextractionconf = new /aws1/cl_qqbmediaextractconf(
    io_audioextractionconf = new /aws1/cl_qqbaudioextractconf( |string| )
    io_imageextractionconf = new /aws1/cl_qqbimageextractconf( |string| )
    io_videoextractionconf = new /aws1/cl_qqbvideoextractconf( |string| )
  )
  io_vpcconfiguration = new /aws1/cl_qqbdatasourcevpcconf(
    it_securitygroupids = VALUE /aws1/cl_qqbsecuritygroupids_w=>tt_securitygroupids(
      ( new /aws1/cl_qqbsecuritygroupids_w( |string| ) )
    )
    it_subnetids = VALUE /aws1/cl_qqbsubnetids_w=>tt_subnetids(
      ( new /aws1/cl_qqbsubnetids_w( |string| ) )
    )
  )
  iv_applicationid = |string|
  iv_datasourceid = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_indexid = |string|
  iv_rolearn = |string|
  iv_syncschedule = |string|
).

This is an example of reading all possible response values

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