File Coverage

blib/lib/Paws/CognitoIdp/UserType.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CognitoIdp::UserType;
2 1     1   416 use Moose;
  1         2  
  1         6  
3             has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::AttributeType]');
4             has Enabled => (is => 'ro', isa => 'Bool');
5             has MFAOptions => (is => 'ro', isa => 'ArrayRef[Paws::CognitoIdp::MFAOptionType]');
6             has UserCreateDate => (is => 'ro', isa => 'Str');
7             has UserLastModifiedDate => (is => 'ro', isa => 'Str');
8             has Username => (is => 'ro', isa => 'Str');
9             has UserStatus => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::CognitoIdp::UserType
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::CognitoIdp::UserType object:
28              
29             $service_obj->Method(Att1 => { Attributes => $value, ..., UserStatus => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserType object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Attributes
37              
38             =head1 DESCRIPTION
39              
40             The user type.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 Attributes => ArrayRef[L<Paws::CognitoIdp::AttributeType>]
46              
47             A container with information about the user type attributes.
48              
49              
50             =head2 Enabled => Bool
51              
52             Specifies whether the user is enabled.
53              
54              
55             =head2 MFAOptions => ArrayRef[L<Paws::CognitoIdp::MFAOptionType>]
56              
57             The MFA options for the user.
58              
59              
60             =head2 UserCreateDate => Str
61              
62             The creation date of the user.
63              
64              
65             =head2 UserLastModifiedDate => Str
66              
67             The last modified date of the user.
68              
69              
70             =head2 Username => Str
71              
72             The user name of the user you wish to describe.
73              
74              
75             =head2 UserStatus => Str
76              
77             The user status. Can be one of the following:
78              
79             =over
80              
81             =item *
82              
83             UNCONFIRMED - User has been created but not confirmed.
84              
85             =item *
86              
87             CONFIRMED - User has been confirmed.
88              
89             =item *
90              
91             ARCHIVED - User is no longer active.
92              
93             =item *
94              
95             COMPROMISED - User is disabled due to a potential security threat.
96              
97             =item *
98              
99             UNKNOWN - User status is not known.
100              
101             =back
102              
103              
104              
105              
106             =head1 SEE ALSO
107              
108             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
109              
110             =head1 BUGS and CONTRIBUTIONS
111              
112             The source code is located here: https://github.com/pplu/aws-sdk-perl
113              
114             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
115              
116             =cut
117