Skip to content

aws.forecast.list_monitor_evaluations

Example SQL Queries

SELECT * FROM
aws.forecast.list_monitor_evaluations
WHERE
"monitor_arn" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
monitor_arn Required Input Column

The Amazon Resource Name (ARN) of the monitor resource.

VARCHAR
filters Input Column

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT.

  • Key - The name of the parameter to filter on. The only valid value is EvaluationState.

  • Value - The value to match. Valid values are only SUCCESS or FAILURE.

For example, to list only successful monitor evaluations, you would specify:

"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]

STRUCT(
"key" VARCHAR,
"value" VARCHAR,
"condition" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].condition

The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

filters[].key

The name of the parameter to filter on.

filters[].value

The value to match.

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
evaluation_state

The status of the monitor evaluation. The state can be SUCCESS or FAILURE.

VARCHAR
evaluation_time

The timestamp that indicates when the monitor evaluation was started.

TIMESTAMP_S
message

Information about any errors that may have occurred during the monitor evaluation.

VARCHAR
metric_results

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.

STRUCT(
"metric_name" VARCHAR,
"metric_value" DOUBLE
)[]
Show child fields
metric_results[]
Show child fields
metric_results[].metric_name

The name of the metric.

metric_results[].metric_value

The value for the metric.

monitor_data_source

The source of the data the monitor resource used during the evaluation.

STRUCT(
"dataset_import_job_arn" VARCHAR,
"forecast_arn" VARCHAR,
"predictor_arn" VARCHAR
)
Show child fields
monitor_data_source.dataset_import_job_arn

The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.

monitor_data_source.forecast_arn

The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.

monitor_data_source.predictor_arn

The Amazon Resource Name (ARN) of the predictor resource you are monitoring.

num_items_evaluated

The number of items considered during the evaluation.

BIGINT
predictor_event

Provides details about a predictor event, such as a retraining.

STRUCT(
"detail" VARCHAR,
"datetime" TIMESTAMP_S
)
Show child fields
predictor_event.datetime

The timestamp for when the event occurred.

predictor_event.detail

The type of event. For example, Retrain. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the Datetime are from the previous predictor. Any new metrics are for the newly retrained predictor.

resource_arn

The Amazon Resource Name (ARN) of the resource to monitor.

VARCHAR
window_end_datetime

The timestamp that indicates the end of the window that is used for monitor evaluation.

TIMESTAMP_S
window_start_datetime

The timestamp that indicates the start of the window that is used for monitor evaluation.

TIMESTAMP_S