File Coverage

blib/lib/Paws/SSM/GetParametersByPath.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SSM::GetParametersByPath;
3 1     1   293 use Moose;
  1         3  
  1         5  
4             has MaxResults => (is => 'ro', isa => 'Int');
5             has NextToken => (is => 'ro', isa => 'Str');
6             has ParameterFilters => (is => 'ro', isa => 'ArrayRef[Paws::SSM::ParameterStringFilter]');
7             has Path => (is => 'ro', isa => 'Str', required => 1);
8             has Recursive => (is => 'ro', isa => 'Bool');
9             has WithDecryption => (is => 'ro', isa => 'Bool');
10              
11 1     1   5339 use MooseX::ClassAttribute;
  1         3  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetParametersByPath');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::GetParametersByPathResult');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::SSM::GetParametersByPath - Arguments for method GetParametersByPath on Paws::SSM
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method GetParametersByPath on the
27             Amazon Simple Systems Manager (SSM) service. Use the attributes of this class
28             as arguments to method GetParametersByPath.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetParametersByPath.
31              
32             As an example:
33              
34             $service_obj->GetParametersByPath(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 MaxResults => Int
42              
43             The maximum number of items to return for this call. The call also
44             returns a token that you can specify in a subsequent call to get the
45             next set of results.
46              
47              
48              
49             =head2 NextToken => Str
50              
51             A token to start the list. Use this token to get the next set of
52             results.
53              
54              
55              
56             =head2 ParameterFilters => ArrayRef[L<Paws::SSM::ParameterStringFilter>]
57              
58             Filters to limit the request results.
59              
60              
61              
62             =head2 B<REQUIRED> Path => Str
63              
64             The hierarchy for the parameter. Hierarchies start with a forward slash
65             (/) and end with the parameter name. A hierarchy can have a maximum of
66             five levels. Examples: /Environment/Test/DBString003
67              
68             /Finance/Prod/IAD/OS/WinServ2016/license15
69              
70              
71              
72             =head2 Recursive => Bool
73              
74             Retrieve all parameters within a hierarchy.
75              
76              
77              
78             =head2 WithDecryption => Bool
79              
80             Retrieve all parameters in a hierarchy with their value decrypted.
81              
82              
83              
84              
85             =head1 SEE ALSO
86              
87             This class forms part of L<Paws>, documenting arguments for method GetParametersByPath in L<Paws::SSM>
88              
89             =head1 BUGS and CONTRIBUTIONS
90              
91             The source code is located here: https://github.com/pplu/aws-sdk-perl
92              
93             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
94              
95             =cut
96