CloudWatchNetworkMonitor / Paginator / ListMonitors


class CloudWatchNetworkMonitor.Paginator.ListMonitors#
paginator = client.get_paginator('list_monitors')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • state (string) – The list of all monitors and their states.

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



Response Syntax

    'monitors': [
            'monitorArn': 'string',
            'monitorName': 'string',
            'state': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
            'aggregationPeriod': 123,
            'tags': {
                'string': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • monitors (list) –

      Lists individual details about each of your monitors.

      • (dict) –

        Displays summary information about a monitor.

        • monitorArn (string) –

          The ARN of the monitor.

        • monitorName (string) –

          The name of the monitor.

        • state (string) –

          The state of the monitor.

        • aggregationPeriod (integer) –

          The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.

        • tags (dict) –

          The list of key-value pairs assigned to the monitor.

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.