line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::CognitoIdp::InitiateAuth; |
3
|
1
|
|
|
1
|
|
323
|
use Moose; |
|
1
|
|
|
|
|
4
|
|
|
1
|
|
|
|
|
5
|
|
4
|
|
|
|
|
|
|
has AuthFlow => (is => 'ro', isa => 'Str', required => 1); |
5
|
|
|
|
|
|
|
has AuthParameters => (is => 'ro', isa => 'Paws::CognitoIdp::AuthParametersType'); |
6
|
|
|
|
|
|
|
has ClientId => (is => 'ro', isa => 'Str', required => 1); |
7
|
|
|
|
|
|
|
has ClientMetadata => (is => 'ro', isa => 'Paws::CognitoIdp::ClientMetadataType'); |
8
|
|
|
|
|
|
|
|
9
|
1
|
|
|
1
|
|
5493
|
use MooseX::ClassAttribute; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
8
|
|
10
|
|
|
|
|
|
|
|
11
|
|
|
|
|
|
|
class_has _api_call => (isa => 'Str', is => 'ro', default => 'InitiateAuth'); |
12
|
|
|
|
|
|
|
class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::InitiateAuthResponse'); |
13
|
|
|
|
|
|
|
class_has _result_key => (isa => 'Str', is => 'ro'); |
14
|
|
|
|
|
|
|
1; |
15
|
|
|
|
|
|
|
|
16
|
|
|
|
|
|
|
### main pod documentation begin ### |
17
|
|
|
|
|
|
|
|
18
|
|
|
|
|
|
|
=head1 NAME |
19
|
|
|
|
|
|
|
|
20
|
|
|
|
|
|
|
Paws::CognitoIdp::InitiateAuth - Arguments for method InitiateAuth on Paws::CognitoIdp |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=head1 DESCRIPTION |
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
This class represents the parameters used for calling the method InitiateAuth on the |
25
|
|
|
|
|
|
|
Amazon Cognito Identity Provider service. Use the attributes of this class |
26
|
|
|
|
|
|
|
as arguments to method InitiateAuth. |
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InitiateAuth. |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
As an example: |
31
|
|
|
|
|
|
|
|
32
|
|
|
|
|
|
|
$service_obj->InitiateAuth(Att1 => $value1, Att2 => $value2, ...); |
33
|
|
|
|
|
|
|
|
34
|
|
|
|
|
|
|
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. |
35
|
|
|
|
|
|
|
|
36
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
37
|
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
|
39
|
|
|
|
|
|
|
=head2 B<REQUIRED> AuthFlow => Str |
40
|
|
|
|
|
|
|
|
41
|
|
|
|
|
|
|
The authentication flow for this call to execute. The API action will |
42
|
|
|
|
|
|
|
depend on this value. For example: |
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
=over |
45
|
|
|
|
|
|
|
|
46
|
|
|
|
|
|
|
=item * |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
C<REFRESH_TOKEN_AUTH> will take in a valid refresh token and return new |
49
|
|
|
|
|
|
|
tokens. |
50
|
|
|
|
|
|
|
|
51
|
|
|
|
|
|
|
=item * |
52
|
|
|
|
|
|
|
|
53
|
|
|
|
|
|
|
C<USER_SRP_AUTH> will take in C<USERNAME> and C<SRP_A> and return the |
54
|
|
|
|
|
|
|
SRP variables to be used for next challenge execution. |
55
|
|
|
|
|
|
|
|
56
|
|
|
|
|
|
|
=back |
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
Valid values include: |
59
|
|
|
|
|
|
|
|
60
|
|
|
|
|
|
|
=over |
61
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
=item * |
63
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
C<USER_SRP_AUTH>: Authentication flow for the Secure Remote Password |
65
|
|
|
|
|
|
|
(SRP) protocol. |
66
|
|
|
|
|
|
|
|
67
|
|
|
|
|
|
|
=item * |
68
|
|
|
|
|
|
|
|
69
|
|
|
|
|
|
|
C<REFRESH_TOKEN_AUTH>/C<REFRESH_TOKEN>: Authentication flow for |
70
|
|
|
|
|
|
|
refreshing the access token and ID token by supplying a valid refresh |
71
|
|
|
|
|
|
|
token. |
72
|
|
|
|
|
|
|
|
73
|
|
|
|
|
|
|
=item * |
74
|
|
|
|
|
|
|
|
75
|
|
|
|
|
|
|
C<CUSTOM_AUTH>: Custom authentication flow. |
76
|
|
|
|
|
|
|
|
77
|
|
|
|
|
|
|
=back |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
C<ADMIN_NO_SRP_AUTH> is not a valid value. |
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
Valid values are: C<"USER_SRP_AUTH">, C<"REFRESH_TOKEN_AUTH">, C<"REFRESH_TOKEN">, C<"CUSTOM_AUTH">, C<"ADMIN_NO_SRP_AUTH"> |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
=head2 AuthParameters => L<Paws::CognitoIdp::AuthParametersType> |
84
|
|
|
|
|
|
|
|
85
|
|
|
|
|
|
|
The authentication parameters. These are inputs corresponding to the |
86
|
|
|
|
|
|
|
C<AuthFlow> that you are invoking. The required values depend on the |
87
|
|
|
|
|
|
|
value of C<AuthFlow>: |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
=over |
90
|
|
|
|
|
|
|
|
91
|
|
|
|
|
|
|
=item * |
92
|
|
|
|
|
|
|
|
93
|
|
|
|
|
|
|
For C<USER_SRP_AUTH>: C<USERNAME> (required), C<SRP_A> (required), |
94
|
|
|
|
|
|
|
C<SECRET_HASH> (required if the app client is configured with a client |
95
|
|
|
|
|
|
|
secret), C<DEVICE_KEY> |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
=item * |
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
For C<REFRESH_TOKEN_AUTH/REFRESH_TOKEN>: C<USERNAME> (required), |
100
|
|
|
|
|
|
|
C<SECRET_HASH> (required if the app client is configured with a client |
101
|
|
|
|
|
|
|
secret), C<REFRESH_TOKEN> (required), C<DEVICE_KEY> |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
=item * |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
For C<CUSTOM_AUTH>: C<USERNAME> (required), C<SECRET_HASH> (if app |
106
|
|
|
|
|
|
|
client is configured with client secret), C<DEVICE_KEY> |
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
=back |
109
|
|
|
|
|
|
|
|
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
|
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
=head2 B<REQUIRED> ClientId => Str |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
The app client ID. |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
|
118
|
|
|
|
|
|
|
|
119
|
|
|
|
|
|
|
=head2 ClientMetadata => L<Paws::CognitoIdp::ClientMetadataType> |
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
This is a random key-value pair map which can contain any key and will |
122
|
|
|
|
|
|
|
be passed to your PreAuthentication Lambda trigger as-is. It can be |
123
|
|
|
|
|
|
|
used to implement additional validations around authentication. |
124
|
|
|
|
|
|
|
|
125
|
|
|
|
|
|
|
|
126
|
|
|
|
|
|
|
|
127
|
|
|
|
|
|
|
|
128
|
|
|
|
|
|
|
=head1 SEE ALSO |
129
|
|
|
|
|
|
|
|
130
|
|
|
|
|
|
|
This class forms part of L<Paws>, documenting arguments for method InitiateAuth in L<Paws::CognitoIdp> |
131
|
|
|
|
|
|
|
|
132
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
133
|
|
|
|
|
|
|
|
134
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
135
|
|
|
|
|
|
|
|
136
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
137
|
|
|
|
|
|
|
|
138
|
|
|
|
|
|
|
=cut |
139
|
|
|
|
|
|
|
|