:doc:`NetworkFlowMonitor <../../networkflowmonitor>` / Client / list_monitors

*************
list_monitors
*************



.. py:method:: NetworkFlowMonitor.Client.list_monitors(**kwargs)

  

  List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the ``STATUS`` parameter.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/ListMonitors>`_  


  **Request Syntax**
  ::

    response = client.list_monitors(
        nextToken='string',
        maxResults=123,
        monitorStatus='PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING'
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. You receive this token from a previous call.

    

  
  :type maxResults: integer
  :param maxResults: 

    The number of query results that you want to return with this call.

    

  
  :type monitorStatus: string
  :param monitorStatus: 

    The status of a monitor. The status can be one of the following

     

    
    * ``PENDING``: The monitor is in the process of being created.
     
    * ``ACTIVE``: The monitor is active.
     
    * ``INACTIVE``: The monitor is inactive.
     
    * ``ERROR``: Monitor creation failed due to an error.
     
    * ``DELETING``: The monitor is in the process of being deleted.
    

    

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

    
    ::

      {
          'monitors': [
              {
                  'monitorArn': 'string',
                  'monitorName': 'string',
                  'monitorStatus': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **monitors** *(list) --* 

        The monitors that are in an account.

        
        

        - *(dict) --* 

          A summary of information about a monitor, including the ARN, the name, and the status.

          
          

          - **monitorArn** *(string) --* 

            The Amazon Resource Name (ARN) of the monitor.

            
          

          - **monitorName** *(string) --* 

            The name of the monitor.

            
          

          - **monitorStatus** *(string) --* 

            The status of a monitor. The status can be one of the following

             

            
            * ``PENDING``: The monitor is in the process of being created.
             
            * ``ACTIVE``: The monitor is active.
             
            * ``INACTIVE``: The monitor is inactive.
             
            * ``ERROR``: Monitor creation failed due to an error.
             
            * ``DELETING``: The monitor is in the process of being deleted.
            

            
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results. You receive this token from a previous call.

        
  
  **Exceptions**
  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.InternalServerException`

  