File Coverage

blib/lib/Paws/CognitoIdp/UpdateUserPool.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	sub	time	code
1
2				package Paws::CognitoIdp::UpdateUserPool;
3	1	1	552	use Moose;
	1		2
	1		8
4				has AdminCreateUserConfig => (is => 'ro', isa => 'Paws::CognitoIdp::AdminCreateUserConfigType');
5				has AutoVerifiedAttributes => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
6				has DeviceConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::DeviceConfigurationType');
7				has EmailConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::EmailConfigurationType');
8				has EmailVerificationMessage => (is => 'ro', isa => 'Str');
9				has EmailVerificationSubject => (is => 'ro', isa => 'Str');
10				has LambdaConfig => (is => 'ro', isa => 'Paws::CognitoIdp::LambdaConfigType');
11				has MfaConfiguration => (is => 'ro', isa => 'Str');
12				has Policies => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolPolicyType');
13				has SmsAuthenticationMessage => (is => 'ro', isa => 'Str');
14				has SmsConfiguration => (is => 'ro', isa => 'Paws::CognitoIdp::SmsConfigurationType');
15				has SmsVerificationMessage => (is => 'ro', isa => 'Str');
16				has UserPoolId => (is => 'ro', isa => 'Str', required => 1);
17				has UserPoolTags => (is => 'ro', isa => 'Paws::CognitoIdp::UserPoolTagsType');
18
19	1	1	6276	use MooseX::ClassAttribute;
	1		2
	1		8
20
21				class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateUserPool');
22				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CognitoIdp::UpdateUserPoolResponse');
23				class_has _result_key => (isa => 'Str', is => 'ro');
24				1;
25
26				### main pod documentation begin ###
27
28				=head1 NAME
29
30				Paws::CognitoIdp::UpdateUserPool - Arguments for method UpdateUserPool on Paws::CognitoIdp
31
32				=head1 DESCRIPTION
33
34				This class represents the parameters used for calling the method UpdateUserPool on the
35				Amazon Cognito Identity Provider service. Use the attributes of this class
36				as arguments to method UpdateUserPool.
37
38				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateUserPool.
39
40				As an example:
41
42				$service_obj->UpdateUserPool(Att1 => $value1, Att2 => $value2, ...);
43
44				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.
45
46				=head1 ATTRIBUTES
47
48
49				=head2 AdminCreateUserConfig => L<Paws::CognitoIdp::AdminCreateUserConfigType>
50
51				The configuration for C<AdminCreateUser> requests.
52
53
54
55				=head2 AutoVerifiedAttributes => ArrayRef[Str\|Undef]
56
57				The attributes that are automatically verified when the Amazon Cognito
58				service makes a request to update user pools.
59
60
61
62				=head2 DeviceConfiguration => L<Paws::CognitoIdp::DeviceConfigurationType>
63
64				Device configuration.
65
66
67
68				=head2 EmailConfiguration => L<Paws::CognitoIdp::EmailConfigurationType>
69
70				Email configuration.
71
72
73
74				=head2 EmailVerificationMessage => Str
75
76				The contents of the email verification message.
77
78
79
80				=head2 EmailVerificationSubject => Str
81
82				The subject of the email verification message.
83
84
85
86				=head2 LambdaConfig => L<Paws::CognitoIdp::LambdaConfigType>
87
88				The AWS Lambda configuration information from the request to update the
89				user pool.
90
91
92
93				=head2 MfaConfiguration => Str
94
95				Can be one of the following values:
96
97				=over
98
99				=item *
100
101				C<OFF> - MFA tokens are not required and cannot be specified during
102				user registration.
103
104				=item *
105
106				C<ON> - MFA tokens are required for all user registrations. You can
107				only specify required when you are initially creating a user pool.
108
109				=item *
110
111				C<OPTIONAL> - Users have the option when registering to create an MFA
112				token.
113
114				=back
115
116
117				Valid values are: C<"OFF">, C<"ON">, C<"OPTIONAL">
118
119				=head2 Policies => L<Paws::CognitoIdp::UserPoolPolicyType>
120
121				A container with the policies you wish to update in a user pool.
122
123
124
125				=head2 SmsAuthenticationMessage => Str
126
127				The contents of the SMS authentication message.
128
129
130
131				=head2 SmsConfiguration => L<Paws::CognitoIdp::SmsConfigurationType>
132
133				SMS configuration.
134
135
136
137				=head2 SmsVerificationMessage => Str
138
139				A container with information about the SMS verification message.
140
141
142
143				=head2 B<REQUIRED> UserPoolId => Str
144
145				The user pool ID for the user pool you want to update.
146
147
148
149				=head2 UserPoolTags => L<Paws::CognitoIdp::UserPoolTagsType>
150
151				The cost allocation tags for the user pool. For more information, see
152				Adding Cost Allocation Tags to Your User Pool
153
154
155
156
157				=head1 SEE ALSO
158
159				This class forms part of L<Paws>, documenting arguments for method UpdateUserPool in L<Paws::CognitoIdp>
160
161				=head1 BUGS and CONTRIBUTIONS
162
163				The source code is located here: https://github.com/pplu/aws-sdk-perl
164
165				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
166
167				=cut
168