File Coverage

blib/lib/Paws/SSM/ComplianceItem.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::SSM::ComplianceItem;
2 1     1   284 use Moose;
  1         2  
  1         6  
3             has ComplianceType => (is => 'ro', isa => 'Str');
4             has Details => (is => 'ro', isa => 'Paws::SSM::ComplianceItemDetails');
5             has ExecutionSummary => (is => 'ro', isa => 'Paws::SSM::ComplianceExecutionSummary');
6             has Id => (is => 'ro', isa => 'Str');
7             has ResourceId => (is => 'ro', isa => 'Str');
8             has ResourceType => (is => 'ro', isa => 'Str');
9             has Severity => (is => 'ro', isa => 'Str');
10             has Status => (is => 'ro', isa => 'Str');
11             has Title => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::SSM::ComplianceItem
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::SSM::ComplianceItem object:
30              
31             $service_obj->Method(Att1 => { ComplianceType => $value, ..., Title => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::ComplianceItem object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->ComplianceType
39              
40             =head1 DESCRIPTION
41              
42             Information about the compliance as defined by the resource type. For
43             example, for a patch resource type, C<Items> includes information about
44             the PatchSeverity, Classification, etc.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 ComplianceType => Str
50              
51             The compliance type. For example, Association (for a State Manager
52             association), Patch, or Custom:C<string> are all valid compliance
53             types.
54              
55              
56             =head2 Details => L<Paws::SSM::ComplianceItemDetails>
57              
58             A "Key": "Value" tag combination for the compliance item.
59              
60              
61             =head2 ExecutionSummary => L<Paws::SSM::ComplianceExecutionSummary>
62              
63             A summary for the compliance item. The summary includes an execution
64             ID, the execution type (for example, command), and the execution time.
65              
66              
67             =head2 Id => Str
68              
69             An ID for the compliance item. For example, if the compliance item is a
70             Windows patch, the ID could be the number of the KB article. Here's an
71             example: KB4010320.
72              
73              
74             =head2 ResourceId => Str
75              
76             An ID for the resource. For a managed instance, this is the instance
77             ID.
78              
79              
80             =head2 ResourceType => Str
81              
82             The type of resource. C<ManagedInstance> is currently the only
83             supported resource type.
84              
85              
86             =head2 Severity => Str
87              
88             The severity of the compliance status. Severity can be one of the
89             following: Critical, High, Medium, Low, Informational, Unspecified.
90              
91              
92             =head2 Status => Str
93              
94             The status of the compliance item. An item is either COMPLIANT or
95             NON_COMPLIANT.
96              
97              
98             =head2 Title => Str
99              
100             A title for the compliance item. For example, if the compliance item is
101             a Windows patch, the title could be the title of the KB article for the
102             patch. Here's an example: Security Update for Active Directory
103             Federation Services.
104              
105              
106              
107             =head1 SEE ALSO
108              
109             This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
110              
111             =head1 BUGS and CONTRIBUTIONS
112              
113             The source code is located here: https://github.com/pplu/aws-sdk-perl
114              
115             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116              
117             =cut
118