| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Forecast::ForecastExportJobSummary; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has Destination => (is => 'ro', isa => 'Paws::Forecast::DataDestination'); | ||
| 6 | has ForecastExportJobArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has ForecastExportJobName => (is => 'ro', isa => 'Str'); | ||
| 8 | has LastModificationTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has Message => (is => 'ro', isa => 'Str'); | ||
| 10 | has Status => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Forecast::ForecastExportJobSummary | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::Forecast::ForecastExportJobSummary object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { CreationTime => $value, ..., Status => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::Forecast::ForecastExportJobSummary object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->CreationTime | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Provides a summary of the forecast export job properties used in the | ||
| 43 | ListForecastExportJobs operation. To get the complete set of | ||
| 44 | properties, call the DescribeForecastExportJob operation, and provide | ||
| 45 | the listed C<ForecastExportJobArn>. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 CreationTime => Str | ||
| 51 | |||
| 52 | When the forecast export job was created. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Destination => L<Paws::Forecast::DataDestination> | ||
| 56 | |||
| 57 | The path to the Amazon Simple Storage Service (Amazon S3) bucket where | ||
| 58 | the forecast is exported. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ForecastExportJobArn => Str | ||
| 62 | |||
| 63 | The Amazon Resource Name (ARN) of the forecast export job. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ForecastExportJobName => Str | ||
| 67 | |||
| 68 | The name of the forecast export job. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 LastModificationTime => Str | ||
| 72 | |||
| 73 | The last time the resource was modified. The timestamp depends on the | ||
| 74 | status of the job: | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | C<CREATE_PENDING> - The C<CreationTime>. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<CREATE_IN_PROGRESS> - The current timestamp. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<CREATE_STOPPING> - The current timestamp. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<CREATE_STOPPED> - When the job stopped. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<ACTIVE> or C<CREATE_FAILED> - When the job finished or failed. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Message => Str | ||
| 103 | |||
| 104 | If an error occurred, an informational message about the error. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Status => Str | ||
| 108 | |||
| 109 | The status of the forecast export job. States include: | ||
| 110 | |||
| 111 | =over | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<ACTIVE> | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<CREATE_PENDING>, C<CREATE_IN_PROGRESS>, C<CREATE_FAILED> | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<CREATE_STOPPING>, C<CREATE_STOPPED> | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<DELETE_PENDING>, C<DELETE_IN_PROGRESS>, C<DELETE_FAILED> | ||
| 128 | |||
| 129 | =back | ||
| 130 | |||
| 131 | The C<Status> of the forecast export job must be C<ACTIVE> before you | ||
| 132 | can access the forecast in your S3 bucket. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head1 SEE ALSO | ||
| 137 | |||
| 138 | This class forms part of L<Paws>, describing an object used in L<Paws::Forecast> | ||
| 139 | |||
| 140 | =head1 BUGS and CONTRIBUTIONS | ||
| 141 | |||
| 142 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 143 | |||
| 144 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 145 | |||
| 146 | =cut | ||
| 147 |