alerts

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

Overview

Name	alerts
Type	Resource
Id	aws.mediatailor.alerts

Fields

The following fields are returned by SELECT queries:

list_alerts

Name	Datatype	Description
alert_code	string	The code for the alert. For example, NOT_PROCESSED.
alert_message	string	If an alert is generated for a resource, an explanation of the reason for the alert.
category	string	The category that MediaTailor assigns to the alert. (SCHEDULING_ERROR, PLAYBACK_WARNING, INFO)
last_modified_time	string (date-time)	The timestamp when the alert was last modified.
related_resource_arns	array	The Amazon Resource Names (ARNs) related to this alert.
resource_arn	string	The Amazon Resource Name (ARN) of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_alerts	select	resourceArn, region	maxResults, nextToken	Lists the alerts that are associated with a MediaTailor channel assembly resource.

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
region	string	AWS region (default: us-east-1)
resourceArn	string	The Amazon Resource Name (ARN) of the resource.
maxResults	integer	The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results. The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
nextToken	string	Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. For the first ListAlerts request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

SELECT examples

list_alerts

Lists the alerts that are associated with a MediaTailor channel assembly resource.

SELECT
alert_code,
alert_message,
category,
last_modified_time,
related_resource_arns,
resource_arn
FROM aws.mediatailor.alerts
WHERE resourceArn = '{{ resourceArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;