[ aws . forecast ]

list-monitor-evaluations

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-monitor-evaluations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PredictorMonitorEvaluations

Synopsis

  list-monitor-evaluations
--monitor-arn <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--monitor-arn (string)

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

--filters (list)

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" } ]

(structure)

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT , which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

Key -> (string)

The name of the parameter to filter on.

Value -> (string)

The value to match.

Condition -> (string)

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

Shorthand Syntax:

Key=string,Value=string,Condition=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string",
    "Condition": "IS"|"IS_NOT"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

PredictorMonitorEvaluations -> (list)

The monitoring results and predictor events collected by the monitor resource during different windows of time.

For information about monitoring see Viewing Monitoring Results . For more information about retrieving monitoring results see Viewing Monitoring Results .

(structure)

Describes the results of a monitor evaluation.

ResourceArn -> (string)

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

MonitorArn -> (string)

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

EvaluationTime -> (timestamp)

The timestamp that indicates when the monitor evaluation was started.

EvaluationState -> (string)

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

WindowStartDatetime -> (timestamp)

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

WindowEndDatetime -> (timestamp)

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

PredictorEvent -> (structure)

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

Detail -> (string)

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.

Datetime -> (timestamp)

The timestamp for when the event occurred.

MonitorDataSource -> (structure)

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

DatasetImportJobArn -> (string)

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

ForecastArn -> (string)

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

PredictorArn -> (string)

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

MetricResults -> (list)

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.

(structure)

An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric’s value in the Baseline to see how your predictor’s performance is changing.

For more information about metrics generated by Forecast see Evaluating Predictor Accuracy

MetricName -> (string)

The name of the metric.

MetricValue -> (double)

The value for the metric.

NumItemsEvaluated -> (long)

The number of items considered during the evaluation.

Message -> (string)

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