monitor_evaluations

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

Overview

Name	monitor_evaluations
Type	Resource
Id	aws.forecast.monitor_evaluations

Fields

The following fields are returned by SELECT queries:

list_monitor_evaluations

Name	Datatype	Description
evaluation_state	string	The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
evaluation_time	string (date-time)	The timestamp that indicates when the monitor evaluation was started.
message	string	Information about any errors that may have occurred during the monitor evaluation.
metric_results	array	A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.
monitor_arn	string	The Amazon Resource Name (ARN) of the monitor resource. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
monitor_data_source	object	The source of the data the monitor resource used during the evaluation.
num_items_evaluated	integer (int64)	The number of items considered during the evaluation.
predictor_event	object	Provides details about a predictor event, such as a retraining.
resource_arn	string	The Amazon Resource Name (ARN) of the resource to monitor. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
window_end_datetime	string (date-time)	The timestamp that indicates the end of the window that is used for monitor evaluation.
window_start_datetime	string (date-time)	The timestamp that indicates the start of the window that is used for monitor evaluation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_monitor_evaluations	select	region		Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

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)

SELECT examples

list_monitor_evaluations

Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.

SELECT
evaluation_state,
evaluation_time,
message,
metric_results,
monitor_arn,
monitor_data_source,
num_items_evaluated,
predictor_event,
resource_arn,
window_end_datetime,
window_start_datetime
FROM aws.forecast.monitor_evaluations
WHERE region = '{{ region }}' -- required
;