:doc:`CloudWatchInternetMonitor <../../internetmonitor>` / Paginator / ListMonitors

************
ListMonitors
************



.. py:class:: CloudWatchInternetMonitor.Paginator.ListMonitors

  ::

    
    paginator = client.get_paginator('list_monitors')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchInternetMonitor.Client.list_monitors`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          MonitorStatus='string',
          IncludeLinkedAccounts=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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.

      

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

      
      ::

        {
            'Monitors': [
                {
                    'MonitorName': 'string',
                    'MonitorArn': 'string',
                    'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR',
                    'ProcessingStatus': 'OK'|'INACTIVE'|'COLLECTING_DATA'|'INSUFFICIENT_DATA'|'FAULT_SERVICE'|'FAULT_ACCESS_CLOUDWATCH'
                },
            ],
            
        }
        
      **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.

              
        
      
    