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_scope(params = {}) ⇒ Types::CreateScopeOutput
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.
-
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor in Network Flow 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_query_results_monitor_top_contributors(params = {}) ⇒ Types::GetQueryResultsMonitorTopContributorsOutput
Return the data for a query with the Network Flow Monitor query interface.
-
#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_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_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_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_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_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.
473 474 475 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 473 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 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.
572 573 574 575 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 572 def create_monitor(params = {}, = {}) req = build_request(:create_monitor, params) req.send_request() end |
#create_scope(params = {}) ⇒ Types::CreateScopeOutput
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.
640 641 642 643 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 640 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.
662 663 664 665 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 662 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#delete_scope(params = {}) ⇒ Struct
Deletes a scope that has been defined.
686 687 688 689 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 686 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.
736 737 738 739 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 736 def get_monitor(params = {}, = {}) req = build_request(:get_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.
832 833 834 835 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 832 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_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.
908 909 910 911 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 908 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.
985 986 987 988 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 985 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.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1030 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_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.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1080 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.
1135 1136 1137 1138 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1135 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.
1179 1180 1181 1182 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1179 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.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1234 def list_monitors(params = {}, = {}) req = build_request(:list_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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1274 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.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1303 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1389 def start_query_monitor_top_contributors(params = {}, = {}) req = build_request(:start_query_monitor_top_contributors, 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1475 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1557 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.
1592 1593 1594 1595 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1592 def stop_query_monitor_top_contributors(params = {}, = {}) req = build_request(:stop_query_monitor_top_contributors, 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.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1629 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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1666 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.
1694 1695 1696 1697 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1694 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
1720 1721 1722 1723 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1720 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.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1816 def update_monitor(params = {}, = {}) req = build_request(:update_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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-networkflowmonitor/lib/aws-sdk-networkflowmonitor/client.rb', line 1884 def update_scope(params = {}, = {}) req = build_request(:update_scope, params) req.send_request() end |