File Coverage

blib/lib/Paws/CognitoIdp/AdminRespondToAuthChallenge.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::AdminRespondToAuthChallenge;
3 1     1   901 use Moose;
  1         2  
  1         7  
4             has ChallengeName => (is => 'ro', isa => 'Str', required => 1);
5             has ChallengeResponses => (is => 'ro', isa => 'Paws::CognitoIdp::ChallengeResponsesType');
6             has ClientId => (is => 'ro', isa => 'Str', required => 1);
7             has Session => (is => 'ro', isa => 'Str');
8             has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   6300 use MooseX::ClassAttribute;
  1         2  
  1         9  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'AdminRespondToAuthChallenge');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::AdminRespondToAuthChallengeResponse');
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::AdminRespondToAuthChallenge - Arguments for method AdminRespondToAuthChallenge on Paws::CognitoIdp
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method AdminRespondToAuthChallenge on the
26             Amazon Cognito Identity Provider service. Use the attributes of this class
27             as arguments to method AdminRespondToAuthChallenge.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AdminRespondToAuthChallenge.
30              
31             As an example:
32              
33             $service_obj->AdminRespondToAuthChallenge(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> ChallengeName => Str
41              
42             The challenge name. For more information, see AdminInitiateAuth.
43              
44             Valid values are: C<"SMS_MFA">, C<"PASSWORD_VERIFIER">, C<"CUSTOM_CHALLENGE">, C<"DEVICE_SRP_AUTH">, C<"DEVICE_PASSWORD_VERIFIER">, C<"ADMIN_NO_SRP_AUTH">, C<"NEW_PASSWORD_REQUIRED">
45              
46             =head2 ChallengeResponses => L<Paws::CognitoIdp::ChallengeResponsesType>
47              
48             The challenge responses. These are inputs corresponding to the value of
49             C<ChallengeName>, for example:
50              
51             =over
52              
53             =item *
54              
55             C<SMS_MFA>: C<SMS_MFA_CODE>, C<USERNAME>, C<SECRET_HASH> (if app client
56             is configured with client secret).
57              
58             =item *
59              
60             C<PASSWORD_VERIFIER>: C<PASSWORD_CLAIM_SIGNATURE>,
61             C<PASSWORD_CLAIM_SECRET_BLOCK>, C<TIMESTAMP>, C<USERNAME>,
62             C<SECRET_HASH> (if app client is configured with client secret).
63              
64             =item *
65              
66             C<ADMIN_NO_SRP_AUTH>: C<PASSWORD>, C<USERNAME>, C<SECRET_HASH> (if app
67             client is configured with client secret).
68              
69             =item *
70              
71             C<NEW_PASSWORD_REQUIRED>: C<NEW_PASSWORD>, any other required
72             attributes, C<USERNAME>, C<SECRET_HASH> (if app client is configured
73             with client secret).
74              
75             =back
76              
77             The value of the C<USERNAME> attribute must be the user's actual
78             username, not an alias (such as email address or phone number). To make
79             this easier, the C<AdminInitiateAuth> response includes the actual
80             username value in the C<USERNAMEUSER_ID_FOR_SRP> attribute, even if you
81             specified an alias in your call to C<AdminInitiateAuth>.
82              
83              
84              
85             =head2 B<REQUIRED> ClientId => Str
86              
87             The app client ID.
88              
89              
90              
91             =head2 Session => Str
92              
93             The session which should be passed both ways in challenge-response
94             calls to the service. If C<InitiateAuth> or C<RespondToAuthChallenge>
95             API call determines that the caller needs to go through another
96             challenge, they return a session with other challenge parameters. This
97             session should be passed as it is to the next C<RespondToAuthChallenge>
98             API call.
99              
100              
101              
102             =head2 B<REQUIRED> UserPoolId => Str
103              
104             The ID of the Amazon Cognito user pool.
105              
106              
107              
108              
109             =head1 SEE ALSO
110              
111             This class forms part of L<Paws>, documenting arguments for method AdminRespondToAuthChallenge in L<Paws::CognitoIdp>
112              
113             =head1 BUGS and CONTRIBUTIONS
114              
115             The source code is located here: https://github.com/pplu/aws-sdk-perl
116              
117             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
118              
119             =cut
120