ElastiCache / Paginator / DescribeUsers


class ElastiCache.Paginator.DescribeUsers#
paginator = client.get_paginator('describe_users')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • Engine (string) – The Redis engine.

  • UserId (string) – The ID of the user.

  • Filters (list) –

    Filter to determine the list of User IDs to return.

    • (dict) –

      Used to streamline results of a search based on the property being filtered.

      • Name (string) – [REQUIRED]

        The property being filtered. For example, UserId.

      • Values (list) – [REQUIRED]

        The property values to filter on. For example, “user-123”.

        • (string) –

  • 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:



Response Syntax

    'Users': [
            'UserId': 'string',
            'UserName': 'string',
            'Status': 'string',
            'Engine': 'string',
            'MinimumEngineVersion': 'string',
            'AccessString': 'string',
            'UserGroupIds': [
            'Authentication': {
                'Type': 'password'|'no-password'|'iam',
                'PasswordCount': 123
            'ARN': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • Users (list) –

      A list of users.

      • (dict) –

        • UserId (string) –

          The ID of the user.

        • UserName (string) –

          The username of the user.

        • Status (string) –

          Indicates the user status. Can be “active”, “modifying” or “deleting”.

        • Engine (string) –

          The current supported value is Redis.

        • MinimumEngineVersion (string) –

          The minimum engine version required, which is Redis 6.0

        • AccessString (string) –

          Access permissions string used for this user.

        • UserGroupIds (list) –

          Returns a list of the user group IDs the user belongs to.

          • (string) –

        • Authentication (dict) –

          Denotes whether the user requires a password to authenticate.

          • Type (string) –

            Indicates whether the user requires a password to authenticate.

          • PasswordCount (integer) –

            The number of passwords belonging to the user. The maximum is two.

        • ARN (string) –

          The Amazon Resource Name (ARN) of the user.

    • NextToken (string) –

      A token to resume pagination.