Skip to content

/AWS1/IF_DIR=>LISTINDEX00()

About ListIndex

Lists objects attached to the specified index.

Method Signature

METHODS /AWS1/IF_DIR~LISTINDEX00
  IMPORTING
    !IV_DIRECTORYARN TYPE /AWS1/DIRARN OPTIONAL
    !IT_RANGESONINDEXEDVALUES TYPE /AWS1/CL_DIROBJECTATTRRANGE=>TT_OBJECTATTRIBUTERANGELIST OPTIONAL
    !IO_INDEXREFERENCE TYPE REF TO /AWS1/CL_DIROBJECTREFERENCE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DIRNUMBERRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DIRNEXTTOKEN OPTIONAL
    !IV_CONSISTENCYLEVEL TYPE /AWS1/DIRCONSISTENCYLEVEL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dirlistindexresponse
  RAISING
    /AWS1/CX_DIRACCESSDENIEDEX
    /AWS1/CX_DIRDIRECTORYNOTENBDEX
    /AWS1/CX_DIRFACETVALIDATIONEX
    /AWS1/CX_DIRINTERNALSERVICEEX
    /AWS1/CX_DIRINVALIDARNEX
    /AWS1/CX_DIRINVALIDNEXTTOKENEX
    /AWS1/CX_DIRLIMITEXCEEDEDEX
    /AWS1/CX_DIRNOTINDEXEXCEPTION
    /AWS1/CX_DIRRESOURCENOTFOUNDEX
    /AWS1/CX_DIRRETRYABLECONFLIC00
    /AWS1/CX_DIRVALIDATIONEX
    /AWS1/CX_DIRCLIENTEXC
    /AWS1/CX_DIRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_directoryarn TYPE /AWS1/DIRARN /AWS1/DIRARN

The ARN of the directory that the index exists in.

io_indexreference TYPE REF TO /AWS1/CL_DIROBJECTREFERENCE /AWS1/CL_DIROBJECTREFERENCE

The reference to the index to list.

Optional arguments:

it_rangesonindexedvalues TYPE /AWS1/CL_DIROBJECTATTRRANGE=>TT_OBJECTATTRIBUTERANGELIST TT_OBJECTATTRIBUTERANGELIST

Specifies the ranges of indexed values that you want to query.

iv_maxresults TYPE /AWS1/DIRNUMBERRESULTS /AWS1/DIRNUMBERRESULTS

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

iv_nexttoken TYPE /AWS1/DIRNEXTTOKEN /AWS1/DIRNEXTTOKEN

The pagination token.

iv_consistencylevel TYPE /AWS1/DIRCONSISTENCYLEVEL /AWS1/DIRCONSISTENCYLEVEL

The consistency level to execute the request at.

RETURNING

oo_output TYPE REF TO /aws1/cl_dirlistindexresponse /AWS1/CL_DIRLISTINDEXRESPONSE

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->listindex00(
  io_indexreference = new /aws1/cl_dirobjectreference( |string| )
  it_rangesonindexedvalues = VALUE /aws1/cl_dirobjectattrrange=>tt_objectattributerangelist(
    (
      new /aws1/cl_dirobjectattrrange(
        io_attributekey = new /aws1/cl_dirattributekey(
          iv_facetname = |string|
          iv_name = |string|
          iv_schemaarn = |string|
        )
        io_range = new /aws1/cl_dirtypedattrvalrange(
          io_endvalue = new /aws1/cl_dirtypedattrvalue(
            iv_binaryvalue = '5347567362473873563239796247513D'
            iv_booleanvalue = ABAP_TRUE
            iv_datetimevalue = '20150101000000.0000000'
            iv_numbervalue = |string|
            iv_stringvalue = |string|
          )
          io_startvalue = new /aws1/cl_dirtypedattrvalue(
            iv_binaryvalue = '5347567362473873563239796247513D'
            iv_booleanvalue = ABAP_TRUE
            iv_datetimevalue = '20150101000000.0000000'
            iv_numbervalue = |string|
            iv_stringvalue = |string|
          )
          iv_endmode = |string|
          iv_startmode = |string|
        )
      )
    )
  )
  iv_consistencylevel = |string|
  iv_directoryarn = |string|
  iv_maxresults = 123
  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_indexattachments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_indexedattributes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lo_attributekey = lo_row_3->get_key( ).
          IF lo_attributekey IS NOT INITIAL.
            lv_arn = lo_attributekey->get_schemaarn( ).
            lv_facetname = lo_attributekey->get_facetname( ).
            lv_attributename = lo_attributekey->get_name( ).
          ENDIF.
          lo_typedattributevalue = lo_row_3->get_value( ).
          IF lo_typedattributevalue IS NOT INITIAL.
            lv_stringattributevalue = lo_typedattributevalue->get_stringvalue( ).
            lv_binaryattributevalue = lo_typedattributevalue->get_binaryvalue( ).
            lv_booleanattributevalue = lo_typedattributevalue->get_booleanvalue( ).
            lv_numberattributevalue = lo_typedattributevalue->get_numbervalue( ).
            lv_datetimeattributevalue = lo_typedattributevalue->get_datetimevalue( ).
          ENDIF.
        ENDIF.
      ENDLOOP.
      lv_objectidentifier = lo_row_1->get_objectidentifier( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To list an index

DATA(lo_result) = lo_client->listindex00(
  io_indexreference = new /aws1/cl_dirobjectreference( |$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q| )
  iv_directoryarn = |arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY|
).