Class: Aws::InternetMonitor::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::InternetMonitor::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb
Overview
An API client for InternetMonitor. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::InternetMonitor::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
Creates a monitor in Amazon CloudWatch Internet Monitor.
-
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor in Amazon CloudWatch Internet Monitor.
-
#get_health_event(params = {}) ⇒ Types::GetHealthEventOutput
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.
-
#get_monitor(params = {}) ⇒ Types::GetMonitorOutput
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
-
#get_query_status(params = {}) ⇒ Types::GetQueryStatusOutput
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.
-
#list_health_events(params = {}) ⇒ Types::ListHealthEventsOutput
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
-
#list_monitors(params = {}) ⇒ Types::ListMonitorsOutput
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags for a resource.
-
#start_query(params = {}) ⇒ Types::StartQueryOutput
Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.
-
#stop_query(params = {}) ⇒ Struct
Stop a query that is progress for a specific monitor.
-
#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
Updates a monitor.
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.
385 386 387 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_monitor(params = {}) ⇒ Types::CreateMonitorOutput
Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
543 544 545 546 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 543 def create_monitor(params = {}, = {}) req = build_request(:create_monitor, params) req.send_request() end |
#delete_monitor(params = {}) ⇒ Struct
Deletes a monitor in Amazon CloudWatch Internet Monitor.
565 566 567 568 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 565 def delete_monitor(params = {}, = {}) req = build_request(:delete_monitor, params) req.send_request() end |
#get_health_event(params = {}) ⇒ Types::GetHealthEventOutput
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.
The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on.
Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
657 658 659 660 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 657 def get_health_event(params = {}, = {}) req = build_request(:get_health_event, params) req.send_request() end |
#get_monitor(params = {}) ⇒ Types::GetMonitorOutput
Gets information about a monitor in Amazon CloudWatch Internet 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.
723 724 725 726 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 723 def get_monitor(params = {}, = {}) req = build_request(:get_monitor, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
Return the data for a query with the Amazon CloudWatch Internet
Monitor query interface. Specify the query that you want to return
results for by providing a QueryId
and a monitor name.
For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
785 786 787 788 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 785 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#get_query_status(params = {}) ⇒ Types::GetQueryStatusOutput
Returns the current status of a query for the Amazon CloudWatch
Internet Monitor query interface, for a specified query ID and
monitor. When you run a query, check the status to make sure that the
query has SUCCEEDED
before you review the results.
QUEUED
: The query is scheduled to run.RUNNING
: The query is in progress but not complete.SUCCEEDED
: The query completed sucessfully.FAILED
: The query failed due to an error.CANCELED
: The query was canceled.
831 832 833 834 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 831 def get_query_status(params = {}, = {}) req = build_request(:get_query_status, params) req.send_request() end |
#list_health_events(params = {}) ⇒ Types::ListHealthEventsOutput
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end time and the status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
932 933 934 935 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 932 def list_health_events(params = {}, = {}) req = build_request(:list_health_events, params) req.send_request() end |
#list_monitors(params = {}) ⇒ Types::ListMonitorsOutput
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
986 987 988 989 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 986 def list_monitors(params = {}, = {}) req = build_request(:list_monitors, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1016 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_query(params = {}) ⇒ Types::StartQueryOutput
Start a query to return data for a specific query type for the Amazon
CloudWatch Internet Monitor query interface. Specify a time period for
the data that you want returned by using StartTime
and EndTime
.
You filter the query results to return by providing parameters that
you specify with FilterParameters
.
For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1108 def start_query(params = {}, = {}) req = build_request(:start_query, params) req.send_request() end |
#stop_query(params = {}) ⇒ Struct
Stop a query that is progress for a specific monitor.
1135 1136 1137 1138 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1135 def stop_query(params = {}, = {}) req = build_request(:stop_query, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.
A minimum of one tag is required for this call. It returns an error if
you use the TagResource
request with 0 tags.
1171 1172 1173 1174 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1171 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a resource.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1197 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_monitor(params = {}) ⇒ Types::UpdateMonitorOutput
Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/client.rb', line 1337 def update_monitor(params = {}, = {}) req = build_request(:update_monitor, params) req.send_request() end |