:doc:`FMS <../../fms>` / Client / list_apps_lists

***************
list_apps_lists
***************



.. py:method:: FMS.Client.list_apps_lists(**kwargs)

  

  Returns an array of ``AppsListDataSummary`` objects.

  

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


  **Request Syntax**
  ::

    response = client.list_apps_lists(
        DefaultLists=True|False,
        NextToken='string',
        MaxResults=123
    )
    
  :type DefaultLists: boolean
  :param DefaultLists: 

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

    

  
  :type NextToken: string
  :param NextToken: 

    If you specify a value for ``MaxResults`` in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

    

  
  :type MaxResults: integer
  :param MaxResults: **[REQUIRED]** 

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a ``NextToken`` value that you can use in a subsequent call to get the next batch of objects.

     

    If you don't specify this, Firewall Manager returns all available objects.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AppsLists': [
              {
                  'ListArn': 'string',
                  'ListId': 'string',
                  'ListName': 'string',
                  'AppsList': [
                      {
                          'AppName': 'string',
                          'Protocol': 'string',
                          'Port': 123
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **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``.

                
          
        
      
    
      

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

        If you specify a value for ``MaxResults`` in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

        
  
  **Exceptions**
  
  *   :py:class:`FMS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`FMS.Client.exceptions.InvalidOperationException`

  
  *   :py:class:`FMS.Client.exceptions.LimitExceededException`

  
  *   :py:class:`FMS.Client.exceptions.InternalErrorException`

  