Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AuditManager.Types.AssessmentReport

Description

Synopsis

data AssessmentReport = AssessmentReport' {
- assessmentId :: Maybe Text
- assessmentName :: Maybe Text
- author :: Maybe Text
- awsAccountId :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- status :: Maybe AssessmentReportStatus
}
newAssessmentReport :: AssessmentReport
assessmentReport_assessmentId :: Lens' AssessmentReport (Maybe Text)
assessmentReport_assessmentName :: Lens' AssessmentReport (Maybe Text)
assessmentReport_author :: Lens' AssessmentReport (Maybe Text)
assessmentReport_awsAccountId :: Lens' AssessmentReport (Maybe Text)
assessmentReport_creationTime :: Lens' AssessmentReport (Maybe UTCTime)
assessmentReport_description :: Lens' AssessmentReport (Maybe Text)
assessmentReport_id :: Lens' AssessmentReport (Maybe Text)
assessmentReport_name :: Lens' AssessmentReport (Maybe Text)
assessmentReport_status :: Lens' AssessmentReport (Maybe AssessmentReportStatus)

Documentation

data AssessmentReport Source #

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.

Constructors

AssessmentReport'

Fields

assessmentId :: Maybe Text
The identifier for the specified assessment.
assessmentName :: Maybe Text
The name of the associated assessment.
author :: Maybe Text
The name of the user who created the assessment report.
awsAccountId :: Maybe Text
The identifier for the specified Amazon Web Services account.
creationTime :: Maybe POSIX
Specifies when the assessment report was created.
description :: Maybe Text
The description of the specified assessment report.
id :: Maybe Text
The unique identifier for the assessment report.
name :: Maybe Text
The name that's given to the assessment report.
status :: Maybe AssessmentReportStatus
The current status of the specified assessment report.

Instances

Instances details

FromJSON AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods parseJSON :: Value -> Parser AssessmentReport # parseJSONList :: Value -> Parser [AssessmentReport] #
Generic AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Associated Types type Rep AssessmentReport :: Type -> Type # Methods from :: AssessmentReport -> Rep AssessmentReport x # to :: Rep AssessmentReport x -> AssessmentReport #
Read AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods readsPrec :: Int -> ReadS AssessmentReport # readList :: ReadS [AssessmentReport] # readPrec :: ReadPrec AssessmentReport # readListPrec :: ReadPrec [AssessmentReport] #
Show AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods showsPrec :: Int -> AssessmentReport -> ShowS # show :: AssessmentReport -> String # showList :: [AssessmentReport] -> ShowS #
NFData AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods rnf :: AssessmentReport -> () #
Eq AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods (==) :: AssessmentReport -> AssessmentReport -> Bool # (/=) :: AssessmentReport -> AssessmentReport -> Bool #
Hashable AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport Methods hashWithSalt :: Int -> AssessmentReport -> Int # hash :: AssessmentReport -> Int #
type Rep AssessmentReport Source #
Instance details Defined in Amazonka.AuditManager.Types.AssessmentReport type Rep AssessmentReport = D1 ('MetaData "AssessmentReport" "Amazonka.AuditManager.Types.AssessmentReport" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "AssessmentReport'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assessmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "assessmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssessmentReportStatus)))))))

newAssessmentReport :: AssessmentReport Source #

Create a value of AssessmentReport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assessmentId:AssessmentReport', assessmentReport_assessmentId - The identifier for the specified assessment.

$sel:assessmentName:AssessmentReport', assessmentReport_assessmentName - The name of the associated assessment.

$sel:author:AssessmentReport', assessmentReport_author - The name of the user who created the assessment report.

$sel:awsAccountId:AssessmentReport', assessmentReport_awsAccountId - The identifier for the specified Amazon Web Services account.

$sel:creationTime:AssessmentReport', assessmentReport_creationTime - Specifies when the assessment report was created.

$sel:description:AssessmentReport', assessmentReport_description - The description of the specified assessment report.

$sel:id:AssessmentReport', assessmentReport_id - The unique identifier for the assessment report.

$sel:name:AssessmentReport', assessmentReport_name - The name that's given to the assessment report.

$sel:status:AssessmentReport', assessmentReport_status - The current status of the specified assessment report.

assessmentReport_assessmentId :: Lens' AssessmentReport (Maybe Text) Source #

The identifier for the specified assessment.

assessmentReport_assessmentName :: Lens' AssessmentReport (Maybe Text) Source #

The name of the associated assessment.

assessmentReport_author :: Lens' AssessmentReport (Maybe Text) Source #

The name of the user who created the assessment report.

assessmentReport_awsAccountId :: Lens' AssessmentReport (Maybe Text) Source #

The identifier for the specified Amazon Web Services account.

assessmentReport_creationTime :: Lens' AssessmentReport (Maybe UTCTime) Source #

Specifies when the assessment report was created.

assessmentReport_description :: Lens' AssessmentReport (Maybe Text) Source #

The description of the specified assessment report.

assessmentReport_id :: Lens' AssessmentReport (Maybe Text) Source #

The unique identifier for the assessment report.

assessmentReport_name :: Lens' AssessmentReport (Maybe Text) Source #

The name that's given to the assessment report.

assessmentReport_status :: Lens' AssessmentReport (Maybe AssessmentReportStatus) Source #

The current status of the specified assessment report.