Skip to content

/AWS1/CL_CGP=>ADMINLISTDEVICES()

About AdminListDevices

Lists devices, as an administrator.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Method Signature

IMPORTING

Required arguments:

IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The user pool ID.

IV_USERNAME TYPE /AWS1/CGPUSERNAMETYPE /AWS1/CGPUSERNAMETYPE

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Optional arguments:

IV_LIMIT TYPE /AWS1/CGPQUERYLIMITTYPE /AWS1/CGPQUERYLIMITTYPE

The limit of the devices request.

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_CGPADMINLISTDEVSRSP /AWS1/CL_CGPADMINLISTDEVSRSP