File Coverage

blib/lib/Paws/Support/TrustedAdvisorCheckSummary.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::Support::TrustedAdvisorCheckSummary;
2 1     1   503 use Moose;
  1     1   3  
  1         7  
  1         289  
  1         2  
  1         5  
3             has CategorySpecificSummary => (is => 'ro', isa => 'Paws::Support::TrustedAdvisorCategorySpecificSummary', request_name => 'categorySpecificSummary', traits => ['NameInRequest'], required => 1);
4             has CheckId => (is => 'ro', isa => 'Str', request_name => 'checkId', traits => ['NameInRequest'], required => 1);
5             has HasFlaggedResources => (is => 'ro', isa => 'Bool', request_name => 'hasFlaggedResources', traits => ['NameInRequest']);
6             has ResourcesSummary => (is => 'ro', isa => 'Paws::Support::TrustedAdvisorResourcesSummary', request_name => 'resourcesSummary', traits => ['NameInRequest'], required => 1);
7             has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest'], required => 1);
8             has Timestamp => (is => 'ro', isa => 'Str', request_name => 'timestamp', traits => ['NameInRequest'], required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::Support::TrustedAdvisorCheckSummary
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::Support::TrustedAdvisorCheckSummary object:
27              
28             $service_obj->Method(Att1 => { CategorySpecificSummary => $value, ..., Timestamp => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::Support::TrustedAdvisorCheckSummary object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->CategorySpecificSummary
36              
37             =head1 DESCRIPTION
38              
39             A summary of a Trusted Advisor check result, including the alert
40             status, last refresh, and number of resources examined.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> CategorySpecificSummary => L<Paws::Support::TrustedAdvisorCategorySpecificSummary>
46              
47             Summary information that relates to the category of the check. Cost
48             Optimizing is the only category that is currently supported.
49              
50              
51             =head2 B<REQUIRED> CheckId => Str
52              
53             The unique identifier for the Trusted Advisor check.
54              
55              
56             =head2 HasFlaggedResources => Bool
57              
58             Specifies whether the Trusted Advisor check has flagged resources.
59              
60              
61             =head2 B<REQUIRED> ResourcesSummary => L<Paws::Support::TrustedAdvisorResourcesSummary>
62              
63            
64              
65              
66             =head2 B<REQUIRED> Status => Str
67              
68             The alert status of the check: "ok" (green), "warning" (yellow),
69             "error" (red), or "not_available".
70              
71              
72             =head2 B<REQUIRED> Timestamp => Str
73              
74             The time of the last refresh of the check.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::Support>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89