« blib/lib/Paws/AccessAnalyzer/ValidatePolicy.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/ValidatePolicyResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AccessAnalyzer::ValidatePolicyFinding; | ||
| 3 | use Moose; | ||
| 4 | has FindingDetails => (is => 'ro', isa => 'Str', request_name => 'findingDetails', traits => ['NameInRequest'], required => 1); | ||
| 5 | has FindingType => (is => 'ro', isa => 'Str', request_name => 'findingType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has IssueCode => (is => 'ro', isa => 'Str', request_name => 'issueCode', traits => ['NameInRequest'], required => 1); | ||
| 7 | has LearnMoreLink => (is => 'ro', isa => 'Str', request_name => 'learnMoreLink', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Locations => (is => 'ro', isa => 'ArrayRef[Paws::AccessAnalyzer::Location]', request_name => 'locations', traits => ['NameInRequest'], required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::AccessAnalyzer::ValidatePolicyFinding | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::AccessAnalyzer::ValidatePolicyFinding object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { FindingDetails => $value, ..., Locations => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::AccessAnalyzer::ValidatePolicyFinding object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->FindingDetails | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A finding in a policy. Each finding is an actionable recommendation | ||
| 41 | that can be used to improve the policy. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> FindingDetails => Str | ||
| 47 | |||
| 48 | A localized message that explains the finding and provides guidance on | ||
| 49 | how to address it. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> FindingType => Str | ||
| 53 | |||
| 54 | The impact of the finding. | ||
| 55 | |||
| 56 | Security warnings report when the policy allows access that we consider | ||
| 57 | overly permissive. | ||
| 58 | |||
| 59 | Errors report when a part of the policy is not functional. | ||
| 60 | |||
| 61 | Warnings report non-security issues when a policy does not conform to | ||
| 62 | policy writing best practices. | ||
| 63 | |||
| 64 | Suggestions recommend stylistic improvements in the policy that do not | ||
| 65 | impact access. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> IssueCode => Str | ||
| 69 | |||
| 70 | The issue code provides an identifier of the issue associated with this | ||
| 71 | finding. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> LearnMoreLink => Str | ||
| 75 | |||
| 76 | A link to additional documentation about the type of finding. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> Locations => ArrayRef[L<Paws::AccessAnalyzer::Location>] | ||
| 80 | |||
| 81 | The list of locations in the policy document that are related to the | ||
| 82 | finding. The issue code provides a summary of an issue identified by | ||
| 83 | the finding. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head1 SEE ALSO | ||
| 88 | |||
| 89 | This class forms part of L<Paws>, describing an object used in L<Paws::AccessAnalyzer> | ||
| 90 | |||
| 91 | =head1 BUGS and CONTRIBUTIONS | ||
| 92 | |||
| 93 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 94 | |||
| 95 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 96 | |||
| 97 | =cut | ||
| 98 |