UpdateMonitorInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-update-monitor-input-schema.json",
  "title": "UpdateMonitorInput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-monitors-api-openapi.yml#/components/schemas/UpdateMonitorInput",
  "type": "object",
  "properties": {
    "MonitorName": {
      "type": "string",
      "description": "The name of the monitor."
    },
    "ResourcesToAdd": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories. You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources. If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity."
    },
    "ResourcesToRemove": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)."
    },
    "Status": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "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."
    },
    "MaxCityNetworksToMonitor": {
      "type": "integer",
      "description": "The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs."
    },
    "InternetMeasurementsLogDelivery": {
      "$ref": "#/$defs/InternetMeasurementsLogDelivery"
    },
    "TrafficPercentageToMonitor": {
      "type": "integer",
      "description": "The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set. To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide."
    },
    "HealthEventsConfig": {
      "$ref": "#/$defs/HealthEventsConfig"
    }
  },
  "required": [
    "MonitorName"
  ],
  "$defs": {
    "HealthEventsConfig": {
      "type": "object",
      "properties": {
        "AvailabilityScoreThreshold": {
          "type": "number",
          "description": "The health event threshold percentage set for availability scores."
        },
        "PerformanceScoreThreshold": {
          "type": "number",
          "description": "The health event threshold percentage set for performance scores."
        },
        "AvailabilityLocalHealthEventsConfig": {
          "$ref": "#/$defs/LocalHealthEventsConfig"
        },
        "PerformanceLocalHealthEventsConfig": {
          "$ref": "#/$defs/LocalHealthEventsConfig"
        }
      }
    },
    "InternetMeasurementsLogDelivery": {
      "type": "object",
      "properties": {
        "S3Config": {
          "$ref": "#/$defs/S3Config"
        }
      }
    },
    "LocalHealthEventsConfig": {
      "type": "object",
      "properties": {
        "Status": {
          "type": "string",
          "description": "The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED."
        },
        "HealthScoreThreshold": {
          "type": "number",
          "description": "The health event threshold percentage set for a local health score."
        },
        "MinTrafficImpact": {
          "type": "number",
          "description": "The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score. If you don't set a minimum traffic impact threshold, the default value is 0.1%."
        }
      }
    },
    "S3Config": {
      "type": "object",
      "properties": {
        "BucketName": {
          "type": "string",
          "description": "The Amazon S3 bucket name."
        },
        "BucketPrefix": {
          "type": "string",
          "description": "The Amazon S3 bucket prefix."
        },
        "LogDeliveryStatus": {
          "type": "string",
          "description": "The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket."
        }
      }
    }
  }
}