alerts

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

Overview

Name	alerts
Type	Resource
Id	aws.medialive.alerts

Fields

The following fields are returned by SELECT queries:

list_alerts

Name	Datatype	Description
alert_type	string	Placeholder documentation for __string
cleared_timestamp	string (date-time)	Placeholder documentation for __timestampIso8601
id	string	Placeholder documentation for __string
message	string	Placeholder documentation for __string
pipeline_id	string	Placeholder documentation for __string
set_timestamp	string (date-time)	Placeholder documentation for __timestampIso8601
state	string	The state of the alert (SET, CLEARED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_alerts	select	channel_id, region	maxResults, nextToken, stateFilter	List the alerts for a channel with optional filtering based on alert state.

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
channel_id	string	The unique ID of the channel
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to return
nextToken	string	The next pagination token
stateFilter	string	Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.

SELECT examples

list_alerts

List the alerts for a channel with optional filtering based on alert state.

SELECT
alert_type,
cleared_timestamp,
id,
message,
pipeline_id,
set_timestamp,
state
FROM aws.medialive.alerts
WHERE channel_id = '{{ channel_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND stateFilter = '{{ stateFilter }}'
;