LISTTHINGGROUPS()`¶

About ListThingGroups¶

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

Method Signature¶

METHODS /AWS1/IF_IOT~LISTTHINGGROUPS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOTREGISTRYMAXRESULTS OPTIONAL
    !IV_PARENTGROUP TYPE /AWS1/IOTTHINGGROUPNAME OPTIONAL
    !IV_NAMEPREFIXFILTER TYPE /AWS1/IOTTHINGGROUPNAME OPTIONAL
    !IV_RECURSIVE TYPE /AWS1/IOTRECURSIVEWITHOUTDEF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotlistthinggroupsrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/IOTNEXTTOKEN` `/AWS1/IOTNEXTTOKEN`¶

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

`iv_maxresults` `TYPE /AWS1/IOTREGISTRYMAXRESULTS` `/AWS1/IOTREGISTRYMAXRESULTS`¶

The maximum number of results to return at one time.

`iv_parentgroup` `TYPE /AWS1/IOTTHINGGROUPNAME` `/AWS1/IOTTHINGGROUPNAME`¶

A filter that limits the results to those with the specified parent group.

`iv_nameprefixfilter` `TYPE /AWS1/IOTTHINGGROUPNAME` `/AWS1/IOTTHINGGROUPNAME`¶

A filter that limits the results to those with the specified name prefix.

`iv_recursive` `TYPE /AWS1/IOTRECURSIVEWITHOUTDEF` `/AWS1/IOTRECURSIVEWITHOUTDEF`¶

If true, return child groups as well.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iotlistthinggroupsrsp` `/AWS1/CL_IOTLISTTHINGGROUPSRSP`¶

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->listthinggroups(
  iv_maxresults = 123
  iv_nameprefixfilter = |string|
  iv_nexttoken = |string|
  iv_parentgroup = |string|
  iv_recursive = ABAP_TRUE
).

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_thinggroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_thinggroupname = lo_row_1->get_groupname( ).
      lv_thinggrouparn = lo_row_1->get_grouparn( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOT=>LISTTHINGGROUPS()¶