File Coverage

blib/lib/Paws/CognitoIdp/UserImportJobType.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::UserImportJobType;
2 1     1   395 use Moose;
  1         4  
  1         6  
3             has CloudWatchLogsRoleArn => (is => 'ro', isa => 'Str');
4             has CompletionDate => (is => 'ro', isa => 'Str');
5             has CompletionMessage => (is => 'ro', isa => 'Str');
6             has CreationDate => (is => 'ro', isa => 'Str');
7             has FailedUsers => (is => 'ro', isa => 'Int');
8             has ImportedUsers => (is => 'ro', isa => 'Int');
9             has JobId => (is => 'ro', isa => 'Str');
10             has JobName => (is => 'ro', isa => 'Str');
11             has PreSignedUrl => (is => 'ro', isa => 'Str');
12             has SkippedUsers => (is => 'ro', isa => 'Int');
13             has StartDate => (is => 'ro', isa => 'Str');
14             has Status => (is => 'ro', isa => 'Str');
15             has UserPoolId => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CognitoIdp::UserImportJobType
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::CognitoIdp::UserImportJobType object:
34              
35             $service_obj->Method(Att1 => { CloudWatchLogsRoleArn => $value, ..., UserPoolId => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::UserImportJobType object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->CloudWatchLogsRoleArn
43              
44             =head1 DESCRIPTION
45              
46             The user import job type.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 CloudWatchLogsRoleArn => Str
52              
53             The role ARN for the Amazon CloudWatch Logging role for the user import
54             job. For more information, see "Creating the CloudWatch Logs IAM Role"
55             in the Amazon Cognito Developer Guide.
56              
57              
58             =head2 CompletionDate => Str
59              
60             The date when the user import job was completed.
61              
62              
63             =head2 CompletionMessage => Str
64              
65             The message returned when the user import job is completed.
66              
67              
68             =head2 CreationDate => Str
69              
70             The date the user import job was created.
71              
72              
73             =head2 FailedUsers => Int
74              
75             The number of users that could not be imported.
76              
77              
78             =head2 ImportedUsers => Int
79              
80             The number of users that were successfully imported.
81              
82              
83             =head2 JobId => Str
84              
85             The job ID for the user import job.
86              
87              
88             =head2 JobName => Str
89              
90             The job name for the user import job.
91              
92              
93             =head2 PreSignedUrl => Str
94              
95             The pre-signed URL to be used to upload the C<.csv> file.
96              
97              
98             =head2 SkippedUsers => Int
99              
100             The number of users that were skipped.
101              
102              
103             =head2 StartDate => Str
104              
105             The date when the user import job was started.
106              
107              
108             =head2 Status => Str
109              
110             The status of the user import job. One of the following:
111              
112             =over
113              
114             =item *
115              
116             C<Created> - The job was created but not started.
117              
118             =item *
119              
120             C<Pending> - A transition state. You have started the job, but it has
121             not begun importing users yet.
122              
123             =item *
124              
125             C<InProgress> - The job has started, and users are being imported.
126              
127             =item *
128              
129             C<Stopping> - You have stopped the job, but the job has not stopped
130             importing users yet.
131              
132             =item *
133              
134             C<Stopped> - You have stopped the job, and the job has stopped
135             importing users.
136              
137             =item *
138              
139             C<Succeeded> - The job has completed successfully.
140              
141             =item *
142              
143             C<Failed> - The job has stopped due to an error.
144              
145             =item *
146              
147             C<Expired> - You created a job, but did not start the job within 24-48
148             hours. All data associated with the job was deleted, and the job cannot
149             be started.
150              
151             =back
152              
153              
154              
155             =head2 UserPoolId => Str
156              
157             The user pool ID for the user pool that the users are being imported
158             into.
159              
160              
161              
162             =head1 SEE ALSO
163              
164             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp>
165              
166             =head1 BUGS and CONTRIBUTIONS
167              
168             The source code is located here: https://github.com/pplu/aws-sdk-perl
169              
170             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
171              
172             =cut
173