File Coverage

blib/lib/Paws/CognitoIdp/ForgotPassword.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::ForgotPassword;
3 1     1   568 use Moose;
  1         3  
  1         7  
4             has ClientId => (is => 'ro', isa => 'Str', required => 1);
5             has SecretHash => (is => 'ro', isa => 'Str');
6             has Username => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   6017 use MooseX::ClassAttribute;
  1         2  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ForgotPassword');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::ForgotPasswordResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::CognitoIdp::ForgotPassword - Arguments for method ForgotPassword on Paws::CognitoIdp
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method ForgotPassword on the
24             Amazon Cognito Identity Provider service. Use the attributes of this class
25             as arguments to method ForgotPassword.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ForgotPassword.
28              
29             As an example:
30              
31             $service_obj->ForgotPassword(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> ClientId => Str
39              
40             The ID of the client associated with the user pool.
41              
42              
43              
44             =head2 SecretHash => Str
45              
46             A keyed-hash message authentication code (HMAC) calculated using the
47             secret key of a user pool client and username plus the client ID in the
48             message.
49              
50              
51              
52             =head2 B<REQUIRED> Username => Str
53              
54             The user name of the user for whom you want to enter a code to reset a
55             forgotten password.
56              
57              
58              
59              
60             =head1 SEE ALSO
61              
62             This class forms part of L<Paws>, documenting arguments for method ForgotPassword in L<Paws::CognitoIdp>
63              
64             =head1 BUGS and CONTRIBUTIONS
65              
66             The source code is located here: https://github.com/pplu/aws-sdk-perl
67              
68             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
69              
70             =cut
71