File Coverage

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