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

************
ListNetworks
************



.. py:class:: WickrAdminAPI.Paginator.ListNetworks

  ::

    
    paginator = client.get_paginator('list_networks')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          sortFields='string',
          sortDirection='ASC'|'DESC',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type sortFields: string
    :param sortFields: 

      The field to sort networks by. Accepted values are 'networkId' and 'networkName'. Default is 'networkId'.

      

    
    :type sortDirection: string
    :param sortDirection: 

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

      

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

      
      ::

        {
            'networks': [
                {
                    'networkId': 'string',
                    'networkName': 'string',
                    'accessLevel': 'STANDARD'|'PREMIUM',
                    'awsAccountId': 'string',
                    'networkArn': 'string',
                    'standing': 123,
                    'freeTrialExpiration': 'string',
                    'migrationState': 123,
                    'encryptionKeyArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **networks** *(list) --* 

          A list of network objects for the Amazon Web Services account.

          
          

          - *(dict) --* 

            Represents a Wickr network with all its configuration and status information.

            
            

            - **networkId** *(string) --* 

              The unique identifier of the network.

              
            

            - **networkName** *(string) --* 

              The name of the network.

              
            

            - **accessLevel** *(string) --* 

              The access level of the network (STANDARD or PREMIUM), which determines available features and capabilities.

              
            

            - **awsAccountId** *(string) --* 

              The Amazon Web Services account ID that owns the network.

              
            

            - **networkArn** *(string) --* 

              The Amazon Resource Name (ARN) of the network.

              
            

            - **standing** *(integer) --* 

              The current standing or status of the network.

              
            

            - **freeTrialExpiration** *(string) --* 

              The expiration date and time for the network's free trial period, if applicable.

              
            

            - **migrationState** *(integer) --* 

              The SSO redirect URI migration state, managed by the SSO redirect migration wizard. Values: 0 (not started), 1 (in progress), or 2 (completed).

              
            

            - **encryptionKeyArn** *(string) --* 

              The ARN of the Amazon Web Services KMS customer managed key used for encrypting sensitive data in the network.

              
        
      
        

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

          A token to resume pagination.

          
    