CognitoIdentityProvider / Client / list_groups

list_groups#

CognitoIdentityProvider.Client.list_groups(**kwargs)#

Lists the groups associated with a user pool.

Note

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

Request Syntax

response = client.list_groups(
    UserPoolId='string',
    Limit=123,
    NextToken='string'
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID for the user pool.
Limit (integer) – The limit of the request to list groups.
NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Groups': [
        {
            'GroupName': 'string',
            'UserPoolId': 'string',
            'Description': 'string',
            'RoleArn': 'string',
            'Precedence': 123,
            'LastModifiedDate': datetime(2015, 1, 1),
            'CreationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Groups (list) –
  
  The group objects for the groups.
  - (dict) –
    
    The group type.
    - GroupName (string) –
      
      The name of the group.
    - UserPoolId (string) –
      
      The user pool ID for the user pool.
    - Description (string) –
      
      A string containing the description of the group.
    - RoleArn (string) –
      
      The role Amazon Resource Name (ARN) for the group.
    - Precedence (integer) –
      
      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.
    - LastModifiedDate (datetime) –
      
      The date and time, in ISO 8601 format, when the item was modified.
    - CreationDate (datetime) –
      
      The date and time, in ISO 8601 format, when the item was created.
- NextToken (string) –
  
  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.