CloudWatchInternetMonitor / Client / get_monitor

get_monitor#

CloudWatchInternetMonitor.Client.get_monitor(**kwargs)#

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

See also: AWS API Documentation

Request Syntax

response = client.get_monitor(
    MonitorName='string'
)
Parameters:

MonitorName (string) –

[REQUIRED]

The name of the monitor.

Return type:

dict

Returns:

Response Syntax

{
    'MonitorName': 'string',
    'MonitorArn': 'string',
    'Resources': [
        'string',
    ],
    'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'ProcessingStatus': 'OK'|'INACTIVE'|'COLLECTING_DATA'|'INSUFFICIENT_DATA'|'FAULT_SERVICE'|'FAULT_ACCESS_CLOUDWATCH',
    'ProcessingStatusInfo': 'string',
    'Tags': {
        'string': 'string'
    },
    'MaxCityNetworksToMonitor': 123
}

Response Structure

  • (dict) –

    • MonitorName (string) –

      The name of the monitor.

    • MonitorArn (string) –

      The Amazon Resource Name (ARN) of the monitor.

    • Resources (list) –

      The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).

      • (string) –

    • Status (string) –

      The status of the monitor.

    • CreatedAt (datetime) –

      The time when the monitor was created.

    • ModifiedAt (datetime) –

      The last time that the monitor was modified.

    • ProcessingStatus (string) –

      The health of the data processing for the monitor.

    • ProcessingStatusInfo (string) –

      Additional information about the health of the data processing for the monitor.

    • Tags (dict) –

      The tags that have been added to monitor.

      • (string) –

        • (string) –

    • MaxCityNetworksToMonitor (integer) –

      The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored for your resources.

Exceptions

  • CloudWatchInternetMonitor.Client.exceptions.InternalServerException

  • CloudWatchInternetMonitor.Client.exceptions.AccessDeniedException

  • CloudWatchInternetMonitor.Client.exceptions.ThrottlingException

  • CloudWatchInternetMonitor.Client.exceptions.ValidationException