Skip to content

/AWS1/CL_CGP=>LISTGROUPS()

About ListGroups

Lists the groups associated with a user pool.

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 for the user pool.

Optional arguments:

IV_LIMIT TYPE /AWS1/CGPQUERYLIMITTYPE /AWS1/CGPQUERYLIMITTYPE

The limit of the request to list groups.

IV_NEXTTOKEN TYPE /AWS1/CGPPAGINATIONKEY /AWS1/CGPPAGINATIONKEY

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CGPLISTGROUPSRESPONSE /AWS1/CL_CGPLISTGROUPSRESPONSE