:doc:`ElastiCache <../../elasticache>` / Paginator / DescribeUsers

*************
DescribeUsers
*************



.. py:class:: ElastiCache.Paginator.DescribeUsers

  ::

    
    paginator = client.get_paginator('describe_users')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_users`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeUsers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Engine='string',
          UserId='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Engine: string
    :param Engine: 

      The engine.

      

    
    :type UserId: string
    :param UserId: 

      The ID of the user.

      

    
    :type Filters: list
    :param Filters: 

      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) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Users': [
                {
                    'UserId': 'string',
                    'UserName': 'string',
                    'Status': 'string',
                    'Engine': 'string',
                    'MinimumEngineVersion': 'string',
                    'AccessString': 'string',
                    'UserGroupIds': [
                        'string',
                    ],
                    '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 options are valkey or redis.

              
            

            - **MinimumEngineVersion** *(string) --* 

              The minimum engine version required, which is Redis OSS 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.

          
    