Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.Types.Compliance

Description

Synopsis

data Compliance = Compliance' {
- status :: Maybe ComplianceStatus
- relatedRequirements :: Maybe [Text]
- statusReasons :: Maybe [StatusReason]
}
newCompliance :: Compliance
compliance_status :: Lens' Compliance (Maybe ComplianceStatus)
compliance_relatedRequirements :: Lens' Compliance (Maybe [Text])
compliance_statusReasons :: Lens' Compliance (Maybe [StatusReason])

Documentation

data Compliance Source #

Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.

See: newCompliance smart constructor.

Constructors

Compliance'

Fields

status :: Maybe ComplianceStatus
The result of a standards check.
The valid values for Status are as follows.
- - PASSED - Standards check passed for all evaluated resources.
  - WARNING - Some information is missing or this check is not supported for your configuration.
  - FAILED - Standards check failed for at least one evaluated resource.
  - NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.
relatedRequirements :: Maybe [Text]
For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.
statusReasons :: Maybe [StatusReason]
For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

Instances

Instances details

Eq Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods (==) :: Compliance -> Compliance -> Bool # (/=) :: Compliance -> Compliance -> Bool #
Read Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods readsPrec :: Int -> ReadS Compliance # readList :: ReadS [Compliance] # readPrec :: ReadPrec Compliance # readListPrec :: ReadPrec [Compliance] #
Show Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods showsPrec :: Int -> Compliance -> ShowS # show :: Compliance -> String # showList :: [Compliance] -> ShowS #
Generic Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Associated Types type Rep Compliance :: Type -> Type # Methods from :: Compliance -> Rep Compliance x # to :: Rep Compliance x -> Compliance #
NFData Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods rnf :: Compliance -> () #
Hashable Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods hashWithSalt :: Int -> Compliance -> Int # hash :: Compliance -> Int #
ToJSON Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods toJSON :: Compliance -> Value # toEncoding :: Compliance -> Encoding # toJSONList :: [Compliance] -> Value # toEncodingList :: [Compliance] -> Encoding #
FromJSON Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance Methods parseJSON :: Value -> Parser Compliance # parseJSONList :: Value -> Parser [Compliance] #
type Rep Compliance Source #
Instance details Defined in Amazonka.SecurityHub.Types.Compliance type Rep Compliance = D1 ('MetaData "Compliance" "Amazonka.SecurityHub.Types.Compliance" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "Compliance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceStatus)) :: (S1 ('MetaSel ('Just "relatedRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "statusReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StatusReason])))))

newCompliance :: Compliance Source #

Create a value of Compliance 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:status:Compliance', compliance_status - The result of a standards check.

The valid values for Status are as follows.

- PASSED - Standards check passed for all evaluated resources.
- WARNING - Some information is missing or this check is not supported for your configuration.
- FAILED - Standards check failed for at least one evaluated resource.
- NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

$sel:relatedRequirements:Compliance', compliance_relatedRequirements - For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

$sel:statusReasons:Compliance', compliance_statusReasons - For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

compliance_status :: Lens' Compliance (Maybe ComplianceStatus) Source #

The result of a standards check.

The valid values for Status are as follows.

- PASSED - Standards check passed for all evaluated resources.
- WARNING - Some information is missing or this check is not supported for your configuration.
- FAILED - Standards check failed for at least one evaluated resource.
- NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

compliance_statusReasons :: Lens' Compliance (Maybe [StatusReason]) Source #

For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.