File Coverage

blib/lib/Paws/IAM/ListGroups.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::IAM::ListGroups;
3 1     1   425 use Moose;
  1     1   3  
  1         8  
  1         465  
  1         6  
  1         8  
4             has Marker => (is => 'ro', isa => 'Str');
5             has MaxItems => (is => 'ro', isa => 'Int');
6             has PathPrefix => (is => 'ro', isa => 'Str');
7              
8 1     1   6899 use MooseX::ClassAttribute;
  1     1   4  
  1         11  
  1         6257  
  1         2  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGroups');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::ListGroupsResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListGroupsResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::IAM::ListGroups - Arguments for method ListGroups on Paws::IAM
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method ListGroups on the
24             AWS Identity and Access Management service. Use the attributes of this class
25             as arguments to method ListGroups.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGroups.
28              
29             As an example:
30              
31             $service_obj->ListGroups(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Marker => Str
39              
40             Use this parameter only when paginating results and only after you
41             receive a response indicating that the results are truncated. Set it to
42             the value of the C<Marker> element in the response that you received to
43             indicate where the next call should start.
44              
45              
46              
47             =head2 MaxItems => Int
48              
49             (Optional) Use this only when paginating results to indicate the
50             maximum number of items you want in the response. If additional items
51             exist beyond the maximum you specify, the C<IsTruncated> response
52             element is C<true>.
53              
54             If you do not include this parameter, it defaults to 100. Note that IAM
55             might return fewer results, even when there are more results available.
56             In that case, the C<IsTruncated> response element returns C<true> and
57             C<Marker> contains a value to include in the subsequent call that tells
58             the service where to continue from.
59              
60              
61              
62             =head2 PathPrefix => Str
63              
64             The path prefix for filtering the results. For example, the prefix
65             C</division_abc/subdivision_xyz/> gets all groups whose path starts
66             with C</division_abc/subdivision_xyz/>.
67              
68             This parameter is optional. If it is not included, it defaults to a
69             slash (/), listing all groups. This paramater allows (per its regex
70             pattern) a string of characters consisting of either a forward slash
71             (/) by itself or a string that must begin and end with forward slashes,
72             containing any ASCII character from the ! (\u0021) thru the DEL
73             character (\u007F), including most punctuation characters, digits, and
74             upper and lowercased letters.
75              
76              
77              
78              
79             =head1 SEE ALSO
80              
81             This class forms part of L<Paws>, documenting arguments for method ListGroups in L<Paws::IAM>
82              
83             =head1 BUGS and CONTRIBUTIONS
84              
85             The source code is located here: https://github.com/pplu/aws-sdk-perl
86              
87             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
88              
89             =cut
90