File Coverage

blib/lib/Paws/CognitoIdp/SignUp.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::SignUp;
3 1     1   528 use Moose;
  1         3  
  1         6  
4             has ClientId => (is => 'ro', isa => 'Str', required => 1);
5             has Password => (is => 'ro', isa => 'Str', required => 1);
6             has SecretHash => (is => 'ro', isa => 'Str');
7             has UserAttributes => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::AttributeType]');
8             has Username => (is => 'ro', isa => 'Str', required => 1);
9             has ValidationData => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::AttributeType]');
10              
11 1     1   6207 use MooseX::ClassAttribute;
  1         3  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SignUp');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::SignUpResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CognitoIdp::SignUp - Arguments for method SignUp on Paws::CognitoIdp
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method SignUp on the
27             Amazon Cognito Identity Provider service. Use the attributes of this class
28             as arguments to method SignUp.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SignUp.
31              
32             As an example:
33              
34             $service_obj->SignUp(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> ClientId => Str
42              
43             The ID of the client associated with the user pool.
44              
45              
46              
47             =head2 B<REQUIRED> Password => Str
48              
49             The password of the user you wish to register.
50              
51              
52              
53             =head2 SecretHash => Str
54              
55             A keyed-hash message authentication code (HMAC) calculated using the
56             secret key of a user pool client and username plus the client ID in the
57             message.
58              
59              
60              
61             =head2 UserAttributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>]
62              
63             An array of name-value pairs representing user attributes.
64              
65             For custom attributes, you must prepend the C<custom:> prefix to the
66             attribute name.
67              
68              
69              
70             =head2 B<REQUIRED> Username => Str
71              
72             The user name of the user you wish to register.
73              
74              
75              
76             =head2 ValidationData => ArrayRef[L<Paws::CognitoIdp::AttributeType>]
77              
78             The validation data in the request to register a user.
79              
80              
81              
82              
83             =head1 SEE ALSO
84              
85             This class forms part of L<Paws>, documenting arguments for method SignUp in L<Paws::CognitoIdp>
86              
87             =head1 BUGS and CONTRIBUTIONS
88              
89             The source code is located here: https://github.com/pplu/aws-sdk-perl
90              
91             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
92              
93             =cut
94