openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 78.6 kB

JSON

{"openapi":"3.0.0","info":{"version":"2021-06-03","x-release":"v4","title":"Amazon CloudWatch Internet Monitor","description":"Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users. It can reduce the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs. Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem. To use Internet Monitor, you create a monitor and associate your application's resources with it - VPCs, NLBs, CloudFront distributions, or WorkSpaces directories - so Internet Monitor can determine where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and ASNs (typically, internet service providers or ISPs) that communicate with your application. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html\">Using Amazon CloudWatch Internet Monitor</a> in the Amazon CloudWatch User Guide.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"internetmonitor","x-aws-signingName":"internetmonitor","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/internetmonitor-2021-06-03.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/internetmonitor/"},"servers":[{"url":"http://internetmonitor.{region}.api.aws","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CloudWatch Internet Monitor multi-region endpoint"},{"url":"https://internetmonitor.{region}.api.aws","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CloudWatch Internet Monitor multi-region endpoint"},{"url":"http://internetmonitor.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CloudWatch Internet Monitor endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://internetmonitor.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CloudWatch Internet Monitor endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v20210603/Monitors":{"post":{"operationId":"CreateMonitor","description":"Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html\">Using Amazon CloudWatch Internet Monitor</a> in the Amazon CloudWatch User Guide. When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html\">Choosing a city-network maximum value</a> in the Amazon CloudWatch User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMonitorOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MonitorName"],"properties":{"MonitorName":{"description":"The name of the monitor. ","type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255},"Resources":{"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. <note> If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity. </note>","type":"array","items":{"$ref":"#/components/schemas/Arn"}},"ClientToken":{"description":"A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.","type":"string"},"Tags":{"description":"The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.","type":"object","minProperties":0,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"MaxCityNetworksToMonitor":{"description":"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 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. To learn more, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html\">Choosing a city-network maximum value </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.","type":"integer","minimum":1,"maximum":500000},"InternetMeasurementsLogDelivery":{"description":"Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.","type":"object","properties":{"S3Config":{"allOf":[{"$ref":"#/components/schemas/S3Config"},{"description":"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 <code>ENABLED</code> or <code>DISABLED</code>, depending on whether you choose to deliver internet measurements to S3 logs."}]}}},"TrafficPercentageToMonitor":{"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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html\">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.","type":"integer","minimum":1,"maximum":100},"HealthEventsConfig":{"description":"A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. If you don't set a health event threshold, the default value is 95%. For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview\"> Change health event thresholds</a> in the Internet Monitor section of the CloudWatch User Guide.","type":"object","properties":{"AvailabilityScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The health event threshold percentage set for availability scores."}]},"PerformanceScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The health event threshold percentage set for performance scores."}]},"AvailabilityLocalHealthEventsConfig":{"allOf":[{"$ref":"#/components/schemas/LocalHealthEventsConfig"},{"description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue."}]},"PerformanceLocalHealthEventsConfig":{"allOf":[{"$ref":"#/components/schemas/LocalHealthEventsConfig"},{"description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListMonitors","description":"Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMonitorsOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results. You receive this token from a previous call.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The number of monitor objects that you want to return with this call.","schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"MonitorStatus","in":"query","required":false,"description":"The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself. For information about the statuses for a monitor, see <a href=\"https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html\"> Monitor</a>.","schema":{"type":"string"}}]}},"/v20210603/Monitors/{MonitorName}":{"delete":{"operationId":"DeleteMonitor","description":"Deletes a monitor in Amazon CloudWatch Internet Monitor. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMonitorOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"MonitorName","in":"path","required":true,"description":"The name of the monitor to delete.","schema":{"type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetMonitor","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMonitorOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"MonitorName","in":"path","required":true,"description":"The name of the monitor.","schema":{"type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255}}]},"patch":{"operationId":"UpdateMonitor","description":"Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html\">Choosing a city-network maximum value</a> in the Amazon CloudWatch User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMonitorOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"MonitorName","in":"path","required":true,"description":"The name of the monitor. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ResourcesToAdd":{"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. <note> 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. </note>","type":"array","items":{"$ref":"#/components/schemas/Arn"}},"ResourcesToRemove":{"description":"The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).","type":"array","items":{"$ref":"#/components/schemas/Arn"}},"Status":{"description":"The status for a monitor. The accepted values for <code>Status</code> with the <code>UpdateMonitor</code> API call are the following: <code>ACTIVE</code> and <code>INACTIVE</code>. The following values are not accepted: <code>PENDING</code>, and <code>ERROR</code>.","type":"string","enum":["PENDING","ACTIVE","INACTIVE","ERROR"]},"ClientToken":{"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.","type":"string"},"MaxCityNetworksToMonitor":{"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.","type":"integer","minimum":1,"maximum":500000},"InternetMeasurementsLogDelivery":{"description":"Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.","type":"object","properties":{"S3Config":{"allOf":[{"$ref":"#/components/schemas/S3Config"},{"description":"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 <code>ENABLED</code> or <code>DISABLED</code>, depending on whether you choose to deliver internet measurements to S3 logs."}]}}},"TrafficPercentageToMonitor":{"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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html\">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.","type":"integer","minimum":1,"maximum":100},"HealthEventsConfig":{"description":"A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies. Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both. You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold. If you don't set a health event threshold, the default value is 95%. For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview\"> Change health event thresholds</a> in the Internet Monitor section of the CloudWatch User Guide.","type":"object","properties":{"AvailabilityScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The health event threshold percentage set for availability scores."}]},"PerformanceScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The health event threshold percentage set for performance scores."}]},"AvailabilityLocalHealthEventsConfig":{"allOf":[{"$ref":"#/components/schemas/LocalHealthEventsConfig"},{"description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue."}]},"PerformanceLocalHealthEventsConfig":{"allOf":[{"$ref":"#/components/schemas/LocalHealthEventsConfig"},{"description":"The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue."}]}}}}}}}}}},"/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}":{"get":{"operationId":"GetHealthEvent","description":"Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location. The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on. Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHealthEventOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"MonitorName","in":"path","required":true,"description":"The name of the monitor.","schema":{"type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255}},{"name":"EventId","in":"path","required":true,"description":"The internally generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must URL-encode the <code>EventID</code> field in the request URL.","schema":{"type":"string","pattern":"[a-zA-Z0-9/_.-]+","minLength":1,"maxLength":255}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v20210603/Monitors/{MonitorName}/HealthEvents":{"get":{"operationId":"ListHealthEvents","description":"Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end time and the status. <note> Health events that have start times during the time frame that is requested are not included in the list of health events. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHealthEventsOutput"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"MonitorName","in":"path","required":true,"description":"The name of the monitor.","schema":{"type":"string","pattern":"[a-zA-Z0-9_.-]+","minLength":1,"maxLength":255}},{"name":"StartTime","in":"query","required":false,"description":"The time when a health event started.","schema":{"type":"string","format":"date-time"}},{"name":"EndTime","in":"query","required":false,"description":"The time when a health event ended. If the health event is still ongoing, then the end time is not set.","schema":{"type":"string","format":"date-time"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results. You receive this token from a previous call.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The number of health event objects that you want to return with this call. ","schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"EventStatus","in":"query","required":false,"description":"The status of a health event.","schema":{"type":"string","enum":["ACTIVE","RESOLVED"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{ResourceArn}":{"get":{"operationId":"ListTagsForResource","description":"Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceOutput"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"ResourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for a resource.","schema":{"type":"string","pattern":"arn:.*","minLength":20,"maxLength":512}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":"Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor. A minimum of one tag is required for this call. It returns an error if you use the <code>TagResource</code> request with 0 tags.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceOutput"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"ResourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.","schema":{"type":"string","pattern":"arn:.*","minLength":20,"maxLength":512}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Tags"],"properties":{"Tags":{"description":"Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.","type":"object","minProperties":0,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/tags/{ResourceArn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Removes a tag from a resource.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceOutput"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"484":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"ResourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for a tag you remove a resource from.","schema":{"type":"string","pattern":"arn:.*","minLength":20,"maxLength":512}},{"name":"tagKeys","in":"query","required":true,"description":"Tag keys that you remove from a resource.","schema":{"type":"array","items":{"$ref":"#/components/schemas/TagKey"},"minItems":0,"maxItems":200}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateMonitorOutput":{"type":"object","required":["Arn","Status"],"properties":{"Arn":{"allOf":[{"$ref":"#/components/schemas/MonitorArn"},{"description":"The Amazon Resource Name (ARN) of the monitor."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/MonitorConfigState"},{"description":"The status of a monitor."}]}}},"Arn":{"type":"string","pattern":"arn:.*","minLength":20,"maxLength":2048},"TagValue":{"type":"string","minLength":0,"maxLength":256},"S3Config":{"type":"object","properties":{"BucketName":{"allOf":[{"$ref":"#/components/schemas/S3ConfigBucketNameString"},{"description":"The Amazon S3 bucket name."}]},"BucketPrefix":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The Amazon S3 bucket prefix."}]},"LogDeliveryStatus":{"allOf":[{"$ref":"#/components/schemas/LogDeliveryStatus"},{"description":"The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket."}]}},"description":"The configuration for publishing Amazon CloudWatch 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 <code>ENABLED</code> or <code>DISABLED</code>, depending on whether you choose to deliver internet measurements to S3 logs."},"Percentage":{"type":"number","format":"double","minimum":0,"maximum":100},"LocalHealthEventsConfig":{"type":"object","properties":{"Status":{"allOf":[{"$ref":"#/components/schemas/LocalHealthEventsConfigStatus"},{"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 <code>ENABLED</code> or <code>DISABLED</code>."}]},"HealthScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The health event threshold percentage set for a local health score."}]},"MinTrafficImpact":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"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."}]}},"description":"A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks. Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview\"> Change health event thresholds</a> in the Internet Monitor section of the CloudWatch User Guide."},"InternalServerException":{},"AccessDeniedException":{},"ThrottlingException":{},"ConflictException":{},"LimitExceededException":{},"ValidationException":{},"DeleteMonitorOutput":{"type":"object","properties":{}},"GetHealthEventOutput":{"type":"object","required":["EventArn","EventId","StartedAt","LastUpdatedAt","ImpactedLocations","Status","ImpactType"],"properties":{"EventArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the event."}]},"EventId":{"allOf":[{"$ref":"#/components/schemas/HealthEventName"},{"description":"The internally generated identifier of a health event."}]},"StartedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The time when a health event started."}]},"EndedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The time when a health event was resolved. If the health event is still active, the end time is not set."}]},"CreatedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The time when a health event was created."}]},"LastUpdatedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The time when a health event was last updated or recalculated."}]},"ImpactedLocations":{"allOf":[{"$ref":"#/components/schemas/ImpactedLocationsList"},{"description":"The locations affected by a health event."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/HealthEventStatus"},{"description":"The status of a health event."}]},"PercentOfTotalTrafficImpacted":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network."}]},"ImpactType":{"allOf":[{"$ref":"#/components/schemas/HealthEventImpactType"},{"description":"The type of impairment of a specific health event."}]},"HealthScoreThreshold":{"allOf":[{"$ref":"#/components/schemas/Percentage"},{"description":"The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users."}]}}},"GetMonitorOutput":{"type":"object","required":["MonitorName","MonitorArn","Resources","Status","CreatedAt","ModifiedAt"],"properties":{"MonitorName":{"allOf":[{"$ref":"#/components/schemas/ResourceName"},{"description":"The name of the monitor."}]},"MonitorArn":{"allOf":[{"$ref":"#/components/schemas/MonitorArn"},{"description":"The Amazon Resource Name (ARN) of the monitor."}]},"Resources":{"allOf":[{"$ref":"#/components/schemas/SetOfARNs"},{"description":"The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs)."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/MonitorConfigState"},{"description":"The status of the monitor."}]},"CreatedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The time when the monitor was created."}]},"ModifiedAt":{"allOf":[{"$ref":"#/components/schemas/SyntheticTimestamp_date_time"},{"description":"The last time that the monitor was modified."}]},"ProcessingStatus":{"allOf":[{"$ref":"#/components/schemas/MonitorProcessingStatusCode"},{"description":"The health of the data processing for the monitor."}]},"ProcessingStatusInfo":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Additional information about the health of the data processing for the monitor."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"The tags that have been added to monitor."}]},"MaxCityNetworksToMonitor":{"allOf":[{"$ref":"#/components/schemas/MaxCityNetworksToMonitor"},{"description":"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 ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs. To learn more, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html\">Choosing a city-network maximum value </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide."}]},"InternetMeasurementsLogDelivery":{"allOf":[{"$ref":"#/components/schemas/InternetMeasurementsLogDelivery"},{"description":"Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs."}]},"TrafficPercentageToMonitor":{"allOf":[{"$ref":"#/components/schemas/TrafficPercentageToMonitor"},{"description":"The percentage of the internet-facing traffic for your application 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html\">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide."}]},"HealthEventsConfig":{"allOf":[{"$ref":"#/components/schemas/HealthEventsConfig"},{"description":"The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview\"> Change health event thresholds</a> in the Internet Monitor section of the CloudWatch User Guide."}]}}},"ListHealthEventsOutput":{"type":"object","required":["HealthEvents"],"properties":{"HealthEvents":{"allOf":[{"$ref":"#/components/schemas/HealthEventList"},{"description":"A list of health events."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The token for the next set of results. You receive this token from a previous call."}]}}},"ListMonitorsOutput":{"type":"object","required":["Monitors"],"properties":{"Monitors":{"allOf":[{"$ref":"#/components/schemas/MonitorList"},{"description":"A list of monitors."}]},"NextToken":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The token for the next set of results. You receive this token from a previous call."}]}}},"ListTagsForResourceOutput":{"type":"object","properties":{"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"Tags for a resource."}]}}},"TooManyRequestsException":{},"NotFoundException":{},"BadRequestException":{},"InternalServerErrorException":{},"TagResourceOutput":{"type":"object","properties":{}},"UntagResourceOutput":{"type":"object","properties":{}},"TagKey":{"type":"string","minLength":1,"maxLength":128},"UpdateMonitorOutput":{"type":"object","required":["MonitorArn","Status"],"properties":{"MonitorArn":{"allOf":[{"$ref":"#/components/schemas/MonitorArn"},{"description":"The Amazon Resource Name (ARN) of the monitor."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/MonitorConfigState"},{"description":"The status of a monitor."}]}}},"ResourceNotFoundException":{},"Double":{"type":"number","format":"double"},"AvailabilityMeasurement":{"type":"object","properties":{"ExperienceScore":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and also summed into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor provides global health scores. The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and availability scores, and when it creates and resolves health events. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores\">How Amazon Web Services calculates performance and availability scores</a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide."}]},"PercentOfTotalTrafficImpacted":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network. For information about how Internet Monitor calculates impact, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html\">How Internet Monitor works</a> in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide."}]},"PercentOfClientLocationImpacted":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The percentage of impact caused by a health event for client location traffic globally. For information about how Internet Monitor calculates impact, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html\">Inside Internet Monitor</a> in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide."}]}},"description":"Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when