« blib/lib/Paws/Forecast/DescribeForecastExportJobResponse.pm
↑ Summary
blib/lib/Paws/Forecast/DescribePredictor.pm »
| 1 | |||
| 2 | package Paws::Forecast::DescribeForecastResponse; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has DatasetGroupArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has EstimatedTimeRemainingInMinutes => (is => 'ro', isa => 'Int'); | ||
| 7 | has ForecastArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has ForecastName => (is => 'ro', isa => 'Str'); | ||
| 9 | has ForecastTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has LastModificationTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has Message => (is => 'ro', isa => 'Str'); | ||
| 12 | has PredictorArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Forecast::DescribeForecastResponse | ||
| 22 | |||
| 23 | =head1 ATTRIBUTES | ||
| 24 | |||
| 25 | |||
| 26 | =head2 CreationTime => Str | ||
| 27 | |||
| 28 | When the forecast creation task was created. | ||
| 29 | |||
| 30 | |||
| 31 | =head2 DatasetGroupArn => Str | ||
| 32 | |||
| 33 | The ARN of the dataset group that provided the data used to train the | ||
| 34 | predictor. | ||
| 35 | |||
| 36 | |||
| 37 | =head2 EstimatedTimeRemainingInMinutes => Int | ||
| 38 | |||
| 39 | The estimated time remaining in minutes for the forecast job to | ||
| 40 | complete. | ||
| 41 | |||
| 42 | |||
| 43 | =head2 ForecastArn => Str | ||
| 44 | |||
| 45 | The forecast ARN as specified in the request. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ForecastName => Str | ||
| 49 | |||
| 50 | The name of the forecast. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ForecastTypes => ArrayRef[Str|Undef] | ||
| 54 | |||
| 55 | The quantiles at which probabilistic forecasts were generated. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 LastModificationTime => Str | ||
| 59 | |||
| 60 | The last time the resource was modified. The timestamp depends on the | ||
| 61 | status of the job: | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | C<CREATE_PENDING> - The C<CreationTime>. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<CREATE_IN_PROGRESS> - The current timestamp. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | C<CREATE_STOPPING> - The current timestamp. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<CREATE_STOPPED> - When the job stopped. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<ACTIVE> or C<CREATE_FAILED> - When the job finished or failed. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Message => Str | ||
| 90 | |||
| 91 | If an error occurred, an informational message about the error. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 PredictorArn => Str | ||
| 95 | |||
| 96 | The ARN of the predictor used to generate the forecast. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Status => Str | ||
| 100 | |||
| 101 | The status of the forecast. States include: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<ACTIVE> | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<CREATE_PENDING>, C<CREATE_IN_PROGRESS>, C<CREATE_FAILED> | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<CREATE_STOPPING>, C<CREATE_STOPPED> | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<DELETE_PENDING>, C<DELETE_IN_PROGRESS>, C<DELETE_FAILED> | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | The C<Status> of the forecast must be C<ACTIVE> before you can query or | ||
| 124 | export the forecast. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 _request_id => Str | ||
| 128 | |||
| 129 | |||
| 130 | =cut | ||
| 131 | |||
| 132 | 1; |