View Source AWS.InternetMonitor (aws-elixir v0.13.2)

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, reducing the time it takes for you to diagnose these issues, from days to minutes.

You can explore internet measurements for different time frames and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.

If the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements to CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity for your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.

To use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces directories that show 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 of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

Link to this section Functions

Link to this function

create_monitor(client, input, options \\ [])

View Source

Creates a monitor in Amazon CloudWatch Internet Monitor.

A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories.

After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).

Link to this function

delete_monitor(client, monitor_name, input, options \\ [])

View Source

Deletes a monitor in Amazon CloudWatch Internet Monitor.

Link to this function

get_health_event(client, event_id, monitor_name, options \\ [])

View Source

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.

Link to this function

get_monitor(client, monitor_name, options \\ [])

View Source

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.

Link to this function

list_health_events(client, monitor_name, end_time \\ nil, event_status \\ nil, max_results \\ nil, next_token \\ nil, start_time \\ nil, options \\ [])

View Source

Lists 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.

Link to this function

list_monitors(client, max_results \\ nil, monitor_status \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for a resource.

Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

update_monitor(client, monitor_name, input, options \\ [])

View Source

Updates a monitor.

You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a monitor.