:doc:`CloudWatchInternetMonitor <../../internetmonitor>` / Client / list_monitors

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



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

  

  Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListMonitors>`_  


  **Request Syntax**
  ::

    response = client.list_monitors(
        NextToken='string',
        MaxResults=123,
        MonitorStatus='string',
        IncludeLinkedAccounts=True|False
    )
    
  :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 monitor objects that you want to return with this call.

    

  
  :type MonitorStatus: string
  :param MonitorStatus: 

    The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.

     

    For information about the statuses for a monitor, see `Monitor <https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html>`__.

    

  
  :type IncludeLinkedAccounts: boolean
  :param IncludeLinkedAccounts: 

    A boolean option that you can set to ``TRUE`` to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see `Internet Monitor cross-account observability <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html>`__ in the Amazon CloudWatch Internet Monitor User Guide.

    

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

    
    ::

      {
          'Monitors': [
              {
                  'MonitorName': 'string',
                  'MonitorArn': 'string',
                  'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR',
                  'ProcessingStatus': 'OK'|'INACTIVE'|'COLLECTING_DATA'|'INSUFFICIENT_DATA'|'FAULT_SERVICE'|'FAULT_ACCESS_CLOUDWATCH'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Monitors** *(list) --* 

        A list of monitors.

        
        

        - *(dict) --* 

          The description of and information about a monitor in Amazon CloudWatch Internet Monitor.

          
          

          - **MonitorName** *(string) --* 

            The name of the monitor.

            
          

          - **MonitorArn** *(string) --* 

            The Amazon Resource Name (ARN) of the monitor.

            
          

          - **Status** *(string) --* 

            The status of a monitor.

            
          

          - **ProcessingStatus** *(string) --* 

            The health of data processing for the monitor.

            
      
    
      

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

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

        
  
  **Exceptions**
  
  *   :py:class:`CloudWatchInternetMonitor.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`CloudWatchInternetMonitor.Client.exceptions.ValidationException`

  