blib/lib/Paws/SSM/ListDocuments.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::ListDocuments;
3 use Moose;
4 has DocumentFilterList => (is => 'ro', isa => 'ArrayRef[Paws::SSM::DocumentFilter]');
5 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::SSM::DocumentKeyValuesFilter]');
6 has MaxResults => (is => 'ro', isa => 'Int');
7 has NextToken => (is => 'ro', isa => 'Str');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListDocuments');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::ListDocumentsResult');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::SSM::ListDocuments - Arguments for method ListDocuments on L<Paws::SSM>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method ListDocuments on the
25 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
26 as arguments to method ListDocuments.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListDocuments.
29  
30 =head1 SYNOPSIS
31  
32 my $ssm = Paws->service('SSM');
33 my $ListDocumentsResult = $ssm->ListDocuments(
34 DocumentFilterList => [
35 {
36 Key => 'Name', # values: Name, Owner, PlatformTypes, DocumentType
37 Value => 'MyDocumentFilterValue', # min: 1
38  
39 },
40 ...
41 ], # OPTIONAL
42 Filters => [
43 {
44 Key => 'MyDocumentKeyValuesFilterKey', # min: 1, max: 128; OPTIONAL
45 Values => [
46 'MyDocumentKeyValuesFilterValue', ... # min: 1, max: 256
47 ], # OPTIONAL
48 },
49 ...
50 ], # OPTIONAL
51 MaxResults => 1, # OPTIONAL
52 NextToken => 'MyNextToken', # OPTIONAL
53 );
54  
55 # Results:
56 my $DocumentIdentifiers = $ListDocumentsResult->DocumentIdentifiers;
57 my $NextToken = $ListDocumentsResult->NextToken;
58  
59 # Returns a L<Paws::SSM::ListDocumentsResult> object.
60  
61 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
62 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/ListDocuments>
63  
64 =head1 ATTRIBUTES
65  
66  
67 =head2 DocumentFilterList => ArrayRef[L<Paws::SSM::DocumentFilter>]
68  
69 This data type is deprecated. Instead, use C<Filters>.
70  
71  
72  
73 =head2 Filters => ArrayRef[L<Paws::SSM::DocumentKeyValuesFilter>]
74  
75 One or more C<DocumentKeyValuesFilter> objects. Use a filter to return
76 a more specific list of results. For keys, you can specify one or more
77 key-value pair tags that have been applied to a document. Other valid
78 keys include C<Owner>, C<Name>, C<PlatformTypes>, C<DocumentType>, and
79 C<TargetType>. For example, to return documents you own use
80 C<Key=Owner,Values=Self>. To specify a custom key-value pair, use the
81 format C<Key=tag:tagName,Values=valueName>.
82  
83 This API action only supports filtering documents by using a single tag
84 key and one or more tag values. For example:
85 C<Key=tag:tagName,Values=valueName1,valueName2>
86  
87  
88  
89 =head2 MaxResults => Int
90  
91 The maximum number of items to return for this call. The call also
92 returns a token that you can specify in a subsequent call to get the
93 next set of results.
94  
95  
96  
97 =head2 NextToken => Str
98  
99 The token for the next set of items to return. (You received this token
100 from a previous call.)
101  
102  
103  
104  
105 =head1 SEE ALSO
106  
107 This class forms part of L<Paws>, documenting arguments for method ListDocuments in L<Paws::SSM>
108  
109 =head1 BUGS and CONTRIBUTIONS
110  
111 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
112  
113 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
114  
115 =cut
116