LISTDEVICES()`¶

About ListDevices¶

Lists the devices that Amazon Cognito has registered to the currently signed-in user. For more information about device authentication, see Working with user devices in your user pool.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_accesstoken` `TYPE /AWS1/CGPTOKENMODELTYPE` `/AWS1/CGPTOKENMODELTYPE`¶

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Optional arguments:¶

`iv_limit` `TYPE /AWS1/CGPQUERYLIMITTYPE` `/AWS1/CGPQUERYLIMITTYPE`¶

The maximum number of devices that you want Amazon Cognito to return in the response.

`iv_paginationtoken` `TYPE /AWS1/CGPSRCHPAGINATIONTOKTYPE` `/AWS1/CGPSRCHPAGINATIONTOKTYPE`¶

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgplistdevicesrsp` `/AWS1/CL_CGPLISTDEVICESRSP`¶

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_cgp~listdevices(
  iv_accesstoken = |string|
  iv_limit = 123
  iv_paginationtoken = |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_devices( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_devicekeytype = lo_row_1->get_devicekey( ).
      LOOP AT lo_row_1->get_deviceattributes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_attributenametype = lo_row_3->get_name( ).
          lv_attributevaluetype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_datetype = lo_row_1->get_devicecreatedate( ).
      lv_datetype = lo_row_1->get_devicelastmodifieddate( ).
      lv_datetype = lo_row_1->get_devicelastauthntctddate( ).
    ENDIF.
  ENDLOOP.
  lv_searchpaginationtokenty = lo_result->get_paginationtoken( ).
ENDIF.

/AWS1/IF_CGP=>LISTDEVICES()¶