Assessment.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.Assessment
-- 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.Assessment where

import Amazonka.AuditManager.Types.AWSAccount
import Amazonka.AuditManager.Types.AssessmentFramework
import Amazonka.AuditManager.Types.AssessmentMetadata
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

-- | An entity that defines the scope of audit evidence collected by Audit
-- Manager. An Audit Manager assessment is an implementation of an Audit
-- Manager framework.
--
-- /See:/ 'newAssessment' smart constructor.
data Assessment = Assessment'
  { -- | The Amazon Resource Name (ARN) of the assessment.
    arn :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Web Services account that\'s associated with the assessment.
    awsAccount :: Prelude.Maybe AWSAccount,
    -- | The framework that the assessment was created from.
    framework :: Prelude.Maybe AssessmentFramework,
    -- | The metadata for the assessment.
    metadata :: Prelude.Maybe AssessmentMetadata,
    -- | The tags that are associated with the assessment.
    tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'Assessment' 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:
--
-- 'arn', 'assessment_arn' - The Amazon Resource Name (ARN) of the assessment.
--
-- 'awsAccount', 'assessment_awsAccount' - The Amazon Web Services account that\'s associated with the assessment.
--
-- 'framework', 'assessment_framework' - The framework that the assessment was created from.
--
-- 'metadata', 'assessment_metadata' - The metadata for the assessment.
--
-- 'tags', 'assessment_tags' - The tags that are associated with the assessment.
newAssessment ::
  Assessment
newAssessment =
  Assessment'
    { arn = Prelude.Nothing,
      awsAccount = Prelude.Nothing,
      framework = Prelude.Nothing,
      metadata = Prelude.Nothing,
      tags = Prelude.Nothing
    }

-- | The Amazon Resource Name (ARN) of the assessment.
assessment_arn :: Lens.Lens' Assessment (Prelude.Maybe Prelude.Text)
assessment_arn = Lens.lens (\Assessment' {arn} -> arn) (\s@Assessment' {} a -> s {arn = a} :: Assessment)

-- | The Amazon Web Services account that\'s associated with the assessment.
assessment_awsAccount :: Lens.Lens' Assessment (Prelude.Maybe AWSAccount)
assessment_awsAccount = Lens.lens (\Assessment' {awsAccount} -> awsAccount) (\s@Assessment' {} a -> s {awsAccount = a} :: Assessment)

-- | The framework that the assessment was created from.
assessment_framework :: Lens.Lens' Assessment (Prelude.Maybe AssessmentFramework)
assessment_framework = Lens.lens (\Assessment' {framework} -> framework) (\s@Assessment' {} a -> s {framework = a} :: Assessment)

-- | The metadata for the assessment.
assessment_metadata :: Lens.Lens' Assessment (Prelude.Maybe AssessmentMetadata)
assessment_metadata = Lens.lens (\Assessment' {metadata} -> metadata) (\s@Assessment' {} a -> s {metadata = a} :: Assessment)

-- | The tags that are associated with the assessment.
assessment_tags :: Lens.Lens' Assessment (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
assessment_tags = Lens.lens (\Assessment' {tags} -> tags) (\s@Assessment' {} a -> s {tags = a} :: Assessment) Prelude.. Lens.mapping Lens.coerced

instance Data.FromJSON Assessment where
  parseJSON =
    Data.withObject
      "Assessment"
      ( \x ->
          Assessment'
            Prelude.<$> (x Data..:? "arn")
            Prelude.<*> (x Data..:? "awsAccount")
            Prelude.<*> (x Data..:? "framework")
            Prelude.<*> (x Data..:? "metadata")
            Prelude.<*> (x Data..:? "tags" Data..!= Prelude.mempty)
      )

instance Prelude.Hashable Assessment where
  hashWithSalt _salt Assessment' {..} =
    _salt
      `Prelude.hashWithSalt` arn
      `Prelude.hashWithSalt` awsAccount
      `Prelude.hashWithSalt` framework
      `Prelude.hashWithSalt` metadata
      `Prelude.hashWithSalt` tags

instance Prelude.NFData Assessment where
  rnf Assessment' {..} =
    Prelude.rnf arn
      `Prelude.seq` Prelude.rnf awsAccount
      `Prelude.seq` Prelude.rnf framework
      `Prelude.seq` Prelude.rnf metadata
      `Prelude.seq` Prelude.rnf tags