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

Description

 
Synopsis

Documentation

data AdditionalDataset Source #

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

Weather Index

The Amazon Forecast Weather Index is a built-in dataset 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 dataset that incorporates 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: newAdditionalDataset smart constructor.

Constructors

AdditionalDataset' 

Fields

  • configuration :: Maybe (HashMap Text (NonEmpty Text))

    Weather Index

    To enable the Weather Index, do not specify a value for Configuration.

    Holidays

    Holidays

    To enable Holidays, set CountryCode to 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
  • name :: Text

    The name of the additional dataset. Valid names: "holiday" and "weather".

Instances

Instances details
FromJSON AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

parseJSON :: Value -> Parser AdditionalDataset #

parseJSONList :: Value -> Parser [AdditionalDataset] #

ToJSON AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

toJSON :: AdditionalDataset -> Value #

toEncoding :: AdditionalDataset -> Encoding #

toJSONList :: [AdditionalDataset] -> Value #

toEncodingList :: [AdditionalDataset] -> Encoding #

Generic AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Associated Types

type Rep AdditionalDataset :: Type -> Type #

Methods

from :: AdditionalDataset -> Rep AdditionalDataset x #

to :: Rep AdditionalDataset x -> AdditionalDataset #

Read AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

readsPrec :: Int -> ReadS AdditionalDataset #

readList :: ReadS [AdditionalDataset] #

readPrec :: ReadPrec AdditionalDataset #

readListPrec :: ReadPrec [AdditionalDataset] #

Show AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

showsPrec :: Int -> AdditionalDataset -> ShowS #

show :: AdditionalDataset -> String #

showList :: [AdditionalDataset] -> ShowS #

NFData AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

rnf :: AdditionalDataset -> () #

Eq AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

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

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

Hashable AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

Methods

hashWithSalt :: Int -> AdditionalDataset -> Int #

hash :: AdditionalDataset -> Int #

type Rep AdditionalDataset Source # 
Instance details

Defined in Amazonka.Forecast.Types.AdditionalDataset

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

newAdditionalDataset Source #

Arguments

:: Text

$sel:name:AdditionalDataset'

-> AdditionalDataset 

Create a value of AdditionalDataset 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:configuration:AdditionalDataset', additionalDataset_configuration - Weather Index

To enable the Weather Index, do not specify a value for Configuration.

Holidays

Holidays

To enable Holidays, set CountryCode to 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

$sel:name:AdditionalDataset', additionalDataset_name - The name of the additional dataset. Valid names: "holiday" and "weather".

additionalDataset_configuration :: Lens' AdditionalDataset (Maybe (HashMap Text (NonEmpty Text))) Source #

Weather Index

To enable the Weather Index, do not specify a value for Configuration.

Holidays

Holidays

To enable Holidays, set CountryCode to 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

additionalDataset_name :: Lens' AdditionalDataset Text Source #

The name of the additional dataset. Valid names: "holiday" and "weather".