ListMonitors

class CloudWatchInternetMonitor.Paginator.ListMonitors
paginator = client.get_paginator('list_monitors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchInternetMonitor.Client.list_monitors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    MonitorStatus='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • MonitorStatus (string) --

    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.

  • PaginationConfig (dict) --

    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.

Return type

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.