internet_events

Creates, updates, deletes, gets or lists an internet_events resource.

Overview

Name	internet_events
Type	Resource
Id	aws.internetmonitor.internet_events

Fields

The following fields are returned by SELECT queries:

get_internet_event

Name	Datatype	Description
client_location	object	The impacted location, such as a city, where clients access Amazon Web Services application resources.
ended_at	string (date-time)	The time when the internet event ended. If the event hasn't ended yet, this value is empty.
event_arn	string	The Amazon Resource Name (ARN) of the internet event. (pattern: <code>arn:.*</code>)
event_id	string	The internally-generated identifier of an internet event. (pattern: <code>[a-zA-Z0-9-]+</code>)
event_status	string	The status of the internet event. (ACTIVE, RESOLVED)
event_type	string	The type of network impairment. (AVAILABILITY, PERFORMANCE)
started_at	string (date-time)	The time when the internet event started.

list_internet_events

Name	Datatype	Description
client_location	object	The impacted location, such as a city, that Amazon Web Services clients access application resources from.
ended_at	string (date-time)	The time when an internet event ended. If the event hasn't ended yet, this value is empty.
event_arn	string	The Amazon Resource Name (ARN) of the internet event. (pattern: <code>arn:.*</code>)
event_id	string	The internally-generated identifier of an internet event. (pattern: <code>[a-zA-Z0-9-]+</code>)
event_status	string	The status of an internet event. (ACTIVE, RESOLVED)
event_type	string	The type of network impairment. (AVAILABILITY, PERFORMANCE)
started_at	string (date-time)	The time when an internet event started.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_internet_event	select	event_id, region		Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY), and the status (ACTIVE or RESOLVED).
list_internet_events	select	region	NextToken, InternetEventMaxResults, StartTime, EndTime, EventStatus, EventType	Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time. You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).

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 EventId of the internet event to return information for.
region	string	AWS region (default: us-east-1)
EndTime	string (date-time)	The end time of the time window that you want to get a list of internet events for.
EventStatus	string	The status of an internet event.
EventType	string	The type of network impairment.
InternetEventMaxResults	integer	The number of query results 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 start time of the time window that you want to get a list of internet events for.

SELECT examples

get_internet_event

Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY), and the status (ACTIVE or RESOLVED).

SELECT
client_location,
ended_at,
event_arn,
event_id,
event_status,
event_type,
started_at
FROM aws.internetmonitor.internet_events
WHERE event_id = '{{ event_id }}' -- required
AND region = '{{ region }}' -- required
;

list_internet_events

Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time. You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).

SELECT
client_location,
ended_at,
event_arn,
event_id,
event_status,
event_type,
started_at
FROM aws.internetmonitor.internet_events
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND InternetEventMaxResults = '{{ InternetEventMaxResults }}'
AND StartTime = '{{ StartTime }}'
AND EndTime = '{{ EndTime }}'
AND EventStatus = '{{ EventStatus }}'
AND EventType = '{{ EventType }}'
;