CognitoIdentityProvider / Paginator / ListGroups

ListGroups

class CognitoIdentityProvider.Paginator.ListGroups

paginator = client.get_paginator('list_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CognitoIdentityProvider.Client.list_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    UserPoolId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• UserPoolId (string) –

  [REQUIRED]

  The user pool ID for the user pool.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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 the group was last modified.

      • CreationDate (datetime) –

        The date the group was created.