{-# 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.AuditManager.Types.AssessmentReport
-- 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.AuditManager.Types.AssessmentReport where

import Amazonka.AuditManager.Types.AssessmentReportStatus
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

-- | A finalized document that\'s generated from an Audit Manager assessment.
-- These reports summarize the relevant evidence that was collected for
-- your audit, and link to the relevant evidence folders. These evidence
-- folders are named and organized according to the controls that are
-- specified in your assessment.
--
-- /See:/ 'newAssessmentReport' smart constructor.
data AssessmentReport = AssessmentReport'
  { -- | The identifier for the specified assessment.
    AssessmentReport -> Maybe Text
assessmentId :: Prelude.Maybe Prelude.Text,
    -- | The name of the associated assessment.
    AssessmentReport -> Maybe Text
assessmentName :: Prelude.Maybe Prelude.Text,
    -- | The name of the user who created the assessment report.
    AssessmentReport -> Maybe Text
author :: Prelude.Maybe Prelude.Text,
    -- | The identifier for the specified Amazon Web Services account.
    AssessmentReport -> Maybe Text
awsAccountId :: Prelude.Maybe Prelude.Text,
    -- | Specifies when the assessment report was created.
    AssessmentReport -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | The description of the specified assessment report.
    AssessmentReport -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier for the assessment report.
    AssessmentReport -> Maybe Text
id :: Prelude.Maybe Prelude.Text,
    -- | The name that\'s given to the assessment report.
    AssessmentReport -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The current status of the specified assessment report.
    AssessmentReport -> Maybe AssessmentReportStatus
status :: Prelude.Maybe AssessmentReportStatus
  }
  deriving (AssessmentReport -> AssessmentReport -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AssessmentReport -> AssessmentReport -> Bool
$c/= :: AssessmentReport -> AssessmentReport -> Bool
== :: AssessmentReport -> AssessmentReport -> Bool
$c== :: AssessmentReport -> AssessmentReport -> Bool
Prelude.Eq, ReadPrec [AssessmentReport]
ReadPrec AssessmentReport
Int -> ReadS AssessmentReport
ReadS [AssessmentReport]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AssessmentReport]
$creadListPrec :: ReadPrec [AssessmentReport]
readPrec :: ReadPrec AssessmentReport
$creadPrec :: ReadPrec AssessmentReport
readList :: ReadS [AssessmentReport]
$creadList :: ReadS [AssessmentReport]
readsPrec :: Int -> ReadS AssessmentReport
$creadsPrec :: Int -> ReadS AssessmentReport
Prelude.Read, Int -> AssessmentReport -> ShowS
[AssessmentReport] -> ShowS
AssessmentReport -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AssessmentReport] -> ShowS
$cshowList :: [AssessmentReport] -> ShowS
show :: AssessmentReport -> String
$cshow :: AssessmentReport -> String
showsPrec :: Int -> AssessmentReport -> ShowS
$cshowsPrec :: Int -> AssessmentReport -> ShowS
Prelude.Show, forall x. Rep AssessmentReport x -> AssessmentReport
forall x. AssessmentReport -> Rep AssessmentReport x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AssessmentReport x -> AssessmentReport
$cfrom :: forall x. AssessmentReport -> Rep AssessmentReport x
Prelude.Generic)

-- |
-- Create a value of 'AssessmentReport' 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:
--
-- 'assessmentId', 'assessmentReport_assessmentId' - The identifier for the specified assessment.
--
-- 'assessmentName', 'assessmentReport_assessmentName' - The name of the associated assessment.
--
-- 'author', 'assessmentReport_author' - The name of the user who created the assessment report.
--
-- 'awsAccountId', 'assessmentReport_awsAccountId' - The identifier for the specified Amazon Web Services account.
--
-- 'creationTime', 'assessmentReport_creationTime' - Specifies when the assessment report was created.
--
-- 'description', 'assessmentReport_description' - The description of the specified assessment report.
--
-- 'id', 'assessmentReport_id' - The unique identifier for the assessment report.
--
-- 'name', 'assessmentReport_name' - The name that\'s given to the assessment report.
--
-- 'status', 'assessmentReport_status' - The current status of the specified assessment report.
newAssessmentReport ::
  AssessmentReport
newAssessmentReport :: AssessmentReport
newAssessmentReport =
  AssessmentReport'
    { $sel:assessmentId:AssessmentReport' :: Maybe Text
assessmentId = forall a. Maybe a
Prelude.Nothing,
      $sel:assessmentName:AssessmentReport' :: Maybe Text
assessmentName = forall a. Maybe a
Prelude.Nothing,
      $sel:author:AssessmentReport' :: Maybe Text
author = forall a. Maybe a
Prelude.Nothing,
      $sel:awsAccountId:AssessmentReport' :: Maybe Text
awsAccountId = forall a. Maybe a
Prelude.Nothing,
      $sel:creationTime:AssessmentReport' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:description:AssessmentReport' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:id:AssessmentReport' :: Maybe Text
id = forall a. Maybe a
Prelude.Nothing,
      $sel:name:AssessmentReport' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:status:AssessmentReport' :: Maybe AssessmentReportStatus
status = forall a. Maybe a
Prelude.Nothing
    }

-- | The identifier for the specified assessment.
assessmentReport_assessmentId :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_assessmentId :: Lens' AssessmentReport (Maybe Text)
assessmentReport_assessmentId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
assessmentId :: Maybe Text
$sel:assessmentId:AssessmentReport' :: AssessmentReport -> Maybe Text
assessmentId} -> Maybe Text
assessmentId) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:assessmentId:AssessmentReport' :: Maybe Text
assessmentId = Maybe Text
a} :: AssessmentReport)

-- | The name of the associated assessment.
assessmentReport_assessmentName :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_assessmentName :: Lens' AssessmentReport (Maybe Text)
assessmentReport_assessmentName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
assessmentName :: Maybe Text
$sel:assessmentName:AssessmentReport' :: AssessmentReport -> Maybe Text
assessmentName} -> Maybe Text
assessmentName) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:assessmentName:AssessmentReport' :: Maybe Text
assessmentName = Maybe Text
a} :: AssessmentReport)

-- | The name of the user who created the assessment report.
assessmentReport_author :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_author :: Lens' AssessmentReport (Maybe Text)
assessmentReport_author = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
author :: Maybe Text
$sel:author:AssessmentReport' :: AssessmentReport -> Maybe Text
author} -> Maybe Text
author) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:author:AssessmentReport' :: Maybe Text
author = Maybe Text
a} :: AssessmentReport)

-- | The identifier for the specified Amazon Web Services account.
assessmentReport_awsAccountId :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_awsAccountId :: Lens' AssessmentReport (Maybe Text)
assessmentReport_awsAccountId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
awsAccountId :: Maybe Text
$sel:awsAccountId:AssessmentReport' :: AssessmentReport -> Maybe Text
awsAccountId} -> Maybe Text
awsAccountId) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:awsAccountId:AssessmentReport' :: Maybe Text
awsAccountId = Maybe Text
a} :: AssessmentReport)

-- | Specifies when the assessment report was created.
assessmentReport_creationTime :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.UTCTime)
assessmentReport_creationTime :: Lens' AssessmentReport (Maybe UTCTime)
assessmentReport_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:AssessmentReport' :: AssessmentReport -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe POSIX
a -> AssessmentReport
s {$sel:creationTime:AssessmentReport' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: AssessmentReport) 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 of the specified assessment report.
assessmentReport_description :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_description :: Lens' AssessmentReport (Maybe Text)
assessmentReport_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
description :: Maybe Text
$sel:description:AssessmentReport' :: AssessmentReport -> Maybe Text
description} -> Maybe Text
description) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:description:AssessmentReport' :: Maybe Text
description = Maybe Text
a} :: AssessmentReport)

-- | The unique identifier for the assessment report.
assessmentReport_id :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_id :: Lens' AssessmentReport (Maybe Text)
assessmentReport_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
id :: Maybe Text
$sel:id:AssessmentReport' :: AssessmentReport -> Maybe Text
id} -> Maybe Text
id) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:id:AssessmentReport' :: Maybe Text
id = Maybe Text
a} :: AssessmentReport)

-- | The name that\'s given to the assessment report.
assessmentReport_name :: Lens.Lens' AssessmentReport (Prelude.Maybe Prelude.Text)
assessmentReport_name :: Lens' AssessmentReport (Maybe Text)
assessmentReport_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe Text
name :: Maybe Text
$sel:name:AssessmentReport' :: AssessmentReport -> Maybe Text
name} -> Maybe Text
name) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe Text
a -> AssessmentReport
s {$sel:name:AssessmentReport' :: Maybe Text
name = Maybe Text
a} :: AssessmentReport)

-- | The current status of the specified assessment report.
assessmentReport_status :: Lens.Lens' AssessmentReport (Prelude.Maybe AssessmentReportStatus)
assessmentReport_status :: Lens' AssessmentReport (Maybe AssessmentReportStatus)
assessmentReport_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AssessmentReport' {Maybe AssessmentReportStatus
status :: Maybe AssessmentReportStatus
$sel:status:AssessmentReport' :: AssessmentReport -> Maybe AssessmentReportStatus
status} -> Maybe AssessmentReportStatus
status) (\s :: AssessmentReport
s@AssessmentReport' {} Maybe AssessmentReportStatus
a -> AssessmentReport
s {$sel:status:AssessmentReport' :: Maybe AssessmentReportStatus
status = Maybe AssessmentReportStatus
a} :: AssessmentReport)

instance Data.FromJSON AssessmentReport where
  parseJSON :: Value -> Parser AssessmentReport
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AssessmentReport"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe AssessmentReportStatus
-> AssessmentReport
AssessmentReport'
            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
"assessmentId")
            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
"assessmentName")
            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
"author")
            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
"awsAccountId")
            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
"creationTime")
            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
"id")
            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
"status")
      )

instance Prelude.Hashable AssessmentReport where
  hashWithSalt :: Int -> AssessmentReport -> Int
hashWithSalt Int
_salt AssessmentReport' {Maybe Text
Maybe POSIX
Maybe AssessmentReportStatus
status :: Maybe AssessmentReportStatus
name :: Maybe Text
id :: Maybe Text
description :: Maybe Text
creationTime :: Maybe POSIX
awsAccountId :: Maybe Text
author :: Maybe Text
assessmentName :: Maybe Text
assessmentId :: Maybe Text
$sel:status:AssessmentReport' :: AssessmentReport -> Maybe AssessmentReportStatus
$sel:name:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:id:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:description:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:creationTime:AssessmentReport' :: AssessmentReport -> Maybe POSIX
$sel:awsAccountId:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:author:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:assessmentName:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:assessmentId:AssessmentReport' :: AssessmentReport -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
assessmentId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
assessmentName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
author
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
awsAccountId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AssessmentReportStatus
status

instance Prelude.NFData AssessmentReport where
  rnf :: AssessmentReport -> ()
rnf AssessmentReport' {Maybe Text
Maybe POSIX
Maybe AssessmentReportStatus
status :: Maybe AssessmentReportStatus
name :: Maybe Text
id :: Maybe Text
description :: Maybe Text
creationTime :: Maybe POSIX
awsAccountId :: Maybe Text
author :: Maybe Text
assessmentName :: Maybe Text
assessmentId :: Maybe Text
$sel:status:AssessmentReport' :: AssessmentReport -> Maybe AssessmentReportStatus
$sel:name:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:id:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:description:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:creationTime:AssessmentReport' :: AssessmentReport -> Maybe POSIX
$sel:awsAccountId:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:author:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:assessmentName:AssessmentReport' :: AssessmentReport -> Maybe Text
$sel:assessmentId:AssessmentReport' :: AssessmentReport -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
assessmentId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
assessmentName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
author
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
awsAccountId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationTime
      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
id
      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 AssessmentReportStatus
status