View Source AWS.NetworkFlowMonitor (aws-elixir v1.0.4)
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.
Link to this section Summary
Functions
Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads.
Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.
Deletes a monitor in Network Flow Monitor.
Deletes a scope that has been defined.
Gets information about a monitor in Network Flow Monitor based on a monitor name.
Return the data for a query with the Network Flow Monitor query interface.
Return the data for a query with the Network Flow Monitor query interface.
Return the data for a query with the Network Flow Monitor query interface.
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
Return the data for a query with the Network Flow Monitor query interface.
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
Gets information about a scope, including the name, status, tags, and target details.
List all monitors in an account.
List all the scopes for an account.
Returns all the tags for a resource.
Start a query to return the data with the Network Flow Monitor query interface.
Start a query to return the data with the Network Flow Monitor query interface.
Return the data for a query with the Network Flow Monitor query interface.
Stop a query with the Network Flow Monitor query interface.
Stop a query with the Network Flow Monitor query interface.
Return the data for a query with the Network Flow Monitor query interface.
Adds a tag to a resource.
Removes a tag from a resource.
Update a monitor to add or remove local or remote resources.
Update 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 resources sending metrics reports to the Network Flow Monitor backend.
Link to this section Functions
Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads.
For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicators (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.
Create a scope of resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.
This call returns a scope ID to identify the scope.
When you create a scope, you enable permissions for Network Flow Monitor. The scope is set to the resources for the Amazon Web Services that enables the feature.
Deletes a monitor in Network Flow Monitor.
Deletes a scope that has been defined.
Gets information about a monitor in Network Flow 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.
get_query_results_monitor_top_contributors(client, monitor_name, query_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturn 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 and a monitor name. This query returns the top contributors for a specific monitor.
Create a query ID for this call by calling the corresponding API call to start
the query,
StartQueryMonitorTopContributors. Use the scope ID that was returned
for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
get_query_results_workload_insights_top_contributors(client, query_id, scope_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturn 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 and a monitor name. This query returns the top contributors for a specific monitor.
Create a query ID for this call by calling the corresponding API call to start
the query,
StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned
for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
get_query_results_workload_insights_top_contributors_data(client, query_id, scope_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturn 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
Create a query ID for this call by calling the corresponding API call to start
the query,
StartQueryWorkloadInsightsTopContributorsData. Use the scope ID that was
returned
for your account by CreateScope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
get_query_status_monitor_top_contributors(client, monitor_name, query_id, options \\ [])
View SourceReturns 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 for the top contributors for a monitor.
When you start a query, use this call to check the status of the query to make
sure that it has
has SUCCEEDED before you review the results. Use the same query ID that you
used for
the corresponding API call to start the query,
StartQueryMonitorTopContributors.
When you run a query, use this call to check the status of the query to make
sure that the query
has SUCCEEDED before you review the results.
get_query_status_workload_insights_top_contributors(client, query_id, scope_id, options \\ [])
View SourceReturn 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 monitor name. This query returns the top contributors for workload insights.
When you start a query, use this call to check the status of the query to make
sure that it has
has SUCCEEDED before you review the results. Use the same query ID that you
used for
the corresponding API call to start the query,
StartQueryWorkloadInsightsTopContributors.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
get_query_status_workload_insights_top_contributors_data(client, query_id, scope_id, options \\ [])
View SourceReturns 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 for the top contributors data for workload insights.
When you start a query, use this call to check the status of the query to make
sure that it has
has SUCCEEDED before you review the results. Use the same query ID that you
used for
the corresponding API call to start the query,
StartQueryWorkloadInsightsTopContributorsData.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
Gets information about a scope, including the name, status, tags, and target details.
The scope in Network Flow Monitor is an account.
list_monitors(client, max_results \\ nil, monitor_status \\ nil, next_token \\ nil, options \\ [])
View SourceList all monitors in an account.
Optionally, you can list only monitors that have a specific status, by
using the STATUS parameter.
list_scopes(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all the scopes for an account.
Returns all the tags for a resource.
start_query_monitor_top_contributors(client, monitor_name, input, options \\ [])
View SourceStart a query to return the data with the Network Flow Monitor query interface.
Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
start_query_workload_insights_top_contributors(client, scope_id, input, options \\ [])
View SourceStart a query to return the data with the Network Flow Monitor query interface.
Specify the query that you want to start by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
start_query_workload_insights_top_contributors_data(client, scope_id, input, options \\ [])
View SourceReturn 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
A query ID is returned from an API call to start a query of a specific type; for example
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
stop_query_monitor_top_contributors(client, monitor_name, query_id, input, options \\ [])
View SourceStop a query with the Network Flow Monitor query interface.
Specify the query that you want to stop by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
stop_query_workload_insights_top_contributors(client, query_id, scope_id, input, options \\ [])
View SourceStop a query with the Network Flow Monitor query interface.
Specify the query that you want to stop by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
stop_query_workload_insights_top_contributors_data(client, query_id, scope_id, input, options \\ [])
View SourceReturn 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 scope ID. This query returns data for the top contributors for workload insights. Workload insights provide a high level view of network flow performance data collected by agents for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.
The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.
Adds a tag to a resource.
Removes a tag from a resource.
Update a monitor to add or remove local or remote resources.
Update 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 resources sending metrics reports to the Network Flow Monitor backend.