:doc:`WorkDocs <../../workdocs>` / Paginator / DescribeUsers

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



.. py:class:: WorkDocs.Paginator.DescribeUsers

  ::

    
    paginator = client.get_paginator('describe_users')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AuthenticationToken='string',
          OrganizationId='string',
          UserIds='string',
          Query='string',
          Include='ALL'|'ACTIVE_PENDING',
          Order='ASCENDING'|'DESCENDING',
          Sort='USER_NAME'|'FULL_NAME'|'STORAGE_LIMIT'|'USER_STATUS'|'STORAGE_USED',
          Fields='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AuthenticationToken: string
    :param AuthenticationToken: 

      Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

      

    
    :type OrganizationId: string
    :param OrganizationId: 

      The ID of the organization.

      

    
    :type UserIds: string
    :param UserIds: 

      The IDs of the users.

      

    
    :type Query: string
    :param Query: 

      A query to filter users by user name. Remember the following about the ``Userids`` and ``Query`` parameters:

       

      
      * If you don't use either parameter, the API returns a paginated list of all users on the site.
       
      * If you use both parameters, the API ignores the ``Query`` parameter.
       
      * The ``Userid`` parameter only returns user names that match a corresponding user ID.
       
      * The ``Query`` parameter runs a "prefix" search for users by the ``GivenName``, ``SurName``, or ``UserName`` fields included in a `CreateUser <https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html>`__ API call. For example, querying on ``Ma`` returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on ``Ma J`` only returns Mateo Jackson.
      

      

    
    :type Include: string
    :param Include: 

      The state of the users. Specify "ALL" to include inactive users.

      

    
    :type Order: string
    :param Order: 

      The order for the results.

      

    
    :type Sort: string
    :param Sort: 

      The sorting criteria.

      

    
    :type Fields: string
    :param Fields: 

      A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

      

    
    :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': [
                {
                    'Id': 'string',
                    'Username': 'string',
                    'EmailAddress': 'string',
                    'GivenName': 'string',
                    'Surname': 'string',
                    'OrganizationId': 'string',
                    'RootFolderId': 'string',
                    'RecycleBinFolderId': 'string',
                    'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
                    'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
                    'CreatedTimestamp': datetime(2015, 1, 1),
                    'ModifiedTimestamp': datetime(2015, 1, 1),
                    'TimeZoneId': 'string',
                    'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
                    'Storage': {
                        'StorageUtilizedInBytes': 123,
                        'StorageRule': {
                            'StorageAllocatedInBytes': 123,
                            'StorageType': 'UNLIMITED'|'QUOTA'
                        }
                    }
                },
            ],
            'TotalNumberOfUsers': 123,
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The users.

          
          

          - *(dict) --* 

            Describes a user.

            
            

            - **Id** *(string) --* 

              The ID of the user.

              
            

            - **Username** *(string) --* 

              The login name of the user.

              
            

            - **EmailAddress** *(string) --* 

              The email address of the user.

              
            

            - **GivenName** *(string) --* 

              The given name of the user.

              
            

            - **Surname** *(string) --* 

              The surname of the user.

              
            

            - **OrganizationId** *(string) --* 

              The ID of the organization.

              
            

            - **RootFolderId** *(string) --* 

              The ID of the root folder.

              
            

            - **RecycleBinFolderId** *(string) --* 

              The ID of the recycle bin folder.

              
            

            - **Status** *(string) --* 

              The status of the user.

              
            

            - **Type** *(string) --* 

              The type of user.

              
            

            - **CreatedTimestamp** *(datetime) --* 

              The time when the user was created.

              
            

            - **ModifiedTimestamp** *(datetime) --* 

              The time when the user was modified.

              
            

            - **TimeZoneId** *(string) --* 

              The time zone ID of the user.

              
            

            - **Locale** *(string) --* 

              The locale of the user.

              
            

            - **Storage** *(dict) --* 

              The storage for the user.

              
              

              - **StorageUtilizedInBytes** *(integer) --* 

                The amount of storage used, in bytes.

                
              

              - **StorageRule** *(dict) --* 

                The storage for a user.

                
                

                - **StorageAllocatedInBytes** *(integer) --* 

                  The amount of storage allocated, in bytes.

                  
                

                - **StorageType** *(string) --* 

                  The type of storage.

                  
            
          
        
      
        

        - **TotalNumberOfUsers** *(integer) --* 

          The total number of users included in the results.

          
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    