File Coverage

blib/lib/Paws/Config/Evaluation.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Config::Evaluation;
2 1     1   565 use Moose;
  1         4  
  1         12  
3             has Annotation => (is => 'ro', isa => 'Str');
4             has ComplianceResourceId => (is => 'ro', isa => 'Str', required => 1);
5             has ComplianceResourceType => (is => 'ro', isa => 'Str', required => 1);
6             has ComplianceType => (is => 'ro', isa => 'Str', required => 1);
7             has OrderingTimestamp => (is => 'ro', isa => 'Str', required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Config::Evaluation
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::Config::Evaluation object:
26              
27             $service_obj->Method(Att1 => { Annotation => $value, ..., OrderingTimestamp => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::Config::Evaluation object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Annotation
35              
36             =head1 DESCRIPTION
37              
38             Identifies an AWS resource and indicates whether it complies with the
39             AWS Config rule that it was evaluated against.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Annotation => Str
45              
46             Supplementary information about how the evaluation determined the
47             compliance.
48              
49              
50             =head2 B<REQUIRED> ComplianceResourceId => Str
51              
52             The ID of the AWS resource that was evaluated.
53              
54              
55             =head2 B<REQUIRED> ComplianceResourceType => Str
56              
57             The type of AWS resource that was evaluated.
58              
59              
60             =head2 B<REQUIRED> ComplianceType => Str
61              
62             Indicates whether the AWS resource complies with the AWS Config rule
63             that it was evaluated against.
64              
65             For the C<Evaluation> data type, AWS Config supports only the
66             C<COMPLIANT>, C<NON_COMPLIANT>, and C<NOT_APPLICABLE> values. AWS
67             Config does not support the C<INSUFFICIENT_DATA> value for this data
68             type.
69              
70             Similarly, AWS Config does not accept C<INSUFFICIENT_DATA> as the value
71             for C<ComplianceType> from a C<PutEvaluations> request. For example, an
72             AWS Lambda function for a custom Config rule cannot pass an
73             C<INSUFFICIENT_DATA> value to AWS Config.
74              
75              
76             =head2 B<REQUIRED> OrderingTimestamp => Str
77              
78             The time of the event in AWS Config that triggered the evaluation. For
79             event-based evaluations, the time indicates when AWS Config created the
80             configuration item that triggered the evaluation. For periodic
81             evaluations, the time indicates when AWS Config triggered the
82             evaluation at the frequency that you specified (for example, every 24
83             hours).
84              
85              
86              
87             =head1 SEE ALSO
88              
89             This class forms part of L<Paws>, describing an object used in L<Paws::Config>
90              
91             =head1 BUGS and CONTRIBUTIONS
92              
93             The source code is located here: https://github.com/pplu/aws-sdk-perl
94              
95             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
96              
97             =cut
98