Skip to content

/AWS1/IF_QQB=>CREATEINDEX()

About CreateIndex

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Method Signature

METHODS /AWS1/IF_QQB~CREATEINDEX
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/QQBINDEXNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION OPTIONAL
    !IV_TYPE TYPE /AWS1/QQBINDEXTYPE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS OPTIONAL
    !IO_CAPACITYCONFIGURATION TYPE REF TO /AWS1/CL_QQBINDEXCAPACITYCONF OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqbcreateindexrsp
  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 using the index.

iv_displayname TYPE /AWS1/QQBINDEXNAME /AWS1/QQBINDEXNAME

A name for the Amazon Q Business index.

Optional arguments:

iv_description TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

A description for the Amazon Q Business index.

iv_type TYPE /AWS1/QQBINDEXTYPE /AWS1/QQBINDEXTYPE

The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.

it_tags TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_TAGS

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

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

iv_clienttoken TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbcreateindexrsp /AWS1/CL_QQBCREATEINDEXRSP

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->createindex(
  io_capacityconfiguration = new /aws1/cl_qqbindexcapacityconf( 123 )
  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_description = |string|
  iv_displayname = |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_indexid = lo_result->get_indexid( ).
  lv_indexarn = lo_result->get_indexarn( ).
ENDIF.