line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
package Paws::CognitoIdp; |
2
|
1
|
|
|
1
|
|
1822
|
use Moose; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
8
|
|
3
|
|
|
|
|
|
|
sub service { 'cognito-idp' } |
4
|
|
|
|
|
|
|
sub version { '2016-04-18' } |
5
|
|
|
|
|
|
|
sub target_prefix { 'AWSCognitoIdentityProviderService' } |
6
|
|
|
|
|
|
|
sub json_version { "1.1" } |
7
|
|
|
|
|
|
|
has max_attempts => (is => 'ro', isa => 'Int', default => 5); |
8
|
|
|
|
|
|
|
has retry => (is => 'ro', isa => 'HashRef', default => sub { |
9
|
|
|
|
|
|
|
{ base => 'rand', type => 'exponential', growth_factor => 2 } |
10
|
|
|
|
|
|
|
}); |
11
|
|
|
|
|
|
|
has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ |
12
|
|
|
|
|
|
|
] }); |
13
|
|
|
|
|
|
|
|
14
|
|
|
|
|
|
|
with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller', 'Paws::Net::JsonResponse'; |
15
|
|
|
|
|
|
|
|
16
|
|
|
|
|
|
|
|
17
|
|
|
|
|
|
|
sub AddCustomAttributes { |
18
|
|
|
|
|
|
|
my $self = shift; |
19
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AddCustomAttributes', @_); |
20
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
21
|
|
|
|
|
|
|
} |
22
|
|
|
|
|
|
|
sub AdminAddUserToGroup { |
23
|
|
|
|
|
|
|
my $self = shift; |
24
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminAddUserToGroup', @_); |
25
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
26
|
|
|
|
|
|
|
} |
27
|
|
|
|
|
|
|
sub AdminConfirmSignUp { |
28
|
|
|
|
|
|
|
my $self = shift; |
29
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminConfirmSignUp', @_); |
30
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
31
|
|
|
|
|
|
|
} |
32
|
|
|
|
|
|
|
sub AdminCreateUser { |
33
|
|
|
|
|
|
|
my $self = shift; |
34
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminCreateUser', @_); |
35
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
36
|
|
|
|
|
|
|
} |
37
|
|
|
|
|
|
|
sub AdminDeleteUser { |
38
|
|
|
|
|
|
|
my $self = shift; |
39
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminDeleteUser', @_); |
40
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
41
|
|
|
|
|
|
|
} |
42
|
|
|
|
|
|
|
sub AdminDeleteUserAttributes { |
43
|
|
|
|
|
|
|
my $self = shift; |
44
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminDeleteUserAttributes', @_); |
45
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
46
|
|
|
|
|
|
|
} |
47
|
|
|
|
|
|
|
sub AdminDisableProviderForUser { |
48
|
|
|
|
|
|
|
my $self = shift; |
49
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminDisableProviderForUser', @_); |
50
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
51
|
|
|
|
|
|
|
} |
52
|
|
|
|
|
|
|
sub AdminDisableUser { |
53
|
|
|
|
|
|
|
my $self = shift; |
54
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminDisableUser', @_); |
55
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
56
|
|
|
|
|
|
|
} |
57
|
|
|
|
|
|
|
sub AdminEnableUser { |
58
|
|
|
|
|
|
|
my $self = shift; |
59
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminEnableUser', @_); |
60
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
61
|
|
|
|
|
|
|
} |
62
|
|
|
|
|
|
|
sub AdminForgetDevice { |
63
|
|
|
|
|
|
|
my $self = shift; |
64
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminForgetDevice', @_); |
65
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
66
|
|
|
|
|
|
|
} |
67
|
|
|
|
|
|
|
sub AdminGetDevice { |
68
|
|
|
|
|
|
|
my $self = shift; |
69
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminGetDevice', @_); |
70
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
71
|
|
|
|
|
|
|
} |
72
|
|
|
|
|
|
|
sub AdminGetUser { |
73
|
|
|
|
|
|
|
my $self = shift; |
74
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminGetUser', @_); |
75
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
76
|
|
|
|
|
|
|
} |
77
|
|
|
|
|
|
|
sub AdminInitiateAuth { |
78
|
|
|
|
|
|
|
my $self = shift; |
79
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminInitiateAuth', @_); |
80
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
81
|
|
|
|
|
|
|
} |
82
|
|
|
|
|
|
|
sub AdminLinkProviderForUser { |
83
|
|
|
|
|
|
|
my $self = shift; |
84
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminLinkProviderForUser', @_); |
85
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
86
|
|
|
|
|
|
|
} |
87
|
|
|
|
|
|
|
sub AdminListDevices { |
88
|
|
|
|
|
|
|
my $self = shift; |
89
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminListDevices', @_); |
90
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
91
|
|
|
|
|
|
|
} |
92
|
|
|
|
|
|
|
sub AdminListGroupsForUser { |
93
|
|
|
|
|
|
|
my $self = shift; |
94
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminListGroupsForUser', @_); |
95
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
96
|
|
|
|
|
|
|
} |
97
|
|
|
|
|
|
|
sub AdminRemoveUserFromGroup { |
98
|
|
|
|
|
|
|
my $self = shift; |
99
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminRemoveUserFromGroup', @_); |
100
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
101
|
|
|
|
|
|
|
} |
102
|
|
|
|
|
|
|
sub AdminResetUserPassword { |
103
|
|
|
|
|
|
|
my $self = shift; |
104
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminResetUserPassword', @_); |
105
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
106
|
|
|
|
|
|
|
} |
107
|
|
|
|
|
|
|
sub AdminRespondToAuthChallenge { |
108
|
|
|
|
|
|
|
my $self = shift; |
109
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminRespondToAuthChallenge', @_); |
110
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
111
|
|
|
|
|
|
|
} |
112
|
|
|
|
|
|
|
sub AdminSetUserSettings { |
113
|
|
|
|
|
|
|
my $self = shift; |
114
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminSetUserSettings', @_); |
115
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
116
|
|
|
|
|
|
|
} |
117
|
|
|
|
|
|
|
sub AdminUpdateDeviceStatus { |
118
|
|
|
|
|
|
|
my $self = shift; |
119
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminUpdateDeviceStatus', @_); |
120
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
121
|
|
|
|
|
|
|
} |
122
|
|
|
|
|
|
|
sub AdminUpdateUserAttributes { |
123
|
|
|
|
|
|
|
my $self = shift; |
124
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminUpdateUserAttributes', @_); |
125
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
126
|
|
|
|
|
|
|
} |
127
|
|
|
|
|
|
|
sub AdminUserGlobalSignOut { |
128
|
|
|
|
|
|
|
my $self = shift; |
129
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::AdminUserGlobalSignOut', @_); |
130
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
131
|
|
|
|
|
|
|
} |
132
|
|
|
|
|
|
|
sub ChangePassword { |
133
|
|
|
|
|
|
|
my $self = shift; |
134
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ChangePassword', @_); |
135
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
136
|
|
|
|
|
|
|
} |
137
|
|
|
|
|
|
|
sub ConfirmDevice { |
138
|
|
|
|
|
|
|
my $self = shift; |
139
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ConfirmDevice', @_); |
140
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
141
|
|
|
|
|
|
|
} |
142
|
|
|
|
|
|
|
sub ConfirmForgotPassword { |
143
|
|
|
|
|
|
|
my $self = shift; |
144
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ConfirmForgotPassword', @_); |
145
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
146
|
|
|
|
|
|
|
} |
147
|
|
|
|
|
|
|
sub ConfirmSignUp { |
148
|
|
|
|
|
|
|
my $self = shift; |
149
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ConfirmSignUp', @_); |
150
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
151
|
|
|
|
|
|
|
} |
152
|
|
|
|
|
|
|
sub CreateGroup { |
153
|
|
|
|
|
|
|
my $self = shift; |
154
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateGroup', @_); |
155
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
156
|
|
|
|
|
|
|
} |
157
|
|
|
|
|
|
|
sub CreateIdentityProvider { |
158
|
|
|
|
|
|
|
my $self = shift; |
159
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateIdentityProvider', @_); |
160
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
161
|
|
|
|
|
|
|
} |
162
|
|
|
|
|
|
|
sub CreateResourceServer { |
163
|
|
|
|
|
|
|
my $self = shift; |
164
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateResourceServer', @_); |
165
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
166
|
|
|
|
|
|
|
} |
167
|
|
|
|
|
|
|
sub CreateUserImportJob { |
168
|
|
|
|
|
|
|
my $self = shift; |
169
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateUserImportJob', @_); |
170
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
171
|
|
|
|
|
|
|
} |
172
|
|
|
|
|
|
|
sub CreateUserPool { |
173
|
|
|
|
|
|
|
my $self = shift; |
174
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateUserPool', @_); |
175
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
176
|
|
|
|
|
|
|
} |
177
|
|
|
|
|
|
|
sub CreateUserPoolClient { |
178
|
|
|
|
|
|
|
my $self = shift; |
179
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateUserPoolClient', @_); |
180
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
181
|
|
|
|
|
|
|
} |
182
|
|
|
|
|
|
|
sub CreateUserPoolDomain { |
183
|
|
|
|
|
|
|
my $self = shift; |
184
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::CreateUserPoolDomain', @_); |
185
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
186
|
|
|
|
|
|
|
} |
187
|
|
|
|
|
|
|
sub DeleteGroup { |
188
|
|
|
|
|
|
|
my $self = shift; |
189
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteGroup', @_); |
190
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
191
|
|
|
|
|
|
|
} |
192
|
|
|
|
|
|
|
sub DeleteIdentityProvider { |
193
|
|
|
|
|
|
|
my $self = shift; |
194
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteIdentityProvider', @_); |
195
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
196
|
|
|
|
|
|
|
} |
197
|
|
|
|
|
|
|
sub DeleteResourceServer { |
198
|
|
|
|
|
|
|
my $self = shift; |
199
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteResourceServer', @_); |
200
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
201
|
|
|
|
|
|
|
} |
202
|
|
|
|
|
|
|
sub DeleteUser { |
203
|
|
|
|
|
|
|
my $self = shift; |
204
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteUser', @_); |
205
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
206
|
|
|
|
|
|
|
} |
207
|
|
|
|
|
|
|
sub DeleteUserAttributes { |
208
|
|
|
|
|
|
|
my $self = shift; |
209
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteUserAttributes', @_); |
210
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
211
|
|
|
|
|
|
|
} |
212
|
|
|
|
|
|
|
sub DeleteUserPool { |
213
|
|
|
|
|
|
|
my $self = shift; |
214
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteUserPool', @_); |
215
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
216
|
|
|
|
|
|
|
} |
217
|
|
|
|
|
|
|
sub DeleteUserPoolClient { |
218
|
|
|
|
|
|
|
my $self = shift; |
219
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteUserPoolClient', @_); |
220
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
221
|
|
|
|
|
|
|
} |
222
|
|
|
|
|
|
|
sub DeleteUserPoolDomain { |
223
|
|
|
|
|
|
|
my $self = shift; |
224
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DeleteUserPoolDomain', @_); |
225
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
226
|
|
|
|
|
|
|
} |
227
|
|
|
|
|
|
|
sub DescribeIdentityProvider { |
228
|
|
|
|
|
|
|
my $self = shift; |
229
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeIdentityProvider', @_); |
230
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
231
|
|
|
|
|
|
|
} |
232
|
|
|
|
|
|
|
sub DescribeResourceServer { |
233
|
|
|
|
|
|
|
my $self = shift; |
234
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeResourceServer', @_); |
235
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
236
|
|
|
|
|
|
|
} |
237
|
|
|
|
|
|
|
sub DescribeUserImportJob { |
238
|
|
|
|
|
|
|
my $self = shift; |
239
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeUserImportJob', @_); |
240
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
241
|
|
|
|
|
|
|
} |
242
|
|
|
|
|
|
|
sub DescribeUserPool { |
243
|
|
|
|
|
|
|
my $self = shift; |
244
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeUserPool', @_); |
245
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
246
|
|
|
|
|
|
|
} |
247
|
|
|
|
|
|
|
sub DescribeUserPoolClient { |
248
|
|
|
|
|
|
|
my $self = shift; |
249
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeUserPoolClient', @_); |
250
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
251
|
|
|
|
|
|
|
} |
252
|
|
|
|
|
|
|
sub DescribeUserPoolDomain { |
253
|
|
|
|
|
|
|
my $self = shift; |
254
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::DescribeUserPoolDomain', @_); |
255
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
256
|
|
|
|
|
|
|
} |
257
|
|
|
|
|
|
|
sub ForgetDevice { |
258
|
|
|
|
|
|
|
my $self = shift; |
259
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ForgetDevice', @_); |
260
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
261
|
|
|
|
|
|
|
} |
262
|
|
|
|
|
|
|
sub ForgotPassword { |
263
|
|
|
|
|
|
|
my $self = shift; |
264
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ForgotPassword', @_); |
265
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
266
|
|
|
|
|
|
|
} |
267
|
|
|
|
|
|
|
sub GetCSVHeader { |
268
|
|
|
|
|
|
|
my $self = shift; |
269
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetCSVHeader', @_); |
270
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
271
|
|
|
|
|
|
|
} |
272
|
|
|
|
|
|
|
sub GetDevice { |
273
|
|
|
|
|
|
|
my $self = shift; |
274
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetDevice', @_); |
275
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
276
|
|
|
|
|
|
|
} |
277
|
|
|
|
|
|
|
sub GetGroup { |
278
|
|
|
|
|
|
|
my $self = shift; |
279
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetGroup', @_); |
280
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
281
|
|
|
|
|
|
|
} |
282
|
|
|
|
|
|
|
sub GetIdentityProviderByIdentifier { |
283
|
|
|
|
|
|
|
my $self = shift; |
284
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetIdentityProviderByIdentifier', @_); |
285
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
286
|
|
|
|
|
|
|
} |
287
|
|
|
|
|
|
|
sub GetUICustomization { |
288
|
|
|
|
|
|
|
my $self = shift; |
289
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetUICustomization', @_); |
290
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
291
|
|
|
|
|
|
|
} |
292
|
|
|
|
|
|
|
sub GetUser { |
293
|
|
|
|
|
|
|
my $self = shift; |
294
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetUser', @_); |
295
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
296
|
|
|
|
|
|
|
} |
297
|
|
|
|
|
|
|
sub GetUserAttributeVerificationCode { |
298
|
|
|
|
|
|
|
my $self = shift; |
299
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GetUserAttributeVerificationCode', @_); |
300
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
301
|
|
|
|
|
|
|
} |
302
|
|
|
|
|
|
|
sub GlobalSignOut { |
303
|
|
|
|
|
|
|
my $self = shift; |
304
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::GlobalSignOut', @_); |
305
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
306
|
|
|
|
|
|
|
} |
307
|
|
|
|
|
|
|
sub InitiateAuth { |
308
|
|
|
|
|
|
|
my $self = shift; |
309
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::InitiateAuth', @_); |
310
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
311
|
|
|
|
|
|
|
} |
312
|
|
|
|
|
|
|
sub ListDevices { |
313
|
|
|
|
|
|
|
my $self = shift; |
314
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListDevices', @_); |
315
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
316
|
|
|
|
|
|
|
} |
317
|
|
|
|
|
|
|
sub ListGroups { |
318
|
|
|
|
|
|
|
my $self = shift; |
319
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListGroups', @_); |
320
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
321
|
|
|
|
|
|
|
} |
322
|
|
|
|
|
|
|
sub ListIdentityProviders { |
323
|
|
|
|
|
|
|
my $self = shift; |
324
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListIdentityProviders', @_); |
325
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
326
|
|
|
|
|
|
|
} |
327
|
|
|
|
|
|
|
sub ListResourceServers { |
328
|
|
|
|
|
|
|
my $self = shift; |
329
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListResourceServers', @_); |
330
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
331
|
|
|
|
|
|
|
} |
332
|
|
|
|
|
|
|
sub ListUserImportJobs { |
333
|
|
|
|
|
|
|
my $self = shift; |
334
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListUserImportJobs', @_); |
335
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
336
|
|
|
|
|
|
|
} |
337
|
|
|
|
|
|
|
sub ListUserPoolClients { |
338
|
|
|
|
|
|
|
my $self = shift; |
339
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListUserPoolClients', @_); |
340
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
341
|
|
|
|
|
|
|
} |
342
|
|
|
|
|
|
|
sub ListUserPools { |
343
|
|
|
|
|
|
|
my $self = shift; |
344
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListUserPools', @_); |
345
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
346
|
|
|
|
|
|
|
} |
347
|
|
|
|
|
|
|
sub ListUsers { |
348
|
|
|
|
|
|
|
my $self = shift; |
349
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListUsers', @_); |
350
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
351
|
|
|
|
|
|
|
} |
352
|
|
|
|
|
|
|
sub ListUsersInGroup { |
353
|
|
|
|
|
|
|
my $self = shift; |
354
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ListUsersInGroup', @_); |
355
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
356
|
|
|
|
|
|
|
} |
357
|
|
|
|
|
|
|
sub ResendConfirmationCode { |
358
|
|
|
|
|
|
|
my $self = shift; |
359
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::ResendConfirmationCode', @_); |
360
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
361
|
|
|
|
|
|
|
} |
362
|
|
|
|
|
|
|
sub RespondToAuthChallenge { |
363
|
|
|
|
|
|
|
my $self = shift; |
364
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::RespondToAuthChallenge', @_); |
365
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
366
|
|
|
|
|
|
|
} |
367
|
|
|
|
|
|
|
sub SetUICustomization { |
368
|
|
|
|
|
|
|
my $self = shift; |
369
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::SetUICustomization', @_); |
370
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
371
|
|
|
|
|
|
|
} |
372
|
|
|
|
|
|
|
sub SetUserSettings { |
373
|
|
|
|
|
|
|
my $self = shift; |
374
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::SetUserSettings', @_); |
375
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
376
|
|
|
|
|
|
|
} |
377
|
|
|
|
|
|
|
sub SignUp { |
378
|
|
|
|
|
|
|
my $self = shift; |
379
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::SignUp', @_); |
380
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
381
|
|
|
|
|
|
|
} |
382
|
|
|
|
|
|
|
sub StartUserImportJob { |
383
|
|
|
|
|
|
|
my $self = shift; |
384
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::StartUserImportJob', @_); |
385
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
386
|
|
|
|
|
|
|
} |
387
|
|
|
|
|
|
|
sub StopUserImportJob { |
388
|
|
|
|
|
|
|
my $self = shift; |
389
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::StopUserImportJob', @_); |
390
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
391
|
|
|
|
|
|
|
} |
392
|
|
|
|
|
|
|
sub UpdateDeviceStatus { |
393
|
|
|
|
|
|
|
my $self = shift; |
394
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateDeviceStatus', @_); |
395
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
396
|
|
|
|
|
|
|
} |
397
|
|
|
|
|
|
|
sub UpdateGroup { |
398
|
|
|
|
|
|
|
my $self = shift; |
399
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateGroup', @_); |
400
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
401
|
|
|
|
|
|
|
} |
402
|
|
|
|
|
|
|
sub UpdateIdentityProvider { |
403
|
|
|
|
|
|
|
my $self = shift; |
404
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateIdentityProvider', @_); |
405
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
406
|
|
|
|
|
|
|
} |
407
|
|
|
|
|
|
|
sub UpdateResourceServer { |
408
|
|
|
|
|
|
|
my $self = shift; |
409
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateResourceServer', @_); |
410
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
411
|
|
|
|
|
|
|
} |
412
|
|
|
|
|
|
|
sub UpdateUserAttributes { |
413
|
|
|
|
|
|
|
my $self = shift; |
414
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateUserAttributes', @_); |
415
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
416
|
|
|
|
|
|
|
} |
417
|
|
|
|
|
|
|
sub UpdateUserPool { |
418
|
|
|
|
|
|
|
my $self = shift; |
419
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateUserPool', @_); |
420
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
421
|
|
|
|
|
|
|
} |
422
|
|
|
|
|
|
|
sub UpdateUserPoolClient { |
423
|
|
|
|
|
|
|
my $self = shift; |
424
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::UpdateUserPoolClient', @_); |
425
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
426
|
|
|
|
|
|
|
} |
427
|
|
|
|
|
|
|
sub VerifyUserAttribute { |
428
|
|
|
|
|
|
|
my $self = shift; |
429
|
|
|
|
|
|
|
my $call_object = $self->new_with_coercions('Paws::CognitoIdp::VerifyUserAttribute', @_); |
430
|
|
|
|
|
|
|
return $self->caller->do_call($self, $call_object); |
431
|
|
|
|
|
|
|
} |
432
|
|
|
|
|
|
|
|
433
|
|
|
|
|
|
|
|
434
|
|
|
|
|
|
|
|
435
|
|
|
|
|
|
|
sub operations { qw/AddCustomAttributes AdminAddUserToGroup AdminConfirmSignUp AdminCreateUser AdminDeleteUser AdminDeleteUserAttributes AdminDisableProviderForUser AdminDisableUser AdminEnableUser AdminForgetDevice AdminGetDevice AdminGetUser AdminInitiateAuth AdminLinkProviderForUser AdminListDevices AdminListGroupsForUser AdminRemoveUserFromGroup AdminResetUserPassword AdminRespondToAuthChallenge AdminSetUserSettings AdminUpdateDeviceStatus AdminUpdateUserAttributes AdminUserGlobalSignOut ChangePassword ConfirmDevice ConfirmForgotPassword ConfirmSignUp CreateGroup CreateIdentityProvider CreateResourceServer CreateUserImportJob CreateUserPool CreateUserPoolClient CreateUserPoolDomain DeleteGroup DeleteIdentityProvider DeleteResourceServer DeleteUser DeleteUserAttributes DeleteUserPool DeleteUserPoolClient DeleteUserPoolDomain DescribeIdentityProvider DescribeResourceServer DescribeUserImportJob DescribeUserPool DescribeUserPoolClient DescribeUserPoolDomain ForgetDevice ForgotPassword GetCSVHeader GetDevice GetGroup GetIdentityProviderByIdentifier GetUICustomization GetUser GetUserAttributeVerificationCode GlobalSignOut InitiateAuth ListDevices ListGroups ListIdentityProviders ListResourceServers ListUserImportJobs ListUserPoolClients ListUserPools ListUsers ListUsersInGroup ResendConfirmationCode RespondToAuthChallenge SetUICustomization SetUserSettings SignUp StartUserImportJob StopUserImportJob UpdateDeviceStatus UpdateGroup UpdateIdentityProvider UpdateResourceServer UpdateUserAttributes UpdateUserPool UpdateUserPoolClient VerifyUserAttribute / } |
436
|
|
|
|
|
|
|
|
437
|
|
|
|
|
|
|
1; |
438
|
|
|
|
|
|
|
|
439
|
|
|
|
|
|
|
### main pod documentation begin ### |
440
|
|
|
|
|
|
|
|
441
|
|
|
|
|
|
|
=head1 NAME |
442
|
|
|
|
|
|
|
|
443
|
|
|
|
|
|
|
Paws::CognitoIdp - Perl Interface to AWS Amazon Cognito Identity Provider |
444
|
|
|
|
|
|
|
|
445
|
|
|
|
|
|
|
=head1 SYNOPSIS |
446
|
|
|
|
|
|
|
|
447
|
|
|
|
|
|
|
use Paws; |
448
|
|
|
|
|
|
|
|
449
|
|
|
|
|
|
|
my $obj = Paws->service('CognitoIdp'); |
450
|
|
|
|
|
|
|
my $res = $obj->Method( |
451
|
|
|
|
|
|
|
Arg1 => $val1, |
452
|
|
|
|
|
|
|
Arg2 => [ 'V1', 'V2' ], |
453
|
|
|
|
|
|
|
# if Arg3 is an object, the HashRef will be used as arguments to the constructor |
454
|
|
|
|
|
|
|
# of the arguments type |
455
|
|
|
|
|
|
|
Arg3 => { Att1 => 'Val1' }, |
456
|
|
|
|
|
|
|
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to |
457
|
|
|
|
|
|
|
# the constructor of the arguments type |
458
|
|
|
|
|
|
|
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], |
459
|
|
|
|
|
|
|
); |
460
|
|
|
|
|
|
|
|
461
|
|
|
|
|
|
|
=head1 DESCRIPTION |
462
|
|
|
|
|
|
|
|
463
|
|
|
|
|
|
|
Using the Amazon Cognito User Pools API, you can create a user pool to |
464
|
|
|
|
|
|
|
manage directories and users. You can authenticate a user to obtain |
465
|
|
|
|
|
|
|
tokens related to user identity and access policies. |
466
|
|
|
|
|
|
|
|
467
|
|
|
|
|
|
|
This API reference provides information about user pools in Amazon |
468
|
|
|
|
|
|
|
Cognito User Pools. |
469
|
|
|
|
|
|
|
|
470
|
|
|
|
|
|
|
For more information, see the Amazon Cognito Documentation. |
471
|
|
|
|
|
|
|
|
472
|
|
|
|
|
|
|
=head1 METHODS |
473
|
|
|
|
|
|
|
|
474
|
|
|
|
|
|
|
=head2 AddCustomAttributes(CustomAttributes => ArrayRef[L<Paws::CognitoIdp::SchemaAttributeType>], UserPoolId => Str) |
475
|
|
|
|
|
|
|
|
476
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AddCustomAttributes> |
477
|
|
|
|
|
|
|
|
478
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AddCustomAttributesResponse> instance |
479
|
|
|
|
|
|
|
|
480
|
|
|
|
|
|
|
Adds additional user attributes to the user pool schema. |
481
|
|
|
|
|
|
|
|
482
|
|
|
|
|
|
|
|
483
|
|
|
|
|
|
|
=head2 AdminAddUserToGroup(GroupName => Str, Username => Str, UserPoolId => Str) |
484
|
|
|
|
|
|
|
|
485
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminAddUserToGroup> |
486
|
|
|
|
|
|
|
|
487
|
|
|
|
|
|
|
Returns: nothing |
488
|
|
|
|
|
|
|
|
489
|
|
|
|
|
|
|
Adds the specified user to the specified group. |
490
|
|
|
|
|
|
|
|
491
|
|
|
|
|
|
|
Requires developer credentials. |
492
|
|
|
|
|
|
|
|
493
|
|
|
|
|
|
|
|
494
|
|
|
|
|
|
|
=head2 AdminConfirmSignUp(Username => Str, UserPoolId => Str) |
495
|
|
|
|
|
|
|
|
496
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminConfirmSignUp> |
497
|
|
|
|
|
|
|
|
498
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminConfirmSignUpResponse> instance |
499
|
|
|
|
|
|
|
|
500
|
|
|
|
|
|
|
Confirms user registration as an admin without using a confirmation |
501
|
|
|
|
|
|
|
code. Works on any user. |
502
|
|
|
|
|
|
|
|
503
|
|
|
|
|
|
|
Requires developer credentials. |
504
|
|
|
|
|
|
|
|
505
|
|
|
|
|
|
|
|
506
|
|
|
|
|
|
|
=head2 AdminCreateUser(Username => Str, UserPoolId => Str, [DesiredDeliveryMediums => ArrayRef[Str|Undef], ForceAliasCreation => Bool, MessageAction => Str, TemporaryPassword => Str, UserAttributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>], ValidationData => ArrayRef[L<Paws::CognitoIdp::AttributeType>]]) |
507
|
|
|
|
|
|
|
|
508
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminCreateUser> |
509
|
|
|
|
|
|
|
|
510
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminCreateUserResponse> instance |
511
|
|
|
|
|
|
|
|
512
|
|
|
|
|
|
|
Creates a new user in the specified user pool and sends a welcome |
513
|
|
|
|
|
|
|
message via email or phone (SMS). This message is based on a template |
514
|
|
|
|
|
|
|
that you configured in your call to CreateUserPool or UpdateUserPool. |
515
|
|
|
|
|
|
|
This template includes your custom sign-up instructions and |
516
|
|
|
|
|
|
|
placeholders for user name and temporary password. |
517
|
|
|
|
|
|
|
|
518
|
|
|
|
|
|
|
Requires developer credentials. |
519
|
|
|
|
|
|
|
|
520
|
|
|
|
|
|
|
|
521
|
|
|
|
|
|
|
=head2 AdminDeleteUser(Username => Str, UserPoolId => Str) |
522
|
|
|
|
|
|
|
|
523
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminDeleteUser> |
524
|
|
|
|
|
|
|
|
525
|
|
|
|
|
|
|
Returns: nothing |
526
|
|
|
|
|
|
|
|
527
|
|
|
|
|
|
|
Deletes a user as an administrator. Works on any user. |
528
|
|
|
|
|
|
|
|
529
|
|
|
|
|
|
|
Requires developer credentials. |
530
|
|
|
|
|
|
|
|
531
|
|
|
|
|
|
|
|
532
|
|
|
|
|
|
|
=head2 AdminDeleteUserAttributes(UserAttributeNames => ArrayRef[Str|Undef], Username => Str, UserPoolId => Str) |
533
|
|
|
|
|
|
|
|
534
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminDeleteUserAttributes> |
535
|
|
|
|
|
|
|
|
536
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminDeleteUserAttributesResponse> instance |
537
|
|
|
|
|
|
|
|
538
|
|
|
|
|
|
|
Deletes the user attributes in a user pool as an administrator. Works |
539
|
|
|
|
|
|
|
on any user. |
540
|
|
|
|
|
|
|
|
541
|
|
|
|
|
|
|
Requires developer credentials. |
542
|
|
|
|
|
|
|
|
543
|
|
|
|
|
|
|
|
544
|
|
|
|
|
|
|
=head2 AdminDisableProviderForUser(User => L<Paws::CognitoIdp::ProviderUserIdentifierType>, UserPoolId => Str) |
545
|
|
|
|
|
|
|
|
546
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminDisableProviderForUser> |
547
|
|
|
|
|
|
|
|
548
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminDisableProviderForUserResponse> instance |
549
|
|
|
|
|
|
|
|
550
|
|
|
|
|
|
|
Disables the user from signing in with the specified external (SAML or |
551
|
|
|
|
|
|
|
social) identity provider. If the user to disable is a Cognito User |
552
|
|
|
|
|
|
|
Pools native username + password user, they are not permitted to use |
553
|
|
|
|
|
|
|
their password to sign-in. If the user to disable is a linked external |
554
|
|
|
|
|
|
|
IdP user, any link between that user and an existing user is removed. |
555
|
|
|
|
|
|
|
The next time the external user (no longer attached to the previously |
556
|
|
|
|
|
|
|
linked C<DestinationUser>) signs in, they must create a new user |
557
|
|
|
|
|
|
|
account. See AdminLinkProviderForUser. |
558
|
|
|
|
|
|
|
|
559
|
|
|
|
|
|
|
This action is enabled only for admin access and requires developer |
560
|
|
|
|
|
|
|
credentials. |
561
|
|
|
|
|
|
|
|
562
|
|
|
|
|
|
|
The C<ProviderName> must match the value specified when creating an IdP |
563
|
|
|
|
|
|
|
for the pool. |
564
|
|
|
|
|
|
|
|
565
|
|
|
|
|
|
|
To disable a native username + password user, the C<ProviderName> value |
566
|
|
|
|
|
|
|
must be C<Cognito> and the C<ProviderAttributeName> must be |
567
|
|
|
|
|
|
|
C<Cognito_Subject>, with the C<ProviderAttributeValue> being the name |
568
|
|
|
|
|
|
|
that is used in the user pool for the user. |
569
|
|
|
|
|
|
|
|
570
|
|
|
|
|
|
|
The C<ProviderAttributeName> must always be C<Cognito_Subject> for |
571
|
|
|
|
|
|
|
social identity providers. The C<ProviderAttributeValue> must always be |
572
|
|
|
|
|
|
|
the exact subject that was used when the user was originally linked as |
573
|
|
|
|
|
|
|
a source user. |
574
|
|
|
|
|
|
|
|
575
|
|
|
|
|
|
|
For de-linking a SAML identity, there are two scenarios. If the linked |
576
|
|
|
|
|
|
|
identity has not yet been used to sign-in, the C<ProviderAttributeName> |
577
|
|
|
|
|
|
|
and C<ProviderAttributeValue> must be the same values that were used |
578
|
|
|
|
|
|
|
for the C<SourceUser> when the identities were originally linked in the |
579
|
|
|
|
|
|
|
AdminLinkProviderForUser call. (If the linking was done with |
580
|
|
|
|
|
|
|
C<ProviderAttributeName> set to C<Cognito_Subject>, the same applies |
581
|
|
|
|
|
|
|
here). However, if the user has already signed in, the |
582
|
|
|
|
|
|
|
C<ProviderAttributeName> must be C<Cognito_Subject> and |
583
|
|
|
|
|
|
|
C<ProviderAttributeValue> must be the subject of the SAML assertion. |
584
|
|
|
|
|
|
|
|
585
|
|
|
|
|
|
|
|
586
|
|
|
|
|
|
|
=head2 AdminDisableUser(Username => Str, UserPoolId => Str) |
587
|
|
|
|
|
|
|
|
588
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminDisableUser> |
589
|
|
|
|
|
|
|
|
590
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminDisableUserResponse> instance |
591
|
|
|
|
|
|
|
|
592
|
|
|
|
|
|
|
Disables the specified user as an administrator. Works on any user. |
593
|
|
|
|
|
|
|
|
594
|
|
|
|
|
|
|
Requires developer credentials. |
595
|
|
|
|
|
|
|
|
596
|
|
|
|
|
|
|
|
597
|
|
|
|
|
|
|
=head2 AdminEnableUser(Username => Str, UserPoolId => Str) |
598
|
|
|
|
|
|
|
|
599
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminEnableUser> |
600
|
|
|
|
|
|
|
|
601
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminEnableUserResponse> instance |
602
|
|
|
|
|
|
|
|
603
|
|
|
|
|
|
|
Enables the specified user as an administrator. Works on any user. |
604
|
|
|
|
|
|
|
|
605
|
|
|
|
|
|
|
Requires developer credentials. |
606
|
|
|
|
|
|
|
|
607
|
|
|
|
|
|
|
|
608
|
|
|
|
|
|
|
=head2 AdminForgetDevice(DeviceKey => Str, Username => Str, UserPoolId => Str) |
609
|
|
|
|
|
|
|
|
610
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminForgetDevice> |
611
|
|
|
|
|
|
|
|
612
|
|
|
|
|
|
|
Returns: nothing |
613
|
|
|
|
|
|
|
|
614
|
|
|
|
|
|
|
Forgets the device, as an administrator. |
615
|
|
|
|
|
|
|
|
616
|
|
|
|
|
|
|
Requires developer credentials. |
617
|
|
|
|
|
|
|
|
618
|
|
|
|
|
|
|
|
619
|
|
|
|
|
|
|
=head2 AdminGetDevice(DeviceKey => Str, Username => Str, UserPoolId => Str) |
620
|
|
|
|
|
|
|
|
621
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminGetDevice> |
622
|
|
|
|
|
|
|
|
623
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminGetDeviceResponse> instance |
624
|
|
|
|
|
|
|
|
625
|
|
|
|
|
|
|
Gets the device, as an administrator. |
626
|
|
|
|
|
|
|
|
627
|
|
|
|
|
|
|
Requires developer credentials. |
628
|
|
|
|
|
|
|
|
629
|
|
|
|
|
|
|
|
630
|
|
|
|
|
|
|
=head2 AdminGetUser(Username => Str, UserPoolId => Str) |
631
|
|
|
|
|
|
|
|
632
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminGetUser> |
633
|
|
|
|
|
|
|
|
634
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminGetUserResponse> instance |
635
|
|
|
|
|
|
|
|
636
|
|
|
|
|
|
|
Gets the specified user by user name in a user pool as an |
637
|
|
|
|
|
|
|
administrator. Works on any user. |
638
|
|
|
|
|
|
|
|
639
|
|
|
|
|
|
|
Requires developer credentials. |
640
|
|
|
|
|
|
|
|
641
|
|
|
|
|
|
|
|
642
|
|
|
|
|
|
|
=head2 AdminInitiateAuth(AuthFlow => Str, ClientId => Str, UserPoolId => Str, [AuthParameters => L<Paws::CognitoIdp::AuthParametersType>, ClientMetadata => L<Paws::CognitoIdp::ClientMetadataType>]) |
643
|
|
|
|
|
|
|
|
644
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminInitiateAuth> |
645
|
|
|
|
|
|
|
|
646
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminInitiateAuthResponse> instance |
647
|
|
|
|
|
|
|
|
648
|
|
|
|
|
|
|
Initiates the authentication flow, as an administrator. |
649
|
|
|
|
|
|
|
|
650
|
|
|
|
|
|
|
Requires developer credentials. |
651
|
|
|
|
|
|
|
|
652
|
|
|
|
|
|
|
|
653
|
|
|
|
|
|
|
=head2 AdminLinkProviderForUser(DestinationUser => L<Paws::CognitoIdp::ProviderUserIdentifierType>, SourceUser => L<Paws::CognitoIdp::ProviderUserIdentifierType>, UserPoolId => Str) |
654
|
|
|
|
|
|
|
|
655
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminLinkProviderForUser> |
656
|
|
|
|
|
|
|
|
657
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminLinkProviderForUserResponse> instance |
658
|
|
|
|
|
|
|
|
659
|
|
|
|
|
|
|
Links an existing user account in a user pool (C<DestinationUser>) to |
660
|
|
|
|
|
|
|
an identity from an external identity provider (C<SourceUser>) based on |
661
|
|
|
|
|
|
|
a specified attribute name and value from the external identity |
662
|
|
|
|
|
|
|
provider. This allows you to create a link from the existing user |
663
|
|
|
|
|
|
|
account to an external federated user identity that has not yet been |
664
|
|
|
|
|
|
|
used to sign in, so that the federated user identity can be used to |
665
|
|
|
|
|
|
|
sign in as the existing user account. |
666
|
|
|
|
|
|
|
|
667
|
|
|
|
|
|
|
For example, if there is an existing user with a username and password, |
668
|
|
|
|
|
|
|
this API links that user to a federated user identity, so that when the |
669
|
|
|
|
|
|
|
federated user identity is used, the user signs in as the existing user |
670
|
|
|
|
|
|
|
account. |
671
|
|
|
|
|
|
|
|
672
|
|
|
|
|
|
|
Because this API allows a user with an external federated identity to |
673
|
|
|
|
|
|
|
sign in as an existing user in the user pool, it is critical that it |
674
|
|
|
|
|
|
|
only be used with external identity providers and provider attributes |
675
|
|
|
|
|
|
|
that have been trusted by the application owner. |
676
|
|
|
|
|
|
|
|
677
|
|
|
|
|
|
|
See also AdminDisableProviderForUser. |
678
|
|
|
|
|
|
|
|
679
|
|
|
|
|
|
|
This action is enabled only for admin access and requires developer |
680
|
|
|
|
|
|
|
credentials. |
681
|
|
|
|
|
|
|
|
682
|
|
|
|
|
|
|
|
683
|
|
|
|
|
|
|
=head2 AdminListDevices(Username => Str, UserPoolId => Str, [Limit => Int, PaginationToken => Str]) |
684
|
|
|
|
|
|
|
|
685
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminListDevices> |
686
|
|
|
|
|
|
|
|
687
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminListDevicesResponse> instance |
688
|
|
|
|
|
|
|
|
689
|
|
|
|
|
|
|
Lists devices, as an administrator. |
690
|
|
|
|
|
|
|
|
691
|
|
|
|
|
|
|
Requires developer credentials. |
692
|
|
|
|
|
|
|
|
693
|
|
|
|
|
|
|
|
694
|
|
|
|
|
|
|
=head2 AdminListGroupsForUser(Username => Str, UserPoolId => Str, [Limit => Int, NextToken => Str]) |
695
|
|
|
|
|
|
|
|
696
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminListGroupsForUser> |
697
|
|
|
|
|
|
|
|
698
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminListGroupsForUserResponse> instance |
699
|
|
|
|
|
|
|
|
700
|
|
|
|
|
|
|
Lists the groups that the user belongs to. |
701
|
|
|
|
|
|
|
|
702
|
|
|
|
|
|
|
Requires developer credentials. |
703
|
|
|
|
|
|
|
|
704
|
|
|
|
|
|
|
|
705
|
|
|
|
|
|
|
=head2 AdminRemoveUserFromGroup(GroupName => Str, Username => Str, UserPoolId => Str) |
706
|
|
|
|
|
|
|
|
707
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminRemoveUserFromGroup> |
708
|
|
|
|
|
|
|
|
709
|
|
|
|
|
|
|
Returns: nothing |
710
|
|
|
|
|
|
|
|
711
|
|
|
|
|
|
|
Removes the specified user from the specified group. |
712
|
|
|
|
|
|
|
|
713
|
|
|
|
|
|
|
Requires developer credentials. |
714
|
|
|
|
|
|
|
|
715
|
|
|
|
|
|
|
|
716
|
|
|
|
|
|
|
=head2 AdminResetUserPassword(Username => Str, UserPoolId => Str) |
717
|
|
|
|
|
|
|
|
718
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminResetUserPassword> |
719
|
|
|
|
|
|
|
|
720
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminResetUserPasswordResponse> instance |
721
|
|
|
|
|
|
|
|
722
|
|
|
|
|
|
|
Resets the specified user's password in a user pool as an |
723
|
|
|
|
|
|
|
administrator. Works on any user. |
724
|
|
|
|
|
|
|
|
725
|
|
|
|
|
|
|
When a developer calls this API, the current password is invalidated, |
726
|
|
|
|
|
|
|
so it must be changed. If a user tries to sign in after the API is |
727
|
|
|
|
|
|
|
called, the app will get a PasswordResetRequiredException exception |
728
|
|
|
|
|
|
|
back and should direct the user down the flow to reset the password, |
729
|
|
|
|
|
|
|
which is the same as the forgot password flow. In addition, if the user |
730
|
|
|
|
|
|
|
pool has phone verification selected and a verified phone number exists |
731
|
|
|
|
|
|
|
for the user, or if email verification is selected and a verified email |
732
|
|
|
|
|
|
|
exists for the user, calling this API will also result in sending a |
733
|
|
|
|
|
|
|
message to the end user with the code to change their password. |
734
|
|
|
|
|
|
|
|
735
|
|
|
|
|
|
|
Requires developer credentials. |
736
|
|
|
|
|
|
|
|
737
|
|
|
|
|
|
|
|
738
|
|
|
|
|
|
|
=head2 AdminRespondToAuthChallenge(ChallengeName => Str, ClientId => Str, UserPoolId => Str, [ChallengeResponses => L<Paws::CognitoIdp::ChallengeResponsesType>, Session => Str]) |
739
|
|
|
|
|
|
|
|
740
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminRespondToAuthChallenge> |
741
|
|
|
|
|
|
|
|
742
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminRespondToAuthChallengeResponse> instance |
743
|
|
|
|
|
|
|
|
744
|
|
|
|
|
|
|
Responds to an authentication challenge, as an administrator. |
745
|
|
|
|
|
|
|
|
746
|
|
|
|
|
|
|
Requires developer credentials. |
747
|
|
|
|
|
|
|
|
748
|
|
|
|
|
|
|
|
749
|
|
|
|
|
|
|
=head2 AdminSetUserSettings(MFAOptions => ArrayRef[L<Paws::CognitoIdp::MFAOptionType>], Username => Str, UserPoolId => Str) |
750
|
|
|
|
|
|
|
|
751
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminSetUserSettings> |
752
|
|
|
|
|
|
|
|
753
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminSetUserSettingsResponse> instance |
754
|
|
|
|
|
|
|
|
755
|
|
|
|
|
|
|
Sets all the user settings for a specified user name. Works on any |
756
|
|
|
|
|
|
|
user. |
757
|
|
|
|
|
|
|
|
758
|
|
|
|
|
|
|
Requires developer credentials. |
759
|
|
|
|
|
|
|
|
760
|
|
|
|
|
|
|
|
761
|
|
|
|
|
|
|
=head2 AdminUpdateDeviceStatus(DeviceKey => Str, Username => Str, UserPoolId => Str, [DeviceRememberedStatus => Str]) |
762
|
|
|
|
|
|
|
|
763
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminUpdateDeviceStatus> |
764
|
|
|
|
|
|
|
|
765
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminUpdateDeviceStatusResponse> instance |
766
|
|
|
|
|
|
|
|
767
|
|
|
|
|
|
|
Updates the device status as an administrator. |
768
|
|
|
|
|
|
|
|
769
|
|
|
|
|
|
|
Requires developer credentials. |
770
|
|
|
|
|
|
|
|
771
|
|
|
|
|
|
|
|
772
|
|
|
|
|
|
|
=head2 AdminUpdateUserAttributes(UserAttributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>], Username => Str, UserPoolId => Str) |
773
|
|
|
|
|
|
|
|
774
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminUpdateUserAttributes> |
775
|
|
|
|
|
|
|
|
776
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminUpdateUserAttributesResponse> instance |
777
|
|
|
|
|
|
|
|
778
|
|
|
|
|
|
|
Updates the specified user's attributes, including developer |
779
|
|
|
|
|
|
|
attributes, as an administrator. Works on any user. |
780
|
|
|
|
|
|
|
|
781
|
|
|
|
|
|
|
For custom attributes, you must prepend the C<custom:> prefix to the |
782
|
|
|
|
|
|
|
attribute name. |
783
|
|
|
|
|
|
|
|
784
|
|
|
|
|
|
|
In addition to updating user attributes, this API can also be used to |
785
|
|
|
|
|
|
|
mark phone and email as verified. |
786
|
|
|
|
|
|
|
|
787
|
|
|
|
|
|
|
Requires developer credentials. |
788
|
|
|
|
|
|
|
|
789
|
|
|
|
|
|
|
|
790
|
|
|
|
|
|
|
=head2 AdminUserGlobalSignOut(Username => Str, UserPoolId => Str) |
791
|
|
|
|
|
|
|
|
792
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::AdminUserGlobalSignOut> |
793
|
|
|
|
|
|
|
|
794
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::AdminUserGlobalSignOutResponse> instance |
795
|
|
|
|
|
|
|
|
796
|
|
|
|
|
|
|
Signs out users from all devices, as an administrator. |
797
|
|
|
|
|
|
|
|
798
|
|
|
|
|
|
|
Requires developer credentials. |
799
|
|
|
|
|
|
|
|
800
|
|
|
|
|
|
|
|
801
|
|
|
|
|
|
|
=head2 ChangePassword(AccessToken => Str, PreviousPassword => Str, ProposedPassword => Str) |
802
|
|
|
|
|
|
|
|
803
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ChangePassword> |
804
|
|
|
|
|
|
|
|
805
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ChangePasswordResponse> instance |
806
|
|
|
|
|
|
|
|
807
|
|
|
|
|
|
|
Changes the password for a specified user in a user pool. |
808
|
|
|
|
|
|
|
|
809
|
|
|
|
|
|
|
|
810
|
|
|
|
|
|
|
=head2 ConfirmDevice(AccessToken => Str, DeviceKey => Str, [DeviceName => Str, DeviceSecretVerifierConfig => L<Paws::CognitoIdp::DeviceSecretVerifierConfigType>]) |
811
|
|
|
|
|
|
|
|
812
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ConfirmDevice> |
813
|
|
|
|
|
|
|
|
814
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ConfirmDeviceResponse> instance |
815
|
|
|
|
|
|
|
|
816
|
|
|
|
|
|
|
Confirms tracking of the device. This API call is the call that begins |
817
|
|
|
|
|
|
|
device tracking. |
818
|
|
|
|
|
|
|
|
819
|
|
|
|
|
|
|
|
820
|
|
|
|
|
|
|
=head2 ConfirmForgotPassword(ClientId => Str, ConfirmationCode => Str, Password => Str, Username => Str, [SecretHash => Str]) |
821
|
|
|
|
|
|
|
|
822
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ConfirmForgotPassword> |
823
|
|
|
|
|
|
|
|
824
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ConfirmForgotPasswordResponse> instance |
825
|
|
|
|
|
|
|
|
826
|
|
|
|
|
|
|
Allows a user to enter a confirmation code to reset a forgotten |
827
|
|
|
|
|
|
|
password. |
828
|
|
|
|
|
|
|
|
829
|
|
|
|
|
|
|
|
830
|
|
|
|
|
|
|
=head2 ConfirmSignUp(ClientId => Str, ConfirmationCode => Str, Username => Str, [ForceAliasCreation => Bool, SecretHash => Str]) |
831
|
|
|
|
|
|
|
|
832
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ConfirmSignUp> |
833
|
|
|
|
|
|
|
|
834
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ConfirmSignUpResponse> instance |
835
|
|
|
|
|
|
|
|
836
|
|
|
|
|
|
|
Confirms registration of a user and handles the existing alias from a |
837
|
|
|
|
|
|
|
previous user. |
838
|
|
|
|
|
|
|
|
839
|
|
|
|
|
|
|
|
840
|
|
|
|
|
|
|
=head2 CreateGroup(GroupName => Str, UserPoolId => Str, [Description => Str, Precedence => Int, RoleArn => Str]) |
841
|
|
|
|
|
|
|
|
842
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateGroup> |
843
|
|
|
|
|
|
|
|
844
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateGroupResponse> instance |
845
|
|
|
|
|
|
|
|
846
|
|
|
|
|
|
|
Creates a new group in the specified user pool. |
847
|
|
|
|
|
|
|
|
848
|
|
|
|
|
|
|
Requires developer credentials. |
849
|
|
|
|
|
|
|
|
850
|
|
|
|
|
|
|
|
851
|
|
|
|
|
|
|
=head2 CreateIdentityProvider(ProviderDetails => L<Paws::CognitoIdp::ProviderDetailsType>, ProviderName => Str, ProviderType => Str, UserPoolId => Str, [AttributeMapping => L<Paws::CognitoIdp::AttributeMappingType>, IdpIdentifiers => ArrayRef[Str|Undef]]) |
852
|
|
|
|
|
|
|
|
853
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateIdentityProvider> |
854
|
|
|
|
|
|
|
|
855
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateIdentityProviderResponse> instance |
856
|
|
|
|
|
|
|
|
857
|
|
|
|
|
|
|
Creates an identity provider for a user pool. |
858
|
|
|
|
|
|
|
|
859
|
|
|
|
|
|
|
|
860
|
|
|
|
|
|
|
=head2 CreateResourceServer(Identifier => Str, Name => Str, UserPoolId => Str, [Scopes => ArrayRef[L<Paws::CognitoIdp::ResourceServerScopeType>]]) |
861
|
|
|
|
|
|
|
|
862
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateResourceServer> |
863
|
|
|
|
|
|
|
|
864
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateResourceServerResponse> instance |
865
|
|
|
|
|
|
|
|
866
|
|
|
|
|
|
|
Creates a new OAuth2.0 resource server and defines custom scopes in it. |
867
|
|
|
|
|
|
|
|
868
|
|
|
|
|
|
|
|
869
|
|
|
|
|
|
|
=head2 CreateUserImportJob(CloudWatchLogsRoleArn => Str, JobName => Str, UserPoolId => Str) |
870
|
|
|
|
|
|
|
|
871
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateUserImportJob> |
872
|
|
|
|
|
|
|
|
873
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateUserImportJobResponse> instance |
874
|
|
|
|
|
|
|
|
875
|
|
|
|
|
|
|
Creates the user import job. |
876
|
|
|
|
|
|
|
|
877
|
|
|
|
|
|
|
|
878
|
|
|
|
|
|
|
=head2 CreateUserPool(PoolName => Str, [AdminCreateUserConfig => L<Paws::CognitoIdp::AdminCreateUserConfigType>, AliasAttributes => ArrayRef[Str|Undef], AutoVerifiedAttributes => ArrayRef[Str|Undef], DeviceConfiguration => L<Paws::CognitoIdp::DeviceConfigurationType>, EmailConfiguration => L<Paws::CognitoIdp::EmailConfigurationType>, EmailVerificationMessage => Str, EmailVerificationSubject => Str, LambdaConfig => L<Paws::CognitoIdp::LambdaConfigType>, MfaConfiguration => Str, Policies => L<Paws::CognitoIdp::UserPoolPolicyType>, Schema => ArrayRef[L<Paws::CognitoIdp::SchemaAttributeType>], SmsAuthenticationMessage => Str, SmsConfiguration => L<Paws::CognitoIdp::SmsConfigurationType>, SmsVerificationMessage => Str, UsernameAttributes => ArrayRef[Str|Undef], UserPoolTags => L<Paws::CognitoIdp::UserPoolTagsType>, VerificationMessageTemplate => L<Paws::CognitoIdp::VerificationMessageTemplateType>]) |
879
|
|
|
|
|
|
|
|
880
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateUserPool> |
881
|
|
|
|
|
|
|
|
882
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateUserPoolResponse> instance |
883
|
|
|
|
|
|
|
|
884
|
|
|
|
|
|
|
Creates a new Amazon Cognito user pool and sets the password policy for |
885
|
|
|
|
|
|
|
the pool. |
886
|
|
|
|
|
|
|
|
887
|
|
|
|
|
|
|
|
888
|
|
|
|
|
|
|
=head2 CreateUserPoolClient(ClientName => Str, UserPoolId => Str, [AllowedOAuthFlows => ArrayRef[Str|Undef], AllowedOAuthFlowsUserPoolClient => Bool, AllowedOAuthScopes => ArrayRef[Str|Undef], CallbackURLs => ArrayRef[Str|Undef], DefaultRedirectURI => Str, ExplicitAuthFlows => ArrayRef[Str|Undef], GenerateSecret => Bool, LogoutURLs => ArrayRef[Str|Undef], ReadAttributes => ArrayRef[Str|Undef], RefreshTokenValidity => Int, SupportedIdentityProviders => ArrayRef[Str|Undef], WriteAttributes => ArrayRef[Str|Undef]]) |
889
|
|
|
|
|
|
|
|
890
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateUserPoolClient> |
891
|
|
|
|
|
|
|
|
892
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateUserPoolClientResponse> instance |
893
|
|
|
|
|
|
|
|
894
|
|
|
|
|
|
|
Creates the user pool client. |
895
|
|
|
|
|
|
|
|
896
|
|
|
|
|
|
|
|
897
|
|
|
|
|
|
|
=head2 CreateUserPoolDomain(Domain => Str, UserPoolId => Str) |
898
|
|
|
|
|
|
|
|
899
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::CreateUserPoolDomain> |
900
|
|
|
|
|
|
|
|
901
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::CreateUserPoolDomainResponse> instance |
902
|
|
|
|
|
|
|
|
903
|
|
|
|
|
|
|
Creates a new domain for a user pool. |
904
|
|
|
|
|
|
|
|
905
|
|
|
|
|
|
|
|
906
|
|
|
|
|
|
|
=head2 DeleteGroup(GroupName => Str, UserPoolId => Str) |
907
|
|
|
|
|
|
|
|
908
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteGroup> |
909
|
|
|
|
|
|
|
|
910
|
|
|
|
|
|
|
Returns: nothing |
911
|
|
|
|
|
|
|
|
912
|
|
|
|
|
|
|
Deletes a group. Currently only groups with no members can be deleted. |
913
|
|
|
|
|
|
|
|
914
|
|
|
|
|
|
|
Requires developer credentials. |
915
|
|
|
|
|
|
|
|
916
|
|
|
|
|
|
|
|
917
|
|
|
|
|
|
|
=head2 DeleteIdentityProvider(ProviderName => Str, UserPoolId => Str) |
918
|
|
|
|
|
|
|
|
919
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteIdentityProvider> |
920
|
|
|
|
|
|
|
|
921
|
|
|
|
|
|
|
Returns: nothing |
922
|
|
|
|
|
|
|
|
923
|
|
|
|
|
|
|
Deletes an identity provider for a user pool. |
924
|
|
|
|
|
|
|
|
925
|
|
|
|
|
|
|
|
926
|
|
|
|
|
|
|
=head2 DeleteResourceServer(Identifier => Str, UserPoolId => Str) |
927
|
|
|
|
|
|
|
|
928
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteResourceServer> |
929
|
|
|
|
|
|
|
|
930
|
|
|
|
|
|
|
Returns: nothing |
931
|
|
|
|
|
|
|
|
932
|
|
|
|
|
|
|
Deletes a resource server. |
933
|
|
|
|
|
|
|
|
934
|
|
|
|
|
|
|
|
935
|
|
|
|
|
|
|
=head2 DeleteUser(AccessToken => Str) |
936
|
|
|
|
|
|
|
|
937
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteUser> |
938
|
|
|
|
|
|
|
|
939
|
|
|
|
|
|
|
Returns: nothing |
940
|
|
|
|
|
|
|
|
941
|
|
|
|
|
|
|
Allows a user to delete himself or herself. |
942
|
|
|
|
|
|
|
|
943
|
|
|
|
|
|
|
|
944
|
|
|
|
|
|
|
=head2 DeleteUserAttributes(AccessToken => Str, UserAttributeNames => ArrayRef[Str|Undef]) |
945
|
|
|
|
|
|
|
|
946
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteUserAttributes> |
947
|
|
|
|
|
|
|
|
948
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DeleteUserAttributesResponse> instance |
949
|
|
|
|
|
|
|
|
950
|
|
|
|
|
|
|
Deletes the attributes for a user. |
951
|
|
|
|
|
|
|
|
952
|
|
|
|
|
|
|
|
953
|
|
|
|
|
|
|
=head2 DeleteUserPool(UserPoolId => Str) |
954
|
|
|
|
|
|
|
|
955
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteUserPool> |
956
|
|
|
|
|
|
|
|
957
|
|
|
|
|
|
|
Returns: nothing |
958
|
|
|
|
|
|
|
|
959
|
|
|
|
|
|
|
Deletes the specified Amazon Cognito user pool. |
960
|
|
|
|
|
|
|
|
961
|
|
|
|
|
|
|
|
962
|
|
|
|
|
|
|
=head2 DeleteUserPoolClient(ClientId => Str, UserPoolId => Str) |
963
|
|
|
|
|
|
|
|
964
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteUserPoolClient> |
965
|
|
|
|
|
|
|
|
966
|
|
|
|
|
|
|
Returns: nothing |
967
|
|
|
|
|
|
|
|
968
|
|
|
|
|
|
|
Allows the developer to delete the user pool client. |
969
|
|
|
|
|
|
|
|
970
|
|
|
|
|
|
|
|
971
|
|
|
|
|
|
|
=head2 DeleteUserPoolDomain(Domain => Str, UserPoolId => Str) |
972
|
|
|
|
|
|
|
|
973
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DeleteUserPoolDomain> |
974
|
|
|
|
|
|
|
|
975
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DeleteUserPoolDomainResponse> instance |
976
|
|
|
|
|
|
|
|
977
|
|
|
|
|
|
|
Deletes a domain for a user pool. |
978
|
|
|
|
|
|
|
|
979
|
|
|
|
|
|
|
|
980
|
|
|
|
|
|
|
=head2 DescribeIdentityProvider(ProviderName => Str, UserPoolId => Str) |
981
|
|
|
|
|
|
|
|
982
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeIdentityProvider> |
983
|
|
|
|
|
|
|
|
984
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeIdentityProviderResponse> instance |
985
|
|
|
|
|
|
|
|
986
|
|
|
|
|
|
|
Gets information about a specific identity provider. |
987
|
|
|
|
|
|
|
|
988
|
|
|
|
|
|
|
|
989
|
|
|
|
|
|
|
=head2 DescribeResourceServer(Identifier => Str, UserPoolId => Str) |
990
|
|
|
|
|
|
|
|
991
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeResourceServer> |
992
|
|
|
|
|
|
|
|
993
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeResourceServerResponse> instance |
994
|
|
|
|
|
|
|
|
995
|
|
|
|
|
|
|
Describes a resource server. |
996
|
|
|
|
|
|
|
|
997
|
|
|
|
|
|
|
|
998
|
|
|
|
|
|
|
=head2 DescribeUserImportJob(JobId => Str, UserPoolId => Str) |
999
|
|
|
|
|
|
|
|
1000
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeUserImportJob> |
1001
|
|
|
|
|
|
|
|
1002
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeUserImportJobResponse> instance |
1003
|
|
|
|
|
|
|
|
1004
|
|
|
|
|
|
|
Describes the user import job. |
1005
|
|
|
|
|
|
|
|
1006
|
|
|
|
|
|
|
|
1007
|
|
|
|
|
|
|
=head2 DescribeUserPool(UserPoolId => Str) |
1008
|
|
|
|
|
|
|
|
1009
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeUserPool> |
1010
|
|
|
|
|
|
|
|
1011
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeUserPoolResponse> instance |
1012
|
|
|
|
|
|
|
|
1013
|
|
|
|
|
|
|
Returns the configuration information and metadata of the specified |
1014
|
|
|
|
|
|
|
user pool. |
1015
|
|
|
|
|
|
|
|
1016
|
|
|
|
|
|
|
|
1017
|
|
|
|
|
|
|
=head2 DescribeUserPoolClient(ClientId => Str, UserPoolId => Str) |
1018
|
|
|
|
|
|
|
|
1019
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeUserPoolClient> |
1020
|
|
|
|
|
|
|
|
1021
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeUserPoolClientResponse> instance |
1022
|
|
|
|
|
|
|
|
1023
|
|
|
|
|
|
|
Client method for returning the configuration information and metadata |
1024
|
|
|
|
|
|
|
of the specified user pool client. |
1025
|
|
|
|
|
|
|
|
1026
|
|
|
|
|
|
|
|
1027
|
|
|
|
|
|
|
=head2 DescribeUserPoolDomain(Domain => Str) |
1028
|
|
|
|
|
|
|
|
1029
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::DescribeUserPoolDomain> |
1030
|
|
|
|
|
|
|
|
1031
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::DescribeUserPoolDomainResponse> instance |
1032
|
|
|
|
|
|
|
|
1033
|
|
|
|
|
|
|
Gets information about a domain. |
1034
|
|
|
|
|
|
|
|
1035
|
|
|
|
|
|
|
|
1036
|
|
|
|
|
|
|
=head2 ForgetDevice(DeviceKey => Str, [AccessToken => Str]) |
1037
|
|
|
|
|
|
|
|
1038
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ForgetDevice> |
1039
|
|
|
|
|
|
|
|
1040
|
|
|
|
|
|
|
Returns: nothing |
1041
|
|
|
|
|
|
|
|
1042
|
|
|
|
|
|
|
Forgets the specified device. |
1043
|
|
|
|
|
|
|
|
1044
|
|
|
|
|
|
|
|
1045
|
|
|
|
|
|
|
=head2 ForgotPassword(ClientId => Str, Username => Str, [SecretHash => Str]) |
1046
|
|
|
|
|
|
|
|
1047
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ForgotPassword> |
1048
|
|
|
|
|
|
|
|
1049
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ForgotPasswordResponse> instance |
1050
|
|
|
|
|
|
|
|
1051
|
|
|
|
|
|
|
Calling this API causes a message to be sent to the end user with a |
1052
|
|
|
|
|
|
|
confirmation code that is required to change the user's password. For |
1053
|
|
|
|
|
|
|
the C<Username> parameter, you can use the username or user alias. If a |
1054
|
|
|
|
|
|
|
verified phone number exists for the user, the confirmation code is |
1055
|
|
|
|
|
|
|
sent to the phone number. Otherwise, if a verified email exists, the |
1056
|
|
|
|
|
|
|
confirmation code is sent to the email. If neither a verified phone |
1057
|
|
|
|
|
|
|
number nor a verified email exists, C<InvalidParameterException> is |
1058
|
|
|
|
|
|
|
thrown. To use the confirmation code for resetting the password, call |
1059
|
|
|
|
|
|
|
ConfirmForgotPassword. |
1060
|
|
|
|
|
|
|
|
1061
|
|
|
|
|
|
|
|
1062
|
|
|
|
|
|
|
=head2 GetCSVHeader(UserPoolId => Str) |
1063
|
|
|
|
|
|
|
|
1064
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetCSVHeader> |
1065
|
|
|
|
|
|
|
|
1066
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetCSVHeaderResponse> instance |
1067
|
|
|
|
|
|
|
|
1068
|
|
|
|
|
|
|
Gets the header information for the .csv file to be used as input for |
1069
|
|
|
|
|
|
|
the user import job. |
1070
|
|
|
|
|
|
|
|
1071
|
|
|
|
|
|
|
|
1072
|
|
|
|
|
|
|
=head2 GetDevice(DeviceKey => Str, [AccessToken => Str]) |
1073
|
|
|
|
|
|
|
|
1074
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetDevice> |
1075
|
|
|
|
|
|
|
|
1076
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetDeviceResponse> instance |
1077
|
|
|
|
|
|
|
|
1078
|
|
|
|
|
|
|
Gets the device. |
1079
|
|
|
|
|
|
|
|
1080
|
|
|
|
|
|
|
|
1081
|
|
|
|
|
|
|
=head2 GetGroup(GroupName => Str, UserPoolId => Str) |
1082
|
|
|
|
|
|
|
|
1083
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetGroup> |
1084
|
|
|
|
|
|
|
|
1085
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetGroupResponse> instance |
1086
|
|
|
|
|
|
|
|
1087
|
|
|
|
|
|
|
Gets a group. |
1088
|
|
|
|
|
|
|
|
1089
|
|
|
|
|
|
|
Requires developer credentials. |
1090
|
|
|
|
|
|
|
|
1091
|
|
|
|
|
|
|
|
1092
|
|
|
|
|
|
|
=head2 GetIdentityProviderByIdentifier(IdpIdentifier => Str, UserPoolId => Str) |
1093
|
|
|
|
|
|
|
|
1094
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetIdentityProviderByIdentifier> |
1095
|
|
|
|
|
|
|
|
1096
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetIdentityProviderByIdentifierResponse> instance |
1097
|
|
|
|
|
|
|
|
1098
|
|
|
|
|
|
|
Gets the specified identity provider. |
1099
|
|
|
|
|
|
|
|
1100
|
|
|
|
|
|
|
|
1101
|
|
|
|
|
|
|
=head2 GetUICustomization(UserPoolId => Str, [ClientId => Str]) |
1102
|
|
|
|
|
|
|
|
1103
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetUICustomization> |
1104
|
|
|
|
|
|
|
|
1105
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetUICustomizationResponse> instance |
1106
|
|
|
|
|
|
|
|
1107
|
|
|
|
|
|
|
Gets the UI Customization information for a particular app client's app |
1108
|
|
|
|
|
|
|
UI, if there is something set. If nothing is set for the particular |
1109
|
|
|
|
|
|
|
client, but there is an existing pool level customization (app |
1110
|
|
|
|
|
|
|
C<clientId> will be C<ALL>), then that is returned. If nothing is |
1111
|
|
|
|
|
|
|
present, then an empty shape is returned. |
1112
|
|
|
|
|
|
|
|
1113
|
|
|
|
|
|
|
|
1114
|
|
|
|
|
|
|
=head2 GetUser(AccessToken => Str) |
1115
|
|
|
|
|
|
|
|
1116
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetUser> |
1117
|
|
|
|
|
|
|
|
1118
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetUserResponse> instance |
1119
|
|
|
|
|
|
|
|
1120
|
|
|
|
|
|
|
Gets the user attributes and metadata for a user. |
1121
|
|
|
|
|
|
|
|
1122
|
|
|
|
|
|
|
|
1123
|
|
|
|
|
|
|
=head2 GetUserAttributeVerificationCode(AccessToken => Str, AttributeName => Str) |
1124
|
|
|
|
|
|
|
|
1125
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GetUserAttributeVerificationCode> |
1126
|
|
|
|
|
|
|
|
1127
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GetUserAttributeVerificationCodeResponse> instance |
1128
|
|
|
|
|
|
|
|
1129
|
|
|
|
|
|
|
Gets the user attribute verification code for the specified attribute |
1130
|
|
|
|
|
|
|
name. |
1131
|
|
|
|
|
|
|
|
1132
|
|
|
|
|
|
|
|
1133
|
|
|
|
|
|
|
=head2 GlobalSignOut(AccessToken => Str) |
1134
|
|
|
|
|
|
|
|
1135
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::GlobalSignOut> |
1136
|
|
|
|
|
|
|
|
1137
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::GlobalSignOutResponse> instance |
1138
|
|
|
|
|
|
|
|
1139
|
|
|
|
|
|
|
Signs out users from all devices. |
1140
|
|
|
|
|
|
|
|
1141
|
|
|
|
|
|
|
|
1142
|
|
|
|
|
|
|
=head2 InitiateAuth(AuthFlow => Str, ClientId => Str, [AuthParameters => L<Paws::CognitoIdp::AuthParametersType>, ClientMetadata => L<Paws::CognitoIdp::ClientMetadataType>]) |
1143
|
|
|
|
|
|
|
|
1144
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::InitiateAuth> |
1145
|
|
|
|
|
|
|
|
1146
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::InitiateAuthResponse> instance |
1147
|
|
|
|
|
|
|
|
1148
|
|
|
|
|
|
|
Initiates the authentication flow. |
1149
|
|
|
|
|
|
|
|
1150
|
|
|
|
|
|
|
|
1151
|
|
|
|
|
|
|
=head2 ListDevices(AccessToken => Str, [Limit => Int, PaginationToken => Str]) |
1152
|
|
|
|
|
|
|
|
1153
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListDevices> |
1154
|
|
|
|
|
|
|
|
1155
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListDevicesResponse> instance |
1156
|
|
|
|
|
|
|
|
1157
|
|
|
|
|
|
|
Lists the devices. |
1158
|
|
|
|
|
|
|
|
1159
|
|
|
|
|
|
|
|
1160
|
|
|
|
|
|
|
=head2 ListGroups(UserPoolId => Str, [Limit => Int, NextToken => Str]) |
1161
|
|
|
|
|
|
|
|
1162
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListGroups> |
1163
|
|
|
|
|
|
|
|
1164
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListGroupsResponse> instance |
1165
|
|
|
|
|
|
|
|
1166
|
|
|
|
|
|
|
Lists the groups associated with a user pool. |
1167
|
|
|
|
|
|
|
|
1168
|
|
|
|
|
|
|
Requires developer credentials. |
1169
|
|
|
|
|
|
|
|
1170
|
|
|
|
|
|
|
|
1171
|
|
|
|
|
|
|
=head2 ListIdentityProviders(UserPoolId => Str, [MaxResults => Int, NextToken => Str]) |
1172
|
|
|
|
|
|
|
|
1173
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListIdentityProviders> |
1174
|
|
|
|
|
|
|
|
1175
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListIdentityProvidersResponse> instance |
1176
|
|
|
|
|
|
|
|
1177
|
|
|
|
|
|
|
Lists information about all identity providers for a user pool. |
1178
|
|
|
|
|
|
|
|
1179
|
|
|
|
|
|
|
|
1180
|
|
|
|
|
|
|
=head2 ListResourceServers(UserPoolId => Str, [MaxResults => Int, NextToken => Str]) |
1181
|
|
|
|
|
|
|
|
1182
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListResourceServers> |
1183
|
|
|
|
|
|
|
|
1184
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListResourceServersResponse> instance |
1185
|
|
|
|
|
|
|
|
1186
|
|
|
|
|
|
|
Lists the resource servers for a user pool. |
1187
|
|
|
|
|
|
|
|
1188
|
|
|
|
|
|
|
|
1189
|
|
|
|
|
|
|
=head2 ListUserImportJobs(MaxResults => Int, UserPoolId => Str, [PaginationToken => Str]) |
1190
|
|
|
|
|
|
|
|
1191
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListUserImportJobs> |
1192
|
|
|
|
|
|
|
|
1193
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListUserImportJobsResponse> instance |
1194
|
|
|
|
|
|
|
|
1195
|
|
|
|
|
|
|
Lists the user import jobs. |
1196
|
|
|
|
|
|
|
|
1197
|
|
|
|
|
|
|
|
1198
|
|
|
|
|
|
|
=head2 ListUserPoolClients(UserPoolId => Str, [MaxResults => Int, NextToken => Str]) |
1199
|
|
|
|
|
|
|
|
1200
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListUserPoolClients> |
1201
|
|
|
|
|
|
|
|
1202
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListUserPoolClientsResponse> instance |
1203
|
|
|
|
|
|
|
|
1204
|
|
|
|
|
|
|
Lists the clients that have been created for the specified user pool. |
1205
|
|
|
|
|
|
|
|
1206
|
|
|
|
|
|
|
|
1207
|
|
|
|
|
|
|
=head2 ListUserPools(MaxResults => Int, [NextToken => Str]) |
1208
|
|
|
|
|
|
|
|
1209
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListUserPools> |
1210
|
|
|
|
|
|
|
|
1211
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListUserPoolsResponse> instance |
1212
|
|
|
|
|
|
|
|
1213
|
|
|
|
|
|
|
Lists the user pools associated with an AWS account. |
1214
|
|
|
|
|
|
|
|
1215
|
|
|
|
|
|
|
|
1216
|
|
|
|
|
|
|
=head2 ListUsers(UserPoolId => Str, [AttributesToGet => ArrayRef[Str|Undef], Filter => Str, Limit => Int, PaginationToken => Str]) |
1217
|
|
|
|
|
|
|
|
1218
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListUsers> |
1219
|
|
|
|
|
|
|
|
1220
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListUsersResponse> instance |
1221
|
|
|
|
|
|
|
|
1222
|
|
|
|
|
|
|
Lists the users in the Amazon Cognito user pool. |
1223
|
|
|
|
|
|
|
|
1224
|
|
|
|
|
|
|
|
1225
|
|
|
|
|
|
|
=head2 ListUsersInGroup(GroupName => Str, UserPoolId => Str, [Limit => Int, NextToken => Str]) |
1226
|
|
|
|
|
|
|
|
1227
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ListUsersInGroup> |
1228
|
|
|
|
|
|
|
|
1229
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ListUsersInGroupResponse> instance |
1230
|
|
|
|
|
|
|
|
1231
|
|
|
|
|
|
|
Lists the users in the specified group. |
1232
|
|
|
|
|
|
|
|
1233
|
|
|
|
|
|
|
Requires developer credentials. |
1234
|
|
|
|
|
|
|
|
1235
|
|
|
|
|
|
|
|
1236
|
|
|
|
|
|
|
=head2 ResendConfirmationCode(ClientId => Str, Username => Str, [SecretHash => Str]) |
1237
|
|
|
|
|
|
|
|
1238
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::ResendConfirmationCode> |
1239
|
|
|
|
|
|
|
|
1240
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::ResendConfirmationCodeResponse> instance |
1241
|
|
|
|
|
|
|
|
1242
|
|
|
|
|
|
|
Resends the confirmation (for confirmation of registration) to a |
1243
|
|
|
|
|
|
|
specific user in the user pool. |
1244
|
|
|
|
|
|
|
|
1245
|
|
|
|
|
|
|
|
1246
|
|
|
|
|
|
|
=head2 RespondToAuthChallenge(ChallengeName => Str, ClientId => Str, [ChallengeResponses => L<Paws::CognitoIdp::ChallengeResponsesType>, Session => Str]) |
1247
|
|
|
|
|
|
|
|
1248
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::RespondToAuthChallenge> |
1249
|
|
|
|
|
|
|
|
1250
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::RespondToAuthChallengeResponse> instance |
1251
|
|
|
|
|
|
|
|
1252
|
|
|
|
|
|
|
Responds to the authentication challenge. |
1253
|
|
|
|
|
|
|
|
1254
|
|
|
|
|
|
|
|
1255
|
|
|
|
|
|
|
=head2 SetUICustomization(UserPoolId => Str, [ClientId => Str, CSS => Str, ImageFile => Str]) |
1256
|
|
|
|
|
|
|
|
1257
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::SetUICustomization> |
1258
|
|
|
|
|
|
|
|
1259
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::SetUICustomizationResponse> instance |
1260
|
|
|
|
|
|
|
|
1261
|
|
|
|
|
|
|
Sets the UI customization information for a user pool's built-in app |
1262
|
|
|
|
|
|
|
UI. |
1263
|
|
|
|
|
|
|
|
1264
|
|
|
|
|
|
|
You can specify app UI customization settings for a single client (with |
1265
|
|
|
|
|
|
|
a specific C<clientId>) or for all clients (by setting the C<clientId> |
1266
|
|
|
|
|
|
|
to C<ALL>). If you specify C<ALL>, the default configuration will be |
1267
|
|
|
|
|
|
|
used for every client that has no UI customization set previously. If |
1268
|
|
|
|
|
|
|
you specify UI customization settings for a particular client, it will |
1269
|
|
|
|
|
|
|
no longer fall back to the C<ALL> configuration. |
1270
|
|
|
|
|
|
|
|
1271
|
|
|
|
|
|
|
To use this API, your user pool must have a domain associated with it. |
1272
|
|
|
|
|
|
|
Otherwise, there is no place to host the app's pages, and the service |
1273
|
|
|
|
|
|
|
will throw an error. |
1274
|
|
|
|
|
|
|
|
1275
|
|
|
|
|
|
|
|
1276
|
|
|
|
|
|
|
=head2 SetUserSettings(AccessToken => Str, MFAOptions => ArrayRef[L<Paws::CognitoIdp::MFAOptionType>]) |
1277
|
|
|
|
|
|
|
|
1278
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::SetUserSettings> |
1279
|
|
|
|
|
|
|
|
1280
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::SetUserSettingsResponse> instance |
1281
|
|
|
|
|
|
|
|
1282
|
|
|
|
|
|
|
Sets the user settings like multi-factor authentication (MFA). If MFA |
1283
|
|
|
|
|
|
|
is to be removed for a particular attribute pass the attribute with |
1284
|
|
|
|
|
|
|
code delivery as null. If null list is passed, all MFA options are |
1285
|
|
|
|
|
|
|
removed. |
1286
|
|
|
|
|
|
|
|
1287
|
|
|
|
|
|
|
|
1288
|
|
|
|
|
|
|
=head2 SignUp(ClientId => Str, Password => Str, Username => Str, [SecretHash => Str, UserAttributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>], ValidationData => ArrayRef[L<Paws::CognitoIdp::AttributeType>]]) |
1289
|
|
|
|
|
|
|
|
1290
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::SignUp> |
1291
|
|
|
|
|
|
|
|
1292
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::SignUpResponse> instance |
1293
|
|
|
|
|
|
|
|
1294
|
|
|
|
|
|
|
Registers the user in the specified user pool and creates a user name, |
1295
|
|
|
|
|
|
|
password, and user attributes. |
1296
|
|
|
|
|
|
|
|
1297
|
|
|
|
|
|
|
|
1298
|
|
|
|
|
|
|
=head2 StartUserImportJob(JobId => Str, UserPoolId => Str) |
1299
|
|
|
|
|
|
|
|
1300
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::StartUserImportJob> |
1301
|
|
|
|
|
|
|
|
1302
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::StartUserImportJobResponse> instance |
1303
|
|
|
|
|
|
|
|
1304
|
|
|
|
|
|
|
Starts the user import. |
1305
|
|
|
|
|
|
|
|
1306
|
|
|
|
|
|
|
|
1307
|
|
|
|
|
|
|
=head2 StopUserImportJob(JobId => Str, UserPoolId => Str) |
1308
|
|
|
|
|
|
|
|
1309
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::StopUserImportJob> |
1310
|
|
|
|
|
|
|
|
1311
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::StopUserImportJobResponse> instance |
1312
|
|
|
|
|
|
|
|
1313
|
|
|
|
|
|
|
Stops the user import job. |
1314
|
|
|
|
|
|
|
|
1315
|
|
|
|
|
|
|
|
1316
|
|
|
|
|
|
|
=head2 UpdateDeviceStatus(AccessToken => Str, DeviceKey => Str, [DeviceRememberedStatus => Str]) |
1317
|
|
|
|
|
|
|
|
1318
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateDeviceStatus> |
1319
|
|
|
|
|
|
|
|
1320
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateDeviceStatusResponse> instance |
1321
|
|
|
|
|
|
|
|
1322
|
|
|
|
|
|
|
Updates the device status. |
1323
|
|
|
|
|
|
|
|
1324
|
|
|
|
|
|
|
|
1325
|
|
|
|
|
|
|
=head2 UpdateGroup(GroupName => Str, UserPoolId => Str, [Description => Str, Precedence => Int, RoleArn => Str]) |
1326
|
|
|
|
|
|
|
|
1327
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateGroup> |
1328
|
|
|
|
|
|
|
|
1329
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateGroupResponse> instance |
1330
|
|
|
|
|
|
|
|
1331
|
|
|
|
|
|
|
Updates the specified group with the specified attributes. |
1332
|
|
|
|
|
|
|
|
1333
|
|
|
|
|
|
|
Requires developer credentials. |
1334
|
|
|
|
|
|
|
|
1335
|
|
|
|
|
|
|
|
1336
|
|
|
|
|
|
|
=head2 UpdateIdentityProvider(ProviderName => Str, UserPoolId => Str, [AttributeMapping => L<Paws::CognitoIdp::AttributeMappingType>, IdpIdentifiers => ArrayRef[Str|Undef], ProviderDetails => L<Paws::CognitoIdp::ProviderDetailsType>]) |
1337
|
|
|
|
|
|
|
|
1338
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateIdentityProvider> |
1339
|
|
|
|
|
|
|
|
1340
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateIdentityProviderResponse> instance |
1341
|
|
|
|
|
|
|
|
1342
|
|
|
|
|
|
|
Updates identity provider information for a user pool. |
1343
|
|
|
|
|
|
|
|
1344
|
|
|
|
|
|
|
|
1345
|
|
|
|
|
|
|
=head2 UpdateResourceServer(Identifier => Str, Name => Str, UserPoolId => Str, [Scopes => ArrayRef[L<Paws::CognitoIdp::ResourceServerScopeType>]]) |
1346
|
|
|
|
|
|
|
|
1347
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateResourceServer> |
1348
|
|
|
|
|
|
|
|
1349
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateResourceServerResponse> instance |
1350
|
|
|
|
|
|
|
|
1351
|
|
|
|
|
|
|
Updates the name and scopes of resource server. All other fields are |
1352
|
|
|
|
|
|
|
read-only. |
1353
|
|
|
|
|
|
|
|
1354
|
|
|
|
|
|
|
|
1355
|
|
|
|
|
|
|
=head2 UpdateUserAttributes(AccessToken => Str, UserAttributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>]) |
1356
|
|
|
|
|
|
|
|
1357
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateUserAttributes> |
1358
|
|
|
|
|
|
|
|
1359
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateUserAttributesResponse> instance |
1360
|
|
|
|
|
|
|
|
1361
|
|
|
|
|
|
|
Allows a user to update a specific attribute (one at a time). |
1362
|
|
|
|
|
|
|
|
1363
|
|
|
|
|
|
|
|
1364
|
|
|
|
|
|
|
=head2 UpdateUserPool(UserPoolId => Str, [AdminCreateUserConfig => L<Paws::CognitoIdp::AdminCreateUserConfigType>, AutoVerifiedAttributes => ArrayRef[Str|Undef], DeviceConfiguration => L<Paws::CognitoIdp::DeviceConfigurationType>, EmailConfiguration => L<Paws::CognitoIdp::EmailConfigurationType>, EmailVerificationMessage => Str, EmailVerificationSubject => Str, LambdaConfig => L<Paws::CognitoIdp::LambdaConfigType>, MfaConfiguration => Str, Policies => L<Paws::CognitoIdp::UserPoolPolicyType>, SmsAuthenticationMessage => Str, SmsConfiguration => L<Paws::CognitoIdp::SmsConfigurationType>, SmsVerificationMessage => Str, UserPoolTags => L<Paws::CognitoIdp::UserPoolTagsType>, VerificationMessageTemplate => L<Paws::CognitoIdp::VerificationMessageTemplateType>]) |
1365
|
|
|
|
|
|
|
|
1366
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateUserPool> |
1367
|
|
|
|
|
|
|
|
1368
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateUserPoolResponse> instance |
1369
|
|
|
|
|
|
|
|
1370
|
|
|
|
|
|
|
Updates the specified user pool with the specified attributes. |
1371
|
|
|
|
|
|
|
|
1372
|
|
|
|
|
|
|
|
1373
|
|
|
|
|
|
|
=head2 UpdateUserPoolClient(ClientId => Str, UserPoolId => Str, [AllowedOAuthFlows => ArrayRef[Str|Undef], AllowedOAuthFlowsUserPoolClient => Bool, AllowedOAuthScopes => ArrayRef[Str|Undef], CallbackURLs => ArrayRef[Str|Undef], ClientName => Str, DefaultRedirectURI => Str, ExplicitAuthFlows => ArrayRef[Str|Undef], LogoutURLs => ArrayRef[Str|Undef], ReadAttributes => ArrayRef[Str|Undef], RefreshTokenValidity => Int, SupportedIdentityProviders => ArrayRef[Str|Undef], WriteAttributes => ArrayRef[Str|Undef]]) |
1374
|
|
|
|
|
|
|
|
1375
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::UpdateUserPoolClient> |
1376
|
|
|
|
|
|
|
|
1377
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::UpdateUserPoolClientResponse> instance |
1378
|
|
|
|
|
|
|
|
1379
|
|
|
|
|
|
|
Allows the developer to update the specified user pool client and |
1380
|
|
|
|
|
|
|
password policy. |
1381
|
|
|
|
|
|
|
|
1382
|
|
|
|
|
|
|
|
1383
|
|
|
|
|
|
|
=head2 VerifyUserAttribute(AccessToken => Str, AttributeName => Str, Code => Str) |
1384
|
|
|
|
|
|
|
|
1385
|
|
|
|
|
|
|
Each argument is described in detail in: L<Paws::CognitoIdp::VerifyUserAttribute> |
1386
|
|
|
|
|
|
|
|
1387
|
|
|
|
|
|
|
Returns: a L<Paws::CognitoIdp::VerifyUserAttributeResponse> instance |
1388
|
|
|
|
|
|
|
|
1389
|
|
|
|
|
|
|
Verifies the specified user attributes in the user pool. |
1390
|
|
|
|
|
|
|
|
1391
|
|
|
|
|
|
|
|
1392
|
|
|
|
|
|
|
|
1393
|
|
|
|
|
|
|
|
1394
|
|
|
|
|
|
|
=head1 PAGINATORS |
1395
|
|
|
|
|
|
|
|
1396
|
|
|
|
|
|
|
Paginator methods are helpers that repetively call methods that return partial results |
1397
|
|
|
|
|
|
|
|
1398
|
|
|
|
|
|
|
|
1399
|
|
|
|
|
|
|
|
1400
|
|
|
|
|
|
|
|
1401
|
|
|
|
|
|
|
=head1 SEE ALSO |
1402
|
|
|
|
|
|
|
|
1403
|
|
|
|
|
|
|
This service class forms part of L<Paws> |
1404
|
|
|
|
|
|
|
|
1405
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
1406
|
|
|
|
|
|
|
|
1407
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
1408
|
|
|
|
|
|
|
|
1409
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
1410
|
|
|
|
|
|
|
|
1411
|
|
|
|
|
|
|
=cut |
1412
|
|
|
|
|
|
|
|