Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.Types.PredictorMonitorEvaluation

Description

Synopsis

Documentation

data PredictorMonitorEvaluation Source #

Describes the results of a monitor evaluation.

See: newPredictorMonitorEvaluation smart constructor.

Constructors

PredictorMonitorEvaluation'

Fields

evaluationState :: Maybe Text
The status of the monitor evaluation. The state can be SUCCESS or FAILURE.
evaluationTime :: Maybe POSIX
The timestamp that indicates when the monitor evaluation was started.
message :: Maybe Text
Information about any errors that may have occurred during the monitor evaluation.
metricResults :: Maybe [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.
monitorArn :: Maybe Text
The Amazon Resource Name (ARN) of the monitor resource.
monitorDataSource :: Maybe MonitorDataSource
The source of the data the monitor resource used during the evaluation.
numItemsEvaluated :: Maybe Integer
The number of items considered during the evaluation.
predictorEvent :: Maybe PredictorEvent
Provides details about a predictor event, such as a retraining.
resourceArn :: Maybe Text
The Amazon Resource Name (ARN) of the resource to monitor.
windowEndDatetime :: Maybe POSIX
The timestamp that indicates the end of the window that is used for monitor evaluation.
windowStartDatetime :: Maybe POSIX
The timestamp that indicates the start of the window that is used for monitor evaluation.

Instances

Instances details

FromJSON PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods parseJSON :: Value -> Parser PredictorMonitorEvaluation # parseJSONList :: Value -> Parser [PredictorMonitorEvaluation] #
Generic PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Associated Types type Rep PredictorMonitorEvaluation :: Type -> Type # Methods from :: PredictorMonitorEvaluation -> Rep PredictorMonitorEvaluation x # to :: Rep PredictorMonitorEvaluation x -> PredictorMonitorEvaluation #
Read PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods readsPrec :: Int -> ReadS PredictorMonitorEvaluation # readList :: ReadS [PredictorMonitorEvaluation] # readPrec :: ReadPrec PredictorMonitorEvaluation # readListPrec :: ReadPrec [PredictorMonitorEvaluation] #
Show PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods showsPrec :: Int -> PredictorMonitorEvaluation -> ShowS # show :: PredictorMonitorEvaluation -> String # showList :: [PredictorMonitorEvaluation] -> ShowS #
NFData PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods rnf :: PredictorMonitorEvaluation -> () #
Eq PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods (==) :: PredictorMonitorEvaluation -> PredictorMonitorEvaluation -> Bool # (/=) :: PredictorMonitorEvaluation -> PredictorMonitorEvaluation -> Bool #
Hashable PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation Methods hashWithSalt :: Int -> PredictorMonitorEvaluation -> Int # hash :: PredictorMonitorEvaluation -> Int #
type Rep PredictorMonitorEvaluation Source #
Instance details Defined in Amazonka.Forecast.Types.PredictorMonitorEvaluation type Rep PredictorMonitorEvaluation = D1 ('MetaData "PredictorMonitorEvaluation" "Amazonka.Forecast.Types.PredictorMonitorEvaluation" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "PredictorMonitorEvaluation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "evaluationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "evaluationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metricResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricResult])) :: S1 ('MetaSel ('Just "monitorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "monitorDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MonitorDataSource)) :: (S1 ('MetaSel ('Just "numItemsEvaluated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "predictorEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PredictorEvent)))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "windowEndDatetime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "windowStartDatetime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newPredictorMonitorEvaluation :: PredictorMonitorEvaluation Source #

Create a value of PredictorMonitorEvaluation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:evaluationState:PredictorMonitorEvaluation', predictorMonitorEvaluation_evaluationState - The status of the monitor evaluation. The state can be SUCCESS or FAILURE.

$sel:evaluationTime:PredictorMonitorEvaluation', predictorMonitorEvaluation_evaluationTime - The timestamp that indicates when the monitor evaluation was started.

$sel:message:PredictorMonitorEvaluation', predictorMonitorEvaluation_message - Information about any errors that may have occurred during the monitor evaluation.

$sel:metricResults:PredictorMonitorEvaluation', predictorMonitorEvaluation_metricResults - 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.

$sel:monitorArn:PredictorMonitorEvaluation', predictorMonitorEvaluation_monitorArn - The Amazon Resource Name (ARN) of the monitor resource.

$sel:monitorDataSource:PredictorMonitorEvaluation', predictorMonitorEvaluation_monitorDataSource - The source of the data the monitor resource used during the evaluation.

$sel:numItemsEvaluated:PredictorMonitorEvaluation', predictorMonitorEvaluation_numItemsEvaluated - The number of items considered during the evaluation.

$sel:predictorEvent:PredictorMonitorEvaluation', predictorMonitorEvaluation_predictorEvent - Provides details about a predictor event, such as a retraining.

$sel:resourceArn:PredictorMonitorEvaluation', predictorMonitorEvaluation_resourceArn - The Amazon Resource Name (ARN) of the resource to monitor.

$sel:windowEndDatetime:PredictorMonitorEvaluation', predictorMonitorEvaluation_windowEndDatetime - The timestamp that indicates the end of the window that is used for monitor evaluation.

$sel:windowStartDatetime:PredictorMonitorEvaluation', predictorMonitorEvaluation_windowStartDatetime - The timestamp that indicates the start of the window that is used for monitor evaluation.

predictorMonitorEvaluation_evaluationState :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #

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

predictorMonitorEvaluation_evaluationTime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #

The timestamp that indicates when the monitor evaluation was started.

predictorMonitorEvaluation_message :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #

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

predictorMonitorEvaluation_metricResults :: Lens' PredictorMonitorEvaluation (Maybe [MetricResult]) Source #

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.

predictorMonitorEvaluation_monitorArn :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #

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

predictorMonitorEvaluation_monitorDataSource :: Lens' PredictorMonitorEvaluation (Maybe MonitorDataSource) Source #

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

predictorMonitorEvaluation_numItemsEvaluated :: Lens' PredictorMonitorEvaluation (Maybe Integer) Source #

The number of items considered during the evaluation.

predictorMonitorEvaluation_predictorEvent :: Lens' PredictorMonitorEvaluation (Maybe PredictorEvent) Source #

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

predictorMonitorEvaluation_resourceArn :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #

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

predictorMonitorEvaluation_windowEndDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #

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

predictorMonitorEvaluation_windowStartDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #

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