{-# 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.SageMaker.Types.ModelExplainabilityAppSpecification
-- 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.SageMaker.Types.ModelExplainabilityAppSpecification 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

-- | Docker container image configuration object for the model explainability
-- job.
--
-- /See:/ 'newModelExplainabilityAppSpecification' smart constructor.
data ModelExplainabilityAppSpecification = ModelExplainabilityAppSpecification'
  { -- | Sets the environment variables in the Docker container.
    ModelExplainabilityAppSpecification -> Maybe (HashMap Text Text)
environment :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | The container image to be run by the model explainability job.
    ModelExplainabilityAppSpecification -> Text
imageUri :: Prelude.Text,
    -- | JSON formatted S3 file that defines explainability parameters. For more
    -- information on this JSON configuration file, see
    -- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html Configure model explainability parameters>.
    ModelExplainabilityAppSpecification -> Text
configUri :: Prelude.Text
  }
  deriving (ModelExplainabilityAppSpecification
-> ModelExplainabilityAppSpecification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ModelExplainabilityAppSpecification
-> ModelExplainabilityAppSpecification -> Bool
$c/= :: ModelExplainabilityAppSpecification
-> ModelExplainabilityAppSpecification -> Bool
== :: ModelExplainabilityAppSpecification
-> ModelExplainabilityAppSpecification -> Bool
$c== :: ModelExplainabilityAppSpecification
-> ModelExplainabilityAppSpecification -> Bool
Prelude.Eq, ReadPrec [ModelExplainabilityAppSpecification]
ReadPrec ModelExplainabilityAppSpecification
Int -> ReadS ModelExplainabilityAppSpecification
ReadS [ModelExplainabilityAppSpecification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ModelExplainabilityAppSpecification]
$creadListPrec :: ReadPrec [ModelExplainabilityAppSpecification]
readPrec :: ReadPrec ModelExplainabilityAppSpecification
$creadPrec :: ReadPrec ModelExplainabilityAppSpecification
readList :: ReadS [ModelExplainabilityAppSpecification]
$creadList :: ReadS [ModelExplainabilityAppSpecification]
readsPrec :: Int -> ReadS ModelExplainabilityAppSpecification
$creadsPrec :: Int -> ReadS ModelExplainabilityAppSpecification
Prelude.Read, Int -> ModelExplainabilityAppSpecification -> ShowS
[ModelExplainabilityAppSpecification] -> ShowS
ModelExplainabilityAppSpecification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ModelExplainabilityAppSpecification] -> ShowS
$cshowList :: [ModelExplainabilityAppSpecification] -> ShowS
show :: ModelExplainabilityAppSpecification -> String
$cshow :: ModelExplainabilityAppSpecification -> String
showsPrec :: Int -> ModelExplainabilityAppSpecification -> ShowS
$cshowsPrec :: Int -> ModelExplainabilityAppSpecification -> ShowS
Prelude.Show, forall x.
Rep ModelExplainabilityAppSpecification x
-> ModelExplainabilityAppSpecification
forall x.
ModelExplainabilityAppSpecification
-> Rep ModelExplainabilityAppSpecification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ModelExplainabilityAppSpecification x
-> ModelExplainabilityAppSpecification
$cfrom :: forall x.
ModelExplainabilityAppSpecification
-> Rep ModelExplainabilityAppSpecification x
Prelude.Generic)

-- |
-- Create a value of 'ModelExplainabilityAppSpecification' 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:
--
-- 'environment', 'modelExplainabilityAppSpecification_environment' - Sets the environment variables in the Docker container.
--
-- 'imageUri', 'modelExplainabilityAppSpecification_imageUri' - The container image to be run by the model explainability job.
--
-- 'configUri', 'modelExplainabilityAppSpecification_configUri' - JSON formatted S3 file that defines explainability parameters. For more
-- information on this JSON configuration file, see
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html Configure model explainability parameters>.
newModelExplainabilityAppSpecification ::
  -- | 'imageUri'
  Prelude.Text ->
  -- | 'configUri'
  Prelude.Text ->
  ModelExplainabilityAppSpecification
newModelExplainabilityAppSpecification :: Text -> Text -> ModelExplainabilityAppSpecification
newModelExplainabilityAppSpecification
  Text
pImageUri_
  Text
pConfigUri_ =
    ModelExplainabilityAppSpecification'
      { $sel:environment:ModelExplainabilityAppSpecification' :: Maybe (HashMap Text Text)
environment =
          forall a. Maybe a
Prelude.Nothing,
        $sel:imageUri:ModelExplainabilityAppSpecification' :: Text
imageUri = Text
pImageUri_,
        $sel:configUri:ModelExplainabilityAppSpecification' :: Text
configUri = Text
pConfigUri_
      }

-- | Sets the environment variables in the Docker container.
modelExplainabilityAppSpecification_environment :: Lens.Lens' ModelExplainabilityAppSpecification (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
modelExplainabilityAppSpecification_environment :: Lens'
  ModelExplainabilityAppSpecification (Maybe (HashMap Text Text))
modelExplainabilityAppSpecification_environment = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelExplainabilityAppSpecification' {Maybe (HashMap Text Text)
environment :: Maybe (HashMap Text Text)
$sel:environment:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Maybe (HashMap Text Text)
environment} -> Maybe (HashMap Text Text)
environment) (\s :: ModelExplainabilityAppSpecification
s@ModelExplainabilityAppSpecification' {} Maybe (HashMap Text Text)
a -> ModelExplainabilityAppSpecification
s {$sel:environment:ModelExplainabilityAppSpecification' :: Maybe (HashMap Text Text)
environment = Maybe (HashMap Text Text)
a} :: ModelExplainabilityAppSpecification) 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 container image to be run by the model explainability job.
modelExplainabilityAppSpecification_imageUri :: Lens.Lens' ModelExplainabilityAppSpecification Prelude.Text
modelExplainabilityAppSpecification_imageUri :: Lens' ModelExplainabilityAppSpecification Text
modelExplainabilityAppSpecification_imageUri = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelExplainabilityAppSpecification' {Text
imageUri :: Text
$sel:imageUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
imageUri} -> Text
imageUri) (\s :: ModelExplainabilityAppSpecification
s@ModelExplainabilityAppSpecification' {} Text
a -> ModelExplainabilityAppSpecification
s {$sel:imageUri:ModelExplainabilityAppSpecification' :: Text
imageUri = Text
a} :: ModelExplainabilityAppSpecification)

-- | JSON formatted S3 file that defines explainability parameters. For more
-- information on this JSON configuration file, see
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html Configure model explainability parameters>.
modelExplainabilityAppSpecification_configUri :: Lens.Lens' ModelExplainabilityAppSpecification Prelude.Text
modelExplainabilityAppSpecification_configUri :: Lens' ModelExplainabilityAppSpecification Text
modelExplainabilityAppSpecification_configUri = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelExplainabilityAppSpecification' {Text
configUri :: Text
$sel:configUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
configUri} -> Text
configUri) (\s :: ModelExplainabilityAppSpecification
s@ModelExplainabilityAppSpecification' {} Text
a -> ModelExplainabilityAppSpecification
s {$sel:configUri:ModelExplainabilityAppSpecification' :: Text
configUri = Text
a} :: ModelExplainabilityAppSpecification)

instance
  Data.FromJSON
    ModelExplainabilityAppSpecification
  where
  parseJSON :: Value -> Parser ModelExplainabilityAppSpecification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ModelExplainabilityAppSpecification"
      ( \Object
x ->
          Maybe (HashMap Text Text)
-> Text -> Text -> ModelExplainabilityAppSpecification
ModelExplainabilityAppSpecification'
            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
"Environment" 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
"ImageUri")
            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
"ConfigUri")
      )

instance
  Prelude.Hashable
    ModelExplainabilityAppSpecification
  where
  hashWithSalt :: Int -> ModelExplainabilityAppSpecification -> Int
hashWithSalt
    Int
_salt
    ModelExplainabilityAppSpecification' {Maybe (HashMap Text Text)
Text
configUri :: Text
imageUri :: Text
environment :: Maybe (HashMap Text Text)
$sel:configUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:imageUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:environment:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Maybe (HashMap Text Text)
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
environment
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
imageUri
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
configUri

instance
  Prelude.NFData
    ModelExplainabilityAppSpecification
  where
  rnf :: ModelExplainabilityAppSpecification -> ()
rnf ModelExplainabilityAppSpecification' {Maybe (HashMap Text Text)
Text
configUri :: Text
imageUri :: Text
environment :: Maybe (HashMap Text Text)
$sel:configUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:imageUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:environment:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Maybe (HashMap Text Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
environment
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
imageUri
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
configUri

instance
  Data.ToJSON
    ModelExplainabilityAppSpecification
  where
  toJSON :: ModelExplainabilityAppSpecification -> Value
toJSON ModelExplainabilityAppSpecification' {Maybe (HashMap Text Text)
Text
configUri :: Text
imageUri :: Text
environment :: Maybe (HashMap Text Text)
$sel:configUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:imageUri:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Text
$sel:environment:ModelExplainabilityAppSpecification' :: ModelExplainabilityAppSpecification -> Maybe (HashMap Text Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Environment" 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 Text)
environment,
            forall a. a -> Maybe a
Prelude.Just (Key
"ImageUri" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
imageUri),
            forall a. a -> Maybe a
Prelude.Just (Key
"ConfigUri" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
configUri)
          ]
      )