Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "Limit": 0,
    "NextToken": "string"
}'
Response Response Example
200 - Example 1
{
    "Groups": [],
    "NextToken": "string"
}

Request

Query Params
Limit
string 
optional
Pagination limit
NextToken
string 
optional
Pagination token
Header Params
X-Amz-Target
string 
required
Body Params application/json
UserPoolId
string 
required
The user pool ID for the user pool.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
Limit
integer 
optional
The limit of the request to list groups.
>= 0<= 60
NextToken
string 
optional
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.
>= 1 characters
Match pattern:
[\S]+
Examples

Responses

🟢200Success
application/json
Body
Groups
array[object (GroupType) {7}] 
optional
The group objects for the groups.
GroupName
string 
optional
The name of the group.
>= 1 characters<= 128 characters
Match pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
UserPoolId
string 
optional
The user pool ID for the user pool.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
Description
string 
optional
A string containing the description of the group.
<= 2048 characters
RoleArn
string 
optional
The role Amazon Resource Name (ARN) for the group.
>= 20 characters<= 2048 characters
Match pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Precedence
integer 
optional
A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher ornull Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.
The default Precedence value is null.
>= 0
LastModifiedDate
string <date-time>
optional
The date the group was last modified.
CreationDate
string <date-time>
optional
The date the group was created.
NextToken
string 
optional
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.
>= 1 characters
Match pattern:
[\S]+
🟠480InvalidParameterException
🟠481ResourceNotFoundException
🟠482TooManyRequestsException
🟠483NotAuthorizedException
🟠484InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with