Class: Aws::ForecastService::Types::PredictorMonitorEvaluation

Inherits:

Struct

• Object
• Struct
• Aws::ForecastService::Types::PredictorMonitorEvaluation

Defined in:

gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Describes the results of a monitor evaluation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #evaluation_state ⇒ String

  The status of the monitor evaluation.

• #evaluation_time ⇒ 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<Types::MetricResult>

  A list of metrics Forecast calculated when monitoring a predictor.

• #monitor_arn ⇒ String

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

• #monitor_data_source ⇒ Types::MonitorDataSource

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

• #num_items_evaluated ⇒ Integer

  The number of items considered during the evaluation.

• #predictor_event ⇒ Types::PredictorEvent

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

• #resource_arn ⇒ String

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

• #window_end_datetime ⇒ Time

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

• #window_start_datetime ⇒ Time

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

Instance Attribute Details

#evaluation_state ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_time ⇒ Time

The timestamp that indicates when the monitor evaluation was started.

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#metric_results ⇒ Array<Types::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.

Returns:

• (Array<Types::MetricResult>)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_data_source ⇒ Types::MonitorDataSource

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

Returns:

• (Types::MonitorDataSource)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#num_items_evaluated ⇒ Integer

The number of items considered during the evaluation.

Returns:

• (Integer)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#predictor_event ⇒ Types::PredictorEvent

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

Returns:

• (Types::PredictorEvent)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#window_end_datetime ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#window_start_datetime ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 6009

class PredictorMonitorEvaluation < Struct.new(
  :resource_arn,
  :monitor_arn,
  :evaluation_time,
  :evaluation_state,
  :window_start_datetime,
  :window_end_datetime,
  :predictor_event,
  :monitor_data_source,
  :metric_results,
  :num_items_evaluated,
  :message)
  SENSITIVE = []
  include Aws::Structure
end