File Coverage

blib/lib/Paws/CognitoIdp/ConfirmSignUp.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::ConfirmSignUp;
3 1     1   297 use Moose;
  1         3  
  1         5  
4             has ClientId => (is => 'ro', isa => 'Str', required => 1);
5             has ConfirmationCode => (is => 'ro', isa => 'Str', required => 1);
6             has ForceAliasCreation => (is => 'ro', isa => 'Bool');
7             has SecretHash => (is => 'ro', isa => 'Str');
8             has Username => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   5338 use MooseX::ClassAttribute;
  1         2  
  1         6  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ConfirmSignUp');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::ConfirmSignUpResponse');
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::ConfirmSignUp - Arguments for method ConfirmSignUp on Paws::CognitoIdp
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ConfirmSignUp on the
26             Amazon Cognito Identity Provider service. Use the attributes of this class
27             as arguments to method ConfirmSignUp.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ConfirmSignUp.
30              
31             As an example:
32              
33             $service_obj->ConfirmSignUp(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 ID of the app client 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 confirm registration.
49              
50              
51              
52             =head2 ForceAliasCreation => Bool
53              
54             Boolean to be specified to force user confirmation irrespective of
55             existing alias. By default set to C<False>. If this parameter is set to
56             C<True> and the phone number/email used for sign up confirmation
57             already exists as an alias with a different user, the API call will
58             migrate the alias from the previous user to the newly created user
59             being confirmed. If set to C<False>, the API will throw an
60             B<AliasExistsException> error.
61              
62              
63              
64             =head2 SecretHash => Str
65              
66             A keyed-hash message authentication code (HMAC) calculated using the
67             secret key of a user pool client and username plus the client ID in the
68             message.
69              
70              
71              
72             =head2 B<REQUIRED> Username => Str
73              
74             The user name of the user whose registration you wish to confirm.
75              
76              
77              
78              
79             =head1 SEE ALSO
80              
81             This class forms part of L<Paws>, documenting arguments for method ConfirmSignUp in L<Paws::CognitoIdp>
82              
83             =head1 BUGS and CONTRIBUTIONS
84              
85             The source code is located here: https://github.com/pplu/aws-sdk-perl
86              
87             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
88              
89             =cut
90