{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Forecast.Types.AdditionalDataset -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) module Amazonka.Forecast.Types.AdditionalDataset where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude -- | 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 -- <https://docs.aws.amazon.com/forecast/latest/dg/weather.html 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 -- <http://jollyday.sourceforge.net/data.html Jollyday> library. For more -- information, see -- <https://docs.aws.amazon.com/forecast/latest/dg/holidays.html Holidays Featurization>. -- -- /See:/ 'newAdditionalDataset' smart constructor. data AdditionalDataset = AdditionalDataset' { -- | __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 -> Maybe (HashMap Text (NonEmpty Text)) configuration :: Prelude.Maybe (Prelude.HashMap Prelude.Text (Prelude.NonEmpty Prelude.Text)), -- | The name of the additional dataset. Valid names: @\"holiday\"@ and -- @\"weather\"@. AdditionalDataset -> Text name :: Prelude.Text } deriving (AdditionalDataset -> AdditionalDataset -> Bool forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a /= :: AdditionalDataset -> AdditionalDataset -> Bool $c/= :: AdditionalDataset -> AdditionalDataset -> Bool == :: AdditionalDataset -> AdditionalDataset -> Bool $c== :: AdditionalDataset -> AdditionalDataset -> Bool Prelude.Eq, ReadPrec [AdditionalDataset] ReadPrec AdditionalDataset Int -> ReadS AdditionalDataset ReadS [AdditionalDataset] forall a. (Int -> ReadS a) -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a readListPrec :: ReadPrec [AdditionalDataset] $creadListPrec :: ReadPrec [AdditionalDataset] readPrec :: ReadPrec AdditionalDataset $creadPrec :: ReadPrec AdditionalDataset readList :: ReadS [AdditionalDataset] $creadList :: ReadS [AdditionalDataset] readsPrec :: Int -> ReadS AdditionalDataset $creadsPrec :: Int -> ReadS AdditionalDataset Prelude.Read, Int -> AdditionalDataset -> ShowS [AdditionalDataset] -> ShowS AdditionalDataset -> String forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a showList :: [AdditionalDataset] -> ShowS $cshowList :: [AdditionalDataset] -> ShowS show :: AdditionalDataset -> String $cshow :: AdditionalDataset -> String showsPrec :: Int -> AdditionalDataset -> ShowS $cshowsPrec :: Int -> AdditionalDataset -> ShowS Prelude.Show, forall x. Rep AdditionalDataset x -> AdditionalDataset forall x. AdditionalDataset -> Rep AdditionalDataset x forall a. (forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a $cto :: forall x. Rep AdditionalDataset x -> AdditionalDataset $cfrom :: forall x. AdditionalDataset -> Rep AdditionalDataset x Prelude.Generic) -- | -- Create a value of 'AdditionalDataset' with all optional fields omitted. -- -- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'configuration', '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 -- -- 'name', 'additionalDataset_name' - The name of the additional dataset. Valid names: @\"holiday\"@ and -- @\"weather\"@. newAdditionalDataset :: -- | 'name' Prelude.Text -> AdditionalDataset newAdditionalDataset :: Text -> AdditionalDataset newAdditionalDataset Text pName_ = AdditionalDataset' { $sel:configuration:AdditionalDataset' :: Maybe (HashMap Text (NonEmpty Text)) configuration = forall a. Maybe a Prelude.Nothing, $sel:name:AdditionalDataset' :: Text name = Text pName_ } -- | __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_configuration :: Lens.Lens' AdditionalDataset (Prelude.Maybe (Prelude.HashMap Prelude.Text (Prelude.NonEmpty Prelude.Text))) additionalDataset_configuration :: Lens' AdditionalDataset (Maybe (HashMap Text (NonEmpty Text))) additionalDataset_configuration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\AdditionalDataset' {Maybe (HashMap Text (NonEmpty Text)) configuration :: Maybe (HashMap Text (NonEmpty Text)) $sel:configuration:AdditionalDataset' :: AdditionalDataset -> Maybe (HashMap Text (NonEmpty Text)) configuration} -> Maybe (HashMap Text (NonEmpty Text)) configuration) (\s :: AdditionalDataset s@AdditionalDataset' {} Maybe (HashMap Text (NonEmpty Text)) a -> AdditionalDataset s {$sel:configuration:AdditionalDataset' :: Maybe (HashMap Text (NonEmpty Text)) configuration = Maybe (HashMap Text (NonEmpty Text)) a} :: AdditionalDataset) forall b c a. (b -> c) -> (a -> b) -> a -> c Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b. (Functor f, Functor g) => AnIso s t a b -> Iso (f s) (g t) (f a) (g b) Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b Lens.coerced -- | The name of the additional dataset. Valid names: @\"holiday\"@ and -- @\"weather\"@. additionalDataset_name :: Lens.Lens' AdditionalDataset Prelude.Text additionalDataset_name :: Lens' AdditionalDataset Text additionalDataset_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\AdditionalDataset' {Text name :: Text $sel:name:AdditionalDataset' :: AdditionalDataset -> Text name} -> Text name) (\s :: AdditionalDataset s@AdditionalDataset' {} Text a -> AdditionalDataset s {$sel:name:AdditionalDataset' :: Text name = Text a} :: AdditionalDataset) instance Data.FromJSON AdditionalDataset where parseJSON :: Value -> Parser AdditionalDataset parseJSON = forall a. String -> (Object -> Parser a) -> Value -> Parser a Data.withObject String "AdditionalDataset" ( \Object x -> Maybe (HashMap Text (NonEmpty Text)) -> Text -> AdditionalDataset AdditionalDataset' forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b Prelude.<$> (Object x forall a. FromJSON a => Object -> Key -> Parser (Maybe a) Data..:? Key "Configuration" forall a. Parser (Maybe a) -> a -> Parser a Data..!= forall a. Monoid a => a Prelude.mempty) forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b Prelude.<*> (Object x forall a. FromJSON a => Object -> Key -> Parser a Data..: Key "Name") ) instance Prelude.Hashable AdditionalDataset where hashWithSalt :: Int -> AdditionalDataset -> Int hashWithSalt Int _salt AdditionalDataset' {Maybe (HashMap Text (NonEmpty Text)) Text name :: Text configuration :: Maybe (HashMap Text (NonEmpty Text)) $sel:name:AdditionalDataset' :: AdditionalDataset -> Text $sel:configuration:AdditionalDataset' :: AdditionalDataset -> Maybe (HashMap Text (NonEmpty Text)) ..} = Int _salt forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe (HashMap Text (NonEmpty Text)) configuration forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Text name instance Prelude.NFData AdditionalDataset where rnf :: AdditionalDataset -> () rnf AdditionalDataset' {Maybe (HashMap Text (NonEmpty Text)) Text name :: Text configuration :: Maybe (HashMap Text (NonEmpty Text)) $sel:name:AdditionalDataset' :: AdditionalDataset -> Text $sel:configuration:AdditionalDataset' :: AdditionalDataset -> Maybe (HashMap Text (NonEmpty Text)) ..} = forall a. NFData a => a -> () Prelude.rnf Maybe (HashMap Text (NonEmpty Text)) configuration seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf Text name instance Data.ToJSON AdditionalDataset where toJSON :: AdditionalDataset -> Value toJSON AdditionalDataset' {Maybe (HashMap Text (NonEmpty Text)) Text name :: Text configuration :: Maybe (HashMap Text (NonEmpty Text)) $sel:name:AdditionalDataset' :: AdditionalDataset -> Text $sel:configuration:AdditionalDataset' :: AdditionalDataset -> Maybe (HashMap Text (NonEmpty Text)) ..} = [Pair] -> Value Data.object ( forall a. [Maybe a] -> [a] Prelude.catMaybes [ (Key "Configuration" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b Prelude.<$> Maybe (HashMap Text (NonEmpty Text)) configuration, forall a. a -> Maybe a Prelude.Just (Key "Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= Text name) ] )