:doc:`Chime <../../chime>` / Paginator / ListUsers

*********
ListUsers
*********



.. py:class:: Chime.Paginator.ListUsers

  ::

    
    paginator = client.get_paginator('list_users')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Chime.Client.list_users`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AccountId='string',
          UserEmail='string',
          UserType='PrivateUser'|'SharedDevice',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AccountId: string
    :param AccountId: **[REQUIRED]** 

      The Amazon Chime account ID.

      

    
    :type UserEmail: string
    :param UserEmail: 

      Optional. The user email address used to filter results. Maximum 1.

      

    
    :type UserType: string
    :param UserType: 

      The user type.

      

    
    :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',
                    'AccountId': 'string',
                    'PrimaryEmail': 'string',
                    'PrimaryProvisionedNumber': 'string',
                    'DisplayName': 'string',
                    'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
                    'UserType': 'PrivateUser'|'SharedDevice',
                    'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
                    'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
                    'RegisteredOn': datetime(2015, 1, 1),
                    'InvitedOn': datetime(2015, 1, 1),
                    'AlexaForBusinessMetadata': {
                        'IsAlexaForBusinessEnabled': True|False,
                        'AlexaForBusinessRoomArn': 'string'
                    },
                    'PersonalPIN': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Users** *(list) --* 

          List of users and user details.

          
          

          - *(dict) --* 

            The user on the Amazon Chime account.

            
            

            - **UserId** *(string) --* 

              The user ID.

              
            

            - **AccountId** *(string) --* 

              The Amazon Chime account ID.

              
            

            - **PrimaryEmail** *(string) --* 

              The primary email address of the user.

              
            

            - **PrimaryProvisionedNumber** *(string) --* 

              The primary phone number associated with the user.

              
            

            - **DisplayName** *(string) --* 

              The display name of the user.

              
            

            - **LicenseType** *(string) --* 

              The license type for the user.

              
            

            - **UserType** *(string) --* 

              The user type.

              
            

            - **UserRegistrationStatus** *(string) --* 

              The user registration status.

              
            

            - **UserInvitationStatus** *(string) --* 

              The user invite status.

              
            

            - **RegisteredOn** *(datetime) --* 

              Date and time when the user is registered, in ISO 8601 format.

              
            

            - **InvitedOn** *(datetime) --* 

              Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

              
            

            - **AlexaForBusinessMetadata** *(dict) --* 

              The Alexa for Business metadata.

              
              

              - **IsAlexaForBusinessEnabled** *(boolean) --* 

                Starts or stops Alexa for Business.

                
              

              - **AlexaForBusinessRoomArn** *(string) --* 

                The ARN of the room resource.

                
          
            

            - **PersonalPIN** *(string) --* 

              The user's personal meeting PIN.

              
        
      
    