health_events

Creates, updates, deletes, gets or lists a health_events resource.

Overview

Name	health_events
Type	Resource
Id	aws.internetmonitor.health_events

Fields

The following fields are returned by SELECT queries:

get_health_event

Name	Datatype	Description
created_at	string (date-time)	The time when a health event was created.
ended_at	string (date-time)	The time when a health event was resolved. If the health event is still active, the end time is not set.
event_arn	string	The Amazon Resource Name (ARN) of the event. (pattern: <code>arn:.*</code>)
event_id	string	The internally-generated identifier of a health event. (pattern: <code>[a-zA-Z0-9/_.-]+</code>)
health_score_threshold	number (double)	The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
impact_type	string	The type of impairment of a specific health event. (AVAILABILITY, PERFORMANCE, LOCAL_AVAILABILITY, LOCAL_PERFORMANCE)
impacted_locations	array	The locations affected by a health event.
last_updated_at	string (date-time)	The time when a health event was last updated or recalculated.
percent_of_total_traffic_impacted	number (double)	The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
started_at	string (date-time)	The time when a health event started.
status	string	The status of a health event. (ACTIVE, RESOLVED)

list_health_events

Name	Datatype	Description
created_at	string (date-time)	When the health event was created.
ended_at	string (date-time)	The time when a health event ended. If the health event is still active, then the end time is not set.
event_arn	string	The Amazon Resource Name (ARN) of the event. (pattern: <code>arn:.*</code>)
event_id	string	The internally-generated identifier of a specific network traffic impairment health event. (pattern: <code>[a-zA-Z0-9/_.-]+</code>)
health_score_threshold	number (double)	The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.
impact_type	string	The type of impairment for a health event. (AVAILABILITY, PERFORMANCE, LOCAL_AVAILABILITY, LOCAL_PERFORMANCE)
impacted_locations	array	The locations impacted by the health event.
last_updated_at	string (date-time)	When the health event was last updated.
percent_of_total_traffic_impacted	number (double)	The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
started_at	string (date-time)	When a health event started.
status	string	The status of a health event. (ACTIVE, RESOLVED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_health_event	select	monitor_name, event_id, region	LinkedAccountId	Gets information that 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.
list_health_events	select	monitor_name, region	StartTime, EndTime, NextToken, MaxResults, EventStatus, LinkedAccountId	Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status. Health events that have start times during the time frame that is requested are not included in the list of health events.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
event_id	string	The internally-generated identifier of a health event. Because EventID contains the forward slash (“/”) character, you must URL-encode the EventID field in the request URL.
monitor_name	string	The name of the monitor.
region	string	AWS region (default: us-east-1)
EndTime	string (date-time)	The time when a health event ended. If the health event is still ongoing, then the end time is not set.
EventStatus	string	The status of a health event.
LinkedAccountId	string	The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.
MaxResults	integer	The number of health event objects that you want to return with this call.
NextToken	string	The token for the next set of results. You receive this token from a previous call.
StartTime	string (date-time)	The time when a health event started.

SELECT examples

get_health_event

Gets information that 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.

SELECT
created_at,
ended_at,
event_arn,
event_id,
health_score_threshold,
impact_type,
impacted_locations,
last_updated_at,
percent_of_total_traffic_impacted,
started_at,
status
FROM aws.internetmonitor.health_events
WHERE monitor_name = '{{ monitor_name }}' -- required
AND event_id = '{{ event_id }}' -- required
AND region = '{{ region }}' -- required
AND LinkedAccountId = '{{ LinkedAccountId }}'
;

list_health_events

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status. Health events that have start times during the time frame that is requested are not included in the list of health events.

SELECT
created_at,
ended_at,
event_arn,
event_id,
health_score_threshold,
impact_type,
impacted_locations,
last_updated_at,
percent_of_total_traffic_impacted,
started_at,
status
FROM aws.internetmonitor.health_events
WHERE monitor_name = '{{ monitor_name }}' -- required
AND region = '{{ region }}' -- required
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND EventStatus = '{{ EventStatus }}'
AND LinkedAccountId = '{{ LinkedAccountId }}'
;