{-# 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.LookoutVision.Types.ModelMetadata
-- 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.LookoutVision.Types.ModelMetadata where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LookoutVision.Types.ModelPerformance
import Amazonka.LookoutVision.Types.ModelStatus
import qualified Amazonka.Prelude as Prelude

-- | Describes an Amazon Lookout for Vision model.
--
-- /See:/ 'newModelMetadata' smart constructor.
data ModelMetadata = ModelMetadata'
  { -- | The unix timestamp for the date and time that the model was created.
    ModelMetadata -> Maybe POSIX
creationTimestamp :: Prelude.Maybe Data.POSIX,
    -- | The description for the model.
    ModelMetadata -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the model.
    ModelMetadata -> Maybe Text
modelArn :: Prelude.Maybe Prelude.Text,
    -- | The version of the model.
    ModelMetadata -> Maybe Text
modelVersion :: Prelude.Maybe Prelude.Text,
    -- | Performance metrics for the model. Not available until training has
    -- successfully completed.
    ModelMetadata -> Maybe ModelPerformance
performance :: Prelude.Maybe ModelPerformance,
    -- | The status of the model.
    ModelMetadata -> Maybe ModelStatus
status :: Prelude.Maybe ModelStatus,
    -- | The status message for the model.
    ModelMetadata -> Maybe Text
statusMessage :: Prelude.Maybe Prelude.Text
  }
  deriving (ModelMetadata -> ModelMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ModelMetadata -> ModelMetadata -> Bool
$c/= :: ModelMetadata -> ModelMetadata -> Bool
== :: ModelMetadata -> ModelMetadata -> Bool
$c== :: ModelMetadata -> ModelMetadata -> Bool
Prelude.Eq, ReadPrec [ModelMetadata]
ReadPrec ModelMetadata
Int -> ReadS ModelMetadata
ReadS [ModelMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ModelMetadata]
$creadListPrec :: ReadPrec [ModelMetadata]
readPrec :: ReadPrec ModelMetadata
$creadPrec :: ReadPrec ModelMetadata
readList :: ReadS [ModelMetadata]
$creadList :: ReadS [ModelMetadata]
readsPrec :: Int -> ReadS ModelMetadata
$creadsPrec :: Int -> ReadS ModelMetadata
Prelude.Read, Int -> ModelMetadata -> ShowS
[ModelMetadata] -> ShowS
ModelMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ModelMetadata] -> ShowS
$cshowList :: [ModelMetadata] -> ShowS
show :: ModelMetadata -> String
$cshow :: ModelMetadata -> String
showsPrec :: Int -> ModelMetadata -> ShowS
$cshowsPrec :: Int -> ModelMetadata -> ShowS
Prelude.Show, forall x. Rep ModelMetadata x -> ModelMetadata
forall x. ModelMetadata -> Rep ModelMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ModelMetadata x -> ModelMetadata
$cfrom :: forall x. ModelMetadata -> Rep ModelMetadata x
Prelude.Generic)

-- |
-- Create a value of 'ModelMetadata' 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:
--
-- 'creationTimestamp', 'modelMetadata_creationTimestamp' - The unix timestamp for the date and time that the model was created.
--
-- 'description', 'modelMetadata_description' - The description for the model.
--
-- 'modelArn', 'modelMetadata_modelArn' - The Amazon Resource Name (ARN) of the model.
--
-- 'modelVersion', 'modelMetadata_modelVersion' - The version of the model.
--
-- 'performance', 'modelMetadata_performance' - Performance metrics for the model. Not available until training has
-- successfully completed.
--
-- 'status', 'modelMetadata_status' - The status of the model.
--
-- 'statusMessage', 'modelMetadata_statusMessage' - The status message for the model.
newModelMetadata ::
  ModelMetadata
newModelMetadata :: ModelMetadata
newModelMetadata =
  ModelMetadata'
    { $sel:creationTimestamp:ModelMetadata' :: Maybe POSIX
creationTimestamp = forall a. Maybe a
Prelude.Nothing,
      $sel:description:ModelMetadata' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:modelArn:ModelMetadata' :: Maybe Text
modelArn = forall a. Maybe a
Prelude.Nothing,
      $sel:modelVersion:ModelMetadata' :: Maybe Text
modelVersion = forall a. Maybe a
Prelude.Nothing,
      $sel:performance:ModelMetadata' :: Maybe ModelPerformance
performance = forall a. Maybe a
Prelude.Nothing,
      $sel:status:ModelMetadata' :: Maybe ModelStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:statusMessage:ModelMetadata' :: Maybe Text
statusMessage = forall a. Maybe a
Prelude.Nothing
    }

-- | The unix timestamp for the date and time that the model was created.
modelMetadata_creationTimestamp :: Lens.Lens' ModelMetadata (Prelude.Maybe Prelude.UTCTime)
modelMetadata_creationTimestamp :: Lens' ModelMetadata (Maybe UTCTime)
modelMetadata_creationTimestamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe POSIX
creationTimestamp :: Maybe POSIX
$sel:creationTimestamp:ModelMetadata' :: ModelMetadata -> Maybe POSIX
creationTimestamp} -> Maybe POSIX
creationTimestamp) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe POSIX
a -> ModelMetadata
s {$sel:creationTimestamp:ModelMetadata' :: Maybe POSIX
creationTimestamp = Maybe POSIX
a} :: ModelMetadata) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The description for the model.
modelMetadata_description :: Lens.Lens' ModelMetadata (Prelude.Maybe Prelude.Text)
modelMetadata_description :: Lens' ModelMetadata (Maybe Text)
modelMetadata_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe Text
description :: Maybe Text
$sel:description:ModelMetadata' :: ModelMetadata -> Maybe Text
description} -> Maybe Text
description) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe Text
a -> ModelMetadata
s {$sel:description:ModelMetadata' :: Maybe Text
description = Maybe Text
a} :: ModelMetadata)

-- | The Amazon Resource Name (ARN) of the model.
modelMetadata_modelArn :: Lens.Lens' ModelMetadata (Prelude.Maybe Prelude.Text)
modelMetadata_modelArn :: Lens' ModelMetadata (Maybe Text)
modelMetadata_modelArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe Text
modelArn :: Maybe Text
$sel:modelArn:ModelMetadata' :: ModelMetadata -> Maybe Text
modelArn} -> Maybe Text
modelArn) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe Text
a -> ModelMetadata
s {$sel:modelArn:ModelMetadata' :: Maybe Text
modelArn = Maybe Text
a} :: ModelMetadata)

-- | The version of the model.
modelMetadata_modelVersion :: Lens.Lens' ModelMetadata (Prelude.Maybe Prelude.Text)
modelMetadata_modelVersion :: Lens' ModelMetadata (Maybe Text)
modelMetadata_modelVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe Text
modelVersion :: Maybe Text
$sel:modelVersion:ModelMetadata' :: ModelMetadata -> Maybe Text
modelVersion} -> Maybe Text
modelVersion) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe Text
a -> ModelMetadata
s {$sel:modelVersion:ModelMetadata' :: Maybe Text
modelVersion = Maybe Text
a} :: ModelMetadata)

-- | Performance metrics for the model. Not available until training has
-- successfully completed.
modelMetadata_performance :: Lens.Lens' ModelMetadata (Prelude.Maybe ModelPerformance)
modelMetadata_performance :: Lens' ModelMetadata (Maybe ModelPerformance)
modelMetadata_performance = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe ModelPerformance
performance :: Maybe ModelPerformance
$sel:performance:ModelMetadata' :: ModelMetadata -> Maybe ModelPerformance
performance} -> Maybe ModelPerformance
performance) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe ModelPerformance
a -> ModelMetadata
s {$sel:performance:ModelMetadata' :: Maybe ModelPerformance
performance = Maybe ModelPerformance
a} :: ModelMetadata)

-- | The status of the model.
modelMetadata_status :: Lens.Lens' ModelMetadata (Prelude.Maybe ModelStatus)
modelMetadata_status :: Lens' ModelMetadata (Maybe ModelStatus)
modelMetadata_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe ModelStatus
status :: Maybe ModelStatus
$sel:status:ModelMetadata' :: ModelMetadata -> Maybe ModelStatus
status} -> Maybe ModelStatus
status) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe ModelStatus
a -> ModelMetadata
s {$sel:status:ModelMetadata' :: Maybe ModelStatus
status = Maybe ModelStatus
a} :: ModelMetadata)

-- | The status message for the model.
modelMetadata_statusMessage :: Lens.Lens' ModelMetadata (Prelude.Maybe Prelude.Text)
modelMetadata_statusMessage :: Lens' ModelMetadata (Maybe Text)
modelMetadata_statusMessage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ModelMetadata' {Maybe Text
statusMessage :: Maybe Text
$sel:statusMessage:ModelMetadata' :: ModelMetadata -> Maybe Text
statusMessage} -> Maybe Text
statusMessage) (\s :: ModelMetadata
s@ModelMetadata' {} Maybe Text
a -> ModelMetadata
s {$sel:statusMessage:ModelMetadata' :: Maybe Text
statusMessage = Maybe Text
a} :: ModelMetadata)

instance Data.FromJSON ModelMetadata where
  parseJSON :: Value -> Parser ModelMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ModelMetadata"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe ModelPerformance
-> Maybe ModelStatus
-> Maybe Text
-> ModelMetadata
ModelMetadata'
            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
"CreationTimestamp")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Description")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ModelArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ModelVersion")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Performance")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Status")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"StatusMessage")
      )

instance Prelude.Hashable ModelMetadata where
  hashWithSalt :: Int -> ModelMetadata -> Int
hashWithSalt Int
_salt ModelMetadata' {Maybe Text
Maybe POSIX
Maybe ModelPerformance
Maybe ModelStatus
statusMessage :: Maybe Text
status :: Maybe ModelStatus
performance :: Maybe ModelPerformance
modelVersion :: Maybe Text
modelArn :: Maybe Text
description :: Maybe Text
creationTimestamp :: Maybe POSIX
$sel:statusMessage:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:status:ModelMetadata' :: ModelMetadata -> Maybe ModelStatus
$sel:performance:ModelMetadata' :: ModelMetadata -> Maybe ModelPerformance
$sel:modelVersion:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:modelArn:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:description:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:creationTimestamp:ModelMetadata' :: ModelMetadata -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTimestamp
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
modelArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
modelVersion
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ModelPerformance
performance
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ModelStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
statusMessage

instance Prelude.NFData ModelMetadata where
  rnf :: ModelMetadata -> ()
rnf ModelMetadata' {Maybe Text
Maybe POSIX
Maybe ModelPerformance
Maybe ModelStatus
statusMessage :: Maybe Text
status :: Maybe ModelStatus
performance :: Maybe ModelPerformance
modelVersion :: Maybe Text
modelArn :: Maybe Text
description :: Maybe Text
creationTimestamp :: Maybe POSIX
$sel:statusMessage:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:status:ModelMetadata' :: ModelMetadata -> Maybe ModelStatus
$sel:performance:ModelMetadata' :: ModelMetadata -> Maybe ModelPerformance
$sel:modelVersion:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:modelArn:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:description:ModelMetadata' :: ModelMetadata -> Maybe Text
$sel:creationTimestamp:ModelMetadata' :: ModelMetadata -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationTimestamp
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
modelArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
modelVersion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ModelPerformance
performance
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ModelStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
statusMessage