File Coverage

blib/lib/Paws/CognitoIdp/ListUsers.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::CognitoIdp::ListUsers;
3 1     1   280 use Moose;
  1         3  
  1         5  
4             has AttributesToGet => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has Filter => (is => 'ro', isa => 'Str');
6             has Limit => (is => 'ro', isa => 'Int');
7             has PaginationToken => (is => 'ro', isa => 'Str');
8             has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   5209 use MooseX::ClassAttribute;
  1         2  
  1         7  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListUsers');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::ListUsersResponse');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::CognitoIdp::ListUsers - Arguments for method ListUsers on Paws::CognitoIdp
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ListUsers on the
26             Amazon Cognito Identity Provider service. Use the attributes of this class
27             as arguments to method ListUsers.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListUsers.
30              
31             As an example:
32              
33             $service_obj->ListUsers(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 AttributesToGet => ArrayRef[Str|Undef]
41              
42             An array of strings, where each string is the name of a user attribute
43             to be returned for each user in the search results. If the array is
44             empty, all attributes are returned.
45              
46              
47              
48             =head2 Filter => Str
49              
50             A filter string of the form "I<AttributeName> I<Filter-Type>
51             "I<AttributeValue>"". Quotation marks within the filter string must be
52             escaped using the backslash (\) character. For example, "C<family_name>
53             = \"Reddy\"".
54              
55             =over
56              
57             =item *
58              
59             I<AttributeName>: The name of the attribute to search for. You can only
60             search for one attribute at a time.
61              
62             =item *
63              
64             I<Filter-Type>: For an exact match, use =, for example, "C<given_name>
65             = \"Jon\"". For a prefix ("starts with") match, use ^=, for example,
66             "C<given_name> ^= \"Jon\"".
67              
68             =item *
69              
70             I<AttributeValue>: The attribute value that must be matched for each
71             user.
72              
73             =back
74              
75             If the filter string is empty, C<ListUsers> returns all users in the
76             user pool.
77              
78             You can only search for the following standard attributes:
79              
80             =over
81              
82             =item *
83              
84             C<username> (case-sensitive)
85              
86             =item *
87              
88             C<email>
89              
90             =item *
91              
92             C<phone_number>
93              
94             =item *
95              
96             C<name>
97              
98             =item *
99              
100             C<given_name>
101              
102             =item *
103              
104             C<family_name>
105              
106             =item *
107              
108             C<preferred_username>
109              
110             =item *
111              
112             C<cognito:user_status> (called B<Enabled> in the Console)
113             (case-sensitive)
114              
115             =item *
116              
117             C<status> (case-insensitive)
118              
119             =back
120              
121             Custom attributes are not searchable.
122              
123             For more information, see Searching for Users Using the ListUsers API
124             and Examples of Using the ListUsers API in the I<Amazon Cognito
125             Developer Guide>.
126              
127              
128              
129             =head2 Limit => Int
130              
131             Maximum number of users to be returned.
132              
133              
134              
135             =head2 PaginationToken => Str
136              
137             An identifier that was returned from the previous call to this
138             operation, which can be used to return the next set of items in the
139             list.
140              
141              
142              
143             =head2 B<REQUIRED> UserPoolId => Str
144              
145             The user pool ID for the user pool on which the search should be
146             performed.
147              
148              
149              
150              
151             =head1 SEE ALSO
152              
153             This class forms part of L<Paws>, documenting arguments for method ListUsers in L<Paws::CognitoIdp>
154              
155             =head1 BUGS and CONTRIBUTIONS
156              
157             The source code is located here: https://github.com/pplu/aws-sdk-perl
158              
159             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
160              
161             =cut
162