amazonka-forecastquery-2.0: Amazon Forecast Query 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.ForecastQuery.Types.Forecast

Description

 
Synopsis

Documentation

data Forecast Source #

Provides information about a forecast. Returned as part of the QueryForecast response.

See: newForecast smart constructor.

Constructors

Forecast' 

Fields

  • predictions :: Maybe (HashMap Text [DataPoint])

    The forecast.

    The string of the string-to-array map is one of the following values:

    • p10
    • p50
    • p90

    The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

Instances

Instances details
FromJSON Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Generic Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Associated Types

type Rep Forecast :: Type -> Type #

Methods

from :: Forecast -> Rep Forecast x #

to :: Rep Forecast x -> Forecast #

Read Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Show Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

NFData Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Methods

rnf :: Forecast -> () #

Eq Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Hashable Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Methods

hashWithSalt :: Int -> Forecast -> Int #

hash :: Forecast -> Int #

type Rep Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

type Rep Forecast = D1 ('MetaData "Forecast" "Amazonka.ForecastQuery.Types.Forecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "Forecast'" 'PrefixI 'True) (S1 ('MetaSel ('Just "predictions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [DataPoint])))))

newForecast :: Forecast Source #

Create a value of Forecast 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:predictions:Forecast', forecast_predictions - The forecast.

The string of the string-to-array map is one of the following values:

  • p10
  • p50
  • p90

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

forecast_predictions :: Lens' Forecast (Maybe (HashMap Text [DataPoint])) Source #

The forecast.

The string of the string-to-array map is one of the following values:

  • p10
  • p50
  • p90

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.