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.ForecastQuery.Types

Contents

Service Configuration
Errors
DataPoint
Forecast

Description

Synopsis

defaultService :: Service
_InvalidInputException :: AsError a => Fold a ServiceError
_InvalidNextTokenException :: AsError a => Fold a ServiceError
_LimitExceededException :: AsError a => Fold a ServiceError
_ResourceInUseException :: AsError a => Fold a ServiceError
_ResourceNotFoundException :: AsError a => Fold a ServiceError
data DataPoint = DataPoint' {
- timestamp :: Maybe Text
- value :: Maybe Double
}
newDataPoint :: DataPoint
dataPoint_timestamp :: Lens' DataPoint (Maybe Text)
dataPoint_value :: Lens' DataPoint (Maybe Double)
data Forecast = Forecast' {
- predictions :: Maybe (HashMap Text [DataPoint])
}
newForecast :: Forecast
forecast_predictions :: Lens' Forecast (Maybe (HashMap Text [DataPoint]))

Service Configuration

defaultService :: Service Source #

API version 2018-06-26 of the Amazon Forecast Query Service SDK configuration.

Errors

_InvalidInputException :: AsError a => Fold a ServiceError Source #

The value is invalid or is too long.

_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #

The token is not valid. Tokens expire after 24 hours.

_LimitExceededException :: AsError a => Fold a ServiceError Source #

The limit on the number of requests per second has been exceeded.

_ResourceInUseException :: AsError a => Fold a ServiceError Source #

The specified resource is in use.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

We can't find that resource. Check the information that you've provided and try again.

DataPoint

data DataPoint Source #

The forecast value for a specific date. Part of the Forecast object.

See: newDataPoint smart constructor.

Constructors

DataPoint'
Fields timestamp :: Maybe Text The timestamp of the specific forecast. value :: Maybe Double The forecast value.

Instances

Instances details

FromJSON DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods parseJSON :: Value -> Parser DataPoint # parseJSONList :: Value -> Parser [DataPoint] #
Generic DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Associated Types type Rep DataPoint :: Type -> Type # Methods from :: DataPoint -> Rep DataPoint x # to :: Rep DataPoint x -> DataPoint #
Read DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods readsPrec :: Int -> ReadS DataPoint # readList :: ReadS [DataPoint] # readPrec :: ReadPrec DataPoint # readListPrec :: ReadPrec [DataPoint] #
Show DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods showsPrec :: Int -> DataPoint -> ShowS # show :: DataPoint -> String # showList :: [DataPoint] -> ShowS #
NFData DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods rnf :: DataPoint -> () #
Eq DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods (==) :: DataPoint -> DataPoint -> Bool # (/=) :: DataPoint -> DataPoint -> Bool #
Hashable DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods hashWithSalt :: Int -> DataPoint -> Int # hash :: DataPoint -> Int #
type Rep DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint type Rep DataPoint = D1 ('MetaData "DataPoint" "Amazonka.ForecastQuery.Types.DataPoint" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "DataPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newDataPoint :: DataPoint Source #

Create a value of DataPoint 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:timestamp:DataPoint', dataPoint_timestamp - The timestamp of the specific forecast.

$sel:value:DataPoint', dataPoint_value - The forecast value.

dataPoint_timestamp :: Lens' DataPoint (Maybe Text) Source #

The timestamp of the specific forecast.

dataPoint_value :: Lens' DataPoint (Maybe Double) Source #

The forecast value.

Forecast

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 Methods parseJSON :: Value -> Parser Forecast # parseJSONList :: Value -> Parser [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 Methods readsPrec :: Int -> ReadS Forecast # readList :: ReadS [Forecast] # readPrec :: ReadPrec Forecast # readListPrec :: ReadPrec [Forecast] #
Show Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods showsPrec :: Int -> Forecast -> ShowS # show :: Forecast -> String # showList :: [Forecast] -> ShowS #
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 Methods (==) :: Forecast -> Forecast -> Bool # (/=) :: Forecast -> Forecast -> Bool #
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.