CloudWatchInternetMonitor / Client / update_monitor

update_monitor

CloudWatchInternetMonitor.Client.update_monitor(**kwargs)

Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or internet service providers), to add or remove resources, or to change the status of the monitor. Note that you can’t change the name of a monitor.

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

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,
    InternetMeasurementsLogDelivery={
        'S3Config': {
            'BucketName': 'string',
            'BucketPrefix': 'string',
            'LogDeliveryStatus': 'ENABLED'|'DISABLED'
        }
    },
    TrafficPercentageToMonitor=123,
    HealthEventsConfig={
        'AvailabilityScoreThreshold': 123.0,
        'PerformanceScoreThreshold': 123.0
    }
)

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-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the network or ASN, such as an internet service provider, that clients access the resources through.

• InternetMeasurementsLogDelivery (dict) –

  Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

  • S3Config (dict) –

    The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.

    • BucketName (string) –

      The Amazon S3 bucket name.

    • BucketPrefix (string) –

      The Amazon S3 bucket prefix.

    • LogDeliveryStatus (string) –

      The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

• TrafficPercentageToMonitor (integer) – The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

• HealthEventsConfig (dict) –

  The list of health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates a health event when there’s an internet issue that affects your application end users.

  • AvailabilityScoreThreshold (float) –

    The health event threshold percentage set for availability scores.

  • PerformanceScoreThreshold (float) –

    The health event threshold percentage set for performance scores.

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