File Coverage

blib/lib/Paws/CognitoIdp/ConfirmForgotPassword.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::ConfirmForgotPassword;
3 1     1   513 use Moose;
  1         2  
  1         8  
4             has ClientId => (is => 'ro', isa => 'Str', required => 1);
5             has ConfirmationCode => (is => 'ro', isa => 'Str', required => 1);
6             has Password => (is => 'ro', isa => 'Str', required => 1);
7             has SecretHash => (is => 'ro', isa => 'Str');
8             has Username => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   6972 use MooseX::ClassAttribute;
  1         4  
  1         12  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ConfirmForgotPassword');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::ConfirmForgotPasswordResponse');
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::ConfirmForgotPassword - Arguments for method ConfirmForgotPassword on Paws::CognitoIdp
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ConfirmForgotPassword on the
26             Amazon Cognito Identity Provider service. Use the attributes of this class
27             as arguments to method ConfirmForgotPassword.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ConfirmForgotPassword.
30              
31             As an example:
32              
33             $service_obj->ConfirmForgotPassword(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> ClientId => Str
41              
42             The app client ID of the app associated with the user pool.
43              
44              
45              
46             =head2 B<REQUIRED> ConfirmationCode => Str
47              
48             The confirmation code sent by a user's request to retrieve a forgotten
49             password. For more information, see ForgotPassword
50              
51              
52              
53             =head2 B<REQUIRED> Password => Str
54              
55             The password sent by a user's request to retrieve a forgotten password.
56              
57              
58              
59             =head2 SecretHash => Str
60              
61             A keyed-hash message authentication code (HMAC) calculated using the
62             secret key of a user pool client and username plus the client ID in the
63             message.
64              
65              
66              
67             =head2 B<REQUIRED> Username => Str
68              
69             The user name of the user for whom you want to enter a code to retrieve
70             a forgotten password.
71              
72              
73              
74              
75             =head1 SEE ALSO
76              
77             This class forms part of L<Paws>, documenting arguments for method ConfirmForgotPassword in L<Paws::CognitoIdp>
78              
79             =head1 BUGS and CONTRIBUTIONS
80              
81             The source code is located here: https://github.com/pplu/aws-sdk-perl
82              
83             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
84              
85             =cut
86