View Source AWS.NetworkFlowMonitor (aws-elixir v1.0.7)
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.
Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor.
Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors.
Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors.
Stop a top contributors query for a monitor.
Stop a top contributors query for workload insights.
Stop a top contributors data query for workload insights.
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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
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 scope for workload insights.
Workload
insights provide a high level view of network flow performance data collected by
agents.
To return the data for the top contributors, see
GetQueryResultsWorkloadInsightsTopContributorsData
.
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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
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 the data for top contributors for workload insights for a
specific scope.
Workload insights provide a high level view of network flow performance data
collected by agents
for a scope. To return just the top contributors, see
GetQueryResultsWorkloadInsightsTopContributors
.
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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
The top contributor network flows overall are 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 create 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 (create) 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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
The top contributor network flows overall are 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 SourceCreate 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 to create the query for.
The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors
to run the query and return 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. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.
start_query_workload_insights_top_contributors(client, scope_id, input, options \\ [])
View SourceCreate 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 create a query for.
The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors
to run the query and return the top contributors for the workload insights for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.
start_query_workload_insights_top_contributors_data(client, scope_id, input, options \\ [])
View SourceCreate 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 you want to create a query for.
The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData
to run the query and return the data for the top contributors for the workload insights for a scope.
Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
stop_query_monitor_top_contributors(client, monitor_name, query_id, input, options \\ [])
View SourceStop 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 Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
stop_query_workload_insights_top_contributors(client, query_id, scope_id, input, options \\ [])
View SourceStop 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 Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
stop_query_workload_insights_top_contributors_data(client, query_id, scope_id, input, options \\ [])
View SourceStop 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 Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.
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.