File Coverage

blib/lib/Paws/SSM/DocumentDescription.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::DocumentDescription;
2 1     1   282 use Moose;
  1         2  
  1         5  
3             has CreatedDate => (is => 'ro', isa => 'Str');
4             has DefaultVersion => (is => 'ro', isa => 'Str');
5             has Description => (is => 'ro', isa => 'Str');
6             has DocumentType => (is => 'ro', isa => 'Str');
7             has DocumentVersion => (is => 'ro', isa => 'Str');
8             has Hash => (is => 'ro', isa => 'Str');
9             has HashType => (is => 'ro', isa => 'Str');
10             has LatestVersion => (is => 'ro', isa => 'Str');
11             has Name => (is => 'ro', isa => 'Str');
12             has Owner => (is => 'ro', isa => 'Str');
13             has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::SSM::DocumentParameter]', request_name => 'DocumentParameter', traits => ['NameInRequest']);
14             has PlatformTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'PlatformType', traits => ['NameInRequest']);
15             has SchemaVersion => (is => 'ro', isa => 'Str');
16             has Sha1 => (is => 'ro', isa => 'Str');
17             has Status => (is => 'ro', isa => 'Str');
18             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Tag]');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::SSM::DocumentDescription
26              
27             =head1 USAGE
28              
29             This class represents one of two things:
30              
31             =head3 Arguments in a call to a service
32              
33             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34             Each attribute should be used as a named argument in the calls that expect this type of object.
35              
36             As an example, if Att1 is expected to be a Paws::SSM::DocumentDescription object:
37              
38             $service_obj->Method(Att1 => { CreatedDate => $value, ..., Tags => $value });
39              
40             =head3 Results returned from an API call
41              
42             Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::DocumentDescription object:
43              
44             $result = $service_obj->Method(...);
45             $result->Att1->CreatedDate
46              
47             =head1 DESCRIPTION
48              
49             Describes a Systems Manager document.
50              
51             =head1 ATTRIBUTES
52              
53              
54             =head2 CreatedDate => Str
55              
56             The date when the document was created.
57              
58              
59             =head2 DefaultVersion => Str
60              
61             The default version.
62              
63              
64             =head2 Description => Str
65              
66             A description of the document.
67              
68              
69             =head2 DocumentType => Str
70              
71             The type of document.
72              
73              
74             =head2 DocumentVersion => Str
75              
76             The document version.
77              
78              
79             =head2 Hash => Str
80              
81             The Sha256 or Sha1 hash created by the system when the document was
82             created.
83              
84             Sha1 hashes have been deprecated.
85              
86              
87             =head2 HashType => Str
88              
89             Sha256 or Sha1.
90              
91             Sha1 hashes have been deprecated.
92              
93              
94             =head2 LatestVersion => Str
95              
96             The latest version of the document.
97              
98              
99             =head2 Name => Str
100              
101             The name of the Systems Manager document.
102              
103              
104             =head2 Owner => Str
105              
106             The AWS user account that created the document.
107              
108              
109             =head2 Parameters => ArrayRef[L<Paws::SSM::DocumentParameter>]
110              
111             A description of the parameters for a document.
112              
113              
114             =head2 PlatformTypes => ArrayRef[Str|Undef]
115              
116             The list of OS platforms compatible with this Systems Manager document.
117              
118              
119             =head2 SchemaVersion => Str
120              
121             The schema version.
122              
123              
124             =head2 Sha1 => Str
125              
126             The SHA1 hash of the document, which you can use for verification.
127              
128              
129             =head2 Status => Str
130              
131             The status of the Systems Manager document.
132              
133              
134             =head2 Tags => ArrayRef[L<Paws::SSM::Tag>]
135              
136             The tags, or metadata, that have been applied to the document.
137              
138              
139              
140             =head1 SEE ALSO
141              
142             This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
143              
144             =head1 BUGS and CONTRIBUTIONS
145              
146             The source code is located here: https://github.com/pplu/aws-sdk-perl
147              
148             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
149              
150             =cut
151