« blib/lib/Paws/Forecast/DescribePredictorBacktestExportJobResponse.pm
↑ Summary
blib/lib/Paws/Forecast/EncryptionConfig.pm »
| 1 | |||
| 2 | package Paws::Forecast::DescribePredictorResponse; | ||
| 3 | use Moose; | ||
| 4 | has AlgorithmArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has AutoMLAlgorithmArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has AutoMLOverrideStrategy => (is => 'ro', isa => 'Str'); | ||
| 7 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has DatasetImportJobArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has EncryptionConfig => (is => 'ro', isa => 'Paws::Forecast::EncryptionConfig'); | ||
| 10 | has EstimatedTimeRemainingInMinutes => (is => 'ro', isa => 'Int'); | ||
| 11 | has EvaluationParameters => (is => 'ro', isa => 'Paws::Forecast::EvaluationParameters'); | ||
| 12 | has FeaturizationConfig => (is => 'ro', isa => 'Paws::Forecast::FeaturizationConfig'); | ||
| 13 | has ForecastHorizon => (is => 'ro', isa => 'Int'); | ||
| 14 | has ForecastTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | has HPOConfig => (is => 'ro', isa => 'Paws::Forecast::HyperParameterTuningJobConfig'); | ||
| 16 | has InputDataConfig => (is => 'ro', isa => 'Paws::Forecast::InputDataConfig'); | ||
| 17 | has LastModificationTime => (is => 'ro', isa => 'Str'); | ||
| 18 | has Message => (is => 'ro', isa => 'Str'); | ||
| 19 | has PerformAutoML => (is => 'ro', isa => 'Bool'); | ||
| 20 | has PerformHPO => (is => 'ro', isa => 'Bool'); | ||
| 21 | has PredictorArn => (is => 'ro', isa => 'Str'); | ||
| 22 | has PredictorExecutionDetails => (is => 'ro', isa => 'Paws::Forecast::PredictorExecutionDetails'); | ||
| 23 | has PredictorName => (is => 'ro', isa => 'Str'); | ||
| 24 | has Status => (is => 'ro', isa => 'Str'); | ||
| 25 | has TrainingParameters => (is => 'ro', isa => 'Paws::Forecast::TrainingParameters'); | ||
| 26 | |||
| 27 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::Forecast::DescribePredictorResponse | ||
| 34 | |||
| 35 | =head1 ATTRIBUTES | ||
| 36 | |||
| 37 | |||
| 38 | =head2 AlgorithmArn => Str | ||
| 39 | |||
| 40 | The Amazon Resource Name (ARN) of the algorithm used for model | ||
| 41 | training. | ||
| 42 | |||
| 43 | |||
| 44 | =head2 AutoMLAlgorithmArns => ArrayRef[Str|Undef] | ||
| 45 | |||
| 46 | When C<PerformAutoML> is specified, the ARN of the chosen algorithm. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 AutoMLOverrideStrategy => Str | ||
| 50 | |||
| 51 | The AutoML strategy used to train the predictor. Unless | ||
| 52 | C<LatencyOptimized> is specified, the AutoML strategy optimizes | ||
| 53 | predictor accuracy. | ||
| 54 | |||
| 55 | This parameter is only valid for predictors trained using AutoML. | ||
| 56 | |||
| 57 | Valid values are: C<"LatencyOptimized"> | ||
| 58 | =head2 CreationTime => Str | ||
| 59 | |||
| 60 | When the model training task was created. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DatasetImportJobArns => ArrayRef[Str|Undef] | ||
| 64 | |||
| 65 | An array of the ARNs of the dataset import jobs used to import training | ||
| 66 | data for the predictor. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 EncryptionConfig => L<Paws::Forecast::EncryptionConfig> | ||
| 70 | |||
| 71 | An AWS Key Management Service (KMS) key and the AWS Identity and Access | ||
| 72 | Management (IAM) role that Amazon Forecast can assume to access the | ||
| 73 | key. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 EstimatedTimeRemainingInMinutes => Int | ||
| 77 | |||
| 78 | The estimated time remaining in minutes for the predictor training job | ||
| 79 | to complete. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 EvaluationParameters => L<Paws::Forecast::EvaluationParameters> | ||
| 83 | |||
| 84 | Used to override the default evaluation parameters of the specified | ||
| 85 | algorithm. Amazon Forecast evaluates a predictor by splitting a dataset | ||
| 86 | into training data and testing data. The evaluation parameters define | ||
| 87 | how to perform the split and the number of iterations. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 FeaturizationConfig => L<Paws::Forecast::FeaturizationConfig> | ||
| 91 | |||
| 92 | The featurization configuration. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 ForecastHorizon => Int | ||
| 96 | |||
| 97 | The number of time-steps of the forecast. The forecast horizon is also | ||
| 98 | called the prediction length. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 ForecastTypes => ArrayRef[Str|Undef] | ||
| 102 | |||
| 103 | The forecast types used during predictor training. Default value is | ||
| 104 | C<["0.1","0.5","0.9"]> | ||
| 105 | |||
| 106 | |||
| 107 | =head2 HPOConfig => L<Paws::Forecast::HyperParameterTuningJobConfig> | ||
| 108 | |||
| 109 | The hyperparameter override values for the algorithm. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 InputDataConfig => L<Paws::Forecast::InputDataConfig> | ||
| 113 | |||
| 114 | Describes the dataset group that contains the data to use to train the | ||
| 115 | predictor. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 LastModificationTime => Str | ||
| 119 | |||
| 120 | The last time the resource was modified. The timestamp depends on the | ||
| 121 | status of the job: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<CREATE_PENDING> - The C<CreationTime>. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<CREATE_IN_PROGRESS> - The current timestamp. | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | C<CREATE_STOPPING> - The current timestamp. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<CREATE_STOPPED> - When the job stopped. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<ACTIVE> or C<CREATE_FAILED> - When the job finished or failed. | ||
| 144 | |||
| 145 | =back | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 Message => Str | ||
| 150 | |||
| 151 | If an error occurred, an informational message about the error. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 PerformAutoML => Bool | ||
| 155 | |||
| 156 | Whether the predictor is set to perform AutoML. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 PerformHPO => Bool | ||
| 160 | |||
| 161 | Whether the predictor is set to perform hyperparameter optimization | ||
| 162 | (HPO). | ||
| 163 | |||
| 164 | |||
| 165 | =head2 PredictorArn => Str | ||
| 166 | |||
| 167 | The ARN of the predictor. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 PredictorExecutionDetails => L<Paws::Forecast::PredictorExecutionDetails> | ||
| 171 | |||
| 172 | Details on the the status and results of the backtests performed to | ||
| 173 | evaluate the accuracy of the predictor. You specify the number of | ||
| 174 | backtests to perform when you call the operation. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 PredictorName => Str | ||
| 178 | |||
| 179 | The name of the predictor. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 Status => Str | ||
| 183 | |||
| 184 | The status of the predictor. States include: | ||
| 185 | |||
| 186 | =over | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<ACTIVE> | ||
| 191 | |||
| 192 | =item * | ||
| 193 | |||
| 194 | C<CREATE_PENDING>, C<CREATE_IN_PROGRESS>, C<CREATE_FAILED> | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | C<DELETE_PENDING>, C<DELETE_IN_PROGRESS>, C<DELETE_FAILED> | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | C<CREATE_STOPPING>, C<CREATE_STOPPED> | ||
| 203 | |||
| 204 | =back | ||
| 205 | |||
| 206 | The C<Status> of the predictor must be C<ACTIVE> before you can use the | ||
| 207 | predictor to create a forecast. | ||
| 208 | |||
| 209 | |||
| 210 | =head2 TrainingParameters => L<Paws::Forecast::TrainingParameters> | ||
| 211 | |||
| 212 | The default training parameters or overrides selected during model | ||
| 213 | training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, | ||
| 214 | the optimized values for the chosen hyperparameters are returned. For | ||
| 215 | more information, see aws-forecast-choosing-recipes. | ||
| 216 | |||
| 217 | |||
| 218 | =head2 _request_id => Str | ||
| 219 | |||
| 220 | |||
| 221 | =cut | ||
| 222 | |||
| 223 | 1; |