Amazon Web Services, Inc.

Amazon CloudWatch Internet Monitor

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide .

Endpoints 16

Monitor

  • GETList monitors/v20210603/Monitors?NextToken=string&MaxResults=0&MonitorStatus=string&IncludeLinkedAccounts=trueLists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
  • POSTCreate monitor/v20210603/MonitorsCreates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network…
  • GETGet monitor/v20210603/Monitors/:MonitorName?LinkedAccountId=stringGets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name…
  • DELETEDelete monitor/v20210603/Monitors/:MonitorNameDeletes a monitor in Amazon CloudWatch Internet Monitor.
  • PATCHUpdate monitor/v20210603/Monitors/:MonitorNameUpdates 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…
  • GETGet query results/v20210603/Monitors/:MonitorName/Queries/:QueryId/Results?NextToken=string&MaxResults=0Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a…
  • GETGet query status/v20210603/Monitors/:MonitorName/Queries/:QueryId/StatusReturns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query,…
  • POSTStart query/v20210603/Monitors/:MonitorName/QueriesStart a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you…
  • DELETEStop query/v20210603/Monitors/:MonitorName/Queries/:QueryIdStop a query that is progress for a specific monitor.

Health event

  • GETGet health event/v20210603/Monitors/:MonitorName/HealthEvents/:EventId?LinkedAccountId=stringGets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the…
  • GETList health events/v20210603/Monitors/:MonitorName/HealthEvents?StartTime=string&EndTime=string&NextToken=string&MaxResults=0&EventStatus=string&LinkedAccountId=stringLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times,…

Internet event

  • GETGet internet event/v20210603/InternetEvents/:EventIdGets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global…
  • GETList internet events/v20210603/InternetEvents?NextToken=string&InternetEventMaxResults=0&StartTime=string&EndTime=string&EventStatus=string&EventType=stringLists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent…
  • GETList tags for resource/tags/:ResourceArnLists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
  • POSTTag resource/tags/:ResourceArnAdds 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…
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes a tag from a resource.

API details

Base URL
https://internetmonitor.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
16 operations on 11 pathsGET 9POST 3DELETE 3PATCH 1
Main resources
Monitor 9Health event 2Internet event 2
Description format
AWS Smithy model, API version 2021-06-03

How to test the Amazon CloudWatch Internet Monitor in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CloudWatch Internet Monitor collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List monitors” (GET /v20210603/Monitors?NextToken=string&MaxResults=0&MonitorStatus=string&IncludeLinkedAccounts=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudWatch Internet Monitor?

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on… It is listed under Developer tools and has 16 endpoints.

Who publishes the Amazon CloudWatch Internet Monitor?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon CloudWatch Internet Monitor?

Requests go to https://internetmonitor.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CloudWatch Internet Monitor?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CloudWatch Internet Monitor have?

16 operations on 11 paths (9 GET, 3 POST, 3 DELETE, 1 PATCH). The largest groups are Monitor, Health event, Internet event.

Is forking the Amazon CloudWatch Internet Monitor free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.