Skip to content

/AWS1/IF_QQB=>UPDATEINDEX()

About UpdateIndex

Updates an Amazon Q Business index.

Method Signature

METHODS /AWS1/IF_QQB~UPDATEINDEX
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_INDEXID TYPE /AWS1/QQBINDEXID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBAPPLICATIONNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION OPTIONAL
    !IO_CAPACITYCONFIGURATION TYPE REF TO /AWS1/CL_QQBINDEXCAPACITYCONF OPTIONAL
    !IT_DOCUMENTATTRIBUTECONFS TYPE /AWS1/CL_QQBDOCUMENTATTRCONF=>TT_DOCUMENTATTRIBUTECONFS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbupdateindexrsp
  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 Amazon Q Business application connected to the index.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the Amazon Q Business index.

Optional arguments:

iv_displayname TYPE /AWS1/QQBAPPLICATIONNAME /AWS1/QQBAPPLICATIONNAME

The name of the Amazon Q Business index.

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

The description of the Amazon Q Business index.

io_capacityconfiguration TYPE REF TO /AWS1/CL_QQBINDEXCAPACITYCONF /AWS1/CL_QQBINDEXCAPACITYCONF

The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.

it_documentattributeconfs TYPE /AWS1/CL_QQBDOCUMENTATTRCONF=>TT_DOCUMENTATTRIBUTECONFS TT_DOCUMENTATTRIBUTECONFS

Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbupdateindexrsp /AWS1/CL_QQBUPDATEINDEXRSP

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->updateindex(
  io_capacityconfiguration = new /aws1/cl_qqbindexcapacityconf( 123 )
  it_documentattributeconfs = VALUE /aws1/cl_qqbdocumentattrconf=>tt_documentattributeconfs(
    (
      new /aws1/cl_qqbdocumentattrconf(
        iv_name = |string|
        iv_search = |string|
        iv_type = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_indexid = |string|
).

This is an example of reading all possible response values

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