blib/lib/Paws/Forecast/ForecastSummary.pm untested

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