Skip to content

/AWS1/IF_IOT=>LISTTHINGS()

About ListThings

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.

Requires permission to access the ListThings action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

Method Signature

METHODS /AWS1/IF_IOT~LISTTHINGS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOTREGISTRYMAXRESULTS OPTIONAL
    !IV_ATTRIBUTENAME TYPE /AWS1/IOTATTRIBUTENAME OPTIONAL
    !IV_ATTRIBUTEVALUE TYPE /AWS1/IOTATTRIBUTEVALUE OPTIONAL
    !IV_THINGTYPENAME TYPE /AWS1/IOTTHINGTYPENAME OPTIONAL
    !IV_USEPREFIXATTRIBUTEVALUE TYPE /AWS1/IOTUSEPREFIXATTRVALUE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotlistthingsresponse
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /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 in this operation.

iv_attributename TYPE /AWS1/IOTATTRIBUTENAME /AWS1/IOTATTRIBUTENAME

The attribute name used to search for things.

iv_attributevalue TYPE /AWS1/IOTATTRIBUTEVALUE /AWS1/IOTATTRIBUTEVALUE

The attribute value used to search for things.

iv_thingtypename TYPE /AWS1/IOTTHINGTYPENAME /AWS1/IOTTHINGTYPENAME

The name of the thing type used to search for things.

iv_useprefixattributevalue TYPE /AWS1/IOTUSEPREFIXATTRVALUE /AWS1/IOTUSEPREFIXATTRVALUE

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotlistthingsresponse /AWS1/CL_IOTLISTTHINGSRESPONSE

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->listthings(
  iv_attributename = |string|
  iv_attributevalue = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_thingtypename = |string|
  iv_useprefixattributevalue = 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_things( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_thingname = lo_row_1->get_thingname( ).
      lv_thingtypename = lo_row_1->get_thingtypename( ).
      lv_thingarn = lo_row_1->get_thingarn( ).
      LOOP AT lo_row_1->get_attributes( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_attributevalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_version = lo_row_1->get_version( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.