File Coverage

blib/lib/Paws/MachineLearning/BatchPrediction.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	sub	time	code
1				package Paws::MachineLearning::BatchPrediction;
2	1	1	494	use Moose;
	1		3
	1		8
3				has BatchPredictionDataSourceId => (is => 'ro', isa => 'Str');
4				has BatchPredictionId => (is => 'ro', isa => 'Str');
5				has ComputeTime => (is => 'ro', isa => 'Int');
6				has CreatedAt => (is => 'ro', isa => 'Str');
7				has CreatedByIamUser => (is => 'ro', isa => 'Str');
8				has FinishedAt => (is => 'ro', isa => 'Str');
9				has InputDataLocationS3 => (is => 'ro', isa => 'Str');
10				has InvalidRecordCount => (is => 'ro', isa => 'Int');
11				has LastUpdatedAt => (is => 'ro', isa => 'Str');
12				has Message => (is => 'ro', isa => 'Str');
13				has MLModelId => (is => 'ro', isa => 'Str');
14				has Name => (is => 'ro', isa => 'Str');
15				has OutputUri => (is => 'ro', isa => 'Str');
16				has StartedAt => (is => 'ro', isa => 'Str');
17				has Status => (is => 'ro', isa => 'Str');
18				has TotalRecordCount => (is => 'ro', isa => 'Int');
19				1;
20
21				### main pod documentation begin ###
22
23				=head1 NAME
24
25				Paws::MachineLearning::BatchPrediction
26
27				=head1 USAGE
28
29				This class represents one of two things:
30
31				=head3 Arguments in a call to a service
32
33				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34				Each attribute should be used as a named argument in the calls that expect this type of object.
35
36				As an example, if Att1 is expected to be a Paws::MachineLearning::BatchPrediction object:
37
38				$service_obj->Method(Att1 => { BatchPredictionDataSourceId => $value, ..., TotalRecordCount => $value });
39
40				=head3 Results returned from an API call
41
42				Use accessors for each attribute. If Att1 is expected to be an Paws::MachineLearning::BatchPrediction object:
43
44				$result = $service_obj->Method(...);
45				$result->Att1->BatchPredictionDataSourceId
46
47				=head1 DESCRIPTION
48
49				Represents the output of a C<GetBatchPrediction> operation.
50
51				The content consists of the detailed metadata, the status, and the data
52				file information of a C<Batch Prediction>.
53
54				=head1 ATTRIBUTES
55
56
57				=head2 BatchPredictionDataSourceId => Str
58
59				The ID of the C<DataSource> that points to the group of observations to
60				predict.
61
62
63				=head2 BatchPredictionId => Str
64
65				The ID assigned to the C<BatchPrediction> at creation. This value
66				should be identical to the value of the C<BatchPredictionID> in the
67				request.
68
69
70				=head2 ComputeTime => Int
71
72
73
74
75				=head2 CreatedAt => Str
76
77				The time that the C<BatchPrediction> was created. The time is expressed
78				in epoch time.
79
80
81				=head2 CreatedByIamUser => Str
82
83				The AWS user account that invoked the C<BatchPrediction>. The account
84				type can be either an AWS root account or an AWS Identity and Access
85				Management (IAM) user account.
86
87
88				=head2 FinishedAt => Str
89
90
91
92
93				=head2 InputDataLocationS3 => Str
94
95				The location of the data file or directory in Amazon Simple Storage
96				Service (Amazon S3).
97
98
99				=head2 InvalidRecordCount => Int
100
101
102
103
104				=head2 LastUpdatedAt => Str
105
106				The time of the most recent edit to the C<BatchPrediction>. The time is
107				expressed in epoch time.
108
109
110				=head2 Message => Str
111
112				A description of the most recent details about processing the batch
113				prediction request.
114
115
116				=head2 MLModelId => Str
117
118				The ID of the C<MLModel> that generated predictions for the
119				C<BatchPrediction> request.
120
121
122				=head2 Name => Str
123
124				A user-supplied name or description of the C<BatchPrediction>.
125
126
127				=head2 OutputUri => Str
128
129				The location of an Amazon S3 bucket or directory to receive the
130				operation results. The following substrings are not allowed in the C<s3
131				key> portion of the C<outputURI> field: ':', '//', '/./', '/../'.
132
133
134				=head2 StartedAt => Str
135
136
137
138
139				=head2 Status => Str
140
141				The status of the C<BatchPrediction>. This element can have one of the
142				following values:
143
144				=over
145
146				=item * C<PENDING> - Amazon Machine Learning (Amazon ML) submitted a
147				request to generate predictions for a batch of observations.
148
149				=item * C<INPROGRESS> - The process is underway.
150
151				=item * C<FAILED> - The request to perform a batch prediction did not
152				run to completion. It is not usable.
153
154				=item * C<COMPLETED> - The batch prediction process completed
155				successfully.
156
157				=item * C<DELETED> - The C<BatchPrediction> is marked as deleted. It is
158				not usable.
159
160				=back
161
162
163
164				=head2 TotalRecordCount => Int
165
166
167
168
169
170				=head1 SEE ALSO
171
172				This class forms part of L<Paws>, describing an object used in L<Paws::MachineLearning>
173
174				=head1 BUGS and CONTRIBUTIONS
175
176				The source code is located here: https://github.com/pplu/aws-sdk-perl
177
178				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
179
180				=cut
181