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