ControlDomainInsights.hs

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

import Amazonka.AuditManager.Types.EvidenceInsights
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 summary of the latest analytics data for a specific control domain.
--
-- Control domain insights are grouped by control domain, and ranked by the
-- highest total count of non-compliant evidence.
--
-- /See:/ 'newControlDomainInsights' smart constructor.
data ControlDomainInsights = ControlDomainInsights'
  { -- | The number of controls in the control domain that collected
    -- non-compliant evidence on the @lastUpdated@ date.
    controlsCountByNoncompliantEvidence :: Prelude.Maybe Prelude.Int,
    -- | A breakdown of the compliance check status for the evidence that’s
    -- associated with the control domain.
    evidenceInsights :: Prelude.Maybe EvidenceInsights,
    -- | The unique identifier for the control domain.
    id :: Prelude.Maybe Prelude.Text,
    -- | The time when the control domain insights were last updated.
    lastUpdated :: Prelude.Maybe Data.POSIX,
    -- | The name of the control domain.
    name :: Prelude.Maybe Prelude.Text,
    -- | The total number of controls in the control domain.
    totalControlsCount :: Prelude.Maybe Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'ControlDomainInsights' 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:
--
-- 'controlsCountByNoncompliantEvidence', 'controlDomainInsights_controlsCountByNoncompliantEvidence' - The number of controls in the control domain that collected
-- non-compliant evidence on the @lastUpdated@ date.
--
-- 'evidenceInsights', 'controlDomainInsights_evidenceInsights' - A breakdown of the compliance check status for the evidence that’s
-- associated with the control domain.
--
-- 'id', 'controlDomainInsights_id' - The unique identifier for the control domain.
--
-- 'lastUpdated', 'controlDomainInsights_lastUpdated' - The time when the control domain insights were last updated.
--
-- 'name', 'controlDomainInsights_name' - The name of the control domain.
--
-- 'totalControlsCount', 'controlDomainInsights_totalControlsCount' - The total number of controls in the control domain.
newControlDomainInsights ::
  ControlDomainInsights
newControlDomainInsights =
  ControlDomainInsights'
    { controlsCountByNoncompliantEvidence =
        Prelude.Nothing,
      evidenceInsights = Prelude.Nothing,
      id = Prelude.Nothing,
      lastUpdated = Prelude.Nothing,
      name = Prelude.Nothing,
      totalControlsCount = Prelude.Nothing
    }

-- | The number of controls in the control domain that collected
-- non-compliant evidence on the @lastUpdated@ date.
controlDomainInsights_controlsCountByNoncompliantEvidence :: Lens.Lens' ControlDomainInsights (Prelude.Maybe Prelude.Int)
controlDomainInsights_controlsCountByNoncompliantEvidence = Lens.lens (\ControlDomainInsights' {controlsCountByNoncompliantEvidence} -> controlsCountByNoncompliantEvidence) (\s@ControlDomainInsights' {} a -> s {controlsCountByNoncompliantEvidence = a} :: ControlDomainInsights)

-- | A breakdown of the compliance check status for the evidence that’s
-- associated with the control domain.
controlDomainInsights_evidenceInsights :: Lens.Lens' ControlDomainInsights (Prelude.Maybe EvidenceInsights)
controlDomainInsights_evidenceInsights = Lens.lens (\ControlDomainInsights' {evidenceInsights} -> evidenceInsights) (\s@ControlDomainInsights' {} a -> s {evidenceInsights = a} :: ControlDomainInsights)

-- | The unique identifier for the control domain.
controlDomainInsights_id :: Lens.Lens' ControlDomainInsights (Prelude.Maybe Prelude.Text)
controlDomainInsights_id = Lens.lens (\ControlDomainInsights' {id} -> id) (\s@ControlDomainInsights' {} a -> s {id = a} :: ControlDomainInsights)

-- | The time when the control domain insights were last updated.
controlDomainInsights_lastUpdated :: Lens.Lens' ControlDomainInsights (Prelude.Maybe Prelude.UTCTime)
controlDomainInsights_lastUpdated = Lens.lens (\ControlDomainInsights' {lastUpdated} -> lastUpdated) (\s@ControlDomainInsights' {} a -> s {lastUpdated = a} :: ControlDomainInsights) Prelude.. Lens.mapping Data._Time

-- | The name of the control domain.
controlDomainInsights_name :: Lens.Lens' ControlDomainInsights (Prelude.Maybe Prelude.Text)
controlDomainInsights_name = Lens.lens (\ControlDomainInsights' {name} -> name) (\s@ControlDomainInsights' {} a -> s {name = a} :: ControlDomainInsights)

-- | The total number of controls in the control domain.
controlDomainInsights_totalControlsCount :: Lens.Lens' ControlDomainInsights (Prelude.Maybe Prelude.Int)
controlDomainInsights_totalControlsCount = Lens.lens (\ControlDomainInsights' {totalControlsCount} -> totalControlsCount) (\s@ControlDomainInsights' {} a -> s {totalControlsCount = a} :: ControlDomainInsights)

instance Data.FromJSON ControlDomainInsights where
  parseJSON =
    Data.withObject
      "ControlDomainInsights"
      ( \x ->
          ControlDomainInsights'
            Prelude.<$> (x Data..:? "controlsCountByNoncompliantEvidence")
            Prelude.<*> (x Data..:? "evidenceInsights")
            Prelude.<*> (x Data..:? "id")
            Prelude.<*> (x Data..:? "lastUpdated")
            Prelude.<*> (x Data..:? "name")
            Prelude.<*> (x Data..:? "totalControlsCount")
      )

instance Prelude.Hashable ControlDomainInsights where
  hashWithSalt _salt ControlDomainInsights' {..} =
    _salt
      `Prelude.hashWithSalt` controlsCountByNoncompliantEvidence
      `Prelude.hashWithSalt` evidenceInsights
      `Prelude.hashWithSalt` id
      `Prelude.hashWithSalt` lastUpdated
      `Prelude.hashWithSalt` name
      `Prelude.hashWithSalt` totalControlsCount

instance Prelude.NFData ControlDomainInsights where
  rnf ControlDomainInsights' {..} =
    Prelude.rnf controlsCountByNoncompliantEvidence
      `Prelude.seq` Prelude.rnf evidenceInsights
      `Prelude.seq` Prelude.rnf id
      `Prelude.seq` Prelude.rnf lastUpdated
      `Prelude.seq` Prelude.rnf name
      `Prelude.seq` Prelude.rnf totalControlsCount