Class: Aws::NetworkFlowMonitor::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::NetworkFlowMonitor::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb
Overview
An API client for NetworkFlowMonitor. To construct a client, you need to configure a :region and :credentials.
client = Aws::NetworkFlowMonitor::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_monitor(params = {}) ⇒ Types::CreateMonitorOutput
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_performance_monitor(params = {}) ⇒ Types::CreatePerformanceMonitorOutput
Create a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon Web Services network is causing issues for your workloads.
-
#create_scope(params = {}) ⇒ Types::CreateScopeOutput
In Network Flow Monitor, you specify a scope for the service to generate metrics for.
-
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor in Network Flow Monitor.
-
#delete_performance_monitor(params = {}) ⇒ Struct
Delete a performance monitor.
-
#delete_scope(params = {}) ⇒ Struct
Deletes a scope that has been defined.
-
#get_monitor(params = {}) ⇒ Types::GetMonitorOutput
Gets information about a monitor in Network Flow Monitor based on a monitor name.
-
#get_monitor_scope_suggestions(params = {}) ⇒ Types::GetMonitorScopeSuggestionsOutput
Returns 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 monitor.
-
#get_performance_monitor(params = {}) ⇒ Types::GetPerformanceMonitorOutput
Returns information about a performance monitor, including the resources that it monitors, its status, and the tags for the monitor.
-
#get_query_results_monitor_top_contributors(params = {}) ⇒ Types::GetQueryResultsMonitorTopContributorsOutput
Return the data for a query with the Network Flow Monitor query interface.
-
#get_query_results_performance_monitor(params = {}) ⇒ Types::GetQueryResultsPerformanceMonitorOutput
Returns the results of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor.
-
#get_query_results_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsOutput
Return the data for a query with the Network Flow Monitor query interface.
-
#get_query_results_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsDataOutput
Return the data for a query with the Network Flow Monitor query interface.
-
#get_query_status_monitor_top_contributors(params = {}) ⇒ Types::GetQueryStatusMonitorTopContributorsOutput
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
-
#get_query_status_performance_monitor(params = {}) ⇒ Types::GetQueryStatusPerformanceMonitorOutput
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor.
-
#get_query_status_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsOutput
Return the data for a query with the Network Flow Monitor query interface.
-
#get_query_status_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsDataOutput
Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor.
-
#get_scope(params = {}) ⇒ Types::GetScopeOutput
Gets information about a scope, including the name, status, tags, and target details.
-
#list_monitors(params = {}) ⇒ Types::ListMonitorsOutput
List all monitors in an account.
-
#list_performance_monitors(params = {}) ⇒ Types::ListPerformanceMonitorsOutput
Returns a list of the performance monitors in an account.
-
#list_scopes(params = {}) ⇒ Types::ListScopesOutput
List all the scopes for an account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns all the tags for a resource.
-
#start_query_monitor_top_contributors(params = {}) ⇒ Types::StartQueryMonitorTopContributorsOutput
Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor.
-
#start_query_performance_monitor(params = {}) ⇒ Types::StartQueryPerformanceMonitorOutput
Create a query that you can use with the Network Flow Monitor query interface to return the top paths for a performance monitor.
-
#start_query_workload_insights_top_contributors(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsOutput
Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors.
-
#start_query_workload_insights_top_contributors_data(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsDataOutput
Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors.
-
#stop_query_monitor_top_contributors(params = {}) ⇒ Struct
Stop a top contributors query for a monitor.
-
#stop_query_performance_monitor(params = {}) ⇒ Struct
Stop a query for the Network Flow Monitor query interface, for a specified query ID and performance monitor.
-
#stop_query_workload_insights_top_contributors(params = {}) ⇒ Struct
Stop a top contributors query for workload insights.
-
#stop_query_workload_insights_top_contributors_data(params = {}) ⇒ Struct
Stop a top contributors data query for workload insights.
-
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
-
#update_monitor(params = {}) ⇒ Types::UpdateMonitorOutput
Update a monitor to add or remove local or remote resources.
-
#update_performance_monitor(params = {}) ⇒ Types::UpdatePerformanceMonitorOutput
Update a performance monitor, to add or remove the resources that the monitor tracks network performance for.
-
#update_scope(params = {}) ⇒ Types::UpdateScopeOutput
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#create_monitor(params = {}) ⇒ Types::CreateMonitorOutput
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 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.
597 598 599 600 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 597 def create_monitor(params = {}, = {}) req = build_request(:create_monitor, params) req.send_request() end |
#create_performance_monitor(params = {}) ⇒ Types::CreatePerformanceMonitorOutput
Create a performance monitor to monitor the traffic of the Amazon Virtual Private Clouds (VPCs) that you specify as targets, to determine whether the Amazon Web Services network is causing issues for your workloads. With a performance monitor, you can identify network degradation across paths between Availability Zones and across Amazon Web Services Regions.
679 680 681 682 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 679 def create_performance_monitor(params = {}, = {}) req = build_request(:create_performance_monitor, params) req.send_request() end |
#create_scope(params = {}) ⇒ Types::CreateScopeOutput
In 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 the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.
A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.
To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:
Targets, which are arrays of targetResources.
Target resources, which are Region-targetIdentifier pairs.
Target identifiers, made up of a targetID (currently always an account ID) and a targetType (currently always an account).
763 764 765 766 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 763 def create_scope(params = {}, = {}) req = build_request(:create_scope, params) req.send_request() end |
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor in Network Flow Monitor.
785 786 787 788 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 785 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#delete_performance_monitor(params = {}) ⇒ Struct
Delete a performance monitor. Network Flow Monitor stops tracking network performance for the resources that the monitor included.
808 809 810 811 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 808 def delete_performance_monitor(params = {}, = {}) req = build_request(:delete_performance_monitor, params) req.send_request() end |
#delete_scope(params = {}) ⇒ Struct
Deletes a scope that has been defined.
832 833 834 835 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 832 def delete_scope(params = {}, = {}) req = build_request(:delete_scope, params) req.send_request() end |
#get_monitor(params = {}) ⇒ Types::GetMonitorOutput
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.
882 883 884 885 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 882 def get_monitor(params = {}, = {}) req = build_request(:get_monitor, params) req.send_request() end |
#get_monitor_scope_suggestions(params = {}) ⇒ Types::GetMonitorScopeSuggestionsOutput
Returns 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 monitor. By adding the suggested accounts to your scope, you enable Network Flow Monitor to resolve the network paths for that traffic.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
935 936 937 938 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 935 def get_monitor_scope_suggestions(params = {}, = {}) req = build_request(:get_monitor_scope_suggestions, params) req.send_request() end |
#get_performance_monitor(params = {}) ⇒ Types::GetPerformanceMonitorOutput
Returns information about a performance monitor, including the resources that it monitors, its status, and the tags for the monitor.
981 982 983 984 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 981 def get_performance_monitor(params = {}, = {}) req = build_request(:get_performance_monitor, params) req.send_request() end |
#get_query_results_monitor_top_contributors(params = {}) ⇒ Types::GetQueryResultsMonitorTopContributorsOutput
Return 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1082 1083 1084 1085 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1082 def get_query_results_monitor_top_contributors(params = {}, = {}) req = build_request(:get_query_results_monitor_top_contributors, params) req.send_request() end |
#get_query_results_performance_monitor(params = {}) ⇒ Types::GetQueryResultsPerformanceMonitorOutput
Returns 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 for a performance monitor.
Create a query with StartQueryPerformanceMonitor, and then use the query ID with this call to return the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1144 def get_query_results_performance_monitor(params = {}, = {}) req = build_request(:get_query_results_performance_monitor, params) req.send_request() end |
#get_query_results_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsOutput
Return 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1220 1221 1222 1223 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1220 def get_query_results_workload_insights_top_contributors(params = {}, = {}) req = build_request(:get_query_results_workload_insights_top_contributors, params) req.send_request() end |
#get_query_results_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsDataOutput
Return 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1297 def get_query_results_workload_insights_top_contributors_data(params = {}, = {}) req = build_request(:get_query_results_workload_insights_top_contributors_data, params) req.send_request() end |
#get_query_status_monitor_top_contributors(params = {}) ⇒ Types::GetQueryStatusMonitorTopContributorsOutput
Returns 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.
1342 1343 1344 1345 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1342 def get_query_status_monitor_top_contributors(params = {}, = {}) req = build_request(:get_query_status_monitor_top_contributors, params) req.send_request() end |
#get_query_status_performance_monitor(params = {}) ⇒ Types::GetQueryStatusPerformanceMonitorOutput
Returns 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 query status for the top paths for a performance monitor.
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. Use the same query ID that you used for the corresponding API
call to start (create) the query, StartQueryPerformanceMonitor.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1384 def get_query_status_performance_monitor(params = {}, = {}) req = build_request(:get_query_status_performance_monitor, params) req.send_request() end |
#get_query_status_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsOutput
Return 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.
1434 1435 1436 1437 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1434 def get_query_status_workload_insights_top_contributors(params = {}, = {}) req = build_request(:get_query_status_workload_insights_top_contributors, params) req.send_request() end |
#get_query_status_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsDataOutput
Returns 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.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1489 def get_query_status_workload_insights_top_contributors_data(params = {}, = {}) req = build_request(:get_query_status_workload_insights_top_contributors_data, params) req.send_request() end |
#get_scope(params = {}) ⇒ Types::GetScopeOutput
Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1533 def get_scope(params = {}, = {}) req = build_request(:get_scope, params) req.send_request() end |
#list_monitors(params = {}) ⇒ Types::ListMonitorsOutput
List all monitors in an account. Optionally, you can list only
monitors that have a specific status, by using the STATUS parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1588 def list_monitors(params = {}, = {}) req = build_request(:list_monitors, params) req.send_request() end |
#list_performance_monitors(params = {}) ⇒ Types::ListPerformanceMonitorsOutput
Returns 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 paginated. Use the nextToken parameter to return
additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1650 def list_performance_monitors(params = {}, = {}) req = build_request(:list_performance_monitors, params) req.send_request() end |
#list_scopes(params = {}) ⇒ Types::ListScopesOutput
List all the scopes for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1690 def list_scopes(params = {}, = {}) req = build_request(:list_scopes, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Returns all the tags for a resource.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1719 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_query_monitor_top_contributors(params = {}) ⇒ Types::StartQueryMonitorTopContributorsOutput
Create 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.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1808 def start_query_monitor_top_contributors(params = {}, = {}) req = build_request(:start_query_monitor_top_contributors, params) req.send_request() end |
#start_query_performance_monitor(params = {}) ⇒ Types::StartQueryPerformanceMonitorOutput
Create 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 monitor that you want to create the query for.
The call returns a query ID that you can use with GetQueryResultsPerformanceMonitor to return the results of the query.
Top paths in Network Flow Monitor are the network paths used by the traffic for the resources that a performance monitor tracks, ranked by impact score and then by traffic volume. Each path includes the traffic and round-trip time for the path, together with a breakdown of the subnet pairs that the path includes.
1896 1897 1898 1899 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1896 def start_query_performance_monitor(params = {}, = {}) req = build_request(:start_query_performance_monitor, params) req.send_request() end |
#start_query_workload_insights_top_contributors(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsOutput
Create 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.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1985 def start_query_workload_insights_top_contributors(params = {}, = {}) req = build_request(:start_query_workload_insights_top_contributors, params) req.send_request() end |
#start_query_workload_insights_top_contributors_data(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsDataOutput
Create 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.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2070 def start_query_workload_insights_top_contributors_data(params = {}, = {}) req = build_request(:start_query_workload_insights_top_contributors_data, params) req.send_request() end |
#stop_query_monitor_top_contributors(params = {}) ⇒ Struct
Stop 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.
2105 2106 2107 2108 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2105 def stop_query_monitor_top_contributors(params = {}, = {}) req = build_request(:stop_query_monitor_top_contributors, params) req.send_request() end |
#stop_query_performance_monitor(params = {}) ⇒ Struct
Stop 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 corresponding API call to start the query,
StartQueryPerformanceMonitor.
2136 2137 2138 2139 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2136 def stop_query_performance_monitor(params = {}, = {}) req = build_request(:stop_query_performance_monitor, params) req.send_request() end |
#stop_query_workload_insights_top_contributors(params = {}) ⇒ Struct
Stop 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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2173 def stop_query_workload_insights_top_contributors(params = {}, = {}) req = build_request(:stop_query_workload_insights_top_contributors, params) req.send_request() end |
#stop_query_workload_insights_top_contributors_data(params = {}) ⇒ Struct
Stop 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.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2210 def stop_query_workload_insights_top_contributors_data(params = {}, = {}) req = build_request(:stop_query_workload_insights_top_contributors_data, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource.
2238 2239 2240 2241 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2238 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
2264 2265 2266 2267 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2264 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_monitor(params = {}) ⇒ Types::UpdateMonitorOutput
Update a monitor to add or remove local or remote resources.
2370 2371 2372 2373 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2370 def update_monitor(params = {}, = {}) req = build_request(:update_monitor, params) req.send_request() end |
#update_performance_monitor(params = {}) ⇒ Types::UpdatePerformanceMonitorOutput
Update a performance monitor, to add or remove the resources that the monitor tracks network performance for.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2444 def update_performance_monitor(params = {}, = {}) req = build_request(:update_performance_monitor, params) req.send_request() end |
#update_scope(params = {}) ⇒ Types::UpdateScopeOutput
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.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 2512 def update_scope(params = {}, = {}) req = build_request(:update_scope, params) req.send_request() end |