:doc:`WickrAdminAPI <../../wickr>` / Paginator / ListGuestUsers

**************
ListGuestUsers
**************



.. py:class:: WickrAdminAPI.Paginator.ListGuestUsers

  ::

    
    paginator = client.get_paginator('list_guest_users')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WickrAdminAPI.Client.list_guest_users`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wickr-2024-02-01/ListGuestUsers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          networkId='string',
          sortDirection='ASC'|'DESC',
          sortFields='string',
          username='string',
          billingPeriod='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type networkId: string
    :param networkId: **[REQUIRED]** 

      The ID of the Wickr network from which to list guest users.

      

    
    :type sortDirection: string
    :param sortDirection: 

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

      

    
    :type sortFields: string
    :param sortFields: 

      The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

      

    
    :type username: string
    :param username: 

      Filter results to only include guest users with usernames matching this value.

      

    
    :type billingPeriod: string
    :param billingPeriod: 

      Filter results to only include guest users from this billing period (e.g., '2024-01').

      

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

      
      ::

        {
            'guestlist': [
                {
                    'billingPeriod': 'string',
                    'username': 'string',
                    'usernameHash': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **guestlist** *(list) --* 

          A list of guest user objects within the current page.

          
          

          - *(dict) --* 

            Represents a guest user who has accessed the network from a federated Wickr network.

            
            

            - **billingPeriod** *(string) --* 

              The billing period when this guest user accessed the network (e.g., '2024-01').

              
            

            - **username** *(string) --* 

              The username of the guest user.

              
            

            - **usernameHash** *(string) --* 

              The unique username hash identifier for the guest user.

              
        
      
        

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

          A token to resume pagination.

          
    