CloudWatchInternetMonitor / Client / list_monitors

list_monitors#

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

Request Syntax

response = client.list_monitors(
    NextToken='string',
    MaxResults=123,
    MonitorStatus='string',
    IncludeLinkedAccounts=True|False
)
Parameters:

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

  • MaxResults (integer) – The number of monitor objects that you want to return with this call.

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

  • IncludeLinkedAccounts (boolean) – 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 in the Amazon CloudWatch Internet Monitor User Guide.

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'
        },
    ],
    '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