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.SupplementaryFeature

Description

 
Synopsis

Documentation

data SupplementaryFeature Source #

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.

Weather Index

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

Holidays

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

See: newSupplementaryFeature smart constructor.

Constructors

SupplementaryFeature' 

Fields

  • name :: Text

    The name of the feature. Valid values: "holiday" and "weather".

  • value :: Text

    Weather Index

    To enable the Weather Index, set the value to "true"

    Holidays

    To enable Holidays, specify a country with one of the following two-letter country codes:

    • "AL" - ALBANIA
    • "AR" - ARGENTINA
    • "AT" - AUSTRIA
    • "AU" - AUSTRALIA
    • "BA" - BOSNIA HERZEGOVINA
    • "BE" - BELGIUM
    • "BG" - BULGARIA
    • "BO" - BOLIVIA
    • "BR" - BRAZIL
    • "BY" - BELARUS
    • "CA" - CANADA
    • "CL" - CHILE
    • "CO" - COLOMBIA
    • "CR" - COSTA RICA
    • "HR" - CROATIA
    • "CZ" - CZECH REPUBLIC
    • "DK" - DENMARK
    • "EC" - ECUADOR
    • "EE" - ESTONIA
    • "ET" - ETHIOPIA
    • "FI" - FINLAND
    • "FR" - FRANCE
    • "DE" - GERMANY
    • "GR" - GREECE
    • "HU" - HUNGARY
    • "IS" - ICELAND
    • "IN" - INDIA
    • "IE" - IRELAND
    • "IT" - ITALY
    • "JP" - JAPAN
    • "KZ" - KAZAKHSTAN
    • "KR" - KOREA
    • "LV" - LATVIA
    • "LI" - LIECHTENSTEIN
    • "LT" - LITHUANIA
    • "LU" - LUXEMBOURG
    • "MK" - MACEDONIA
    • "MT" - MALTA
    • "MX" - MEXICO
    • "MD" - MOLDOVA
    • "ME" - MONTENEGRO
    • "NL" - NETHERLANDS
    • "NZ" - NEW ZEALAND
    • "NI" - NICARAGUA
    • "NG" - NIGERIA
    • "NO" - NORWAY
    • "PA" - PANAMA
    • "PY" - PARAGUAY
    • "PE" - PERU
    • "PL" - POLAND
    • "PT" - PORTUGAL
    • "RO" - ROMANIA
    • "RU" - RUSSIA
    • "RS" - SERBIA
    • "SK" - SLOVAKIA
    • "SI" - SLOVENIA
    • "ZA" - SOUTH AFRICA
    • "ES" - SPAIN
    • "SE" - SWEDEN
    • "CH" - SWITZERLAND
    • "UA" - UKRAINE
    • "AE" - UNITED ARAB EMIRATES
    • "US" - UNITED STATES
    • "UK" - UNITED KINGDOM
    • "UY" - URUGUAY
    • "VE" - VENEZUELA

Instances

Instances details
FromJSON SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

parseJSON :: Value -> Parser SupplementaryFeature #

parseJSONList :: Value -> Parser [SupplementaryFeature] #

ToJSON SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

toJSON :: SupplementaryFeature -> Value #

toEncoding :: SupplementaryFeature -> Encoding #

toJSONList :: [SupplementaryFeature] -> Value #

toEncodingList :: [SupplementaryFeature] -> Encoding #

Generic SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Associated Types

type Rep SupplementaryFeature :: Type -> Type #

Methods

from :: SupplementaryFeature -> Rep SupplementaryFeature x #

to :: Rep SupplementaryFeature x -> SupplementaryFeature #

Read SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

readsPrec :: Int -> ReadS SupplementaryFeature #

readList :: ReadS [SupplementaryFeature] #

readPrec :: ReadPrec SupplementaryFeature #

readListPrec :: ReadPrec [SupplementaryFeature] #

Show SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

showsPrec :: Int -> SupplementaryFeature -> ShowS #

show :: SupplementaryFeature -> String #

showList :: [SupplementaryFeature] -> ShowS #

NFData SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

rnf :: SupplementaryFeature -> () #

Eq SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

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

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

Hashable SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

Methods

hashWithSalt :: Int -> SupplementaryFeature -> Int #

hash :: SupplementaryFeature -> Int #

type Rep SupplementaryFeature Source # 
Instance details

Defined in Amazonka.Forecast.Types.SupplementaryFeature

type Rep SupplementaryFeature = D1 ('MetaData "SupplementaryFeature" "Amazonka.Forecast.Types.SupplementaryFeature" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "SupplementaryFeature'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSupplementaryFeature Source #

Arguments

:: Text

$sel:name:SupplementaryFeature'

-> Text

$sel:value:SupplementaryFeature'

-> SupplementaryFeature 

Create a value of SupplementaryFeature 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:name:SupplementaryFeature', supplementaryFeature_name - The name of the feature. Valid values: "holiday" and "weather".

$sel:value:SupplementaryFeature', supplementaryFeature_value - Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

  • "AL" - ALBANIA
  • "AR" - ARGENTINA
  • "AT" - AUSTRIA
  • "AU" - AUSTRALIA
  • "BA" - BOSNIA HERZEGOVINA
  • "BE" - BELGIUM
  • "BG" - BULGARIA
  • "BO" - BOLIVIA
  • "BR" - BRAZIL
  • "BY" - BELARUS
  • "CA" - CANADA
  • "CL" - CHILE
  • "CO" - COLOMBIA
  • "CR" - COSTA RICA
  • "HR" - CROATIA
  • "CZ" - CZECH REPUBLIC
  • "DK" - DENMARK
  • "EC" - ECUADOR
  • "EE" - ESTONIA
  • "ET" - ETHIOPIA
  • "FI" - FINLAND
  • "FR" - FRANCE
  • "DE" - GERMANY
  • "GR" - GREECE
  • "HU" - HUNGARY
  • "IS" - ICELAND
  • "IN" - INDIA
  • "IE" - IRELAND
  • "IT" - ITALY
  • "JP" - JAPAN
  • "KZ" - KAZAKHSTAN
  • "KR" - KOREA
  • "LV" - LATVIA
  • "LI" - LIECHTENSTEIN
  • "LT" - LITHUANIA
  • "LU" - LUXEMBOURG
  • "MK" - MACEDONIA
  • "MT" - MALTA
  • "MX" - MEXICO
  • "MD" - MOLDOVA
  • "ME" - MONTENEGRO
  • "NL" - NETHERLANDS
  • "NZ" - NEW ZEALAND
  • "NI" - NICARAGUA
  • "NG" - NIGERIA
  • "NO" - NORWAY
  • "PA" - PANAMA
  • "PY" - PARAGUAY
  • "PE" - PERU
  • "PL" - POLAND
  • "PT" - PORTUGAL
  • "RO" - ROMANIA
  • "RU" - RUSSIA
  • "RS" - SERBIA
  • "SK" - SLOVAKIA
  • "SI" - SLOVENIA
  • "ZA" - SOUTH AFRICA
  • "ES" - SPAIN
  • "SE" - SWEDEN
  • "CH" - SWITZERLAND
  • "UA" - UKRAINE
  • "AE" - UNITED ARAB EMIRATES
  • "US" - UNITED STATES
  • "UK" - UNITED KINGDOM
  • "UY" - URUGUAY
  • "VE" - VENEZUELA

supplementaryFeature_name :: Lens' SupplementaryFeature Text Source #

The name of the feature. Valid values: "holiday" and "weather".

supplementaryFeature_value :: Lens' SupplementaryFeature Text Source #

Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

  • "AL" - ALBANIA
  • "AR" - ARGENTINA
  • "AT" - AUSTRIA
  • "AU" - AUSTRALIA
  • "BA" - BOSNIA HERZEGOVINA
  • "BE" - BELGIUM
  • "BG" - BULGARIA
  • "BO" - BOLIVIA
  • "BR" - BRAZIL
  • "BY" - BELARUS
  • "CA" - CANADA
  • "CL" - CHILE
  • "CO" - COLOMBIA
  • "CR" - COSTA RICA
  • "HR" - CROATIA
  • "CZ" - CZECH REPUBLIC
  • "DK" - DENMARK
  • "EC" - ECUADOR
  • "EE" - ESTONIA
  • "ET" - ETHIOPIA
  • "FI" - FINLAND
  • "FR" - FRANCE
  • "DE" - GERMANY
  • "GR" - GREECE
  • "HU" - HUNGARY
  • "IS" - ICELAND
  • "IN" - INDIA
  • "IE" - IRELAND
  • "IT" - ITALY
  • "JP" - JAPAN
  • "KZ" - KAZAKHSTAN
  • "KR" - KOREA
  • "LV" - LATVIA
  • "LI" - LIECHTENSTEIN
  • "LT" - LITHUANIA
  • "LU" - LUXEMBOURG
  • "MK" - MACEDONIA
  • "MT" - MALTA
  • "MX" - MEXICO
  • "MD" - MOLDOVA
  • "ME" - MONTENEGRO
  • "NL" - NETHERLANDS
  • "NZ" - NEW ZEALAND
  • "NI" - NICARAGUA
  • "NG" - NIGERIA
  • "NO" - NORWAY
  • "PA" - PANAMA
  • "PY" - PARAGUAY
  • "PE" - PERU
  • "PL" - POLAND
  • "PT" - PORTUGAL
  • "RO" - ROMANIA
  • "RU" - RUSSIA
  • "RS" - SERBIA
  • "SK" - SLOVAKIA
  • "SI" - SLOVENIA
  • "ZA" - SOUTH AFRICA
  • "ES" - SPAIN
  • "SE" - SWEDEN
  • "CH" - SWITZERLAND
  • "UA" - UKRAINE
  • "AE" - UNITED ARAB EMIRATES
  • "US" - UNITED STATES
  • "UK" - UNITED KINGDOM
  • "UY" - URUGUAY
  • "VE" - VENEZUELA