blib/lib/Paws/IAM/ListGroups.pm

filter: Statementstmt 100% 13 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 15 / 15 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/IAM/ListAccountAliasesResponse.pm ↑ Summary blib/lib/Paws/IAM/ListGroupsResponse.pm »
1  
2 package Paws::IAM::ListGroups;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has Marker => (is => 'ro', isa => 'Str');
5 1 has MaxItems => (is => 'ro', isa => 'Int');
6 1 has PathPrefix => (is => 'ro', isa => 'Str');
7  
8 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListGroups');
11 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::ListGroupsResponse');
12 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListGroupsResult');
13 1 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::IAM::ListGroups - Arguments for method ListGroups on L<Paws::IAM>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method ListGroups on the
24 L<AWS Identity and Access Management|Paws::IAM> 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 =head1 SYNOPSIS
30  
31 my $iam = Paws->service('IAM');
32 # To list the IAM groups for the current account
33 # The following command lists the IAM groups in the current account:
34 my $ListGroupsResponse = $iam->ListGroups();
35  
36 # Results:
37 my $Groups = $ListGroupsResponse->Groups;
38  
39 # Returns a L<Paws::IAM::ListGroupsResponse> object.
40  
41 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.
42 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/ListGroups>
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 Marker => Str
48  
49 Use this parameter only when paginating results and only after you
50 receive a response indicating that the results are truncated. Set it to
51 the value of the C<Marker> element in the response that you received to
52 indicate where the next call should start.
53  
54  
55  
56 =head2 MaxItems => Int
57  
58 Use this only when paginating results to indicate the maximum number of
59 items you want in the response. If additional items exist beyond the
60 maximum you specify, the C<IsTruncated> response element is C<true>.
61  
62 If you do not include this parameter, the number of items defaults to
63 100. Note that IAM might return fewer results, even when there are more
64 results available. In that case, the C<IsTruncated> response element
65 returns C<true>, and C<Marker> contains a value to include in the
66 subsequent call that tells the service where to continue from.
67  
68  
69  
70 =head2 PathPrefix => Str
71  
72 The path prefix for filtering the results. For example, the prefix
73 C</division_abc/subdivision_xyz/> gets all groups whose path starts
74 with C</division_abc/subdivision_xyz/>.
75  
76 This parameter is optional. If it is not included, it defaults to a
77 slash (/), listing all groups. This parameter allows (through its regex
78 pattern (http://wikipedia.org/wiki/regex)) a string of characters
79 consisting of either a forward slash (/) by itself or a string that
80 must begin and end with forward slashes. In addition, it can contain
81 any ASCII character from the ! (C<\u0021>) through the DEL character
82 (C<\u007F>), including most punctuation characters, digits, and upper
83 and lowercased letters.
84  
85  
86  
87  
88 =head1 SEE ALSO
89  
90 This class forms part of L<Paws>, documenting arguments for method ListGroups in L<Paws::IAM>
91  
92 =head1 BUGS and CONTRIBUTIONS
93  
94 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
95  
96 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
97  
98 =cut
99  
« blib/lib/Paws/IAM/ListAccountAliasesResponse.pm ↑ Summary blib/lib/Paws/IAM/ListGroupsResponse.pm »