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.AccessAnalyzer.Types.ValidatePolicyFinding

Description

Documentation

data ValidatePolicyFinding Source #

A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.

See: newValidatePolicyFinding smart constructor.

Constructors

ValidatePolicyFinding'

Fields

findingDetails :: Text
A localized message that explains the finding and provides guidance on how to address it.
findingType :: ValidatePolicyFindingType
The impact of the finding.
Security warnings report when the policy allows access that we consider overly permissive.
Errors report when a part of the policy is not functional.
Warnings report non-security issues when a policy does not conform to policy writing best practices.
Suggestions recommend stylistic improvements in the policy that do not impact access.
issueCode :: Text
The issue code provides an identifier of the issue associated with this finding.
learnMoreLink :: Text
A link to additional documentation about the type of finding.
locations :: [Location]
The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

Instances

Instances details

FromJSON ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods parseJSON :: Value -> Parser ValidatePolicyFinding # parseJSONList :: Value -> Parser [ValidatePolicyFinding] #
Generic ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Associated Types type Rep ValidatePolicyFinding :: Type -> Type # Methods from :: ValidatePolicyFinding -> Rep ValidatePolicyFinding x # to :: Rep ValidatePolicyFinding x -> ValidatePolicyFinding #
Read ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods readsPrec :: Int -> ReadS ValidatePolicyFinding # readList :: ReadS [ValidatePolicyFinding] # readPrec :: ReadPrec ValidatePolicyFinding # readListPrec :: ReadPrec [ValidatePolicyFinding] #
Show ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods showsPrec :: Int -> ValidatePolicyFinding -> ShowS # show :: ValidatePolicyFinding -> String # showList :: [ValidatePolicyFinding] -> ShowS #
NFData ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods rnf :: ValidatePolicyFinding -> () #
Eq ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods (==) :: ValidatePolicyFinding -> ValidatePolicyFinding -> Bool # (/=) :: ValidatePolicyFinding -> ValidatePolicyFinding -> Bool #
Hashable ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding Methods hashWithSalt :: Int -> ValidatePolicyFinding -> Int # hash :: ValidatePolicyFinding -> Int #
type Rep ValidatePolicyFinding Source #
Instance details Defined in Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding type Rep ValidatePolicyFinding = D1 ('MetaData "ValidatePolicyFinding" "Amazonka.AccessAnalyzer.Types.ValidatePolicyFinding" "amazonka-accessanalyzer-2.0-A0JZirwj4a95MolJaaBere" 'False) (C1 ('MetaCons "ValidatePolicyFinding'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "findingDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "findingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidatePolicyFindingType)) :: (S1 ('MetaSel ('Just "issueCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "learnMoreLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Location])))))

newValidatePolicyFinding Source #

Arguments

:: Text	`$sel:findingDetails:ValidatePolicyFinding'`
-> ValidatePolicyFindingType	`$sel:findingType:ValidatePolicyFinding'`
-> Text	`$sel:issueCode:ValidatePolicyFinding'`
-> Text	`$sel:learnMoreLink:ValidatePolicyFinding'`
-> ValidatePolicyFinding

Create a value of ValidatePolicyFinding 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:findingDetails:ValidatePolicyFinding', validatePolicyFinding_findingDetails - A localized message that explains the finding and provides guidance on how to address it.

$sel:findingType:ValidatePolicyFinding', validatePolicyFinding_findingType - The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

$sel:issueCode:ValidatePolicyFinding', validatePolicyFinding_issueCode - The issue code provides an identifier of the issue associated with this finding.

$sel:learnMoreLink:ValidatePolicyFinding', validatePolicyFinding_learnMoreLink - A link to additional documentation about the type of finding.

$sel:locations:ValidatePolicyFinding', validatePolicyFinding_locations - The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

validatePolicyFinding_findingDetails :: Lens' ValidatePolicyFinding Text Source #

A localized message that explains the finding and provides guidance on how to address it.

validatePolicyFinding_findingType :: Lens' ValidatePolicyFinding ValidatePolicyFindingType Source #

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

validatePolicyFinding_issueCode :: Lens' ValidatePolicyFinding Text Source #

The issue code provides an identifier of the issue associated with this finding.

validatePolicyFinding_learnMoreLink :: Lens' ValidatePolicyFinding Text Source #

A link to additional documentation about the type of finding.

validatePolicyFinding_locations :: Lens' ValidatePolicyFinding [Location] Source #

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.