File Coverage

blib/lib/Paws/Support/TrustedAdvisorCheckDescription.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::Support::TrustedAdvisorCheckDescription;
2 1     1   599 use Moose;
  1         4  
  1         8  
3             has Category => (is => 'ro', isa => 'Str', request_name => 'category', traits => ['NameInRequest'], required => 1);
4             has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest'], required => 1);
5             has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest'], required => 1);
6             has Metadata => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'metadata', traits => ['NameInRequest'], required => 1);
7             has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Support::TrustedAdvisorCheckDescription
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::Support::TrustedAdvisorCheckDescription object:
26              
27             $service_obj->Method(Att1 => { Category => $value, ..., Name => $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::Support::TrustedAdvisorCheckDescription object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Category
35              
36             =head1 DESCRIPTION
37              
38             The description and metadata for a Trusted Advisor check.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> Category => Str
44              
45             The category of the Trusted Advisor check.
46              
47              
48             =head2 B<REQUIRED> Description => Str
49              
50             The description of the Trusted Advisor check, which includes the alert
51             criteria and recommended actions (contains HTML markup).
52              
53              
54             =head2 B<REQUIRED> Id => Str
55              
56             The unique identifier for the Trusted Advisor check.
57              
58              
59             =head2 B<REQUIRED> Metadata => ArrayRef[Str|Undef]
60              
61             The column headings for the data returned by the Trusted Advisor check.
62             The order of the headings corresponds to the order of the data in the
63             B<Metadata> element of the TrustedAdvisorResourceDetail for the check.
64             B<Metadata> contains all the data that is shown in the Excel download,
65             even in those cases where the UI shows just summary data.
66              
67              
68             =head2 B<REQUIRED> Name => Str
69              
70             The display name for the Trusted Advisor check.
71              
72              
73              
74             =head1 SEE ALSO
75              
76             This class forms part of L<Paws>, describing an object used in L<Paws::Support>
77              
78             =head1 BUGS and CONTRIBUTIONS
79              
80             The source code is located here: https://github.com/pplu/aws-sdk-perl
81              
82             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
83              
84             =cut
85