File Coverage

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