{-# 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.ExplainabilityConfig
-- 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.ExplainabilityConfig where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Forecast.Types.TimePointGranularity
import Amazonka.Forecast.Types.TimeSeriesGranularity
import qualified Amazonka.Prelude as Prelude

-- | The ExplainabilityConfig data type defines the number of time series and
-- time points included in CreateExplainability.
--
-- If you provide a predictor ARN for @ResourceArn@, you must set both
-- @TimePointGranularity@ and @TimeSeriesGranularity@ to “ALL”. When
-- creating Predictor Explainability, Amazon Forecast considers all time
-- series and time points.
--
-- If you provide a forecast ARN for @ResourceArn@, you can set
-- @TimePointGranularity@ and @TimeSeriesGranularity@ to either “ALL” or
-- “Specific”.
--
-- /See:/ 'newExplainabilityConfig' smart constructor.
data ExplainabilityConfig = ExplainabilityConfig'
  { -- | To create an Explainability for all time series in your datasets, use
    -- @ALL@. To create an Explainability for specific time series in your
    -- datasets, use @SPECIFIC@.
    --
    -- Specify time series by uploading a CSV or Parquet file to an Amazon S3
    -- bucket and set the location within the DataDestination data type.
    ExplainabilityConfig -> TimeSeriesGranularity
timeSeriesGranularity :: TimeSeriesGranularity,
    -- | To create an Explainability for all time points in your forecast
    -- horizon, use @ALL@. To create an Explainability for specific time points
    -- in your forecast horizon, use @SPECIFIC@.
    --
    -- Specify time points with the @StartDateTime@ and @EndDateTime@
    -- parameters within the CreateExplainability operation.
    ExplainabilityConfig -> TimePointGranularity
timePointGranularity :: TimePointGranularity
  }
  deriving (ExplainabilityConfig -> ExplainabilityConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExplainabilityConfig -> ExplainabilityConfig -> Bool
$c/= :: ExplainabilityConfig -> ExplainabilityConfig -> Bool
== :: ExplainabilityConfig -> ExplainabilityConfig -> Bool
$c== :: ExplainabilityConfig -> ExplainabilityConfig -> Bool
Prelude.Eq, ReadPrec [ExplainabilityConfig]
ReadPrec ExplainabilityConfig
Int -> ReadS ExplainabilityConfig
ReadS [ExplainabilityConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ExplainabilityConfig]
$creadListPrec :: ReadPrec [ExplainabilityConfig]
readPrec :: ReadPrec ExplainabilityConfig
$creadPrec :: ReadPrec ExplainabilityConfig
readList :: ReadS [ExplainabilityConfig]
$creadList :: ReadS [ExplainabilityConfig]
readsPrec :: Int -> ReadS ExplainabilityConfig
$creadsPrec :: Int -> ReadS ExplainabilityConfig
Prelude.Read, Int -> ExplainabilityConfig -> ShowS
[ExplainabilityConfig] -> ShowS
ExplainabilityConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExplainabilityConfig] -> ShowS
$cshowList :: [ExplainabilityConfig] -> ShowS
show :: ExplainabilityConfig -> String
$cshow :: ExplainabilityConfig -> String
showsPrec :: Int -> ExplainabilityConfig -> ShowS
$cshowsPrec :: Int -> ExplainabilityConfig -> ShowS
Prelude.Show, forall x. Rep ExplainabilityConfig x -> ExplainabilityConfig
forall x. ExplainabilityConfig -> Rep ExplainabilityConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ExplainabilityConfig x -> ExplainabilityConfig
$cfrom :: forall x. ExplainabilityConfig -> Rep ExplainabilityConfig x
Prelude.Generic)

-- |
-- Create a value of 'ExplainabilityConfig' 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:
--
-- 'timeSeriesGranularity', 'explainabilityConfig_timeSeriesGranularity' - To create an Explainability for all time series in your datasets, use
-- @ALL@. To create an Explainability for specific time series in your
-- datasets, use @SPECIFIC@.
--
-- Specify time series by uploading a CSV or Parquet file to an Amazon S3
-- bucket and set the location within the DataDestination data type.
--
-- 'timePointGranularity', 'explainabilityConfig_timePointGranularity' - To create an Explainability for all time points in your forecast
-- horizon, use @ALL@. To create an Explainability for specific time points
-- in your forecast horizon, use @SPECIFIC@.
--
-- Specify time points with the @StartDateTime@ and @EndDateTime@
-- parameters within the CreateExplainability operation.
newExplainabilityConfig ::
  -- | 'timeSeriesGranularity'
  TimeSeriesGranularity ->
  -- | 'timePointGranularity'
  TimePointGranularity ->
  ExplainabilityConfig
newExplainabilityConfig :: TimeSeriesGranularity
-> TimePointGranularity -> ExplainabilityConfig
newExplainabilityConfig
  TimeSeriesGranularity
pTimeSeriesGranularity_
  TimePointGranularity
pTimePointGranularity_ =
    ExplainabilityConfig'
      { $sel:timeSeriesGranularity:ExplainabilityConfig' :: TimeSeriesGranularity
timeSeriesGranularity =
          TimeSeriesGranularity
pTimeSeriesGranularity_,
        $sel:timePointGranularity:ExplainabilityConfig' :: TimePointGranularity
timePointGranularity = TimePointGranularity
pTimePointGranularity_
      }

-- | To create an Explainability for all time series in your datasets, use
-- @ALL@. To create an Explainability for specific time series in your
-- datasets, use @SPECIFIC@.
--
-- Specify time series by uploading a CSV or Parquet file to an Amazon S3
-- bucket and set the location within the DataDestination data type.
explainabilityConfig_timeSeriesGranularity :: Lens.Lens' ExplainabilityConfig TimeSeriesGranularity
explainabilityConfig_timeSeriesGranularity :: Lens' ExplainabilityConfig TimeSeriesGranularity
explainabilityConfig_timeSeriesGranularity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExplainabilityConfig' {TimeSeriesGranularity
timeSeriesGranularity :: TimeSeriesGranularity
$sel:timeSeriesGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimeSeriesGranularity
timeSeriesGranularity} -> TimeSeriesGranularity
timeSeriesGranularity) (\s :: ExplainabilityConfig
s@ExplainabilityConfig' {} TimeSeriesGranularity
a -> ExplainabilityConfig
s {$sel:timeSeriesGranularity:ExplainabilityConfig' :: TimeSeriesGranularity
timeSeriesGranularity = TimeSeriesGranularity
a} :: ExplainabilityConfig)

-- | To create an Explainability for all time points in your forecast
-- horizon, use @ALL@. To create an Explainability for specific time points
-- in your forecast horizon, use @SPECIFIC@.
--
-- Specify time points with the @StartDateTime@ and @EndDateTime@
-- parameters within the CreateExplainability operation.
explainabilityConfig_timePointGranularity :: Lens.Lens' ExplainabilityConfig TimePointGranularity
explainabilityConfig_timePointGranularity :: Lens' ExplainabilityConfig TimePointGranularity
explainabilityConfig_timePointGranularity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExplainabilityConfig' {TimePointGranularity
timePointGranularity :: TimePointGranularity
$sel:timePointGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimePointGranularity
timePointGranularity} -> TimePointGranularity
timePointGranularity) (\s :: ExplainabilityConfig
s@ExplainabilityConfig' {} TimePointGranularity
a -> ExplainabilityConfig
s {$sel:timePointGranularity:ExplainabilityConfig' :: TimePointGranularity
timePointGranularity = TimePointGranularity
a} :: ExplainabilityConfig)

instance Data.FromJSON ExplainabilityConfig where
  parseJSON :: Value -> Parser ExplainabilityConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ExplainabilityConfig"
      ( \Object
x ->
          TimeSeriesGranularity
-> TimePointGranularity -> ExplainabilityConfig
ExplainabilityConfig'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"TimeSeriesGranularity")
            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
"TimePointGranularity")
      )

instance Prelude.Hashable ExplainabilityConfig where
  hashWithSalt :: Int -> ExplainabilityConfig -> Int
hashWithSalt Int
_salt ExplainabilityConfig' {TimePointGranularity
TimeSeriesGranularity
timePointGranularity :: TimePointGranularity
timeSeriesGranularity :: TimeSeriesGranularity
$sel:timePointGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimePointGranularity
$sel:timeSeriesGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimeSeriesGranularity
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TimeSeriesGranularity
timeSeriesGranularity
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TimePointGranularity
timePointGranularity

instance Prelude.NFData ExplainabilityConfig where
  rnf :: ExplainabilityConfig -> ()
rnf ExplainabilityConfig' {TimePointGranularity
TimeSeriesGranularity
timePointGranularity :: TimePointGranularity
timeSeriesGranularity :: TimeSeriesGranularity
$sel:timePointGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimePointGranularity
$sel:timeSeriesGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimeSeriesGranularity
..} =
    forall a. NFData a => a -> ()
Prelude.rnf TimeSeriesGranularity
timeSeriesGranularity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf TimePointGranularity
timePointGranularity

instance Data.ToJSON ExplainabilityConfig where
  toJSON :: ExplainabilityConfig -> Value
toJSON ExplainabilityConfig' {TimePointGranularity
TimeSeriesGranularity
timePointGranularity :: TimePointGranularity
timeSeriesGranularity :: TimeSeriesGranularity
$sel:timePointGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimePointGranularity
$sel:timeSeriesGranularity:ExplainabilityConfig' :: ExplainabilityConfig -> TimeSeriesGranularity
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              ( Key
"TimeSeriesGranularity"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TimeSeriesGranularity
timeSeriesGranularity
              ),
            forall a. a -> Maybe a
Prelude.Just
              ( Key
"TimePointGranularity"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TimePointGranularity
timePointGranularity
              )
          ]
      )