:doc:`FMS <../../fms>` / Paginator / ListAppsLists

*************
ListAppsLists
*************



.. py:class:: FMS.Paginator.ListAppsLists

  ::

    
    paginator = client.get_paginator('list_apps_lists')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`FMS.Client.list_apps_lists`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DefaultLists=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DefaultLists: boolean
    :param DefaultLists: 

      Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

      

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

      
      ::

        {
            'AppsLists': [
                {
                    'ListArn': 'string',
                    'ListId': 'string',
                    'ListName': 'string',
                    'AppsList': [
                        {
                            'AppName': 'string',
                            'Protocol': 'string',
                            'Port': 123
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **AppsLists** *(list) --* 

          An array of ``AppsListDataSummary`` objects.

          
          

          - *(dict) --* 

            Details of the Firewall Manager applications list.

            
            

            - **ListArn** *(string) --* 

              The Amazon Resource Name (ARN) of the applications list.

              
            

            - **ListId** *(string) --* 

              The ID of the applications list.

              
            

            - **ListName** *(string) --* 

              The name of the applications list.

              
            

            - **AppsList** *(list) --* 

              An array of ``App`` objects in the Firewall Manager applications list.

              
              

              - *(dict) --* 

                An individual Firewall Manager application.

                
                

                - **AppName** *(string) --* 

                  The application's name.

                  
                

                - **Protocol** *(string) --* 

                  The IP protocol name or number. The name can be one of ``tcp``, ``udp``, or ``icmp``. For information on possible numbers, see `Protocol Numbers <https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml>`__.

                  
                

                - **Port** *(integer) --* 

                  The application's port number, for example ``80``.

                  
            
          
        
      
    