amazonka-forecast-2.0: Amazon Forecast Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Forecast.Types.PredictorSummary

Description

 
Synopsis

Documentation

data PredictorSummary Source #

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

See: newPredictorSummary smart constructor.

Constructors

PredictorSummary' 

Fields

  • creationTime :: Maybe POSIX

    When the model training task was created.

  • datasetGroupArn :: Maybe Text

    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

  • isAutoPredictor :: Maybe Bool

    Whether AutoPredictor was used to create the predictor.

  • lastModificationTime :: Maybe POSIX

    The last time the resource was modified. The timestamp depends on the status of the job:

    • CREATE_PENDING - The CreationTime.
    • CREATE_IN_PROGRESS - The current timestamp.
    • CREATE_STOPPING - The current timestamp.
    • CREATE_STOPPED - When the job stopped.
    • ACTIVE or CREATE_FAILED - When the job finished or failed.
  • message :: Maybe Text

    If an error occurred, an informational message about the error.

  • predictorArn :: Maybe Text

    The ARN of the predictor.

  • predictorName :: Maybe Text

    The name of the predictor.

  • referencePredictorSummary :: Maybe ReferencePredictorSummary

    A summary of the reference predictor used if the predictor was retrained or upgraded.

  • status :: Maybe Text

    The status of the predictor. States include:

    • ACTIVE
    • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    • CREATE_STOPPING, CREATE_STOPPED

    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

Instances

Instances details
FromJSON PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

parseJSON :: Value -> Parser PredictorSummary #

parseJSONList :: Value -> Parser [PredictorSummary] #

Generic PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Associated Types

type Rep PredictorSummary :: Type -> Type #

Methods

from :: PredictorSummary -> Rep PredictorSummary x #

to :: Rep PredictorSummary x -> PredictorSummary #

Read PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

readsPrec :: Int -> ReadS PredictorSummary #

readList :: ReadS [PredictorSummary] #

readPrec :: ReadPrec PredictorSummary #

readListPrec :: ReadPrec [PredictorSummary] #

Show PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

showsPrec :: Int -> PredictorSummary -> ShowS #

show :: PredictorSummary -> String #

showList :: [PredictorSummary] -> ShowS #

NFData PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

rnf :: PredictorSummary -> () #

Eq PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

(==) :: PredictorSummary -> PredictorSummary -> Bool #

(/=) :: PredictorSummary -> PredictorSummary -> Bool #

Hashable PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

Methods

hashWithSalt :: Int -> PredictorSummary -> Int #

hash :: PredictorSummary -> Int #

type Rep PredictorSummary Source # 
Instance details

Defined in Amazonka.Forecast.Types.PredictorSummary

type Rep PredictorSummary = D1 ('MetaData "PredictorSummary" "Amazonka.Forecast.Types.PredictorSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "PredictorSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "datasetGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isAutoPredictor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "predictorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "predictorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "referencePredictorSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReferencePredictorSummary)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newPredictorSummary :: PredictorSummary Source #

Create a value of PredictorSummary 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:creationTime:PredictorSummary', predictorSummary_creationTime - When the model training task was created.

$sel:datasetGroupArn:PredictorSummary', predictorSummary_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

$sel:isAutoPredictor:PredictorSummary', predictorSummary_isAutoPredictor - Whether AutoPredictor was used to create the predictor.

$sel:lastModificationTime:PredictorSummary', predictorSummary_lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.
  • CREATE_IN_PROGRESS - The current timestamp.
  • CREATE_STOPPING - The current timestamp.
  • CREATE_STOPPED - When the job stopped.
  • ACTIVE or CREATE_FAILED - When the job finished or failed.

$sel:message:PredictorSummary', predictorSummary_message - If an error occurred, an informational message about the error.

$sel:predictorArn:PredictorSummary', predictorSummary_predictorArn - The ARN of the predictor.

$sel:predictorName:PredictorSummary', predictorSummary_predictorName - The name of the predictor.

$sel:referencePredictorSummary:PredictorSummary', predictorSummary_referencePredictorSummary - A summary of the reference predictor used if the predictor was retrained or upgraded.

$sel:status:PredictorSummary', predictorSummary_status - The status of the predictor. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

predictorSummary_creationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #

When the model training task was created.

predictorSummary_datasetGroupArn :: Lens' PredictorSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

predictorSummary_isAutoPredictor :: Lens' PredictorSummary (Maybe Bool) Source #

Whether AutoPredictor was used to create the predictor.

predictorSummary_lastModificationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.
  • CREATE_IN_PROGRESS - The current timestamp.
  • CREATE_STOPPING - The current timestamp.
  • CREATE_STOPPED - When the job stopped.
  • ACTIVE or CREATE_FAILED - When the job finished or failed.

predictorSummary_message :: Lens' PredictorSummary (Maybe Text) Source #

If an error occurred, an informational message about the error.

predictorSummary_predictorArn :: Lens' PredictorSummary (Maybe Text) Source #

The ARN of the predictor.

predictorSummary_predictorName :: Lens' PredictorSummary (Maybe Text) Source #

The name of the predictor.

predictorSummary_referencePredictorSummary :: Lens' PredictorSummary (Maybe ReferencePredictorSummary) Source #

A summary of the reference predictor used if the predictor was retrained or upgraded.

predictorSummary_status :: Lens' PredictorSummary (Maybe Text) Source #

The status of the predictor. States include:

  • ACTIVE
  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.