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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

Describes the results of a monitor evaluation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#evaluation_stateString

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

Returns:

  • (String)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_timeTime

The timestamp that indicates when the monitor evaluation was started.

Returns:

  • (Time)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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

#messageString

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

Returns:

  • (String)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_resultsArray<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:



6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_arnString

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

Returns:

  • (String)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_sourceTypes::MonitorDataSource

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



6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_evaluatedInteger

The number of items considered during the evaluation.

Returns:

  • (Integer)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_eventTypes::PredictorEvent

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



6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_arnString

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

Returns:

  • (String)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_datetimeTime

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

Returns:

  • (Time)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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_datetimeTime

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

Returns:

  • (Time)


6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
# 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