CloudWatchNetworkMonitor / Client / update_monitor

update_monitor#

CloudWatchNetworkMonitor.Client.update_monitor(**kwargs)#

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.

See also: AWS API Documentation

Request Syntax

response = client.update_monitor(
    monitorName='string',
    aggregationPeriod=123
)
Parameters:

  • monitorName (string) –

    [REQUIRED]

    The name of the monitor to update.

  • aggregationPeriod (integer) –

    [REQUIRED]

    The aggregation time, in seconds, to change to. This must be either 30 or 60.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • monitorArn (string) –

      The ARN of the monitor that was updated.

    • monitorName (string) –

      The name of the monitor that was updated.

    • state (string) –

      The state of the updated monitor.

    • aggregationPeriod (integer) –

      The changed aggregation period.

    • tags (dict) –

      The list of key-value pairs associated with the monitor.

      • (string) –

        • (string) –

Exceptions