{-# 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.Personalize.Types.RecommenderSummary
-- 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.Personalize.Types.RecommenderSummary where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Personalize.Types.RecommenderConfig
import qualified Amazonka.Prelude as Prelude

-- | Provides a summary of the properties of the recommender.
--
-- /See:/ 'newRecommenderSummary' smart constructor.
data RecommenderSummary = RecommenderSummary'
  { -- | The date and time (in Unix format) that the recommender was created.
    RecommenderSummary -> Maybe POSIX
creationDateTime :: Prelude.Maybe Data.POSIX,
    -- | The Amazon Resource Name (ARN) of the Domain dataset group that contains
    -- the recommender.
    RecommenderSummary -> Maybe Text
datasetGroupArn :: Prelude.Maybe Prelude.Text,
    -- | The date and time (in Unix format) that the recommender was last
    -- updated.
    RecommenderSummary -> Maybe POSIX
lastUpdatedDateTime :: Prelude.Maybe Data.POSIX,
    -- | The name of the recommender.
    RecommenderSummary -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the recipe (Domain dataset group use
    -- case) that the recommender was created for.
    RecommenderSummary -> Maybe Text
recipeArn :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the recommender.
    RecommenderSummary -> Maybe Text
recommenderArn :: Prelude.Maybe Prelude.Text,
    -- | The configuration details of the recommender.
    RecommenderSummary -> Maybe RecommenderConfig
recommenderConfig :: Prelude.Maybe RecommenderConfig,
    -- | The status of the recommender. A recommender can be in one of the
    -- following states:
    --
    -- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    --
    -- -   STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
    --     IN_PROGRESS > ACTIVE
    --
    -- -   DELETE PENDING > DELETE IN_PROGRESS
    RecommenderSummary -> Maybe Text
status :: Prelude.Maybe Prelude.Text
  }
  deriving (RecommenderSummary -> RecommenderSummary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RecommenderSummary -> RecommenderSummary -> Bool
$c/= :: RecommenderSummary -> RecommenderSummary -> Bool
== :: RecommenderSummary -> RecommenderSummary -> Bool
$c== :: RecommenderSummary -> RecommenderSummary -> Bool
Prelude.Eq, ReadPrec [RecommenderSummary]
ReadPrec RecommenderSummary
Int -> ReadS RecommenderSummary
ReadS [RecommenderSummary]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RecommenderSummary]
$creadListPrec :: ReadPrec [RecommenderSummary]
readPrec :: ReadPrec RecommenderSummary
$creadPrec :: ReadPrec RecommenderSummary
readList :: ReadS [RecommenderSummary]
$creadList :: ReadS [RecommenderSummary]
readsPrec :: Int -> ReadS RecommenderSummary
$creadsPrec :: Int -> ReadS RecommenderSummary
Prelude.Read, Int -> RecommenderSummary -> ShowS
[RecommenderSummary] -> ShowS
RecommenderSummary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RecommenderSummary] -> ShowS
$cshowList :: [RecommenderSummary] -> ShowS
show :: RecommenderSummary -> String
$cshow :: RecommenderSummary -> String
showsPrec :: Int -> RecommenderSummary -> ShowS
$cshowsPrec :: Int -> RecommenderSummary -> ShowS
Prelude.Show, forall x. Rep RecommenderSummary x -> RecommenderSummary
forall x. RecommenderSummary -> Rep RecommenderSummary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RecommenderSummary x -> RecommenderSummary
$cfrom :: forall x. RecommenderSummary -> Rep RecommenderSummary x
Prelude.Generic)

-- |
-- Create a value of 'RecommenderSummary' 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:
--
-- 'creationDateTime', 'recommenderSummary_creationDateTime' - The date and time (in Unix format) that the recommender was created.
--
-- 'datasetGroupArn', 'recommenderSummary_datasetGroupArn' - The Amazon Resource Name (ARN) of the Domain dataset group that contains
-- the recommender.
--
-- 'lastUpdatedDateTime', 'recommenderSummary_lastUpdatedDateTime' - The date and time (in Unix format) that the recommender was last
-- updated.
--
-- 'name', 'recommenderSummary_name' - The name of the recommender.
--
-- 'recipeArn', 'recommenderSummary_recipeArn' - The Amazon Resource Name (ARN) of the recipe (Domain dataset group use
-- case) that the recommender was created for.
--
-- 'recommenderArn', 'recommenderSummary_recommenderArn' - The Amazon Resource Name (ARN) of the recommender.
--
-- 'recommenderConfig', 'recommenderSummary_recommenderConfig' - The configuration details of the recommender.
--
-- 'status', 'recommenderSummary_status' - The status of the recommender. A recommender can be in one of the
-- following states:
--
-- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
--
-- -   STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
--     IN_PROGRESS > ACTIVE
--
-- -   DELETE PENDING > DELETE IN_PROGRESS
newRecommenderSummary ::
  RecommenderSummary
newRecommenderSummary :: RecommenderSummary
newRecommenderSummary =
  RecommenderSummary'
    { $sel:creationDateTime:RecommenderSummary' :: Maybe POSIX
creationDateTime =
        forall a. Maybe a
Prelude.Nothing,
      $sel:datasetGroupArn:RecommenderSummary' :: Maybe Text
datasetGroupArn = forall a. Maybe a
Prelude.Nothing,
      $sel:lastUpdatedDateTime:RecommenderSummary' :: Maybe POSIX
lastUpdatedDateTime = forall a. Maybe a
Prelude.Nothing,
      $sel:name:RecommenderSummary' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:recipeArn:RecommenderSummary' :: Maybe Text
recipeArn = forall a. Maybe a
Prelude.Nothing,
      $sel:recommenderArn:RecommenderSummary' :: Maybe Text
recommenderArn = forall a. Maybe a
Prelude.Nothing,
      $sel:recommenderConfig:RecommenderSummary' :: Maybe RecommenderConfig
recommenderConfig = forall a. Maybe a
Prelude.Nothing,
      $sel:status:RecommenderSummary' :: Maybe Text
status = forall a. Maybe a
Prelude.Nothing
    }

-- | The date and time (in Unix format) that the recommender was created.
recommenderSummary_creationDateTime :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.UTCTime)
recommenderSummary_creationDateTime :: Lens' RecommenderSummary (Maybe UTCTime)
recommenderSummary_creationDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe POSIX
creationDateTime :: Maybe POSIX
$sel:creationDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
creationDateTime} -> Maybe POSIX
creationDateTime) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe POSIX
a -> RecommenderSummary
s {$sel:creationDateTime:RecommenderSummary' :: Maybe POSIX
creationDateTime = Maybe POSIX
a} :: RecommenderSummary) 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 Amazon Resource Name (ARN) of the Domain dataset group that contains
-- the recommender.
recommenderSummary_datasetGroupArn :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.Text)
recommenderSummary_datasetGroupArn :: Lens' RecommenderSummary (Maybe Text)
recommenderSummary_datasetGroupArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe Text
datasetGroupArn :: Maybe Text
$sel:datasetGroupArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
datasetGroupArn} -> Maybe Text
datasetGroupArn) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe Text
a -> RecommenderSummary
s {$sel:datasetGroupArn:RecommenderSummary' :: Maybe Text
datasetGroupArn = Maybe Text
a} :: RecommenderSummary)

-- | The date and time (in Unix format) that the recommender was last
-- updated.
recommenderSummary_lastUpdatedDateTime :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.UTCTime)
recommenderSummary_lastUpdatedDateTime :: Lens' RecommenderSummary (Maybe UTCTime)
recommenderSummary_lastUpdatedDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe POSIX
lastUpdatedDateTime :: Maybe POSIX
$sel:lastUpdatedDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
lastUpdatedDateTime} -> Maybe POSIX
lastUpdatedDateTime) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe POSIX
a -> RecommenderSummary
s {$sel:lastUpdatedDateTime:RecommenderSummary' :: Maybe POSIX
lastUpdatedDateTime = Maybe POSIX
a} :: RecommenderSummary) 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 name of the recommender.
recommenderSummary_name :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.Text)
recommenderSummary_name :: Lens' RecommenderSummary (Maybe Text)
recommenderSummary_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe Text
name :: Maybe Text
$sel:name:RecommenderSummary' :: RecommenderSummary -> Maybe Text
name} -> Maybe Text
name) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe Text
a -> RecommenderSummary
s {$sel:name:RecommenderSummary' :: Maybe Text
name = Maybe Text
a} :: RecommenderSummary)

-- | The Amazon Resource Name (ARN) of the recipe (Domain dataset group use
-- case) that the recommender was created for.
recommenderSummary_recipeArn :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.Text)
recommenderSummary_recipeArn :: Lens' RecommenderSummary (Maybe Text)
recommenderSummary_recipeArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe Text
recipeArn :: Maybe Text
$sel:recipeArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
recipeArn} -> Maybe Text
recipeArn) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe Text
a -> RecommenderSummary
s {$sel:recipeArn:RecommenderSummary' :: Maybe Text
recipeArn = Maybe Text
a} :: RecommenderSummary)

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

-- | The configuration details of the recommender.
recommenderSummary_recommenderConfig :: Lens.Lens' RecommenderSummary (Prelude.Maybe RecommenderConfig)
recommenderSummary_recommenderConfig :: Lens' RecommenderSummary (Maybe RecommenderConfig)
recommenderSummary_recommenderConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe RecommenderConfig
recommenderConfig :: Maybe RecommenderConfig
$sel:recommenderConfig:RecommenderSummary' :: RecommenderSummary -> Maybe RecommenderConfig
recommenderConfig} -> Maybe RecommenderConfig
recommenderConfig) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe RecommenderConfig
a -> RecommenderSummary
s {$sel:recommenderConfig:RecommenderSummary' :: Maybe RecommenderConfig
recommenderConfig = Maybe RecommenderConfig
a} :: RecommenderSummary)

-- | The status of the recommender. A recommender can be in one of the
-- following states:
--
-- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
--
-- -   STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START
--     IN_PROGRESS > ACTIVE
--
-- -   DELETE PENDING > DELETE IN_PROGRESS
recommenderSummary_status :: Lens.Lens' RecommenderSummary (Prelude.Maybe Prelude.Text)
recommenderSummary_status :: Lens' RecommenderSummary (Maybe Text)
recommenderSummary_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommenderSummary' {Maybe Text
status :: Maybe Text
$sel:status:RecommenderSummary' :: RecommenderSummary -> Maybe Text
status} -> Maybe Text
status) (\s :: RecommenderSummary
s@RecommenderSummary' {} Maybe Text
a -> RecommenderSummary
s {$sel:status:RecommenderSummary' :: Maybe Text
status = Maybe Text
a} :: RecommenderSummary)

instance Data.FromJSON RecommenderSummary where
  parseJSON :: Value -> Parser RecommenderSummary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"RecommenderSummary"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe RecommenderConfig
-> Maybe Text
-> RecommenderSummary
RecommenderSummary'
            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
"creationDateTime")
            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
"datasetGroupArn")
            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
"lastUpdatedDateTime")
            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
"name")
            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
"recipeArn")
            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
"recommenderArn")
            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
"recommenderConfig")
            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")
      )

instance Prelude.Hashable RecommenderSummary where
  hashWithSalt :: Int -> RecommenderSummary -> Int
hashWithSalt Int
_salt RecommenderSummary' {Maybe Text
Maybe POSIX
Maybe RecommenderConfig
status :: Maybe Text
recommenderConfig :: Maybe RecommenderConfig
recommenderArn :: Maybe Text
recipeArn :: Maybe Text
name :: Maybe Text
lastUpdatedDateTime :: Maybe POSIX
datasetGroupArn :: Maybe Text
creationDateTime :: Maybe POSIX
$sel:status:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:recommenderConfig:RecommenderSummary' :: RecommenderSummary -> Maybe RecommenderConfig
$sel:recommenderArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:recipeArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:name:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:lastUpdatedDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
$sel:datasetGroupArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:creationDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
datasetGroupArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastUpdatedDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
recipeArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
recommenderArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe RecommenderConfig
recommenderConfig
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
status

instance Prelude.NFData RecommenderSummary where
  rnf :: RecommenderSummary -> ()
rnf RecommenderSummary' {Maybe Text
Maybe POSIX
Maybe RecommenderConfig
status :: Maybe Text
recommenderConfig :: Maybe RecommenderConfig
recommenderArn :: Maybe Text
recipeArn :: Maybe Text
name :: Maybe Text
lastUpdatedDateTime :: Maybe POSIX
datasetGroupArn :: Maybe Text
creationDateTime :: Maybe POSIX
$sel:status:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:recommenderConfig:RecommenderSummary' :: RecommenderSummary -> Maybe RecommenderConfig
$sel:recommenderArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:recipeArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:name:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:lastUpdatedDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
$sel:datasetGroupArn:RecommenderSummary' :: RecommenderSummary -> Maybe Text
$sel:creationDateTime:RecommenderSummary' :: RecommenderSummary -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
datasetGroupArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastUpdatedDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
recipeArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
recommenderArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe RecommenderConfig
recommenderConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
status