File Coverage

blib/lib/Paws/SSM/DocumentKeyValuesFilter.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::DocumentKeyValuesFilter;
2 1     1   288 use Moose;
  1         2  
  1         6  
3             has Key => (is => 'ro', isa => 'Str');
4             has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::SSM::DocumentKeyValuesFilter
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::SSM::DocumentKeyValuesFilter object:
23              
24             $service_obj->Method(Att1 => { Key => $value, ..., Values => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::DocumentKeyValuesFilter object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Key
32              
33             =head1 DESCRIPTION
34              
35             One or more filters. Use a filter to return a more specific list of
36             documents.
37              
38             For keys, you can specify one or more tags that have been applied to a
39             document.
40              
41             Other valid values include Owner, Name, PlatformTypes, and
42             DocumentType.
43              
44             Note that only one Owner can be specified in a request. For example:
45             C<Key=Owner,Values=Self>.
46              
47             If you use Name as a key, you can use a name prefix to return a list of
48             documents. For example, in the AWS CLI, to return a list of all
49             documents that begin with C<Te>, run the following command:
50              
51             C<aws ssm list-documents --filters Key=Name,Values=Te>
52              
53             If you specify more than two keys, only documents that are identified
54             by all the tags are returned in the results. If you specify more than
55             two values for a key, documents that are identified by any of the
56             values are returned in the results.
57              
58             To specify a custom key and value pair, use the format
59             C<Key=tag:[tagName],Values=[valueName]>.
60              
61             For example, if you created a Key called region and are using the AWS
62             CLI to call the C<list-documents> command:
63              
64             C<aws ssm list-documents --filters Key=tag:region,Values=east,west
65             Key=Owner,Values=Self>
66              
67             =head1 ATTRIBUTES
68              
69              
70             =head2 Key => Str
71              
72             The name of the filter key.
73              
74              
75             =head2 Values => ArrayRef[Str|Undef]
76              
77             The value for the filter key.
78              
79              
80              
81             =head1 SEE ALSO
82              
83             This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
84              
85             =head1 BUGS and CONTRIBUTIONS
86              
87             The source code is located here: https://github.com/pplu/aws-sdk-perl
88              
89             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
90              
91             =cut
92