aws-sdk-forecastservice 1.8.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-forecastservice.rb +3 -2
- data/lib/aws-sdk-forecastservice/client.rb +312 -30
- data/lib/aws-sdk-forecastservice/client_api.rb +117 -1
- data/lib/aws-sdk-forecastservice/types.rb +470 -49
- metadata +4 -4
@@ -31,6 +31,8 @@ module Aws::ForecastService
|
|
31
31
|
CreateForecastExportJobResponse = Shapes::StructureShape.new(name: 'CreateForecastExportJobResponse')
|
32
32
|
CreateForecastRequest = Shapes::StructureShape.new(name: 'CreateForecastRequest')
|
33
33
|
CreateForecastResponse = Shapes::StructureShape.new(name: 'CreateForecastResponse')
|
34
|
+
CreatePredictorBacktestExportJobRequest = Shapes::StructureShape.new(name: 'CreatePredictorBacktestExportJobRequest')
|
35
|
+
CreatePredictorBacktestExportJobResponse = Shapes::StructureShape.new(name: 'CreatePredictorBacktestExportJobResponse')
|
34
36
|
CreatePredictorRequest = Shapes::StructureShape.new(name: 'CreatePredictorRequest')
|
35
37
|
CreatePredictorResponse = Shapes::StructureShape.new(name: 'CreatePredictorResponse')
|
36
38
|
DataDestination = Shapes::StructureShape.new(name: 'DataDestination')
|
@@ -47,6 +49,7 @@ module Aws::ForecastService
|
|
47
49
|
DeleteDatasetRequest = Shapes::StructureShape.new(name: 'DeleteDatasetRequest')
|
48
50
|
DeleteForecastExportJobRequest = Shapes::StructureShape.new(name: 'DeleteForecastExportJobRequest')
|
49
51
|
DeleteForecastRequest = Shapes::StructureShape.new(name: 'DeleteForecastRequest')
|
52
|
+
DeletePredictorBacktestExportJobRequest = Shapes::StructureShape.new(name: 'DeletePredictorBacktestExportJobRequest')
|
50
53
|
DeletePredictorRequest = Shapes::StructureShape.new(name: 'DeletePredictorRequest')
|
51
54
|
DescribeDatasetGroupRequest = Shapes::StructureShape.new(name: 'DescribeDatasetGroupRequest')
|
52
55
|
DescribeDatasetGroupResponse = Shapes::StructureShape.new(name: 'DescribeDatasetGroupResponse')
|
@@ -58,12 +61,16 @@ module Aws::ForecastService
|
|
58
61
|
DescribeForecastExportJobResponse = Shapes::StructureShape.new(name: 'DescribeForecastExportJobResponse')
|
59
62
|
DescribeForecastRequest = Shapes::StructureShape.new(name: 'DescribeForecastRequest')
|
60
63
|
DescribeForecastResponse = Shapes::StructureShape.new(name: 'DescribeForecastResponse')
|
64
|
+
DescribePredictorBacktestExportJobRequest = Shapes::StructureShape.new(name: 'DescribePredictorBacktestExportJobRequest')
|
65
|
+
DescribePredictorBacktestExportJobResponse = Shapes::StructureShape.new(name: 'DescribePredictorBacktestExportJobResponse')
|
61
66
|
DescribePredictorRequest = Shapes::StructureShape.new(name: 'DescribePredictorRequest')
|
62
67
|
DescribePredictorResponse = Shapes::StructureShape.new(name: 'DescribePredictorResponse')
|
63
68
|
Domain = Shapes::StringShape.new(name: 'Domain')
|
64
69
|
Double = Shapes::FloatShape.new(name: 'Double')
|
65
70
|
EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
|
66
71
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
72
|
+
ErrorMetric = Shapes::StructureShape.new(name: 'ErrorMetric')
|
73
|
+
ErrorMetrics = Shapes::ListShape.new(name: 'ErrorMetrics')
|
67
74
|
EvaluationParameters = Shapes::StructureShape.new(name: 'EvaluationParameters')
|
68
75
|
EvaluationResult = Shapes::StructureShape.new(name: 'EvaluationResult')
|
69
76
|
EvaluationType = Shapes::StringShape.new(name: 'EvaluationType')
|
@@ -107,6 +114,8 @@ module Aws::ForecastService
|
|
107
114
|
ListForecastExportJobsResponse = Shapes::StructureShape.new(name: 'ListForecastExportJobsResponse')
|
108
115
|
ListForecastsRequest = Shapes::StructureShape.new(name: 'ListForecastsRequest')
|
109
116
|
ListForecastsResponse = Shapes::StructureShape.new(name: 'ListForecastsResponse')
|
117
|
+
ListPredictorBacktestExportJobsRequest = Shapes::StructureShape.new(name: 'ListPredictorBacktestExportJobsRequest')
|
118
|
+
ListPredictorBacktestExportJobsResponse = Shapes::StructureShape.new(name: 'ListPredictorBacktestExportJobsResponse')
|
110
119
|
ListPredictorsRequest = Shapes::StructureShape.new(name: 'ListPredictorsRequest')
|
111
120
|
ListPredictorsResponse = Shapes::StructureShape.new(name: 'ListPredictorsResponse')
|
112
121
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -119,6 +128,8 @@ module Aws::ForecastService
|
|
119
128
|
ParameterKey = Shapes::StringShape.new(name: 'ParameterKey')
|
120
129
|
ParameterRanges = Shapes::StructureShape.new(name: 'ParameterRanges')
|
121
130
|
ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
|
131
|
+
PredictorBacktestExportJobSummary = Shapes::StructureShape.new(name: 'PredictorBacktestExportJobSummary')
|
132
|
+
PredictorBacktestExportJobs = Shapes::ListShape.new(name: 'PredictorBacktestExportJobs')
|
122
133
|
PredictorEvaluationResults = Shapes::ListShape.new(name: 'PredictorEvaluationResults')
|
123
134
|
PredictorExecution = Shapes::StructureShape.new(name: 'PredictorExecution')
|
124
135
|
PredictorExecutionDetails = Shapes::StructureShape.new(name: 'PredictorExecutionDetails')
|
@@ -227,9 +238,19 @@ module Aws::ForecastService
|
|
227
238
|
CreateForecastResponse.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ForecastArn"))
|
228
239
|
CreateForecastResponse.struct_class = Types::CreateForecastResponse
|
229
240
|
|
241
|
+
CreatePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "PredictorBacktestExportJobName"))
|
242
|
+
CreatePredictorBacktestExportJobRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
243
|
+
CreatePredictorBacktestExportJobRequest.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, required: true, location_name: "Destination"))
|
244
|
+
CreatePredictorBacktestExportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
245
|
+
CreatePredictorBacktestExportJobRequest.struct_class = Types::CreatePredictorBacktestExportJobRequest
|
246
|
+
|
247
|
+
CreatePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
248
|
+
CreatePredictorBacktestExportJobResponse.struct_class = Types::CreatePredictorBacktestExportJobResponse
|
249
|
+
|
230
250
|
CreatePredictorRequest.add_member(:predictor_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "PredictorName"))
|
231
251
|
CreatePredictorRequest.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
232
252
|
CreatePredictorRequest.add_member(:forecast_horizon, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "ForecastHorizon"))
|
253
|
+
CreatePredictorRequest.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
233
254
|
CreatePredictorRequest.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformAutoML"))
|
234
255
|
CreatePredictorRequest.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformHPO"))
|
235
256
|
CreatePredictorRequest.add_member(:training_parameters, Shapes::ShapeRef.new(shape: TrainingParameters, location_name: "TrainingParameters"))
|
@@ -294,6 +315,9 @@ module Aws::ForecastService
|
|
294
315
|
DeleteForecastRequest.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ForecastArn"))
|
295
316
|
DeleteForecastRequest.struct_class = Types::DeleteForecastRequest
|
296
317
|
|
318
|
+
DeletePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorBacktestExportJobArn"))
|
319
|
+
DeletePredictorBacktestExportJobRequest.struct_class = Types::DeletePredictorBacktestExportJobRequest
|
320
|
+
|
297
321
|
DeletePredictorRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
298
322
|
DeletePredictorRequest.struct_class = Types::DeletePredictorRequest
|
299
323
|
|
@@ -367,6 +391,19 @@ module Aws::ForecastService
|
|
367
391
|
DescribeForecastResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
368
392
|
DescribeForecastResponse.struct_class = Types::DescribeForecastResponse
|
369
393
|
|
394
|
+
DescribePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorBacktestExportJobArn"))
|
395
|
+
DescribePredictorBacktestExportJobRequest.struct_class = Types::DescribePredictorBacktestExportJobRequest
|
396
|
+
|
397
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
398
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorBacktestExportJobName"))
|
399
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
|
400
|
+
DescribePredictorBacktestExportJobResponse.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, location_name: "Destination"))
|
401
|
+
DescribePredictorBacktestExportJobResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
402
|
+
DescribePredictorBacktestExportJobResponse.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
|
403
|
+
DescribePredictorBacktestExportJobResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
404
|
+
DescribePredictorBacktestExportJobResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
405
|
+
DescribePredictorBacktestExportJobResponse.struct_class = Types::DescribePredictorBacktestExportJobResponse
|
406
|
+
|
370
407
|
DescribePredictorRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
371
408
|
DescribePredictorRequest.struct_class = Types::DescribePredictorRequest
|
372
409
|
|
@@ -374,6 +411,7 @@ module Aws::ForecastService
|
|
374
411
|
DescribePredictorResponse.add_member(:predictor_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorName"))
|
375
412
|
DescribePredictorResponse.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
376
413
|
DescribePredictorResponse.add_member(:forecast_horizon, Shapes::ShapeRef.new(shape: Integer, location_name: "ForecastHorizon"))
|
414
|
+
DescribePredictorResponse.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
377
415
|
DescribePredictorResponse.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformAutoML"))
|
378
416
|
DescribePredictorResponse.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformHPO"))
|
379
417
|
DescribePredictorResponse.add_member(:training_parameters, Shapes::ShapeRef.new(shape: TrainingParameters, location_name: "TrainingParameters"))
|
@@ -395,6 +433,13 @@ module Aws::ForecastService
|
|
395
433
|
EncryptionConfig.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KMSKeyArn, required: true, location_name: "KMSKeyArn"))
|
396
434
|
EncryptionConfig.struct_class = Types::EncryptionConfig
|
397
435
|
|
436
|
+
ErrorMetric.add_member(:forecast_type, Shapes::ShapeRef.new(shape: ForecastType, location_name: "ForecastType"))
|
437
|
+
ErrorMetric.add_member(:wape, Shapes::ShapeRef.new(shape: Double, location_name: "WAPE"))
|
438
|
+
ErrorMetric.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
|
439
|
+
ErrorMetric.struct_class = Types::ErrorMetric
|
440
|
+
|
441
|
+
ErrorMetrics.member = Shapes::ShapeRef.new(shape: ErrorMetric)
|
442
|
+
|
398
443
|
EvaluationParameters.add_member(:number_of_backtest_windows, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfBacktestWindows"))
|
399
444
|
EvaluationParameters.add_member(:back_test_window_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BackTestWindowOffset"))
|
400
445
|
EvaluationParameters.struct_class = Types::EvaluationParameters
|
@@ -533,6 +578,15 @@ module Aws::ForecastService
|
|
533
578
|
ListForecastsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
534
579
|
ListForecastsResponse.struct_class = Types::ListForecastsResponse
|
535
580
|
|
581
|
+
ListPredictorBacktestExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
582
|
+
ListPredictorBacktestExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
583
|
+
ListPredictorBacktestExportJobsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
584
|
+
ListPredictorBacktestExportJobsRequest.struct_class = Types::ListPredictorBacktestExportJobsRequest
|
585
|
+
|
586
|
+
ListPredictorBacktestExportJobsResponse.add_member(:predictor_backtest_export_jobs, Shapes::ShapeRef.new(shape: PredictorBacktestExportJobs, location_name: "PredictorBacktestExportJobs"))
|
587
|
+
ListPredictorBacktestExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
588
|
+
ListPredictorBacktestExportJobsResponse.struct_class = Types::ListPredictorBacktestExportJobsResponse
|
589
|
+
|
536
590
|
ListPredictorsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
537
591
|
ListPredictorsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
538
592
|
ListPredictorsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
@@ -548,8 +602,9 @@ module Aws::ForecastService
|
|
548
602
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
549
603
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
550
604
|
|
551
|
-
Metrics.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
|
605
|
+
Metrics.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, deprecated: true, location_name: "RMSE", metadata: {"deprecatedMessage"=>"This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE"}))
|
552
606
|
Metrics.add_member(:weighted_quantile_losses, Shapes::ShapeRef.new(shape: WeightedQuantileLosses, location_name: "WeightedQuantileLosses"))
|
607
|
+
Metrics.add_member(:error_metrics, Shapes::ShapeRef.new(shape: ErrorMetrics, location_name: "ErrorMetrics"))
|
553
608
|
Metrics.struct_class = Types::Metrics
|
554
609
|
|
555
610
|
ParameterRanges.add_member(:categorical_parameter_ranges, Shapes::ShapeRef.new(shape: CategoricalParameterRanges, location_name: "CategoricalParameterRanges"))
|
@@ -557,6 +612,17 @@ module Aws::ForecastService
|
|
557
612
|
ParameterRanges.add_member(:integer_parameter_ranges, Shapes::ShapeRef.new(shape: IntegerParameterRanges, location_name: "IntegerParameterRanges"))
|
558
613
|
ParameterRanges.struct_class = Types::ParameterRanges
|
559
614
|
|
615
|
+
PredictorBacktestExportJobSummary.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
616
|
+
PredictorBacktestExportJobSummary.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorBacktestExportJobName"))
|
617
|
+
PredictorBacktestExportJobSummary.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, location_name: "Destination"))
|
618
|
+
PredictorBacktestExportJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
|
619
|
+
PredictorBacktestExportJobSummary.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
620
|
+
PredictorBacktestExportJobSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
621
|
+
PredictorBacktestExportJobSummary.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
622
|
+
PredictorBacktestExportJobSummary.struct_class = Types::PredictorBacktestExportJobSummary
|
623
|
+
|
624
|
+
PredictorBacktestExportJobs.member = Shapes::ShapeRef.new(shape: PredictorBacktestExportJobSummary)
|
625
|
+
|
560
626
|
PredictorEvaluationResults.member = Shapes::ShapeRef.new(shape: EvaluationResult)
|
561
627
|
|
562
628
|
PredictorExecution.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
@@ -767,6 +833,19 @@ module Aws::ForecastService
|
|
767
833
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
768
834
|
end)
|
769
835
|
|
836
|
+
api.add_operation(:create_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
837
|
+
o.name = "CreatePredictorBacktestExportJob"
|
838
|
+
o.http_method = "POST"
|
839
|
+
o.http_request_uri = "/"
|
840
|
+
o.input = Shapes::ShapeRef.new(shape: CreatePredictorBacktestExportJobRequest)
|
841
|
+
o.output = Shapes::ShapeRef.new(shape: CreatePredictorBacktestExportJobResponse)
|
842
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
843
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
844
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
845
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
846
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
847
|
+
end)
|
848
|
+
|
770
849
|
api.add_operation(:delete_dataset, Seahorse::Model::Operation.new.tap do |o|
|
771
850
|
o.name = "DeleteDataset"
|
772
851
|
o.http_method = "POST"
|
@@ -833,6 +912,17 @@ module Aws::ForecastService
|
|
833
912
|
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
834
913
|
end)
|
835
914
|
|
915
|
+
api.add_operation(:delete_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
916
|
+
o.name = "DeletePredictorBacktestExportJob"
|
917
|
+
o.http_method = "POST"
|
918
|
+
o.http_request_uri = "/"
|
919
|
+
o.input = Shapes::ShapeRef.new(shape: DeletePredictorBacktestExportJobRequest)
|
920
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
921
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
922
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
923
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
924
|
+
end)
|
925
|
+
|
836
926
|
api.add_operation(:describe_dataset, Seahorse::Model::Operation.new.tap do |o|
|
837
927
|
o.name = "DescribeDataset"
|
838
928
|
o.http_method = "POST"
|
@@ -893,6 +983,16 @@ module Aws::ForecastService
|
|
893
983
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
894
984
|
end)
|
895
985
|
|
986
|
+
api.add_operation(:describe_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
987
|
+
o.name = "DescribePredictorBacktestExportJob"
|
988
|
+
o.http_method = "POST"
|
989
|
+
o.http_request_uri = "/"
|
990
|
+
o.input = Shapes::ShapeRef.new(shape: DescribePredictorBacktestExportJobRequest)
|
991
|
+
o.output = Shapes::ShapeRef.new(shape: DescribePredictorBacktestExportJobResponse)
|
992
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
993
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
994
|
+
end)
|
995
|
+
|
896
996
|
api.add_operation(:get_accuracy_metrics, Seahorse::Model::Operation.new.tap do |o|
|
897
997
|
o.name = "GetAccuracyMetrics"
|
898
998
|
o.http_method = "POST"
|
@@ -982,6 +1082,22 @@ module Aws::ForecastService
|
|
982
1082
|
)
|
983
1083
|
end)
|
984
1084
|
|
1085
|
+
api.add_operation(:list_predictor_backtest_export_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1086
|
+
o.name = "ListPredictorBacktestExportJobs"
|
1087
|
+
o.http_method = "POST"
|
1088
|
+
o.http_request_uri = "/"
|
1089
|
+
o.input = Shapes::ShapeRef.new(shape: ListPredictorBacktestExportJobsRequest)
|
1090
|
+
o.output = Shapes::ShapeRef.new(shape: ListPredictorBacktestExportJobsResponse)
|
1091
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
1092
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1093
|
+
o[:pager] = Aws::Pager.new(
|
1094
|
+
limit_key: "max_results",
|
1095
|
+
tokens: {
|
1096
|
+
"next_token" => "next_token"
|
1097
|
+
}
|
1098
|
+
)
|
1099
|
+
end)
|
1100
|
+
|
985
1101
|
api.add_operation(:list_predictors, Seahorse::Model::Operation.new.tap do |o|
|
986
1102
|
o.name = "ListPredictors"
|
987
1103
|
o.http_method = "POST"
|
@@ -645,6 +645,96 @@ module Aws::ForecastService
|
|
645
645
|
include Aws::Structure
|
646
646
|
end
|
647
647
|
|
648
|
+
# @note When making an API call, you may pass CreatePredictorBacktestExportJobRequest
|
649
|
+
# data as a hash:
|
650
|
+
#
|
651
|
+
# {
|
652
|
+
# predictor_backtest_export_job_name: "Name", # required
|
653
|
+
# predictor_arn: "Arn", # required
|
654
|
+
# destination: { # required
|
655
|
+
# s3_config: { # required
|
656
|
+
# path: "S3Path", # required
|
657
|
+
# role_arn: "Arn", # required
|
658
|
+
# kms_key_arn: "KMSKeyArn",
|
659
|
+
# },
|
660
|
+
# },
|
661
|
+
# tags: [
|
662
|
+
# {
|
663
|
+
# key: "TagKey", # required
|
664
|
+
# value: "TagValue", # required
|
665
|
+
# },
|
666
|
+
# ],
|
667
|
+
# }
|
668
|
+
#
|
669
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
670
|
+
# The name for the backtest export job.
|
671
|
+
# @return [String]
|
672
|
+
#
|
673
|
+
# @!attribute [rw] predictor_arn
|
674
|
+
# The Amazon Resource Name (ARN) of the predictor that you want to
|
675
|
+
# export.
|
676
|
+
# @return [String]
|
677
|
+
#
|
678
|
+
# @!attribute [rw] destination
|
679
|
+
# The destination for an export job, an AWS Identity and Access
|
680
|
+
# Management (IAM) role that allows Amazon Forecast to access the
|
681
|
+
# location and, optionally, an AWS Key Management Service (KMS) key.
|
682
|
+
# @return [Types::DataDestination]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] tags
|
685
|
+
# Optional metadata to help you categorize and organize your
|
686
|
+
# backtests. Each tag consists of a key and an optional value, both of
|
687
|
+
# which you define. Tag keys and values are case sensitive.
|
688
|
+
#
|
689
|
+
# The following restrictions apply to tags:
|
690
|
+
#
|
691
|
+
# * For each resource, each tag key must be unique and each tag key
|
692
|
+
# must have one value.
|
693
|
+
#
|
694
|
+
# * Maximum number of tags per resource: 50.
|
695
|
+
#
|
696
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
697
|
+
#
|
698
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
699
|
+
#
|
700
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
701
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
702
|
+
# across other services and resources, the character restrictions of
|
703
|
+
# those services also apply.
|
704
|
+
#
|
705
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
706
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
707
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
708
|
+
# be a user tag and will count against the limit of 50 tags. Tags
|
709
|
+
# with only the key prefix of `aws` do not count against your tags
|
710
|
+
# per resource limit. You cannot edit or delete tag keys with this
|
711
|
+
# prefix.
|
712
|
+
# @return [Array<Types::Tag>]
|
713
|
+
#
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobRequest AWS API Documentation
|
715
|
+
#
|
716
|
+
class CreatePredictorBacktestExportJobRequest < Struct.new(
|
717
|
+
:predictor_backtest_export_job_name,
|
718
|
+
:predictor_arn,
|
719
|
+
:destination,
|
720
|
+
:tags)
|
721
|
+
SENSITIVE = []
|
722
|
+
include Aws::Structure
|
723
|
+
end
|
724
|
+
|
725
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
726
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job
|
727
|
+
# that you want to export.
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobResponse AWS API Documentation
|
731
|
+
#
|
732
|
+
class CreatePredictorBacktestExportJobResponse < Struct.new(
|
733
|
+
:predictor_backtest_export_job_arn)
|
734
|
+
SENSITIVE = []
|
735
|
+
include Aws::Structure
|
736
|
+
end
|
737
|
+
|
648
738
|
# @note When making an API call, you may pass CreatePredictorRequest
|
649
739
|
# data as a hash:
|
650
740
|
#
|
@@ -652,6 +742,7 @@ module Aws::ForecastService
|
|
652
742
|
# predictor_name: "Name", # required
|
653
743
|
# algorithm_arn: "Arn",
|
654
744
|
# forecast_horizon: 1, # required
|
745
|
+
# forecast_types: ["ForecastType"],
|
655
746
|
# perform_auto_ml: false,
|
656
747
|
# perform_hpo: false,
|
657
748
|
# training_parameters: {
|
@@ -737,9 +828,9 @@ module Aws::ForecastService
|
|
737
828
|
#
|
738
829
|
# * `arn:aws:forecast:::algorithm/ARIMA`
|
739
830
|
#
|
740
|
-
# * `arn:aws:forecast:::algorithm/
|
831
|
+
# * `arn:aws:forecast:::algorithm/CNN-QR`
|
741
832
|
#
|
742
|
-
#
|
833
|
+
# * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
|
743
834
|
#
|
744
835
|
# * `arn:aws:forecast:::algorithm/ETS`
|
745
836
|
#
|
@@ -761,6 +852,15 @@ module Aws::ForecastService
|
|
761
852
|
# of the TARGET\_TIME\_SERIES dataset length.
|
762
853
|
# @return [Integer]
|
763
854
|
#
|
855
|
+
# @!attribute [rw] forecast_types
|
856
|
+
# Specifies the forecast types used to train a predictor. You can
|
857
|
+
# specify up to five forecast types. Forecast types can be quantiles
|
858
|
+
# from 0.01 to 0.99, by increments of 0.01 or higher. You can also
|
859
|
+
# specify the mean forecast with `mean`.
|
860
|
+
#
|
861
|
+
# The default value is `["0.10", "0.50", "0.9"]`.
|
862
|
+
# @return [Array<String>]
|
863
|
+
#
|
764
864
|
# @!attribute [rw] perform_auto_ml
|
765
865
|
# Whether to perform AutoML. When Amazon Forecast performs AutoML, it
|
766
866
|
# evaluates the algorithms it provides and chooses the best algorithm
|
@@ -790,11 +890,11 @@ module Aws::ForecastService
|
|
790
890
|
# hyperparameter. In this case, you are required to specify an
|
791
891
|
# algorithm and `PerformAutoML` must be false.
|
792
892
|
#
|
793
|
-
# The following
|
893
|
+
# The following algorithms support HPO:
|
794
894
|
#
|
795
895
|
# * DeepAR+
|
796
896
|
#
|
797
|
-
#
|
897
|
+
# * CNN-QR
|
798
898
|
# @return [Boolean]
|
799
899
|
#
|
800
900
|
# @!attribute [rw] training_parameters
|
@@ -877,6 +977,7 @@ module Aws::ForecastService
|
|
877
977
|
:predictor_name,
|
878
978
|
:algorithm_arn,
|
879
979
|
:forecast_horizon,
|
980
|
+
:forecast_types,
|
880
981
|
:perform_auto_ml,
|
881
982
|
:perform_hpo,
|
882
983
|
:training_parameters,
|
@@ -902,10 +1003,9 @@ module Aws::ForecastService
|
|
902
1003
|
include Aws::Structure
|
903
1004
|
end
|
904
1005
|
|
905
|
-
# The destination for an
|
1006
|
+
# The destination for an export job, an AWS Identity and Access
|
906
1007
|
# Management (IAM) role that allows Amazon Forecast to access the
|
907
1008
|
# location and, optionally, an AWS Key Management Service (KMS) key.
|
908
|
-
# This object is submitted in the CreateForecastExportJob request.
|
909
1009
|
#
|
910
1010
|
# @note When making an API call, you may pass DataDestination
|
911
1011
|
# data as a hash:
|
@@ -1205,6 +1305,26 @@ module Aws::ForecastService
|
|
1205
1305
|
include Aws::Structure
|
1206
1306
|
end
|
1207
1307
|
|
1308
|
+
# @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
|
1309
|
+
# data as a hash:
|
1310
|
+
#
|
1311
|
+
# {
|
1312
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1313
|
+
# }
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1316
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job
|
1317
|
+
# to delete.
|
1318
|
+
# @return [String]
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
|
1321
|
+
#
|
1322
|
+
class DeletePredictorBacktestExportJobRequest < Struct.new(
|
1323
|
+
:predictor_backtest_export_job_arn)
|
1324
|
+
SENSITIVE = []
|
1325
|
+
include Aws::Structure
|
1326
|
+
end
|
1327
|
+
|
1208
1328
|
# @note When making an API call, you may pass DeletePredictorRequest
|
1209
1329
|
# data as a hash:
|
1210
1330
|
#
|
@@ -1693,6 +1813,89 @@ module Aws::ForecastService
|
|
1693
1813
|
include Aws::Structure
|
1694
1814
|
end
|
1695
1815
|
|
1816
|
+
# @note When making an API call, you may pass DescribePredictorBacktestExportJobRequest
|
1817
|
+
# data as a hash:
|
1818
|
+
#
|
1819
|
+
# {
|
1820
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1821
|
+
# }
|
1822
|
+
#
|
1823
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1824
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1825
|
+
# @return [String]
|
1826
|
+
#
|
1827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobRequest AWS API Documentation
|
1828
|
+
#
|
1829
|
+
class DescribePredictorBacktestExportJobRequest < Struct.new(
|
1830
|
+
:predictor_backtest_export_job_arn)
|
1831
|
+
SENSITIVE = []
|
1832
|
+
include Aws::Structure
|
1833
|
+
end
|
1834
|
+
|
1835
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1836
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1837
|
+
# @return [String]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
1840
|
+
# The name of the predictor backtest export job.
|
1841
|
+
# @return [String]
|
1842
|
+
#
|
1843
|
+
# @!attribute [rw] predictor_arn
|
1844
|
+
# The Amazon Resource Name (ARN) of the predictor.
|
1845
|
+
# @return [String]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] destination
|
1848
|
+
# The destination for an export job, an AWS Identity and Access
|
1849
|
+
# Management (IAM) role that allows Amazon Forecast to access the
|
1850
|
+
# location and, optionally, an AWS Key Management Service (KMS) key.
|
1851
|
+
# @return [Types::DataDestination]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] message
|
1854
|
+
# Information about any errors that may have occurred during the
|
1855
|
+
# backtest export.
|
1856
|
+
# @return [String]
|
1857
|
+
#
|
1858
|
+
# @!attribute [rw] status
|
1859
|
+
# The status of the predictor backtest export job. States include:
|
1860
|
+
#
|
1861
|
+
# * `ACTIVE`
|
1862
|
+
#
|
1863
|
+
# * `CREATE_PENDING`
|
1864
|
+
#
|
1865
|
+
# * `CREATE_IN_PROGRESS`
|
1866
|
+
#
|
1867
|
+
# * `CREATE_FAILED`
|
1868
|
+
#
|
1869
|
+
# * `DELETE_PENDING`
|
1870
|
+
#
|
1871
|
+
# * `DELETE_IN_PROGRESS`
|
1872
|
+
#
|
1873
|
+
# * `DELETE_FAILED`
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] creation_time
|
1877
|
+
# When the predictor backtest export job was created.
|
1878
|
+
# @return [Time]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] last_modification_time
|
1881
|
+
# When the last successful export job finished.
|
1882
|
+
# @return [Time]
|
1883
|
+
#
|
1884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobResponse AWS API Documentation
|
1885
|
+
#
|
1886
|
+
class DescribePredictorBacktestExportJobResponse < Struct.new(
|
1887
|
+
:predictor_backtest_export_job_arn,
|
1888
|
+
:predictor_backtest_export_job_name,
|
1889
|
+
:predictor_arn,
|
1890
|
+
:destination,
|
1891
|
+
:message,
|
1892
|
+
:status,
|
1893
|
+
:creation_time,
|
1894
|
+
:last_modification_time)
|
1895
|
+
SENSITIVE = []
|
1896
|
+
include Aws::Structure
|
1897
|
+
end
|
1898
|
+
|
1696
1899
|
# @note When making an API call, you may pass DescribePredictorRequest
|
1697
1900
|
# data as a hash:
|
1698
1901
|
#
|
@@ -1731,6 +1934,11 @@ module Aws::ForecastService
|
|
1731
1934
|
# also called the prediction length.
|
1732
1935
|
# @return [Integer]
|
1733
1936
|
#
|
1937
|
+
# @!attribute [rw] forecast_types
|
1938
|
+
# The forecast types used during predictor training. Default value is
|
1939
|
+
# `["0.1","0.5","0.9"]`
|
1940
|
+
# @return [Array<String>]
|
1941
|
+
#
|
1734
1942
|
# @!attribute [rw] perform_auto_ml
|
1735
1943
|
# Whether the predictor is set to perform AutoML.
|
1736
1944
|
# @return [Boolean]
|
@@ -1742,10 +1950,9 @@ module Aws::ForecastService
|
|
1742
1950
|
#
|
1743
1951
|
# @!attribute [rw] training_parameters
|
1744
1952
|
# The default training parameters or overrides selected during model
|
1745
|
-
# training.
|
1746
|
-
#
|
1747
|
-
#
|
1748
|
-
# aws-forecast-choosing-recipes.
|
1953
|
+
# training. When running AutoML or choosing HPO with CNN-QR or
|
1954
|
+
# DeepAR+, the optimized values for the chosen hyperparameters are
|
1955
|
+
# returned. For more information, see aws-forecast-choosing-recipes.
|
1749
1956
|
# @return [Hash<String,String>]
|
1750
1957
|
#
|
1751
1958
|
# @!attribute [rw] evaluation_parameters
|
@@ -1830,6 +2037,7 @@ module Aws::ForecastService
|
|
1830
2037
|
:predictor_name,
|
1831
2038
|
:algorithm_arn,
|
1832
2039
|
:forecast_horizon,
|
2040
|
+
:forecast_types,
|
1833
2041
|
:perform_auto_ml,
|
1834
2042
|
:perform_hpo,
|
1835
2043
|
:training_parameters,
|
@@ -1884,6 +2092,31 @@ module Aws::ForecastService
|
|
1884
2092
|
include Aws::Structure
|
1885
2093
|
end
|
1886
2094
|
|
2095
|
+
# Provides detailed error metrics to evaluate the performance of a
|
2096
|
+
# predictor. This object is part of the Metrics object.
|
2097
|
+
#
|
2098
|
+
# @!attribute [rw] forecast_type
|
2099
|
+
# The Forecast type used to compute WAPE and RMSE.
|
2100
|
+
# @return [String]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] wape
|
2103
|
+
# The weighted absolute percentage error (WAPE).
|
2104
|
+
# @return [Float]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] rmse
|
2107
|
+
# The root-mean-square error (RMSE).
|
2108
|
+
# @return [Float]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class ErrorMetric < Struct.new(
|
2113
|
+
:forecast_type,
|
2114
|
+
:wape,
|
2115
|
+
:rmse)
|
2116
|
+
SENSITIVE = []
|
2117
|
+
include Aws::Structure
|
2118
|
+
end
|
2119
|
+
|
1887
2120
|
# Parameters that define how to split a dataset into training data and
|
1888
2121
|
# testing data, and the number of iterations to perform. These
|
1889
2122
|
# parameters are specified in the predefined algorithms but you can
|
@@ -2146,6 +2379,11 @@ module Aws::ForecastService
|
|
2146
2379
|
# * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2147
2380
|
#
|
2148
2381
|
# * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2382
|
+
#
|
2383
|
+
# To set a filling method to a specific value, set the fill parameter
|
2384
|
+
# to `value` and define the value in a corresponding `_value`
|
2385
|
+
# parameter. For example, to set backfilling to a value of 2, include
|
2386
|
+
# the following: `"backfill": "value"` and `"backfill_value":"2"`.
|
2149
2387
|
# @return [Hash<String,String>]
|
2150
2388
|
#
|
2151
2389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationMethod AWS API Documentation
|
@@ -2886,6 +3124,80 @@ module Aws::ForecastService
|
|
2886
3124
|
include Aws::Structure
|
2887
3125
|
end
|
2888
3126
|
|
3127
|
+
# @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
|
3128
|
+
# data as a hash:
|
3129
|
+
#
|
3130
|
+
# {
|
3131
|
+
# next_token: "NextToken",
|
3132
|
+
# max_results: 1,
|
3133
|
+
# filters: [
|
3134
|
+
# {
|
3135
|
+
# key: "String", # required
|
3136
|
+
# value: "Arn", # required
|
3137
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3138
|
+
# },
|
3139
|
+
# ],
|
3140
|
+
# }
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] next_token
|
3143
|
+
# If the result of the previous request was truncated, the response
|
3144
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
3145
|
+
# token in the next request. Tokens expire after 24 hours.
|
3146
|
+
# @return [String]
|
3147
|
+
#
|
3148
|
+
# @!attribute [rw] max_results
|
3149
|
+
# The number of items to return in the response.
|
3150
|
+
# @return [Integer]
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] filters
|
3153
|
+
# An array of filters. For each filter, provide a condition and a
|
3154
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
3155
|
+
# specifies whether to include or exclude the predictor backtest
|
3156
|
+
# export jobs that match the statement from the list. The match
|
3157
|
+
# statement consists of a key and a value.
|
3158
|
+
#
|
3159
|
+
# **Filter properties**
|
3160
|
+
#
|
3161
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3162
|
+
# `IS_NOT`. To include the predictor backtest export jobs that match
|
3163
|
+
# the statement, specify `IS`. To exclude matching predictor
|
3164
|
+
# backtest export jobs, specify `IS_NOT`.
|
3165
|
+
#
|
3166
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
3167
|
+
# `PredictorBacktestExportJobArn` and `Status`.
|
3168
|
+
#
|
3169
|
+
# * `Value` - The value to match.
|
3170
|
+
# @return [Array<Types::Filter>]
|
3171
|
+
#
|
3172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsRequest AWS API Documentation
|
3173
|
+
#
|
3174
|
+
class ListPredictorBacktestExportJobsRequest < Struct.new(
|
3175
|
+
:next_token,
|
3176
|
+
:max_results,
|
3177
|
+
:filters)
|
3178
|
+
SENSITIVE = []
|
3179
|
+
include Aws::Structure
|
3180
|
+
end
|
3181
|
+
|
3182
|
+
# @!attribute [rw] predictor_backtest_export_jobs
|
3183
|
+
# An array of objects that summarize the properties of each predictor
|
3184
|
+
# backtest export job.
|
3185
|
+
# @return [Array<Types::PredictorBacktestExportJobSummary>]
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] next_token
|
3188
|
+
# Returns this token if the response is truncated. To retrieve the
|
3189
|
+
# next set of results, use the token in the next request.
|
3190
|
+
# @return [String]
|
3191
|
+
#
|
3192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsResponse AWS API Documentation
|
3193
|
+
#
|
3194
|
+
class ListPredictorBacktestExportJobsResponse < Struct.new(
|
3195
|
+
:predictor_backtest_export_jobs,
|
3196
|
+
:next_token)
|
3197
|
+
SENSITIVE = []
|
3198
|
+
include Aws::Structure
|
3199
|
+
end
|
3200
|
+
|
2889
3201
|
# @note When making an API call, you may pass ListPredictorsRequest
|
2890
3202
|
# data as a hash:
|
2891
3203
|
#
|
@@ -3002,7 +3314,7 @@ module Aws::ForecastService
|
|
3002
3314
|
# predictor. This object is part of the WindowSummary object.
|
3003
3315
|
#
|
3004
3316
|
# @!attribute [rw] rmse
|
3005
|
-
# The root
|
3317
|
+
# The root-mean-square error (RMSE).
|
3006
3318
|
# @return [Float]
|
3007
3319
|
#
|
3008
3320
|
# @!attribute [rw] weighted_quantile_losses
|
@@ -3011,11 +3323,17 @@ module Aws::ForecastService
|
|
3011
3323
|
# this case is the loss function.
|
3012
3324
|
# @return [Array<Types::WeightedQuantileLoss>]
|
3013
3325
|
#
|
3326
|
+
# @!attribute [rw] error_metrics
|
3327
|
+
# Provides detailed error metrics on forecast type, root-mean
|
3328
|
+
# square-error (RMSE), and weighted average percentage error (WAPE).
|
3329
|
+
# @return [Array<Types::ErrorMetric>]
|
3330
|
+
#
|
3014
3331
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Metrics AWS API Documentation
|
3015
3332
|
#
|
3016
3333
|
class Metrics < Struct.new(
|
3017
3334
|
:rmse,
|
3018
|
-
:weighted_quantile_losses
|
3335
|
+
:weighted_quantile_losses,
|
3336
|
+
:error_metrics)
|
3019
3337
|
SENSITIVE = []
|
3020
3338
|
include Aws::Structure
|
3021
3339
|
end
|
@@ -3076,6 +3394,71 @@ module Aws::ForecastService
|
|
3076
3394
|
include Aws::Structure
|
3077
3395
|
end
|
3078
3396
|
|
3397
|
+
# Provides a summary of the predictor backtest export job properties
|
3398
|
+
# used in the ListPredictorBacktestExportJobs operation. To get a
|
3399
|
+
# complete set of properties, call the
|
3400
|
+
# DescribePredictorBacktestExportJob operation, and provide the listed
|
3401
|
+
# `PredictorBacktestExportJobArn`.
|
3402
|
+
#
|
3403
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
3404
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
3405
|
+
# @return [String]
|
3406
|
+
#
|
3407
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
3408
|
+
# The name of the predictor backtest export job.
|
3409
|
+
# @return [String]
|
3410
|
+
#
|
3411
|
+
# @!attribute [rw] destination
|
3412
|
+
# The destination for an export job, an AWS Identity and Access
|
3413
|
+
# Management (IAM) role that allows Amazon Forecast to access the
|
3414
|
+
# location and, optionally, an AWS Key Management Service (KMS) key.
|
3415
|
+
# @return [Types::DataDestination]
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] status
|
3418
|
+
# The status of the predictor backtest export job. States include:
|
3419
|
+
#
|
3420
|
+
# * `ACTIVE`
|
3421
|
+
#
|
3422
|
+
# * `CREATE_PENDING`
|
3423
|
+
#
|
3424
|
+
# * `CREATE_IN_PROGRESS`
|
3425
|
+
#
|
3426
|
+
# * `CREATE_FAILED`
|
3427
|
+
#
|
3428
|
+
# * `DELETE_PENDING`
|
3429
|
+
#
|
3430
|
+
# * `DELETE_IN_PROGRESS`
|
3431
|
+
#
|
3432
|
+
# * `DELETE_FAILED`
|
3433
|
+
# @return [String]
|
3434
|
+
#
|
3435
|
+
# @!attribute [rw] message
|
3436
|
+
# Information about any errors that may have occurred during the
|
3437
|
+
# backtest export.
|
3438
|
+
# @return [String]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] creation_time
|
3441
|
+
# When the predictor backtest export job was created.
|
3442
|
+
# @return [Time]
|
3443
|
+
#
|
3444
|
+
# @!attribute [rw] last_modification_time
|
3445
|
+
# When the last successful export job finished.
|
3446
|
+
# @return [Time]
|
3447
|
+
#
|
3448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorBacktestExportJobSummary AWS API Documentation
|
3449
|
+
#
|
3450
|
+
class PredictorBacktestExportJobSummary < Struct.new(
|
3451
|
+
:predictor_backtest_export_job_arn,
|
3452
|
+
:predictor_backtest_export_job_name,
|
3453
|
+
:destination,
|
3454
|
+
:status,
|
3455
|
+
:message,
|
3456
|
+
:creation_time,
|
3457
|
+
:last_modification_time)
|
3458
|
+
SENSITIVE = []
|
3459
|
+
include Aws::Structure
|
3460
|
+
end
|
3461
|
+
|
3079
3462
|
# The algorithm used to perform a backtest and the status of those
|
3080
3463
|
# tests.
|
3081
3464
|
#
|
@@ -3228,8 +3611,7 @@ module Aws::ForecastService
|
|
3228
3611
|
# Amazon Forecast can assume to access the file(s). Optionally, includes
|
3229
3612
|
# an AWS Key Management Service (KMS) key. This object is part of the
|
3230
3613
|
# DataSource object that is submitted in the CreateDatasetImportJob
|
3231
|
-
# request, and part of the DataDestination object
|
3232
|
-
# the CreateForecastExportJob request.
|
3614
|
+
# request, and part of the DataDestination object.
|
3233
3615
|
#
|
3234
3616
|
# @note When making an API call, you may pass S3Config
|
3235
3617
|
# data as a hash:
|
@@ -3381,39 +3763,10 @@ module Aws::ForecastService
|
|
3381
3763
|
# Describes a supplementary feature of a dataset group. This object is
|
3382
3764
|
# part of the InputDataConfig object.
|
3383
3765
|
#
|
3384
|
-
# The only supported feature is
|
3385
|
-
#
|
3386
|
-
#
|
3387
|
-
#
|
3388
|
-
#
|
3389
|
-
# India and Korea's holidays are not included in the Jollyday library,
|
3390
|
-
# but both are supported by Amazon Forecast. Their holidays are:
|
3391
|
-
#
|
3392
|
-
# **"IN" - INDIA**
|
3393
|
-
#
|
3394
|
-
# * `JANUARY 26 - REPUBLIC DAY`
|
3395
|
-
#
|
3396
|
-
# * `AUGUST 15 - INDEPENDENCE DAY`
|
3397
|
-
#
|
3398
|
-
# * `OCTOBER 2 GANDHI'S BIRTHDAY`
|
3399
|
-
#
|
3400
|
-
# **"KR" - KOREA**
|
3401
|
-
#
|
3402
|
-
# * `JANUARY 1 - NEW YEAR`
|
3403
|
-
#
|
3404
|
-
# * `MARCH 1 - INDEPENDENCE MOVEMENT DAY`
|
3405
|
-
#
|
3406
|
-
# * `MAY 5 - CHILDREN'S DAY`
|
3407
|
-
#
|
3408
|
-
# * `JUNE 6 - MEMORIAL DAY`
|
3409
|
-
#
|
3410
|
-
# * `AUGUST 15 - LIBERATION DAY`
|
3411
|
-
#
|
3412
|
-
# * `OCTOBER 3 - NATIONAL FOUNDATION DAY`
|
3413
|
-
#
|
3414
|
-
# * `OCTOBER 9 - HANGEUL DAY`
|
3415
|
-
#
|
3416
|
-
# * `DECEMBER 25 - CHRISTMAS DAY`
|
3766
|
+
# The only supported feature is Holidays. If you use the calendar, all
|
3767
|
+
# data in the datasets should belong to the same country as the
|
3768
|
+
# calendar. For the holiday calendar data, see the [Jollyday][1]
|
3769
|
+
# website.
|
3417
3770
|
#
|
3418
3771
|
#
|
3419
3772
|
#
|
@@ -3434,19 +3787,35 @@ module Aws::ForecastService
|
|
3434
3787
|
# @!attribute [rw] value
|
3435
3788
|
# One of the following 2 letter country codes:
|
3436
3789
|
#
|
3790
|
+
# * "AL" - ALBANIA
|
3791
|
+
#
|
3437
3792
|
# * "AR" - ARGENTINA
|
3438
3793
|
#
|
3439
3794
|
# * "AT" - AUSTRIA
|
3440
3795
|
#
|
3441
3796
|
# * "AU" - AUSTRALIA
|
3442
3797
|
#
|
3798
|
+
# * "BA" - BOSNIA HERZEGOVINA
|
3799
|
+
#
|
3443
3800
|
# * "BE" - BELGIUM
|
3444
3801
|
#
|
3802
|
+
# * "BG" - BULGARIA
|
3803
|
+
#
|
3804
|
+
# * "BO" - BOLIVIA
|
3805
|
+
#
|
3445
3806
|
# * "BR" - BRAZIL
|
3446
3807
|
#
|
3808
|
+
# * "BY" - BELARUS
|
3809
|
+
#
|
3447
3810
|
# * "CA" - CANADA
|
3448
3811
|
#
|
3449
|
-
# * "
|
3812
|
+
# * "CL" - CHILE
|
3813
|
+
#
|
3814
|
+
# * "CO" - COLOMBIA
|
3815
|
+
#
|
3816
|
+
# * "CR" - COSTA RICA
|
3817
|
+
#
|
3818
|
+
# * "HR" - CROATIA
|
3450
3819
|
#
|
3451
3820
|
# * "CZ" - CZECH REPUBLIC
|
3452
3821
|
#
|
@@ -3454,38 +3823,82 @@ module Aws::ForecastService
|
|
3454
3823
|
#
|
3455
3824
|
# * "EC" - ECUADOR
|
3456
3825
|
#
|
3826
|
+
# * "EE" - ESTONIA
|
3827
|
+
#
|
3828
|
+
# * "ET" - ETHIOPIA
|
3829
|
+
#
|
3457
3830
|
# * "FI" - FINLAND
|
3458
3831
|
#
|
3459
3832
|
# * "FR" - FRANCE
|
3460
3833
|
#
|
3461
3834
|
# * "DE" - GERMANY
|
3462
3835
|
#
|
3836
|
+
# * "GR" - GREECE
|
3837
|
+
#
|
3463
3838
|
# * "HU" - HUNGARY
|
3464
3839
|
#
|
3465
|
-
# * "
|
3840
|
+
# * "IS" - ICELAND
|
3466
3841
|
#
|
3467
3842
|
# * "IN" - INDIA
|
3468
3843
|
#
|
3844
|
+
# * "IE" - IRELAND
|
3845
|
+
#
|
3469
3846
|
# * "IT" - ITALY
|
3470
3847
|
#
|
3471
3848
|
# * "JP" - JAPAN
|
3472
3849
|
#
|
3850
|
+
# * "KZ" - KAZAKHSTAN
|
3851
|
+
#
|
3473
3852
|
# * "KR" - KOREA
|
3474
3853
|
#
|
3854
|
+
# * "LV" - LATVIA
|
3855
|
+
#
|
3856
|
+
# * "LI" - LIECHTENSTEIN
|
3857
|
+
#
|
3858
|
+
# * "LT" - LITHUANIA
|
3859
|
+
#
|
3475
3860
|
# * "LU" - LUXEMBOURG
|
3476
3861
|
#
|
3862
|
+
# * "MK" - MACEDONIA
|
3863
|
+
#
|
3864
|
+
# * "MT" - MALTA
|
3865
|
+
#
|
3477
3866
|
# * "MX" - MEXICO
|
3478
3867
|
#
|
3868
|
+
# * "MD" - MOLDOVA
|
3869
|
+
#
|
3870
|
+
# * "ME" - MONTENEGRO
|
3871
|
+
#
|
3479
3872
|
# * "NL" - NETHERLANDS
|
3480
3873
|
#
|
3874
|
+
# * "NZ" - NEW ZEALAND
|
3875
|
+
#
|
3876
|
+
# * "NI" - NICARAGUA
|
3877
|
+
#
|
3878
|
+
# * "NG" - NIGERIA
|
3879
|
+
#
|
3481
3880
|
# * "NO" - NORWAY
|
3482
3881
|
#
|
3882
|
+
# * "PA" - PANAMA
|
3883
|
+
#
|
3884
|
+
# * "PY" - PARAGUAY
|
3885
|
+
#
|
3886
|
+
# * "PE" - PERU
|
3887
|
+
#
|
3483
3888
|
# * "PL" - POLAND
|
3484
3889
|
#
|
3485
3890
|
# * "PT" - PORTUGAL
|
3486
3891
|
#
|
3892
|
+
# * "RO" - ROMANIA
|
3893
|
+
#
|
3487
3894
|
# * "RU" - RUSSIA
|
3488
3895
|
#
|
3896
|
+
# * "RS" - SERBIA
|
3897
|
+
#
|
3898
|
+
# * "SK" - SLOVAKIA
|
3899
|
+
#
|
3900
|
+
# * "SI" - SLOVENIA
|
3901
|
+
#
|
3489
3902
|
# * "ZA" - SOUTH AFRICA
|
3490
3903
|
#
|
3491
3904
|
# * "ES" - SPAIN
|
@@ -3494,9 +3907,17 @@ module Aws::ForecastService
|
|
3494
3907
|
#
|
3495
3908
|
# * "CH" - SWITZERLAND
|
3496
3909
|
#
|
3910
|
+
# * "UA" - UKRAINE
|
3911
|
+
#
|
3912
|
+
# * "AE" - UNITED ARAB EMIRATES
|
3913
|
+
#
|
3497
3914
|
# * "US" - UNITED STATES
|
3498
3915
|
#
|
3499
3916
|
# * "UK" - UNITED KINGDOM
|
3917
|
+
#
|
3918
|
+
# * "UY" - URUGUAY
|
3919
|
+
#
|
3920
|
+
# * "VE" - VENEZUELA
|
3500
3921
|
# @return [String]
|
3501
3922
|
#
|
3502
3923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SupplementaryFeature AWS API Documentation
|