Amazonka.IoT.Types.AuditFinding

Documentation

data AuditFinding

The findings (results) of the audit.

See: newAuditFinding smart constructor.

Constructors

AuditFinding'

Fields

• checkName :: Maybe Text

  The audit check that generated this result.

• findingId :: Maybe Text

  A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

• findingTime :: Maybe POSIX

  The time the result (finding) was discovered.

• isSuppressed :: Maybe Bool

  Indicates whether the audit finding was suppressed or not during reporting.

• nonCompliantResource :: Maybe NonCompliantResource

  The resource that was found to be noncompliant with the audit check.

• reasonForNonCompliance :: Maybe Text

  The reason the resource was noncompliant.

• reasonForNonComplianceCode :: Maybe Text

  A code that indicates the reason that the resource was noncompliant.

• relatedResources :: Maybe [RelatedResource]

  The list of related resources.

• severity :: Maybe AuditFindingSeverity

  The severity of the result (finding).

• taskId :: Maybe Text

  The ID of the audit that generated this result (finding).

• taskStartTime :: Maybe POSIX

  The time the audit started.

Instances

FromJSON AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

parseJSON :: Value -> Parser AuditFinding

parseJSONList :: Value -> Parser [AuditFinding]

Generic AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Associated Types

type Rep AuditFinding :: Type -> Type

Methods

from :: AuditFinding -> Rep AuditFinding x

to :: Rep AuditFinding x -> AuditFinding

Read AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

readsPrec :: Int -> ReadS AuditFinding

readList :: ReadS [AuditFinding]

readPrec :: ReadPrec AuditFinding

readListPrec :: ReadPrec [AuditFinding]

Show AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

showsPrec :: Int -> AuditFinding -> ShowS

show :: AuditFinding -> String

showList :: [AuditFinding] -> ShowS

NFData AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

rnf :: AuditFinding -> ()

Eq AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

(==) :: AuditFinding -> AuditFinding -> Bool

(/=) :: AuditFinding -> AuditFinding -> Bool

Hashable AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

Methods

hashWithSalt :: Int -> AuditFinding -> Int

hash :: AuditFinding -> Int

type Rep AuditFinding

Defined in Amazonka.IoT.Types.AuditFinding

type Rep AuditFinding = D1 ('MetaData "AuditFinding" "Amazonka.IoT.Types.AuditFinding" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AuditFinding'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "findingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "findingTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "isSuppressed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nonCompliantResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NonCompliantResource))))) :*: ((S1 ('MetaSel ('Just "reasonForNonCompliance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reasonForNonComplianceCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "relatedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelatedResource])))) :*: (S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditFindingSeverity)) :*: (S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newAuditFinding :: AuditFinding

Create a value of AuditFinding 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:checkName:AuditFinding', auditFinding_checkName - The audit check that generated this result.

$sel:findingId:AuditFinding', auditFinding_findingId - A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

$sel:findingTime:AuditFinding', auditFinding_findingTime - The time the result (finding) was discovered.

$sel:isSuppressed:AuditFinding', auditFinding_isSuppressed - Indicates whether the audit finding was suppressed or not during reporting.

$sel:nonCompliantResource:AuditFinding', auditFinding_nonCompliantResource - The resource that was found to be noncompliant with the audit check.

$sel:reasonForNonCompliance:AuditFinding', auditFinding_reasonForNonCompliance - The reason the resource was noncompliant.

$sel:reasonForNonComplianceCode:AuditFinding', auditFinding_reasonForNonComplianceCode - A code that indicates the reason that the resource was noncompliant.

$sel:relatedResources:AuditFinding', auditFinding_relatedResources - The list of related resources.

$sel:severity:AuditFinding', auditFinding_severity - The severity of the result (finding).

$sel:taskId:AuditFinding', auditFinding_taskId - The ID of the audit that generated this result (finding).

$sel:taskStartTime:AuditFinding', auditFinding_taskStartTime - The time the audit started.

auditFinding_checkName :: Lens' AuditFinding (Maybe Text)

The audit check that generated this result.

auditFinding_findingId :: Lens' AuditFinding (Maybe Text)

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

auditFinding_findingTime :: Lens' AuditFinding (Maybe UTCTime)

The time the result (finding) was discovered.

auditFinding_isSuppressed :: Lens' AuditFinding (Maybe Bool)

Indicates whether the audit finding was suppressed or not during reporting.

auditFinding_nonCompliantResource :: Lens' AuditFinding (Maybe NonCompliantResource)

The resource that was found to be noncompliant with the audit check.

auditFinding_reasonForNonCompliance :: Lens' AuditFinding (Maybe Text)

The reason the resource was noncompliant.

auditFinding_reasonForNonComplianceCode :: Lens' AuditFinding (Maybe Text)

A code that indicates the reason that the resource was noncompliant.

auditFinding_relatedResources :: Lens' AuditFinding (Maybe [RelatedResource])

The list of related resources.

auditFinding_severity :: Lens' AuditFinding (Maybe AuditFindingSeverity)

The severity of the result (finding).

auditFinding_taskId :: Lens' AuditFinding (Maybe Text)

The ID of the audit that generated this result (finding).

auditFinding_taskStartTime :: Lens' AuditFinding (Maybe UTCTime)

The time the audit started.