View Source AWS.InternetMonitor (aws-elixir v0.13.3)
Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users.
It reduces the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs.
Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.
To use Internet Monitor, you create a monitor and associate your application's resources with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and networks that communicate with your application.
For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
Link to this section Summary
Functions
Creates a monitor in Amazon CloudWatch Internet Monitor.
Deletes a monitor in Amazon CloudWatch Internet Monitor.
Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
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.
Lists the tags for a resource.
Adds a tag to a resource.
Removes a tag from a resource.
Updates a monitor.
Link to this section Functions
Creates a monitor in Amazon CloudWatch Internet Monitor.
A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and 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 set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time by updating your monitor. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
Deletes a monitor in Amazon CloudWatch Internet Monitor.
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 of the information related to the event by location.
The information returned includes the performance, availability, and round-trip time impact, information about the network providers, 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.
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.
list_health_events(client, monitor_name, end_time \\ nil, event_status \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, options \\ [])
View SourceLists all health events for a monitor in Amazon CloudWatch Internet Monitor.
Returns all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.
Health events that have start times during the time frame that is requested are not included in the list of health events.
list_monitors(client, max_results \\ nil, monitor_status \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
Lists the tags for a resource.
Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
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.
Removes a tag from a resource.
Updates a monitor.
You can update a monitor to change the maximum number of city-networks (locations and ASNs or internet service providers), 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.