Network Flow Monitor
Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web…
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
Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues. In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts. To learn more about Network Flow Monitor, see the Network Flow Monitor User Guide in the Amazon CloudWatch User Guide.
Endpoints 35
Monitor
- GETList monitors
/monitors?nextToken=string&maxResults=0&monitorStatus=stringList all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter. - POSTCreate monitor
/monitorsCreate a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your… - GETGet monitor
/monitors/:monitorNameGets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create… - DELETEDelete monitor
/monitors/:monitorNameDeletes a monitor in Network Flow Monitor. - PATCHUpdate monitor
/monitors/:monitorNameUpdate a monitor to add or remove local or remote resources. - GETGet query results monitor top contributors
/monitors/:monitorName/topContributorsQueries/:queryId/results?nextToken=string&maxResults=0Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID… - GETGet query status monitor top contributors
/monitors/:monitorName/topContributorsQueries/:queryId/statusReturns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status… - POSTStart query monitor top contributors
/monitors/:monitorName/topContributorsQueriesCreate a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want… - DELETEStop query monitor top contributors
/monitors/:monitorName/topContributorsQueries/:queryIdStop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name. Top contributors in Network…
Performance monitor
- GETList performance monitors
/performance-monitors?nextToken=string&maxResults=0&monitorStatus=string&monitorType=stringReturns a list of the performance monitors in an account. You can optionally return only the monitors that have a specific status or type. Results are… - POSTCreate performance monitor
/performance-monitorsCreate a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon… - GETGet performance monitor
/performance-monitors/:monitorNameReturns information about a performance monitor, including the resources that it monitors, its status, and the tags for the monitor. - DELETEDelete performance monitor
/performance-monitors/:monitorNameDelete a performance monitor. Network Flow Monitor stops tracking network performance for the resources that the monitor included. - PATCHUpdate performance monitor
/performance-monitors/:monitorNameUpdate a performance monitor, to add or remove the resources that the monitor tracks network performance for. - GETGet query results performance monitor
/performance-monitors/:monitorName/queries/:queryId/results?nextToken=string&maxResults=0Returns the results of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. This call returns the top paths… - GETGet query status performance monitor
/performance-monitors/:monitorName/queries/:queryId/statusReturns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. This call returns the… - POSTStart query performance monitor
/performance-monitors/:monitorName/queriesCreate a query that you can use with the Network Flow Monitor query interface to return the top paths for a performance monitor. Specify the performance… - DELETEStop query performance monitor
/performance-monitors/:monitorName/queries/:queryIdStop a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor. Use the same query ID that you used for the…
Scope
- GETList scopes
/scopes?nextToken=string&maxResults=0List all the scopes for an account. - POSTCreate scope
/scopesIn Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all… - GETGet scope
/scopes/:scopeIdGets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account. - DELETEDelete scope
/scopes/:scopeIdDeletes a scope that has been defined. - PATCHUpdate scope
/scopes/:scopeIdUpdate a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those… - GETGet query results workload insights top contributors
/workloadInsights/:scopeId/topContributorsQueries/:queryId/results?nextToken=string&maxResults=0Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID… - GETGet query results workload insights top contributors data
/workloadInsights/:scopeId/topContributorsDataQueries/:queryId/results?nextToken=string&maxResults=0Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a… - GETGet query status workload insights top contributors
/workloadInsights/:scopeId/topContributorsQueries/:queryId/statusReturn the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a… - GETGet query status workload insights top contributors data
/workloadInsights/:scopeId/topContributorsDataQueries/:queryId/statusReturns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status… - POSTStart query workload insights top contributors
/workloadInsights/:scopeId/topContributorsQueriesCreate a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to… - POSTStart query workload insights top contributors data
/workloadInsights/:scopeId/topContributorsDataQueriesCreate a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that… - DELETEStop query workload insights top contributors
/workloadInsights/:scopeId/topContributorsQueries/:queryIdStop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. Top contributors in… - DELETEStop query workload insights top contributors data
/workloadInsights/:scopeId/topContributorsDataQueries/:queryIdStop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. Top contributors in…
- GETGet monitor scope suggestions
/monitor-scope-suggestions?monitorArn=string&maxResults=0&nextToken=stringReturns the accounts that are sending traffic to, or receiving traffic from, resources in a monitor, but that aren't included in the monitoring scope for the… - GETList tags for resource
/tags/:resourceArnReturns all the tags for a resource. - POSTTag resource
/tags/:resourceArnAdds a tag to a resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag from a resource.
API details
- Base URL
https://networkflowmonitor.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 35 operations on 24 pathsGET 16POST 8DELETE 8PATCH 3
- Main resources
- Scope 13Monitor 9Performance monitor 9
- Description format
- AWS Smithy model, API version
2023-04-19 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Network Flow Monitor in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Network Flow Monitor collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “List monitors” (GET /monitors?nextToken=string&maxResults=0&monitorStatus=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Network Flow Monitor?
Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web… It is listed under Developer tools and has 35 endpoints.
Who publishes the Network Flow 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 Network Flow Monitor?
Requests go to https://networkflowmonitor.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Network Flow Monitor?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Network Flow Monitor have?
35 operations on 24 paths (16 GET, 8 POST, 8 DELETE, 3 PATCH). The largest groups are Scope, Monitor, Performance monitor.
Is forking the Network Flow Monitor free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.