« blib/lib/Paws/Config/DescribeRetentionConfigurationsResponse.pm
↑ Summary
blib/lib/Paws/Config/EvaluationResult.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::Evaluation; | ||
| 3 | use Moose; | ||
| 4 | has Annotation => (is => 'ro', isa => 'Str'); | ||
| 5 | has ComplianceResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ComplianceResourceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ComplianceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has OrderingTimestamp => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Config::Evaluation | ||
| 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::Config::Evaluation object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Annotation => $value, ..., OrderingTimestamp => $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::Config::Evaluation object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Annotation | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Identifies an AWS resource and indicates whether it complies with the | ||
| 41 | AWS Config rule that it was evaluated against. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Annotation => Str | ||
| 47 | |||
| 48 | Supplementary information about how the evaluation determined the | ||
| 49 | compliance. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> ComplianceResourceId => Str | ||
| 53 | |||
| 54 | The ID of the AWS resource that was evaluated. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ComplianceResourceType => Str | ||
| 58 | |||
| 59 | The type of AWS resource that was evaluated. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> ComplianceType => Str | ||
| 63 | |||
| 64 | Indicates whether the AWS resource complies with the AWS Config rule | ||
| 65 | that it was evaluated against. | ||
| 66 | |||
| 67 | For the C<Evaluation> data type, AWS Config supports only the | ||
| 68 | C<COMPLIANT>, C<NON_COMPLIANT>, and C<NOT_APPLICABLE> values. AWS | ||
| 69 | Config does not support the C<INSUFFICIENT_DATA> value for this data | ||
| 70 | type. | ||
| 71 | |||
| 72 | Similarly, AWS Config does not accept C<INSUFFICIENT_DATA> as the value | ||
| 73 | for C<ComplianceType> from a C<PutEvaluations> request. For example, an | ||
| 74 | AWS Lambda function for a custom AWS Config rule cannot pass an | ||
| 75 | C<INSUFFICIENT_DATA> value to AWS Config. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> OrderingTimestamp => Str | ||
| 79 | |||
| 80 | The time of the event in AWS Config that triggered the evaluation. For | ||
| 81 | event-based evaluations, the time indicates when AWS Config created the | ||
| 82 | configuration item that triggered the evaluation. For periodic | ||
| 83 | evaluations, the time indicates when AWS Config triggered the | ||
| 84 | evaluation at the frequency that you specified (for example, every 24 | ||
| 85 | hours). | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |