CognitoIdentityProvider / Paginator / ListUsersInGroup

ListUsersInGroup

class CognitoIdentityProvider.Paginator.ListUsersInGroup

paginator = client.get_paginator('list_users_in_group')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• UserPoolId (string) –

  [REQUIRED]

  The ID of the user pool where you want to view the membership of the requested group.

• GroupName (string) –

  [REQUIRED]

  The name of the group that you want to query for user membership.

• 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

{
    'Users': [
        {
            'Username': 'string',
            'Attributes': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'UserCreateDate': datetime(2015, 1, 1),
            'UserLastModifiedDate': datetime(2015, 1, 1),
            'Enabled': True|False,
            'UserStatus': 'UNCONFIRMED'|'CONFIRMED'|'ARCHIVED'|'COMPROMISED'|'UNKNOWN'|'RESET_REQUIRED'|'FORCE_CHANGE_PASSWORD'|'EXTERNAL_PROVIDER',
            'MFAOptions': [
                {
                    'DeliveryMedium': 'SMS'|'EMAIL',
                    'AttributeName': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Users (list) –

    An array of users who are members in the group, and their attributes.

    • (dict) –

      A user profile in a Amazon Cognito user pool.

      • Username (string) –

        The user’s username.

      • Attributes (list) –

        Names and values of a user’s attributes, for example email.

        • (dict) –

          The name and value of a user attribute.

          • Name (string) –

            The name of the attribute, for example email or custom:department.

            In some older user pools, the regex pattern for acceptable values of this parameter is [\p{L}\p{M}\p{S}\p{N}\p{P}]+. Older pools will eventually be updated to use the new pattern. Affected user pools are those created before May 2024 in US East (N. Virginia), US East (Ohio), US West (N. California), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), Middle East (Bahrain), and South America (São Paulo).

          • Value (string) –

            The value of the attribute.

      • UserCreateDate (datetime) –

        The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      • UserLastModifiedDate (datetime) –

        The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      • Enabled (boolean) –

        Indicates whether the user’s account is enabled or disabled.

      • UserStatus (string) –

        The user status. This can be one of the following:

        • UNCONFIRMED: User has been created but not confirmed.

        • CONFIRMED: User has been confirmed.

        • EXTERNAL_PROVIDER: User signed in with a third-party IdP.

        • RESET_REQUIRED: User is confirmed, but the user must request a code and reset their password before they can sign in.

        • FORCE_CHANGE_PASSWORD: The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.

        The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

      • MFAOptions (list) –

        The user’s MFA configuration.

        • (dict) –

          This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

          • DeliveryMedium (string) –

            The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

          • AttributeName (string) –

            The attribute name of the MFA option type. The only valid value is phone_number.