update_monitor

CloudWatchInternetMonitor.Client.update_monitor(**kwargs)

Updates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a monitor.

See also: AWS API Documentation

Request Syntax

response = client.update_monitor(
    MonitorName='string',
    ResourcesToAdd=[
        'string',
    ],
    ResourcesToRemove=[
        'string',
    ],
    Status='PENDING'|'ACTIVE'|'INACTIVE'|'ERROR',
    ClientToken='string',
    MaxCityNetworksToMonitor=123
)

Parameters

• MonitorName (string) --

  [REQUIRED]

  The name of the monitor.

• ResourcesToAdd (list) --

  The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

  You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of resources.

  Note

  If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

  • (string) --
• ResourcesToRemove (list) --

  The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

  • (string) --
• Status (string) -- The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE . The following values are not accepted: PENDING , and ERROR .
• ClientToken (string) --

  A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.

  This field is autopopulated if not provided.

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

Return type

dict

Returns

Response Syntax

{
    'MonitorArn': 'string',
    'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'
}

Response Structure

• (dict) --

  • MonitorArn (string) --

    The Amazon Resource Name (ARN) of the monitor.

  • Status (string) --

    The status of a monitor.

Exceptions

• CloudWatchInternetMonitor.Client.exceptions.InternalServerException
• CloudWatchInternetMonitor.Client.exceptions.ResourceNotFoundException
• CloudWatchInternetMonitor.Client.exceptions.AccessDeniedException
• CloudWatchInternetMonitor.Client.exceptions.ThrottlingException
• CloudWatchInternetMonitor.Client.exceptions.LimitExceededException
• CloudWatchInternetMonitor.Client.exceptions.ValidationException