Skip to content

/AWS1/CL_KND=>LISTEXPERIENCEENTITIES()

About ListExperienceEntities

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

Method Signature

IMPORTING

Required arguments:

iv_id TYPE /AWS1/KNDEXPERIENCEID /AWS1/KNDEXPERIENCEID

The identifier of your Amazon Kendra experience.

iv_indexid TYPE /AWS1/KNDINDEXID /AWS1/KNDINDEXID

The identifier of the index for your Amazon Kendra experience.

Optional arguments:

iv_nexttoken TYPE /AWS1/KNDNEXTTOKEN /AWS1/KNDNEXTTOKEN

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.

RETURNING

oo_output TYPE REF TO /aws1/cl_kndlstexperienceent01 /AWS1/CL_KNDLSTEXPERIENCEENT01

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->/aws1/if_knd~listexperienceentities(
  iv_id = |string|
  iv_indexid = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_summaryitems( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityid = lo_row_1->get_entityid( ).
      lv_entitytype = lo_row_1->get_entitytype( ).
      lo_entitydisplaydata = lo_row_1->get_displaydata( ).
      IF lo_entitydisplaydata IS NOT INITIAL.
        lv_nametype = lo_entitydisplaydata->get_username( ).
        lv_nametype = lo_entitydisplaydata->get_groupname( ).
        lv_nametype = lo_entitydisplaydata->get_identifiedusername( ).
        lv_nametype = lo_entitydisplaydata->get_firstname( ).
        lv_nametype = lo_entitydisplaydata->get_lastname( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.