Amazon Web Services, Inc.

Amazon CloudWatch Network Monitor

Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web…

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 Network Monitor is an Amazon Web Services active network monitoring
service that identifies if a network issues exists within the Amazon Web Services network
or your own company network. Within Network Monitor you'll choose the source VPCs and
subnets from the Amazon Web Services network in which you operate and then you'll choose
the destination IP addresses from your on-premises network. From these sources and
destinations, Network Monitor creates a monitor containing all the possible source and
destination combinations, each of which is called a probe, within a single monitor.
These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
Before you begin, ensure the Amazon Web Services CLI is configured in the Amazon Web Services Account where you will create the Network Monitor resource. Network
Monitor doesn’t support creation on cross-account resources, but you can create a
Network Monitor in any subnet belonging to a VPC owned by your Account.
For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide .

Endpoints 12

Monitor

  • GETList monitors/monitors?nextToken=string&maxResults=0&state=stringReturns a list of all of your monitors.
  • POSTCreate monitor/monitorsCreates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between…
  • GETGet monitor/monitors/:monitorNameReturns details about a specific monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.
  • DELETEDelete monitor/monitors/:monitorNameDeletes a specified monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.
  • PATCHUpdate monitor/monitors/:monitorNameUpdates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and…

Probe

  • POSTCreate probe/monitors/:monitorName/probesCreate a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This…
  • GETGet probe/monitors/:monitorName/probes/:probeIdReturns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run…
  • DELETEDelete probe/monitors/:monitorName/probes/:probeIdDeletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe. This action requires both the monitorName and…
  • PATCHUpdate probe/monitors/:monitorName/probes/:probeIdUpdates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to…
  • GETList tags for resource/tags/:resourceArnLists the tags assigned to this resource.
  • POSTTag resource/tags/:resourceArnAdds key-value pairs to a monitor or probe.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a key-value pair from a monitor or probe.

API details

Base URL
https://networkmonitor.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 5 pathsGET 4POST 3DELETE 3PATCH 2
Main resources
Monitor 5Probe 4
Description format
AWS Smithy model, API version 2023-08-01

How to test the Amazon CloudWatch Network 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 Network 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 /monitors?nextToken=string&maxResults=0&state=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudWatch Network Monitor?

Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring service that identifies if a network issues exists within the Amazon Web… It is listed under Developer tools and has 12 endpoints.

Who publishes the Amazon CloudWatch Network 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 Network Monitor?

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

How do I authenticate with the Amazon CloudWatch Network Monitor?

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

How many endpoints does the Amazon CloudWatch Network Monitor have?

12 operations on 5 paths (4 GET, 3 POST, 3 DELETE, 2 PATCH). The largest groups are Monitor, Probe.

Is forking the Amazon CloudWatch Network 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.