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