Struct aws_sdk_forecast::types::PredictorMonitorEvaluation

#[non_exhaustive]
pub struct PredictorMonitorEvaluation {
    pub resource_arn: Option<String>,
    pub monitor_arn: Option<String>,
    pub evaluation_time: Option<DateTime>,
    pub evaluation_state: Option<String>,
    pub window_start_datetime: Option<DateTime>,
    pub window_end_datetime: Option<DateTime>,
    pub predictor_event: Option<PredictorEvent>,
    pub monitor_data_source: Option<MonitorDataSource>,
    pub metric_results: Option<Vec<MetricResult>>,
    pub num_items_evaluated: Option<i64>,
    pub message: Option<String>,
}

Describes the results of a monitor evaluation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

resource_arn: Option<String>

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

monitor_arn: Option<String>

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

evaluation_time: Option<DateTime>

The timestamp that indicates when the monitor evaluation was started.

evaluation_state: Option<String>

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

window_start_datetime: Option<DateTime>

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

window_end_datetime: Option<DateTime>

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

predictor_event: Option<PredictorEvent>

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

monitor_data_source: Option<MonitorDataSource>

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

metric_results: Option<Vec<MetricResult>>

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.

num_items_evaluated: Option<i64>

The number of items considered during the evaluation.

message: Option<String>

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

Implementations

impl PredictorMonitorEvaluation

pub fn resource_arn(&self) -> Option<&str>

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

pub fn monitor_arn(&self) -> Option<&str>

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

pub fn evaluation_time(&self) -> Option<&DateTime>

The timestamp that indicates when the monitor evaluation was started.

pub fn evaluation_state(&self) -> Option<&str>

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

pub fn window_start_datetime(&self) -> Option<&DateTime>

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

pub fn window_end_datetime(&self) -> Option<&DateTime>

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

pub fn predictor_event(&self) -> Option<&PredictorEvent>

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

pub fn monitor_data_source(&self) -> Option<&MonitorDataSource>

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

pub fn metric_results(&self) -> &[MetricResult]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_results.is_none().

pub fn num_items_evaluated(&self) -> Option<i64>

The number of items considered during the evaluation.

pub fn message(&self) -> Option<&str>

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

impl PredictorMonitorEvaluation

pub fn builder() -> PredictorMonitorEvaluationBuilder

Creates a new builder-style object to manufacture PredictorMonitorEvaluation.

Trait Implementations

impl Clone for PredictorMonitorEvaluation

fn clone(&self) -> PredictorMonitorEvaluation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PredictorMonitorEvaluation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PredictorMonitorEvaluation

fn eq(&self, other: &PredictorMonitorEvaluation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PredictorMonitorEvaluation