blib/lib/Paws/Forecast.pm untested

filter: Statementstmt 0.0% 0 / 260 Branchbran 0.0% 0 / 28 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 49 Podpod 0.0% 0 / 48 totaltotal 0.0% 0 / 385 CC 15 SCAR 16.7
CC
15
Cov
0%
ListAllDatasetGroups
12.0
ListAllDatasetImportJobs
12.0
ListAllDatasets
12.0
CRAP 5.3
1 package Paws::Forecast;
2 use Moose;
3 sub service { 'forecast' }
4 sub signing_name { 'forecast' }
5 sub version { '2018-06-26' }
6 sub target_prefix { 'AmazonForecast' }
7 sub json_version { "1.1" }
8 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 has retry => (is => 'ro', isa => 'HashRef', default => sub {
10 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 });
12 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
13 ] });
14  
15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller';
16  
17
18 sub CreateDataset {
19 my $self = shift;
20 my $call_object = $self->new_with_coercions('Paws::Forecast::CreateDataset', @_);
21 return $self->caller->do_call($self, $call_object);
22 }
23 sub CreateDatasetGroup {
24 my $self = shift;
25 my $call_object = $self->new_with_coercions('Paws::Forecast::CreateDatasetGroup', @_);
26 return $self->caller->do_call($self, $call_object);
27 }
28 sub CreateDatasetImportJob {
29 my $self = shift;
30 my $call_object = $self->new_with_coercions('Paws::Forecast::CreateDatasetImportJob', @_);
31 return $self->caller->do_call($self, $call_object);
32 }
33 sub CreateForecast {
34 my $self = shift;
35 my $call_object = $self->new_with_coercions('Paws::Forecast::CreateForecast', @_);
36 return $self->caller->do_call($self, $call_object);
37 }
38 sub CreateForecastExportJob {
39 my $self = shift;
40 my $call_object = $self->new_with_coercions('Paws::Forecast::CreateForecastExportJob', @_);
41 return $self->caller->do_call($self, $call_object);
42 }
43 sub CreatePredictor {
44 my $self = shift;
45 my $call_object = $self->new_with_coercions('Paws::Forecast::CreatePredictor', @_);
46 return $self->caller->do_call($self, $call_object);
47 }
48 sub CreatePredictorBacktestExportJob {
49 my $self = shift;
50 my $call_object = $self->new_with_coercions('Paws::Forecast::CreatePredictorBacktestExportJob', @_);
51 return $self->caller->do_call($self, $call_object);
52 }
53 sub DeleteDataset {
54 my $self = shift;
55 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteDataset', @_);
56 return $self->caller->do_call($self, $call_object);
57 }
58 sub DeleteDatasetGroup {
59 my $self = shift;
60 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteDatasetGroup', @_);
61 return $self->caller->do_call($self, $call_object);
62 }
63 sub DeleteDatasetImportJob {
64 my $self = shift;
65 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteDatasetImportJob', @_);
66 return $self->caller->do_call($self, $call_object);
67 }
68 sub DeleteForecast {
69 my $self = shift;
70 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteForecast', @_);
71 return $self->caller->do_call($self, $call_object);
72 }
73 sub DeleteForecastExportJob {
74 my $self = shift;
75 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteForecastExportJob', @_);
76 return $self->caller->do_call($self, $call_object);
77 }
78 sub DeletePredictor {
79 my $self = shift;
80 my $call_object = $self->new_with_coercions('Paws::Forecast::DeletePredictor', @_);
81 return $self->caller->do_call($self, $call_object);
82 }
83 sub DeletePredictorBacktestExportJob {
84 my $self = shift;
85 my $call_object = $self->new_with_coercions('Paws::Forecast::DeletePredictorBacktestExportJob', @_);
86 return $self->caller->do_call($self, $call_object);
87 }
88 sub DeleteResourceTree {
89 my $self = shift;
90 my $call_object = $self->new_with_coercions('Paws::Forecast::DeleteResourceTree', @_);
91 return $self->caller->do_call($self, $call_object);
92 }
93 sub DescribeDataset {
94 my $self = shift;
95 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribeDataset', @_);
96 return $self->caller->do_call($self, $call_object);
97 }
98 sub DescribeDatasetGroup {
99 my $self = shift;
100 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribeDatasetGroup', @_);
101 return $self->caller->do_call($self, $call_object);
102 }
103 sub DescribeDatasetImportJob {
104 my $self = shift;
105 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribeDatasetImportJob', @_);
106 return $self->caller->do_call($self, $call_object);
107 }
108 sub DescribeForecast {
109 my $self = shift;
110 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribeForecast', @_);
111 return $self->caller->do_call($self, $call_object);
112 }
113 sub DescribeForecastExportJob {
114 my $self = shift;
115 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribeForecastExportJob', @_);
116 return $self->caller->do_call($self, $call_object);
117 }
118 sub DescribePredictor {
119 my $self = shift;
120 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribePredictor', @_);
121 return $self->caller->do_call($self, $call_object);
122 }
123 sub DescribePredictorBacktestExportJob {
124 my $self = shift;
125 my $call_object = $self->new_with_coercions('Paws::Forecast::DescribePredictorBacktestExportJob', @_);
126 return $self->caller->do_call($self, $call_object);
127 }
128 sub GetAccuracyMetrics {
129 my $self = shift;
130 my $call_object = $self->new_with_coercions('Paws::Forecast::GetAccuracyMetrics', @_);
131 return $self->caller->do_call($self, $call_object);
132 }
133 sub ListDatasetGroups {
134 my $self = shift;
135 my $call_object = $self->new_with_coercions('Paws::Forecast::ListDatasetGroups', @_);
136 return $self->caller->do_call($self, $call_object);
137 }
138 sub ListDatasetImportJobs {
139 my $self = shift;
140 my $call_object = $self->new_with_coercions('Paws::Forecast::ListDatasetImportJobs', @_);
141 return $self->caller->do_call($self, $call_object);
142 }
143 sub ListDatasets {
144 my $self = shift;
145 my $call_object = $self->new_with_coercions('Paws::Forecast::ListDatasets', @_);
146 return $self->caller->do_call($self, $call_object);
147 }
148 sub ListForecastExportJobs {
149 my $self = shift;
150 my $call_object = $self->new_with_coercions('Paws::Forecast::ListForecastExportJobs', @_);
151 return $self->caller->do_call($self, $call_object);
152 }
153 sub ListForecasts {
154 my $self = shift;
155 my $call_object = $self->new_with_coercions('Paws::Forecast::ListForecasts', @_);
156 return $self->caller->do_call($self, $call_object);
157 }
158 sub ListPredictorBacktestExportJobs {
159 my $self = shift;
160 my $call_object = $self->new_with_coercions('Paws::Forecast::ListPredictorBacktestExportJobs', @_);
161 return $self->caller->do_call($self, $call_object);
162 }
163 sub ListPredictors {
164 my $self = shift;
165 my $call_object = $self->new_with_coercions('Paws::Forecast::ListPredictors', @_);
166 return $self->caller->do_call($self, $call_object);
167 }
168 sub ListTagsForResource {
169 my $self = shift;
170 my $call_object = $self->new_with_coercions('Paws::Forecast::ListTagsForResource', @_);
171 return $self->caller->do_call($self, $call_object);
172 }
173 sub StopResource {
174 my $self = shift;
175 my $call_object = $self->new_with_coercions('Paws::Forecast::StopResource', @_);
176 return $self->caller->do_call($self, $call_object);
177 }
178 sub TagResource {
179 my $self = shift;
180 my $call_object = $self->new_with_coercions('Paws::Forecast::TagResource', @_);
181 return $self->caller->do_call($self, $call_object);
182 }
183 sub UntagResource {
184 my $self = shift;
185 my $call_object = $self->new_with_coercions('Paws::Forecast::UntagResource', @_);
186 return $self->caller->do_call($self, $call_object);
187 }
188 sub UpdateDatasetGroup {
189 my $self = shift;
190 my $call_object = $self->new_with_coercions('Paws::Forecast::UpdateDatasetGroup', @_);
191 return $self->caller->do_call($self, $call_object);
192 }
193
194 sub ListAllDatasetGroups {
195 my $self = shift;
196  
197 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
198 my $result = $self->ListDatasetGroups(@_);
199 my $next_result = $result;
200  
201 if (not defined $callback) {
202 while ($next_result->NextToken) {
203 $next_result = $self->ListDatasetGroups(@_, NextToken => $next_result->NextToken);
204 push @{ $result->DatasetGroups }, @{ $next_result->DatasetGroups };
205 }
206 return $result;
207 } else {
208 while ($result->NextToken) {
209 $callback->($_ => 'DatasetGroups') foreach (@{ $result->DatasetGroups });
210 $result = $self->ListDatasetGroups(@_, NextToken => $result->NextToken);
211 }
212 $callback->($_ => 'DatasetGroups') foreach (@{ $result->DatasetGroups });
213 }
214  
215 return undef
216 }
217 sub ListAllDatasetImportJobs {
218 my $self = shift;
219  
220 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
221 my $result = $self->ListDatasetImportJobs(@_);
222 my $next_result = $result;
223  
224 if (not defined $callback) {
225 while ($next_result->NextToken) {
226 $next_result = $self->ListDatasetImportJobs(@_, NextToken => $next_result->NextToken);
227 push @{ $result->DatasetImportJobs }, @{ $next_result->DatasetImportJobs };
228 }
229 return $result;
230 } else {
231 while ($result->NextToken) {
232 $callback->($_ => 'DatasetImportJobs') foreach (@{ $result->DatasetImportJobs });
233 $result = $self->ListDatasetImportJobs(@_, NextToken => $result->NextToken);
234 }
235 $callback->($_ => 'DatasetImportJobs') foreach (@{ $result->DatasetImportJobs });
236 }
237  
238 return undef
239 }
240 sub ListAllDatasets {
241 my $self = shift;
242  
243 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
244 my $result = $self->ListDatasets(@_);
245 my $next_result = $result;
246  
247 if (not defined $callback) {
248 while ($next_result->NextToken) {
249 $next_result = $self->ListDatasets(@_, NextToken => $next_result->NextToken);
250 push @{ $result->Datasets }, @{ $next_result->Datasets };
251 }
252 return $result;
253 } else {
254 while ($result->NextToken) {
255 $callback->($_ => 'Datasets') foreach (@{ $result->Datasets });
256 $result = $self->ListDatasets(@_, NextToken => $result->NextToken);
257 }
258 $callback->($_ => 'Datasets') foreach (@{ $result->Datasets });
259 }
260  
261 return undef
262 }
263 sub ListAllForecastExportJobs {
264 my $self = shift;
265  
266 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
267 my $result = $self->ListForecastExportJobs(@_);
268 my $next_result = $result;
269  
270 if (not defined $callback) {
271 while ($next_result->NextToken) {
272 $next_result = $self->ListForecastExportJobs(@_, NextToken => $next_result->NextToken);
273 push @{ $result->ForecastExportJobs }, @{ $next_result->ForecastExportJobs };
274 }
275 return $result;
276 } else {
277 while ($result->NextToken) {
278 $callback->($_ => 'ForecastExportJobs') foreach (@{ $result->ForecastExportJobs });
279 $result = $self->ListForecastExportJobs(@_, NextToken => $result->NextToken);
280 }
281 $callback->($_ => 'ForecastExportJobs') foreach (@{ $result->ForecastExportJobs });
282 }
283  
284 return undef
285 }
286 sub ListAllForecasts {
287 my $self = shift;
288  
289 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
290 my $result = $self->ListForecasts(@_);
291 my $next_result = $result;
292  
293 if (not defined $callback) {
294 while ($next_result->NextToken) {
295 $next_result = $self->ListForecasts(@_, NextToken => $next_result->NextToken);
296 push @{ $result->Forecasts }, @{ $next_result->Forecasts };
297 }
298 return $result;
299 } else {
300 while ($result->NextToken) {
301 $callback->($_ => 'Forecasts') foreach (@{ $result->Forecasts });
302 $result = $self->ListForecasts(@_, NextToken => $result->NextToken);
303 }
304 $callback->($_ => 'Forecasts') foreach (@{ $result->Forecasts });
305 }
306  
307 return undef
308 }
309 sub ListAllPredictorBacktestExportJobs {
310 my $self = shift;
311  
312 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
313 my $result = $self->ListPredictorBacktestExportJobs(@_);
314 my $next_result = $result;
315  
316 if (not defined $callback) {
317 while ($next_result->NextToken) {
318 $next_result = $self->ListPredictorBacktestExportJobs(@_, NextToken => $next_result->NextToken);
319 push @{ $result->PredictorBacktestExportJobs }, @{ $next_result->PredictorBacktestExportJobs };
320 }
321 return $result;
322 } else {
323 while ($result->NextToken) {
324 $callback->($_ => 'PredictorBacktestExportJobs') foreach (@{ $result->PredictorBacktestExportJobs });
325 $result = $self->ListPredictorBacktestExportJobs(@_, NextToken => $result->NextToken);
326 }
327 $callback->($_ => 'PredictorBacktestExportJobs') foreach (@{ $result->PredictorBacktestExportJobs });
328 }
329  
330 return undef
331 }
332 sub ListAllPredictors {
333 my $self = shift;
334  
335 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
336 my $result = $self->ListPredictors(@_);
337 my $next_result = $result;
338  
339 if (not defined $callback) {
340 while ($next_result->NextToken) {
341 $next_result = $self->ListPredictors(@_, NextToken => $next_result->NextToken);
342 push @{ $result->Predictors }, @{ $next_result->Predictors };
343 }
344 return $result;
345 } else {
346 while ($result->NextToken) {
347 $callback->($_ => 'Predictors') foreach (@{ $result->Predictors });
348 $result = $self->ListPredictors(@_, NextToken => $result->NextToken);
349 }
350 $callback->($_ => 'Predictors') foreach (@{ $result->Predictors });
351 }
352  
353 return undef
354 }
355  
356  
357 sub operations { qw/CreateDataset CreateDatasetGroup CreateDatasetImportJob CreateForecast CreateForecastExportJob CreatePredictor CreatePredictorBacktestExportJob DeleteDataset DeleteDatasetGroup DeleteDatasetImportJob DeleteForecast DeleteForecastExportJob DeletePredictor DeletePredictorBacktestExportJob DeleteResourceTree DescribeDataset DescribeDatasetGroup DescribeDatasetImportJob DescribeForecast DescribeForecastExportJob DescribePredictor DescribePredictorBacktestExportJob GetAccuracyMetrics ListDatasetGroups ListDatasetImportJobs ListDatasets ListForecastExportJobs ListForecasts ListPredictorBacktestExportJobs ListPredictors ListTagsForResource StopResource TagResource UntagResource UpdateDatasetGroup / }
358  
359 1;
360  
361 ### main pod documentation begin ###
362  
363 =head1 NAME
364  
365 Paws::Forecast - Perl Interface to AWS Amazon Forecast Service
366  
367 =head1 SYNOPSIS
368  
369 use Paws;
370  
371 my $obj = Paws->service('Forecast');
372 my $res = $obj->Method(
373 Arg1 => $val1,
374 Arg2 => [ 'V1', 'V2' ],
375 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
376 # of the arguments type
377 Arg3 => { Att1 => 'Val1' },
378 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
379 # the constructor of the arguments type
380 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
381 );
382  
383 =head1 DESCRIPTION
384  
385 Provides APIs for creating and managing Amazon Forecast resources.
386  
387 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26>
388  
389  
390 =head1 METHODS
391  
392 =head2 CreateDataset
393  
394 =over
395  
396 =item DatasetName => Str
397  
398 =item DatasetType => Str
399  
400 =item Domain => Str
401  
402 =item Schema => L<Paws::Forecast::Schema>
403  
404 =item [DataFrequency => Str]
405  
406 =item [EncryptionConfig => L<Paws::Forecast::EncryptionConfig>]
407  
408 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
409  
410  
411 =back
412  
413 Each argument is described in detail in: L<Paws::Forecast::CreateDataset>
414  
415 Returns: a L<Paws::Forecast::CreateDatasetResponse> instance
416  
417 Creates an Amazon Forecast dataset. The information about the dataset
418 that you provide helps Forecast understand how to consume the data for
419 model training. This includes the following:
420  
421 =over
422  
423 =item *
424  
425 I<C<DataFrequency> > - How frequently your historical time-series data
426 is collected.
427  
428 =item *
429  
430 I<C<Domain> > and I< C<DatasetType> > - Each dataset has an associated
431 dataset domain and a type within the domain. Amazon Forecast provides a
432 list of predefined domains and types within each domain. For each
433 unique dataset domain and type within the domain, Amazon Forecast
434 requires your data to include a minimum set of predefined fields.
435  
436 =item *
437  
438 I<C<Schema> > - A schema specifies the fields in the dataset, including
439 the field name and data type.
440  
441 =back
442  
443 After creating a dataset, you import your training data into it and add
444 the dataset to a dataset group. You use the dataset group to create a
445 predictor. For more information, see howitworks-datasets-groups.
446  
447 To get a list of all your datasets, use the ListDatasets operation.
448  
449 For example Forecast datasets, see the Amazon Forecast Sample GitHub
450 repository (https://github.com/aws-samples/amazon-forecast-samples).
451  
452 The C<Status> of a dataset must be C<ACTIVE> before you can import
453 training data. Use the DescribeDataset operation to get the status.
454  
455  
456 =head2 CreateDatasetGroup
457  
458 =over
459  
460 =item DatasetGroupName => Str
461  
462 =item Domain => Str
463  
464 =item [DatasetArns => ArrayRef[Str|Undef]]
465  
466 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
467  
468  
469 =back
470  
471 Each argument is described in detail in: L<Paws::Forecast::CreateDatasetGroup>
472  
473 Returns: a L<Paws::Forecast::CreateDatasetGroupResponse> instance
474  
475 Creates a dataset group, which holds a collection of related datasets.
476 You can add datasets to the dataset group when you create the dataset
477 group, or later by using the UpdateDatasetGroup operation.
478  
479 After creating a dataset group and adding datasets, you use the dataset
480 group when you create a predictor. For more information, see
481 howitworks-datasets-groups.
482  
483 To get a list of all your datasets groups, use the ListDatasetGroups
484 operation.
485  
486 The C<Status> of a dataset group must be C<ACTIVE> before you can use
487 the dataset group to create a predictor. To get the status, use the
488 DescribeDatasetGroup operation.
489  
490  
491 =head2 CreateDatasetImportJob
492  
493 =over
494  
495 =item DatasetArn => Str
496  
497 =item DatasetImportJobName => Str
498  
499 =item DataSource => L<Paws::Forecast::DataSource>
500  
501 =item [GeolocationFormat => Str]
502  
503 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
504  
505 =item [TimestampFormat => Str]
506  
507 =item [TimeZone => Str]
508  
509 =item [UseGeolocationForTimeZone => Bool]
510  
511  
512 =back
513  
514 Each argument is described in detail in: L<Paws::Forecast::CreateDatasetImportJob>
515  
516 Returns: a L<Paws::Forecast::CreateDatasetImportJobResponse> instance
517  
518 Imports your training data to an Amazon Forecast dataset. You provide
519 the location of your training data in an Amazon Simple Storage Service
520 (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
521 that you want to import the data to.
522  
523 You must specify a DataSource object that includes an AWS Identity and
524 Access Management (IAM) role that Amazon Forecast can assume to access
525 the data, as Amazon Forecast makes a copy of your data and processes it
526 in an internal AWS system. For more information, see
527 aws-forecast-iam-roles.
528  
529 The training data must be in CSV format. The delimiter must be a comma
530 (,).
531  
532 You can specify the path to a specific CSV file, the S3 bucket, or to a
533 folder in the S3 bucket. For the latter two cases, Amazon Forecast
534 imports all files up to the limit of 10,000 files.
535  
536 Because dataset imports are not aggregated, your most recent dataset
537 import is the one that is used when training a predictor or generating
538 a forecast. Make sure that your most recent dataset import contains all
539 of the data you want to model off of, and not just the new data
540 collected since the previous import.
541  
542 To get a list of all your dataset import jobs, filtered by specified
543 criteria, use the ListDatasetImportJobs operation.
544  
545  
546 =head2 CreateForecast
547  
548 =over
549  
550 =item ForecastName => Str
551  
552 =item PredictorArn => Str
553  
554 =item [ForecastTypes => ArrayRef[Str|Undef]]
555  
556 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
557  
558  
559 =back
560  
561 Each argument is described in detail in: L<Paws::Forecast::CreateForecast>
562  
563 Returns: a L<Paws::Forecast::CreateForecastResponse> instance
564  
565 Creates a forecast for each item in the C<TARGET_TIME_SERIES> dataset
566 that was used to train the predictor. This is known as inference. To
567 retrieve the forecast for a single item at low latency, use the
568 operation. To export the complete forecast into your Amazon Simple
569 Storage Service (Amazon S3) bucket, use the CreateForecastExportJob
570 operation.
571  
572 The range of the forecast is determined by the C<ForecastHorizon>
573 value, which you specify in the CreatePredictor request. When you query
574 a forecast, you can request a specific date range within the forecast.
575  
576 To get a list of all your forecasts, use the ListForecasts operation.
577  
578 The forecasts generated by Amazon Forecast are in the same time zone as
579 the dataset that was used to create the predictor.
580  
581 For more information, see howitworks-forecast.
582  
583 The C<Status> of the forecast must be C<ACTIVE> before you can query or
584 export the forecast. Use the DescribeForecast operation to get the
585 status.
586  
587  
588 =head2 CreateForecastExportJob
589  
590 =over
591  
592 =item Destination => L<Paws::Forecast::DataDestination>
593  
594 =item ForecastArn => Str
595  
596 =item ForecastExportJobName => Str
597  
598 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
599  
600  
601 =back
602  
603 Each argument is described in detail in: L<Paws::Forecast::CreateForecastExportJob>
604  
605 Returns: a L<Paws::Forecast::CreateForecastExportJobResponse> instance
606  
607 Exports a forecast created by the CreateForecast operation to your
608 Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
609 name will match the following conventions:
610  
611 E<lt>ForecastExportJobNameE<gt>_E<lt>ExportTimestampE<gt>_E<lt>PartNumberE<gt>
612  
613 where the E<lt>ExportTimestampE<gt> component is in Java
614 SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
615  
616 You must specify a DataDestination object that includes an AWS Identity
617 and Access Management (IAM) role that Amazon Forecast can assume to
618 access the Amazon S3 bucket. For more information, see
619 aws-forecast-iam-roles.
620  
621 For more information, see howitworks-forecast.
622  
623 To get a list of all your forecast export jobs, use the
624 ListForecastExportJobs operation.
625  
626 The C<Status> of the forecast export job must be C<ACTIVE> before you
627 can access the forecast in your Amazon S3 bucket. To get the status,
628 use the DescribeForecastExportJob operation.
629  
630  
631 =head2 CreatePredictor
632  
633 =over
634  
635 =item FeaturizationConfig => L<Paws::Forecast::FeaturizationConfig>
636  
637 =item ForecastHorizon => Int
638  
639 =item InputDataConfig => L<Paws::Forecast::InputDataConfig>
640  
641 =item PredictorName => Str
642  
643 =item [AlgorithmArn => Str]
644  
645 =item [AutoMLOverrideStrategy => Str]
646  
647 =item [EncryptionConfig => L<Paws::Forecast::EncryptionConfig>]
648  
649 =item [EvaluationParameters => L<Paws::Forecast::EvaluationParameters>]
650  
651 =item [ForecastTypes => ArrayRef[Str|Undef]]
652  
653 =item [HPOConfig => L<Paws::Forecast::HyperParameterTuningJobConfig>]
654  
655 =item [PerformAutoML => Bool]
656  
657 =item [PerformHPO => Bool]
658  
659 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
660  
661 =item [TrainingParameters => L<Paws::Forecast::TrainingParameters>]
662  
663  
664 =back
665  
666 Each argument is described in detail in: L<Paws::Forecast::CreatePredictor>
667  
668 Returns: a L<Paws::Forecast::CreatePredictorResponse> instance
669  
670 Creates an Amazon Forecast predictor.
671  
672 In the request, provide a dataset group and either specify an algorithm
673 or let Amazon Forecast choose an algorithm for you using AutoML. If you
674 specify an algorithm, you also can override algorithm-specific
675 hyperparameters.
676  
677 Amazon Forecast uses the algorithm to train a predictor using the
678 latest version of the datasets in the specified dataset group. You can
679 then generate a forecast using the CreateForecast operation.
680  
681 To see the evaluation metrics, use the GetAccuracyMetrics operation.
682  
683 You can specify a featurization configuration to fill and aggregate the
684 data fields in the C<TARGET_TIME_SERIES> dataset to improve model
685 training. For more information, see FeaturizationConfig.
686  
687 For RELATED_TIME_SERIES datasets, C<CreatePredictor> verifies that the
688 C<DataFrequency> specified when the dataset was created matches the
689 C<ForecastFrequency>. TARGET_TIME_SERIES datasets don't have this
690 restriction. Amazon Forecast also verifies the delimiter and timestamp
691 format. For more information, see howitworks-datasets-groups.
692  
693 By default, predictors are trained and evaluated at the 0.1 (P10), 0.5
694 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to
695 train and evaluate your predictor by setting the C<ForecastTypes>.
696  
697 B<AutoML>
698  
699 If you want Amazon Forecast to evaluate each algorithm and choose the
700 one that minimizes the C<objective function>, set C<PerformAutoML> to
701 C<true>. The C<objective function> is defined as the mean of the
702 weighted losses over the forecast types. By default, these are the p10,
703 p50, and p90 quantile losses. For more information, see
704 EvaluationResult.
705  
706 When AutoML is enabled, the following properties are disallowed:
707  
708 =over
709  
710 =item *
711  
712 C<AlgorithmArn>
713  
714 =item *
715  
716 C<HPOConfig>
717  
718 =item *
719  
720 C<PerformHPO>
721  
722 =item *
723  
724 C<TrainingParameters>
725  
726 =back
727  
728 To get a list of all of your predictors, use the ListPredictors
729 operation.
730  
731 Before you can use the predictor to create a forecast, the C<Status> of
732 the predictor must be C<ACTIVE>, signifying that training has
733 completed. To get the status, use the DescribePredictor operation.
734  
735  
736 =head2 CreatePredictorBacktestExportJob
737  
738 =over
739  
740 =item Destination => L<Paws::Forecast::DataDestination>
741  
742 =item PredictorArn => Str
743  
744 =item PredictorBacktestExportJobName => Str
745  
746 =item [Tags => ArrayRef[L<Paws::Forecast::Tag>]]
747  
748  
749 =back
750  
751 Each argument is described in detail in: L<Paws::Forecast::CreatePredictorBacktestExportJob>
752  
753 Returns: a L<Paws::Forecast::CreatePredictorBacktestExportJobResponse> instance
754  
755 Exports backtest forecasts and accuracy metrics generated by the
756 CreatePredictor operation. Two folders containing CSV files are
757 exported to your specified S3 bucket.
758  
759 The export file names will match the following conventions:
760  
761 C<E<lt>ExportJobNameE<gt>_E<lt>ExportTimestampE<gt>_E<lt>PartNumberE<gt>.csv>
762  
763 The E<lt>ExportTimestampE<gt> component is in Java SimpleDate format
764 (yyyy-MM-ddTHH-mm-ssZ).
765  
766 You must specify a DataDestination object that includes an Amazon S3
767 bucket and an AWS Identity and Access Management (IAM) role that Amazon
768 Forecast can assume to access the Amazon S3 bucket. For more
769 information, see aws-forecast-iam-roles.
770  
771 The C<Status> of the export job must be C<ACTIVE> before you can access
772 the export in your Amazon S3 bucket. To get the status, use the
773 DescribePredictorBacktestExportJob operation.
774  
775  
776 =head2 DeleteDataset
777  
778 =over
779  
780 =item DatasetArn => Str
781  
782  
783 =back
784  
785 Each argument is described in detail in: L<Paws::Forecast::DeleteDataset>
786  
787 Returns: nothing
788  
789 Deletes an Amazon Forecast dataset that was created using the
790 CreateDataset operation. You can only delete datasets that have a
791 status of C<ACTIVE> or C<CREATE_FAILED>. To get the status use the
792 DescribeDataset operation.
793  
794 Forecast does not automatically update any dataset groups that contain
795 the deleted dataset. In order to update the dataset group, use the
796 operation, omitting the deleted dataset's ARN.
797  
798  
799 =head2 DeleteDatasetGroup
800  
801 =over
802  
803 =item DatasetGroupArn => Str
804  
805  
806 =back
807  
808 Each argument is described in detail in: L<Paws::Forecast::DeleteDatasetGroup>
809  
810 Returns: nothing
811  
812 Deletes a dataset group created using the CreateDatasetGroup operation.
813 You can only delete dataset groups that have a status of C<ACTIVE>,
814 C<CREATE_FAILED>, or C<UPDATE_FAILED>. To get the status, use the
815 DescribeDatasetGroup operation.
816  
817 This operation deletes only the dataset group, not the datasets in the
818 group.
819  
820  
821 =head2 DeleteDatasetImportJob
822  
823 =over
824  
825 =item DatasetImportJobArn => Str
826  
827  
828 =back
829  
830 Each argument is described in detail in: L<Paws::Forecast::DeleteDatasetImportJob>
831  
832 Returns: nothing
833  
834 Deletes a dataset import job created using the CreateDatasetImportJob
835 operation. You can delete only dataset import jobs that have a status
836 of C<ACTIVE> or C<CREATE_FAILED>. To get the status, use the
837 DescribeDatasetImportJob operation.
838  
839  
840 =head2 DeleteForecast
841  
842 =over
843  
844 =item ForecastArn => Str
845  
846  
847 =back
848  
849 Each argument is described in detail in: L<Paws::Forecast::DeleteForecast>
850  
851 Returns: nothing
852  
853 Deletes a forecast created using the CreateForecast operation. You can
854 delete only forecasts that have a status of C<ACTIVE> or
855 C<CREATE_FAILED>. To get the status, use the DescribeForecast
856 operation.
857  
858 You can't delete a forecast while it is being exported. After a
859 forecast is deleted, you can no longer query the forecast.
860  
861  
862 =head2 DeleteForecastExportJob
863  
864 =over
865  
866 =item ForecastExportJobArn => Str
867  
868  
869 =back
870  
871 Each argument is described in detail in: L<Paws::Forecast::DeleteForecastExportJob>
872  
873 Returns: nothing
874  
875 Deletes a forecast export job created using the CreateForecastExportJob
876 operation. You can delete only export jobs that have a status of
877 C<ACTIVE> or C<CREATE_FAILED>. To get the status, use the
878 DescribeForecastExportJob operation.
879  
880  
881 =head2 DeletePredictor
882  
883 =over
884  
885 =item PredictorArn => Str
886  
887  
888 =back
889  
890 Each argument is described in detail in: L<Paws::Forecast::DeletePredictor>
891  
892 Returns: nothing
893  
894 Deletes a predictor created using the CreatePredictor operation. You
895 can delete only predictor that have a status of C<ACTIVE> or
896 C<CREATE_FAILED>. To get the status, use the DescribePredictor
897 operation.
898  
899  
900 =head2 DeletePredictorBacktestExportJob
901  
902 =over
903  
904 =item PredictorBacktestExportJobArn => Str
905  
906  
907 =back
908  
909 Each argument is described in detail in: L<Paws::Forecast::DeletePredictorBacktestExportJob>
910  
911 Returns: nothing
912  
913 Deletes a predictor backtest export job.
914  
915  
916 =head2 DeleteResourceTree
917  
918 =over
919  
920 =item ResourceArn => Str
921  
922  
923 =back
924  
925 Each argument is described in detail in: L<Paws::Forecast::DeleteResourceTree>
926  
927 Returns: nothing
928  
929 Deletes an entire resource tree. This operation will delete the parent
930 resource and its child resources.
931  
932 Child resources are resources that were created from another resource.
933 For example, when a forecast is generated from a predictor, the
934 forecast is the child resource and the predictor is the parent
935 resource.
936  
937 Amazon Forecast resources possess the following parent-child resource
938 hierarchies:
939  
940 =over
941  
942 =item *
943  
944 B<Dataset>: dataset import jobs
945  
946 =item *
947  
948 B<Dataset Group>: predictors, predictor backtest export jobs,
949 forecasts, forecast export jobs
950  
951 =item *
952  
953 B<Predictor>: predictor backtest export jobs, forecasts, forecast
954 export jobs
955  
956 =item *
957  
958 B<Forecast>: forecast export jobs
959  
960 =back
961  
962 C<DeleteResourceTree> will only delete Amazon Forecast resources, and
963 will not delete datasets or exported files stored in Amazon S3.
964  
965  
966 =head2 DescribeDataset
967  
968 =over
969  
970 =item DatasetArn => Str
971  
972  
973 =back
974  
975 Each argument is described in detail in: L<Paws::Forecast::DescribeDataset>
976  
977 Returns: a L<Paws::Forecast::DescribeDatasetResponse> instance
978  
979 Describes an Amazon Forecast dataset created using the CreateDataset
980 operation.
981  
982 In addition to listing the parameters specified in the C<CreateDataset>
983 request, this operation includes the following dataset properties:
984  
985 =over
986  
987 =item *
988  
989 C<CreationTime>
990  
991 =item *
992  
993 C<LastModificationTime>
994  
995 =item *
996  
997 C<Status>
998  
999 =back
1000  
1001  
1002  
1003 =head2 DescribeDatasetGroup
1004  
1005 =over
1006  
1007 =item DatasetGroupArn => Str
1008  
1009  
1010 =back
1011  
1012 Each argument is described in detail in: L<Paws::Forecast::DescribeDatasetGroup>
1013  
1014 Returns: a L<Paws::Forecast::DescribeDatasetGroupResponse> instance
1015  
1016 Describes a dataset group created using the CreateDatasetGroup
1017 operation.
1018  
1019 In addition to listing the parameters provided in the
1020 C<CreateDatasetGroup> request, this operation includes the following
1021 properties:
1022  
1023 =over
1024  
1025 =item *
1026  
1027 C<DatasetArns> - The datasets belonging to the group.
1028  
1029 =item *
1030  
1031 C<CreationTime>
1032  
1033 =item *
1034  
1035 C<LastModificationTime>
1036  
1037 =item *
1038  
1039 C<Status>
1040  
1041 =back
1042  
1043  
1044  
1045 =head2 DescribeDatasetImportJob
1046  
1047 =over
1048  
1049 =item DatasetImportJobArn => Str
1050  
1051  
1052 =back
1053  
1054 Each argument is described in detail in: L<Paws::Forecast::DescribeDatasetImportJob>
1055  
1056 Returns: a L<Paws::Forecast::DescribeDatasetImportJobResponse> instance
1057  
1058 Describes a dataset import job created using the CreateDatasetImportJob
1059 operation.
1060  
1061 In addition to listing the parameters provided in the
1062 C<CreateDatasetImportJob> request, this operation includes the
1063 following properties:
1064  
1065 =over
1066  
1067 =item *
1068  
1069 C<CreationTime>
1070  
1071 =item *
1072  
1073 C<LastModificationTime>
1074  
1075 =item *
1076  
1077 C<DataSize>
1078  
1079 =item *
1080  
1081 C<FieldStatistics>
1082  
1083 =item *
1084  
1085 C<Status>
1086  
1087 =item *
1088  
1089 C<Message> - If an error occurred, information about the error.
1090  
1091 =back
1092  
1093  
1094  
1095 =head2 DescribeForecast
1096  
1097 =over
1098  
1099 =item ForecastArn => Str
1100  
1101  
1102 =back
1103  
1104 Each argument is described in detail in: L<Paws::Forecast::DescribeForecast>
1105  
1106 Returns: a L<Paws::Forecast::DescribeForecastResponse> instance
1107  
1108 Describes a forecast created using the CreateForecast operation.
1109  
1110 In addition to listing the properties provided in the C<CreateForecast>
1111 request, this operation lists the following properties:
1112  
1113 =over
1114  
1115 =item *
1116  
1117 C<DatasetGroupArn> - The dataset group that provided the training data.
1118  
1119 =item *
1120  
1121 C<CreationTime>
1122  
1123 =item *
1124  
1125 C<LastModificationTime>
1126  
1127 =item *
1128  
1129 C<Status>
1130  
1131 =item *
1132  
1133 C<Message> - If an error occurred, information about the error.
1134  
1135 =back
1136  
1137  
1138  
1139 =head2 DescribeForecastExportJob
1140  
1141 =over
1142  
1143 =item ForecastExportJobArn => Str
1144  
1145  
1146 =back
1147  
1148 Each argument is described in detail in: L<Paws::Forecast::DescribeForecastExportJob>
1149  
1150 Returns: a L<Paws::Forecast::DescribeForecastExportJobResponse> instance
1151  
1152 Describes a forecast export job created using the
1153 CreateForecastExportJob operation.
1154  
1155 In addition to listing the properties provided by the user in the
1156 C<CreateForecastExportJob> request, this operation lists the following
1157 properties:
1158  
1159 =over
1160  
1161 =item *
1162  
1163 C<CreationTime>
1164  
1165 =item *
1166  
1167 C<LastModificationTime>
1168  
1169 =item *
1170  
1171 C<Status>
1172  
1173 =item *
1174  
1175 C<Message> - If an error occurred, information about the error.
1176  
1177 =back
1178  
1179  
1180  
1181 =head2 DescribePredictor
1182  
1183 =over
1184  
1185 =item PredictorArn => Str
1186  
1187  
1188 =back
1189  
1190 Each argument is described in detail in: L<Paws::Forecast::DescribePredictor>
1191  
1192 Returns: a L<Paws::Forecast::DescribePredictorResponse> instance
1193  
1194 Describes a predictor created using the CreatePredictor operation.
1195  
1196 In addition to listing the properties provided in the
1197 C<CreatePredictor> request, this operation lists the following
1198 properties:
1199  
1200 =over
1201  
1202 =item *
1203  
1204 C<DatasetImportJobArns> - The dataset import jobs used to import
1205 training data.
1206  
1207 =item *
1208  
1209 C<AutoMLAlgorithmArns> - If AutoML is performed, the algorithms that
1210 were evaluated.
1211  
1212 =item *
1213  
1214 C<CreationTime>
1215  
1216 =item *
1217  
1218 C<LastModificationTime>
1219  
1220 =item *
1221  
1222 C<Status>
1223  
1224 =item *
1225  
1226 C<Message> - If an error occurred, information about the error.
1227  
1228 =back
1229  
1230  
1231  
1232 =head2 DescribePredictorBacktestExportJob
1233  
1234 =over
1235  
1236 =item PredictorBacktestExportJobArn => Str
1237  
1238  
1239 =back
1240  
1241 Each argument is described in detail in: L<Paws::Forecast::DescribePredictorBacktestExportJob>
1242  
1243 Returns: a L<Paws::Forecast::DescribePredictorBacktestExportJobResponse> instance
1244  
1245 Describes a predictor backtest export job created using the
1246 CreatePredictorBacktestExportJob operation.
1247  
1248 In addition to listing the properties provided by the user in the
1249 C<CreatePredictorBacktestExportJob> request, this operation lists the
1250 following properties:
1251  
1252 =over
1253  
1254 =item *
1255  
1256 C<CreationTime>
1257  
1258 =item *
1259  
1260 C<LastModificationTime>
1261  
1262 =item *
1263  
1264 C<Status>
1265  
1266 =item *
1267  
1268 C<Message> (if an error occurred)
1269  
1270 =back
1271  
1272  
1273  
1274 =head2 GetAccuracyMetrics
1275  
1276 =over
1277  
1278 =item PredictorArn => Str
1279  
1280  
1281 =back
1282  
1283 Each argument is described in detail in: L<Paws::Forecast::GetAccuracyMetrics>
1284  
1285 Returns: a L<Paws::Forecast::GetAccuracyMetricsResponse> instance
1286  
1287 Provides metrics on the accuracy of the models that were trained by the
1288 CreatePredictor operation. Use metrics to see how well the model
1289 performed and to decide whether to use the predictor to generate a
1290 forecast. For more information, see Predictor Metrics
1291 (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html).
1292  
1293 This operation generates metrics for each backtest window that was
1294 evaluated. The number of backtest windows (C<NumberOfBacktestWindows>)
1295 is specified using the EvaluationParameters object, which is optionally
1296 included in the C<CreatePredictor> request. If
1297 C<NumberOfBacktestWindows> isn't specified, the number defaults to one.
1298  
1299 The parameters of the C<filling> method determine which items
1300 contribute to the metrics. If you want all items to contribute, specify
1301 C<zero>. If you want only those items that have complete data in the
1302 range being evaluated to contribute, specify C<nan>. For more
1303 information, see FeaturizationMethod.
1304  
1305 Before you can get accuracy metrics, the C<Status> of the predictor
1306 must be C<ACTIVE>, signifying that training has completed. To get the
1307 status, use the DescribePredictor operation.
1308  
1309  
1310 =head2 ListDatasetGroups
1311  
1312 =over
1313  
1314 =item [MaxResults => Int]
1315  
1316 =item [NextToken => Str]
1317  
1318  
1319 =back
1320  
1321 Each argument is described in detail in: L<Paws::Forecast::ListDatasetGroups>
1322  
1323 Returns: a L<Paws::Forecast::ListDatasetGroupsResponse> instance
1324  
1325 Returns a list of dataset groups created using the CreateDatasetGroup
1326 operation. For each dataset group, this operation returns a summary of
1327 its properties, including its Amazon Resource Name (ARN). You can
1328 retrieve the complete set of properties by using the dataset group ARN
1329 with the DescribeDatasetGroup operation.
1330  
1331  
1332 =head2 ListDatasetImportJobs
1333  
1334 =over
1335  
1336 =item [Filters => ArrayRef[L<Paws::Forecast::Filter>]]
1337  
1338 =item [MaxResults => Int]
1339  
1340 =item [NextToken => Str]
1341  
1342  
1343 =back
1344  
1345 Each argument is described in detail in: L<Paws::Forecast::ListDatasetImportJobs>
1346  
1347 Returns: a L<Paws::Forecast::ListDatasetImportJobsResponse> instance
1348  
1349 Returns a list of dataset import jobs created using the
1350 CreateDatasetImportJob operation. For each import job, this operation
1351 returns a summary of its properties, including its Amazon Resource Name
1352 (ARN). You can retrieve the complete set of properties by using the ARN
1353 with the DescribeDatasetImportJob operation. You can filter the list by
1354 providing an array of Filter objects.
1355  
1356  
1357 =head2 ListDatasets
1358  
1359 =over
1360  
1361 =item [MaxResults => Int]
1362  
1363 =item [NextToken => Str]
1364  
1365  
1366 =back
1367  
1368 Each argument is described in detail in: L<Paws::Forecast::ListDatasets>
1369  
1370 Returns: a L<Paws::Forecast::ListDatasetsResponse> instance
1371  
1372 Returns a list of datasets created using the CreateDataset operation.
1373 For each dataset, a summary of its properties, including its Amazon
1374 Resource Name (ARN), is returned. To retrieve the complete set of
1375 properties, use the ARN with the DescribeDataset operation.
1376  
1377  
1378 =head2 ListForecastExportJobs
1379  
1380 =over
1381  
1382 =item [Filters => ArrayRef[L<Paws::Forecast::Filter>]]
1383  
1384 =item [MaxResults => Int]
1385  
1386 =item [NextToken => Str]
1387  
1388  
1389 =back
1390  
1391 Each argument is described in detail in: L<Paws::Forecast::ListForecastExportJobs>
1392  
1393 Returns: a L<Paws::Forecast::ListForecastExportJobsResponse> instance
1394  
1395 Returns a list of forecast export jobs created using the
1396 CreateForecastExportJob operation. For each forecast export job, this
1397 operation returns a summary of its properties, including its Amazon
1398 Resource Name (ARN). To retrieve the complete set of properties, use
1399 the ARN with the DescribeForecastExportJob operation. You can filter
1400 the list using an array of Filter objects.
1401  
1402  
1403 =head2 ListForecasts
1404  
1405 =over
1406  
1407 =item [Filters => ArrayRef[L<Paws::Forecast::Filter>]]
1408  
1409 =item [MaxResults => Int]
1410  
1411 =item [NextToken => Str]
1412  
1413  
1414 =back
1415  
1416 Each argument is described in detail in: L<Paws::Forecast::ListForecasts>
1417  
1418 Returns: a L<Paws::Forecast::ListForecastsResponse> instance
1419  
1420 Returns a list of forecasts created using the CreateForecast operation.
1421 For each forecast, this operation returns a summary of its properties,
1422 including its Amazon Resource Name (ARN). To retrieve the complete set
1423 of properties, specify the ARN with the DescribeForecast operation. You
1424 can filter the list using an array of Filter objects.
1425  
1426  
1427 =head2 ListPredictorBacktestExportJobs
1428  
1429 =over
1430  
1431 =item [Filters => ArrayRef[L<Paws::Forecast::Filter>]]
1432  
1433 =item [MaxResults => Int]
1434  
1435 =item [NextToken => Str]
1436  
1437  
1438 =back
1439  
1440 Each argument is described in detail in: L<Paws::Forecast::ListPredictorBacktestExportJobs>
1441  
1442 Returns: a L<Paws::Forecast::ListPredictorBacktestExportJobsResponse> instance
1443  
1444 Returns a list of predictor backtest export jobs created using the
1445 CreatePredictorBacktestExportJob operation. This operation returns a
1446 summary for each backtest export job. You can filter the list using an
1447 array of Filter objects.
1448  
1449 To retrieve the complete set of properties for a particular backtest
1450 export job, use the ARN with the DescribePredictorBacktestExportJob
1451 operation.
1452  
1453  
1454 =head2 ListPredictors
1455  
1456 =over
1457  
1458 =item [Filters => ArrayRef[L<Paws::Forecast::Filter>]]
1459  
1460 =item [MaxResults => Int]
1461  
1462 =item [NextToken => Str]
1463  
1464  
1465 =back
1466  
1467 Each argument is described in detail in: L<Paws::Forecast::ListPredictors>
1468  
1469 Returns: a L<Paws::Forecast::ListPredictorsResponse> instance
1470  
1471 Returns a list of predictors created using the CreatePredictor
1472 operation. For each predictor, this operation returns a summary of its
1473 properties, including its Amazon Resource Name (ARN). You can retrieve
1474 the complete set of properties by using the ARN with the
1475 DescribePredictor operation. You can filter the list using an array of
1476 Filter objects.
1477  
1478  
1479 =head2 ListTagsForResource
1480  
1481 =over
1482  
1483 =item ResourceArn => Str
1484  
1485  
1486 =back
1487  
1488 Each argument is described in detail in: L<Paws::Forecast::ListTagsForResource>
1489  
1490 Returns: a L<Paws::Forecast::ListTagsForResourceResponse> instance
1491  
1492 Lists the tags for an Amazon Forecast resource.
1493  
1494  
1495 =head2 StopResource
1496  
1497 =over
1498  
1499 =item ResourceArn => Str
1500  
1501  
1502 =back
1503  
1504 Each argument is described in detail in: L<Paws::Forecast::StopResource>
1505  
1506 Returns: nothing
1507  
1508 Stops a resource.
1509  
1510 The resource undergoes the following states: C<CREATE_STOPPING> and
1511 C<CREATE_STOPPED>. You cannot resume a resource once it has been
1512 stopped.
1513  
1514 This operation can be applied to the following resources (and their
1515 corresponding child resources):
1516  
1517 =over
1518  
1519 =item *
1520  
1521 Dataset Import Job
1522  
1523 =item *
1524  
1525 Predictor Job
1526  
1527 =item *
1528  
1529 Forecast Job
1530  
1531 =item *
1532  
1533 Forecast Export Job
1534  
1535 =item *
1536  
1537 Predictor Backtest Export Job
1538  
1539 =back
1540  
1541  
1542  
1543 =head2 TagResource
1544  
1545 =over
1546  
1547 =item ResourceArn => Str
1548  
1549 =item Tags => ArrayRef[L<Paws::Forecast::Tag>]
1550  
1551  
1552 =back
1553  
1554 Each argument is described in detail in: L<Paws::Forecast::TagResource>
1555  
1556 Returns: a L<Paws::Forecast::TagResourceResponse> instance
1557  
1558 Associates the specified tags to a resource with the specified
1559 C<resourceArn>. If existing tags on a resource are not specified in the
1560 request parameters, they are not changed. When a resource is deleted,
1561 the tags associated with that resource are also deleted.
1562  
1563  
1564 =head2 UntagResource
1565  
1566 =over
1567  
1568 =item ResourceArn => Str
1569  
1570 =item TagKeys => ArrayRef[Str|Undef]
1571  
1572  
1573 =back
1574  
1575 Each argument is described in detail in: L<Paws::Forecast::UntagResource>
1576  
1577 Returns: a L<Paws::Forecast::UntagResourceResponse> instance
1578  
1579 Deletes the specified tags from a resource.
1580  
1581  
1582 =head2 UpdateDatasetGroup
1583  
1584 =over
1585  
1586 =item DatasetArns => ArrayRef[Str|Undef]
1587  
1588 =item DatasetGroupArn => Str
1589  
1590  
1591 =back
1592  
1593 Each argument is described in detail in: L<Paws::Forecast::UpdateDatasetGroup>
1594  
1595 Returns: a L<Paws::Forecast::UpdateDatasetGroupResponse> instance
1596  
1597 Replaces the datasets in a dataset group with the specified datasets.
1598  
1599 The C<Status> of the dataset group must be C<ACTIVE> before you can use
1600 the dataset group to create a predictor. Use the DescribeDatasetGroup
1601 operation to get the status.
1602  
1603  
1604  
1605  
1606 =head1 PAGINATORS
1607  
1608 Paginator methods are helpers that repetively call methods that return partial results
1609  
1610 =head2 ListAllDatasetGroups(sub { },[MaxResults => Int, NextToken => Str])
1611  
1612 =head2 ListAllDatasetGroups([MaxResults => Int, NextToken => Str])
1613  
1614  
1615 If passed a sub as first parameter, it will call the sub for each element found in :
1616  
1617 - DatasetGroups, passing the object as the first parameter, and the string 'DatasetGroups' as the second parameter
1618  
1619 If not, it will return a a L<Paws::Forecast::ListDatasetGroupsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1620  
1621  
1622 =head2 ListAllDatasetImportJobs(sub { },[Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1623  
1624 =head2 ListAllDatasetImportJobs([Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1625  
1626  
1627 If passed a sub as first parameter, it will call the sub for each element found in :
1628  
1629 - DatasetImportJobs, passing the object as the first parameter, and the string 'DatasetImportJobs' as the second parameter
1630  
1631 If not, it will return a a L<Paws::Forecast::ListDatasetImportJobsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1632  
1633  
1634 =head2 ListAllDatasets(sub { },[MaxResults => Int, NextToken => Str])
1635  
1636 =head2 ListAllDatasets([MaxResults => Int, NextToken => Str])
1637  
1638  
1639 If passed a sub as first parameter, it will call the sub for each element found in :
1640  
1641 - Datasets, passing the object as the first parameter, and the string 'Datasets' as the second parameter
1642  
1643 If not, it will return a a L<Paws::Forecast::ListDatasetsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1644  
1645  
1646 =head2 ListAllForecastExportJobs(sub { },[Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1647  
1648 =head2 ListAllForecastExportJobs([Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1649  
1650  
1651 If passed a sub as first parameter, it will call the sub for each element found in :
1652  
1653 - ForecastExportJobs, passing the object as the first parameter, and the string 'ForecastExportJobs' as the second parameter
1654  
1655 If not, it will return a a L<Paws::Forecast::ListForecastExportJobsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1656  
1657  
1658 =head2 ListAllForecasts(sub { },[Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1659  
1660 =head2 ListAllForecasts([Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1661  
1662  
1663 If passed a sub as first parameter, it will call the sub for each element found in :
1664  
1665 - Forecasts, passing the object as the first parameter, and the string 'Forecasts' as the second parameter
1666  
1667 If not, it will return a a L<Paws::Forecast::ListForecastsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1668  
1669  
1670 =head2 ListAllPredictorBacktestExportJobs(sub { },[Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1671  
1672 =head2 ListAllPredictorBacktestExportJobs([Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1673  
1674  
1675 If passed a sub as first parameter, it will call the sub for each element found in :
1676  
1677 - PredictorBacktestExportJobs, passing the object as the first parameter, and the string 'PredictorBacktestExportJobs' as the second parameter
1678  
1679 If not, it will return a a L<Paws::Forecast::ListPredictorBacktestExportJobsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1680  
1681  
1682 =head2 ListAllPredictors(sub { },[Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1683  
1684 =head2 ListAllPredictors([Filters => ArrayRef[L<Paws::Forecast::Filter>], MaxResults => Int, NextToken => Str])
1685  
1686  
1687 If passed a sub as first parameter, it will call the sub for each element found in :
1688  
1689 - Predictors, passing the object as the first parameter, and the string 'Predictors' as the second parameter
1690  
1691 If not, it will return a a L<Paws::Forecast::ListPredictorsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1692  
1693  
1694  
1695  
1696  
1697 =head1 SEE ALSO
1698  
1699 This service class forms part of L<Paws>
1700  
1701 =head1 BUGS and CONTRIBUTIONS
1702  
1703 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1704  
1705 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1706  
1707 =cut
1708