ElastiCache / Paginator / DescribeUserGroups

DescribeUserGroups

class ElastiCache.Paginator.DescribeUserGroups

paginator = client.get_paginator('describe_user_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ElastiCache.Client.describe_user_groups().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• UserGroupId (string) – The ID of the user group.

• 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

{
    'UserGroups': [
        {
            'UserGroupId': 'string',
            'Status': 'string',
            'Engine': 'string',
            'UserIds': [
                'string',
            ],
            'MinimumEngineVersion': 'string',
            'PendingChanges': {
                'UserIdsToRemove': [
                    'string',
                ],
                'UserIdsToAdd': [
                    'string',
                ]
            },
            'ReplicationGroups': [
                'string',
            ],
            'ARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • UserGroups (list) –

    Returns a list of user groups.

    • (dict) –

      • UserGroupId (string) –

        The ID of the user group.

      • Status (string) –

        Indicates user group status. Can be “creating”, “active”, “modifying”, “deleting”.

      • Engine (string) –

        The current supported value is Redis.

      • UserIds (list) –

        The list of user IDs that belong to the user group.

        • (string) –

      • MinimumEngineVersion (string) –

        The minimum engine version required, which is Redis 6.0

      • PendingChanges (dict) –

        A list of updates being applied to the user group.

        • UserIdsToRemove (list) –

          The list of user IDs to remove.

          • (string) –

        • UserIdsToAdd (list) –

          The list of user IDs to add.

          • (string) –

      • ReplicationGroups (list) –

        A list of replication groups that the user group can access.

        • (string) –

      • ARN (string) –

        The Amazon Resource Name (ARN) of the user group.

  • NextToken (string) –

    A token to resume pagination.