aws-sdk-forecastservice 1.11.0 → 1.16.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 +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +384 -25
- data/lib/aws-sdk-forecastservice/client_api.rb +141 -1
- data/lib/aws-sdk-forecastservice/types.rb +686 -90
- 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')
|
@@ -86,6 +93,7 @@ module Aws::ForecastService
|
|
86
93
|
ForecastTypes = Shapes::ListShape.new(name: 'ForecastTypes')
|
87
94
|
Forecasts = Shapes::ListShape.new(name: 'Forecasts')
|
88
95
|
Frequency = Shapes::StringShape.new(name: 'Frequency')
|
96
|
+
GeolocationFormat = Shapes::StringShape.new(name: 'GeolocationFormat')
|
89
97
|
GetAccuracyMetricsRequest = Shapes::StructureShape.new(name: 'GetAccuracyMetricsRequest')
|
90
98
|
GetAccuracyMetricsResponse = Shapes::StructureShape.new(name: 'GetAccuracyMetricsResponse')
|
91
99
|
HyperParameterTuningJobConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobConfig')
|
@@ -107,6 +115,8 @@ module Aws::ForecastService
|
|
107
115
|
ListForecastExportJobsResponse = Shapes::StructureShape.new(name: 'ListForecastExportJobsResponse')
|
108
116
|
ListForecastsRequest = Shapes::StructureShape.new(name: 'ListForecastsRequest')
|
109
117
|
ListForecastsResponse = Shapes::StructureShape.new(name: 'ListForecastsResponse')
|
118
|
+
ListPredictorBacktestExportJobsRequest = Shapes::StructureShape.new(name: 'ListPredictorBacktestExportJobsRequest')
|
119
|
+
ListPredictorBacktestExportJobsResponse = Shapes::StructureShape.new(name: 'ListPredictorBacktestExportJobsResponse')
|
110
120
|
ListPredictorsRequest = Shapes::StructureShape.new(name: 'ListPredictorsRequest')
|
111
121
|
ListPredictorsResponse = Shapes::StructureShape.new(name: 'ListPredictorsResponse')
|
112
122
|
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
@@ -119,6 +129,8 @@ module Aws::ForecastService
|
|
119
129
|
ParameterKey = Shapes::StringShape.new(name: 'ParameterKey')
|
120
130
|
ParameterRanges = Shapes::StructureShape.new(name: 'ParameterRanges')
|
121
131
|
ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
|
132
|
+
PredictorBacktestExportJobSummary = Shapes::StructureShape.new(name: 'PredictorBacktestExportJobSummary')
|
133
|
+
PredictorBacktestExportJobs = Shapes::ListShape.new(name: 'PredictorBacktestExportJobs')
|
122
134
|
PredictorEvaluationResults = Shapes::ListShape.new(name: 'PredictorEvaluationResults')
|
123
135
|
PredictorExecution = Shapes::StructureShape.new(name: 'PredictorExecution')
|
124
136
|
PredictorExecutionDetails = Shapes::StructureShape.new(name: 'PredictorExecutionDetails')
|
@@ -136,6 +148,7 @@ module Aws::ForecastService
|
|
136
148
|
SchemaAttributes = Shapes::ListShape.new(name: 'SchemaAttributes')
|
137
149
|
Statistics = Shapes::StructureShape.new(name: 'Statistics')
|
138
150
|
Status = Shapes::StringShape.new(name: 'Status')
|
151
|
+
StopResourceRequest = Shapes::StructureShape.new(name: 'StopResourceRequest')
|
139
152
|
String = Shapes::StringShape.new(name: 'String')
|
140
153
|
SupplementaryFeature = Shapes::StructureShape.new(name: 'SupplementaryFeature')
|
141
154
|
SupplementaryFeatures = Shapes::ListShape.new(name: 'SupplementaryFeatures')
|
@@ -149,6 +162,7 @@ module Aws::ForecastService
|
|
149
162
|
TestWindowDetails = Shapes::ListShape.new(name: 'TestWindowDetails')
|
150
163
|
TestWindowSummary = Shapes::StructureShape.new(name: 'TestWindowSummary')
|
151
164
|
TestWindows = Shapes::ListShape.new(name: 'TestWindows')
|
165
|
+
TimeZone = Shapes::StringShape.new(name: 'TimeZone')
|
152
166
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
153
167
|
TimestampFormat = Shapes::StringShape.new(name: 'TimestampFormat')
|
154
168
|
TrainingParameters = Shapes::MapShape.new(name: 'TrainingParameters')
|
@@ -156,6 +170,7 @@ module Aws::ForecastService
|
|
156
170
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
157
171
|
UpdateDatasetGroupRequest = Shapes::StructureShape.new(name: 'UpdateDatasetGroupRequest')
|
158
172
|
UpdateDatasetGroupResponse = Shapes::StructureShape.new(name: 'UpdateDatasetGroupResponse')
|
173
|
+
UseGeolocationForTimeZone = Shapes::BooleanShape.new(name: 'UseGeolocationForTimeZone')
|
159
174
|
Value = Shapes::StringShape.new(name: 'Value')
|
160
175
|
Values = Shapes::ListShape.new(name: 'Values')
|
161
176
|
WeightedQuantileLoss = Shapes::StructureShape.new(name: 'WeightedQuantileLoss')
|
@@ -191,6 +206,9 @@ module Aws::ForecastService
|
|
191
206
|
CreateDatasetImportJobRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetArn"))
|
192
207
|
CreateDatasetImportJobRequest.add_member(:data_source, Shapes::ShapeRef.new(shape: DataSource, required: true, location_name: "DataSource"))
|
193
208
|
CreateDatasetImportJobRequest.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "TimestampFormat"))
|
209
|
+
CreateDatasetImportJobRequest.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
|
210
|
+
CreateDatasetImportJobRequest.add_member(:use_geolocation_for_time_zone, Shapes::ShapeRef.new(shape: UseGeolocationForTimeZone, location_name: "UseGeolocationForTimeZone"))
|
211
|
+
CreateDatasetImportJobRequest.add_member(:geolocation_format, Shapes::ShapeRef.new(shape: GeolocationFormat, location_name: "GeolocationFormat"))
|
194
212
|
CreateDatasetImportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
195
213
|
CreateDatasetImportJobRequest.struct_class = Types::CreateDatasetImportJobRequest
|
196
214
|
|
@@ -227,9 +245,19 @@ module Aws::ForecastService
|
|
227
245
|
CreateForecastResponse.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "ForecastArn"))
|
228
246
|
CreateForecastResponse.struct_class = Types::CreateForecastResponse
|
229
247
|
|
248
|
+
CreatePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "PredictorBacktestExportJobName"))
|
249
|
+
CreatePredictorBacktestExportJobRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
250
|
+
CreatePredictorBacktestExportJobRequest.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, required: true, location_name: "Destination"))
|
251
|
+
CreatePredictorBacktestExportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
252
|
+
CreatePredictorBacktestExportJobRequest.struct_class = Types::CreatePredictorBacktestExportJobRequest
|
253
|
+
|
254
|
+
CreatePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
255
|
+
CreatePredictorBacktestExportJobResponse.struct_class = Types::CreatePredictorBacktestExportJobResponse
|
256
|
+
|
230
257
|
CreatePredictorRequest.add_member(:predictor_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "PredictorName"))
|
231
258
|
CreatePredictorRequest.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
232
259
|
CreatePredictorRequest.add_member(:forecast_horizon, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "ForecastHorizon"))
|
260
|
+
CreatePredictorRequest.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
233
261
|
CreatePredictorRequest.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformAutoML"))
|
234
262
|
CreatePredictorRequest.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformHPO"))
|
235
263
|
CreatePredictorRequest.add_member(:training_parameters, Shapes::ShapeRef.new(shape: TrainingParameters, location_name: "TrainingParameters"))
|
@@ -294,6 +322,9 @@ module Aws::ForecastService
|
|
294
322
|
DeleteForecastRequest.add_member(:forecast_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ForecastArn"))
|
295
323
|
DeleteForecastRequest.struct_class = Types::DeleteForecastRequest
|
296
324
|
|
325
|
+
DeletePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorBacktestExportJobArn"))
|
326
|
+
DeletePredictorBacktestExportJobRequest.struct_class = Types::DeletePredictorBacktestExportJobRequest
|
327
|
+
|
297
328
|
DeletePredictorRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
298
329
|
DeletePredictorRequest.struct_class = Types::DeletePredictorRequest
|
299
330
|
|
@@ -316,6 +347,9 @@ module Aws::ForecastService
|
|
316
347
|
DescribeDatasetImportJobResponse.add_member(:dataset_import_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetImportJobArn"))
|
317
348
|
DescribeDatasetImportJobResponse.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetArn"))
|
318
349
|
DescribeDatasetImportJobResponse.add_member(:timestamp_format, Shapes::ShapeRef.new(shape: TimestampFormat, location_name: "TimestampFormat"))
|
350
|
+
DescribeDatasetImportJobResponse.add_member(:time_zone, Shapes::ShapeRef.new(shape: TimeZone, location_name: "TimeZone"))
|
351
|
+
DescribeDatasetImportJobResponse.add_member(:use_geolocation_for_time_zone, Shapes::ShapeRef.new(shape: UseGeolocationForTimeZone, location_name: "UseGeolocationForTimeZone"))
|
352
|
+
DescribeDatasetImportJobResponse.add_member(:geolocation_format, Shapes::ShapeRef.new(shape: GeolocationFormat, location_name: "GeolocationFormat"))
|
319
353
|
DescribeDatasetImportJobResponse.add_member(:data_source, Shapes::ShapeRef.new(shape: DataSource, location_name: "DataSource"))
|
320
354
|
DescribeDatasetImportJobResponse.add_member(:field_statistics, Shapes::ShapeRef.new(shape: FieldStatistics, location_name: "FieldStatistics"))
|
321
355
|
DescribeDatasetImportJobResponse.add_member(:data_size, Shapes::ShapeRef.new(shape: Double, location_name: "DataSize"))
|
@@ -367,6 +401,19 @@ module Aws::ForecastService
|
|
367
401
|
DescribeForecastResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
368
402
|
DescribeForecastResponse.struct_class = Types::DescribeForecastResponse
|
369
403
|
|
404
|
+
DescribePredictorBacktestExportJobRequest.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorBacktestExportJobArn"))
|
405
|
+
DescribePredictorBacktestExportJobRequest.struct_class = Types::DescribePredictorBacktestExportJobRequest
|
406
|
+
|
407
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
408
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorBacktestExportJobName"))
|
409
|
+
DescribePredictorBacktestExportJobResponse.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorArn"))
|
410
|
+
DescribePredictorBacktestExportJobResponse.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, location_name: "Destination"))
|
411
|
+
DescribePredictorBacktestExportJobResponse.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
412
|
+
DescribePredictorBacktestExportJobResponse.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
|
413
|
+
DescribePredictorBacktestExportJobResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
414
|
+
DescribePredictorBacktestExportJobResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
415
|
+
DescribePredictorBacktestExportJobResponse.struct_class = Types::DescribePredictorBacktestExportJobResponse
|
416
|
+
|
370
417
|
DescribePredictorRequest.add_member(:predictor_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "PredictorArn"))
|
371
418
|
DescribePredictorRequest.struct_class = Types::DescribePredictorRequest
|
372
419
|
|
@@ -374,6 +421,7 @@ module Aws::ForecastService
|
|
374
421
|
DescribePredictorResponse.add_member(:predictor_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorName"))
|
375
422
|
DescribePredictorResponse.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
376
423
|
DescribePredictorResponse.add_member(:forecast_horizon, Shapes::ShapeRef.new(shape: Integer, location_name: "ForecastHorizon"))
|
424
|
+
DescribePredictorResponse.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
377
425
|
DescribePredictorResponse.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformAutoML"))
|
378
426
|
DescribePredictorResponse.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: Boolean, location_name: "PerformHPO"))
|
379
427
|
DescribePredictorResponse.add_member(:training_parameters, Shapes::ShapeRef.new(shape: TrainingParameters, location_name: "TrainingParameters"))
|
@@ -395,6 +443,13 @@ module Aws::ForecastService
|
|
395
443
|
EncryptionConfig.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KMSKeyArn, required: true, location_name: "KMSKeyArn"))
|
396
444
|
EncryptionConfig.struct_class = Types::EncryptionConfig
|
397
445
|
|
446
|
+
ErrorMetric.add_member(:forecast_type, Shapes::ShapeRef.new(shape: ForecastType, location_name: "ForecastType"))
|
447
|
+
ErrorMetric.add_member(:wape, Shapes::ShapeRef.new(shape: Double, location_name: "WAPE"))
|
448
|
+
ErrorMetric.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
|
449
|
+
ErrorMetric.struct_class = Types::ErrorMetric
|
450
|
+
|
451
|
+
ErrorMetrics.member = Shapes::ShapeRef.new(shape: ErrorMetric)
|
452
|
+
|
398
453
|
EvaluationParameters.add_member(:number_of_backtest_windows, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfBacktestWindows"))
|
399
454
|
EvaluationParameters.add_member(:back_test_window_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BackTestWindowOffset"))
|
400
455
|
EvaluationParameters.struct_class = Types::EvaluationParameters
|
@@ -533,6 +588,15 @@ module Aws::ForecastService
|
|
533
588
|
ListForecastsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
534
589
|
ListForecastsResponse.struct_class = Types::ListForecastsResponse
|
535
590
|
|
591
|
+
ListPredictorBacktestExportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
592
|
+
ListPredictorBacktestExportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
593
|
+
ListPredictorBacktestExportJobsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
594
|
+
ListPredictorBacktestExportJobsRequest.struct_class = Types::ListPredictorBacktestExportJobsRequest
|
595
|
+
|
596
|
+
ListPredictorBacktestExportJobsResponse.add_member(:predictor_backtest_export_jobs, Shapes::ShapeRef.new(shape: PredictorBacktestExportJobs, location_name: "PredictorBacktestExportJobs"))
|
597
|
+
ListPredictorBacktestExportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
598
|
+
ListPredictorBacktestExportJobsResponse.struct_class = Types::ListPredictorBacktestExportJobsResponse
|
599
|
+
|
536
600
|
ListPredictorsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
537
601
|
ListPredictorsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
538
602
|
ListPredictorsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
@@ -548,8 +612,9 @@ module Aws::ForecastService
|
|
548
612
|
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
549
613
|
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
550
614
|
|
551
|
-
Metrics.add_member(:rmse, Shapes::ShapeRef.new(shape: Double, location_name: "RMSE"))
|
615
|
+
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
616
|
Metrics.add_member(:weighted_quantile_losses, Shapes::ShapeRef.new(shape: WeightedQuantileLosses, location_name: "WeightedQuantileLosses"))
|
617
|
+
Metrics.add_member(:error_metrics, Shapes::ShapeRef.new(shape: ErrorMetrics, location_name: "ErrorMetrics"))
|
553
618
|
Metrics.struct_class = Types::Metrics
|
554
619
|
|
555
620
|
ParameterRanges.add_member(:categorical_parameter_ranges, Shapes::ShapeRef.new(shape: CategoricalParameterRanges, location_name: "CategoricalParameterRanges"))
|
@@ -557,6 +622,17 @@ module Aws::ForecastService
|
|
557
622
|
ParameterRanges.add_member(:integer_parameter_ranges, Shapes::ShapeRef.new(shape: IntegerParameterRanges, location_name: "IntegerParameterRanges"))
|
558
623
|
ParameterRanges.struct_class = Types::ParameterRanges
|
559
624
|
|
625
|
+
PredictorBacktestExportJobSummary.add_member(:predictor_backtest_export_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "PredictorBacktestExportJobArn"))
|
626
|
+
PredictorBacktestExportJobSummary.add_member(:predictor_backtest_export_job_name, Shapes::ShapeRef.new(shape: Name, location_name: "PredictorBacktestExportJobName"))
|
627
|
+
PredictorBacktestExportJobSummary.add_member(:destination, Shapes::ShapeRef.new(shape: DataDestination, location_name: "Destination"))
|
628
|
+
PredictorBacktestExportJobSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "Status"))
|
629
|
+
PredictorBacktestExportJobSummary.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
630
|
+
PredictorBacktestExportJobSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
631
|
+
PredictorBacktestExportJobSummary.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
632
|
+
PredictorBacktestExportJobSummary.struct_class = Types::PredictorBacktestExportJobSummary
|
633
|
+
|
634
|
+
PredictorBacktestExportJobs.member = Shapes::ShapeRef.new(shape: PredictorBacktestExportJobSummary)
|
635
|
+
|
560
636
|
PredictorEvaluationResults.member = Shapes::ShapeRef.new(shape: EvaluationResult)
|
561
637
|
|
562
638
|
PredictorExecution.add_member(:algorithm_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "AlgorithmArn"))
|
@@ -612,6 +688,9 @@ module Aws::ForecastService
|
|
612
688
|
Statistics.add_member(:stddev, Shapes::ShapeRef.new(shape: Double, location_name: "Stddev"))
|
613
689
|
Statistics.struct_class = Types::Statistics
|
614
690
|
|
691
|
+
StopResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "ResourceArn"))
|
692
|
+
StopResourceRequest.struct_class = Types::StopResourceRequest
|
693
|
+
|
615
694
|
SupplementaryFeature.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "Name"))
|
616
695
|
SupplementaryFeature.add_member(:value, Shapes::ShapeRef.new(shape: Value, required: true, location_name: "Value"))
|
617
696
|
SupplementaryFeature.struct_class = Types::SupplementaryFeature
|
@@ -767,6 +846,19 @@ module Aws::ForecastService
|
|
767
846
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
768
847
|
end)
|
769
848
|
|
849
|
+
api.add_operation(:create_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
850
|
+
o.name = "CreatePredictorBacktestExportJob"
|
851
|
+
o.http_method = "POST"
|
852
|
+
o.http_request_uri = "/"
|
853
|
+
o.input = Shapes::ShapeRef.new(shape: CreatePredictorBacktestExportJobRequest)
|
854
|
+
o.output = Shapes::ShapeRef.new(shape: CreatePredictorBacktestExportJobResponse)
|
855
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
856
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
857
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
858
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
859
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
860
|
+
end)
|
861
|
+
|
770
862
|
api.add_operation(:delete_dataset, Seahorse::Model::Operation.new.tap do |o|
|
771
863
|
o.name = "DeleteDataset"
|
772
864
|
o.http_method = "POST"
|
@@ -833,6 +925,17 @@ module Aws::ForecastService
|
|
833
925
|
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
834
926
|
end)
|
835
927
|
|
928
|
+
api.add_operation(:delete_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
929
|
+
o.name = "DeletePredictorBacktestExportJob"
|
930
|
+
o.http_method = "POST"
|
931
|
+
o.http_request_uri = "/"
|
932
|
+
o.input = Shapes::ShapeRef.new(shape: DeletePredictorBacktestExportJobRequest)
|
933
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
934
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
935
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
936
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
|
937
|
+
end)
|
938
|
+
|
836
939
|
api.add_operation(:describe_dataset, Seahorse::Model::Operation.new.tap do |o|
|
837
940
|
o.name = "DescribeDataset"
|
838
941
|
o.http_method = "POST"
|
@@ -893,6 +996,16 @@ module Aws::ForecastService
|
|
893
996
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
894
997
|
end)
|
895
998
|
|
999
|
+
api.add_operation(:describe_predictor_backtest_export_job, Seahorse::Model::Operation.new.tap do |o|
|
1000
|
+
o.name = "DescribePredictorBacktestExportJob"
|
1001
|
+
o.http_method = "POST"
|
1002
|
+
o.http_request_uri = "/"
|
1003
|
+
o.input = Shapes::ShapeRef.new(shape: DescribePredictorBacktestExportJobRequest)
|
1004
|
+
o.output = Shapes::ShapeRef.new(shape: DescribePredictorBacktestExportJobResponse)
|
1005
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1006
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1007
|
+
end)
|
1008
|
+
|
896
1009
|
api.add_operation(:get_accuracy_metrics, Seahorse::Model::Operation.new.tap do |o|
|
897
1010
|
o.name = "GetAccuracyMetrics"
|
898
1011
|
o.http_method = "POST"
|
@@ -982,6 +1095,22 @@ module Aws::ForecastService
|
|
982
1095
|
)
|
983
1096
|
end)
|
984
1097
|
|
1098
|
+
api.add_operation(:list_predictor_backtest_export_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1099
|
+
o.name = "ListPredictorBacktestExportJobs"
|
1100
|
+
o.http_method = "POST"
|
1101
|
+
o.http_request_uri = "/"
|
1102
|
+
o.input = Shapes::ShapeRef.new(shape: ListPredictorBacktestExportJobsRequest)
|
1103
|
+
o.output = Shapes::ShapeRef.new(shape: ListPredictorBacktestExportJobsResponse)
|
1104
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
1105
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1106
|
+
o[:pager] = Aws::Pager.new(
|
1107
|
+
limit_key: "max_results",
|
1108
|
+
tokens: {
|
1109
|
+
"next_token" => "next_token"
|
1110
|
+
}
|
1111
|
+
)
|
1112
|
+
end)
|
1113
|
+
|
985
1114
|
api.add_operation(:list_predictors, Seahorse::Model::Operation.new.tap do |o|
|
986
1115
|
o.name = "ListPredictors"
|
987
1116
|
o.http_method = "POST"
|
@@ -1008,6 +1137,17 @@ module Aws::ForecastService
|
|
1008
1137
|
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1009
1138
|
end)
|
1010
1139
|
|
1140
|
+
api.add_operation(:stop_resource, Seahorse::Model::Operation.new.tap do |o|
|
1141
|
+
o.name = "StopResource"
|
1142
|
+
o.http_method = "POST"
|
1143
|
+
o.http_request_uri = "/"
|
1144
|
+
o.input = Shapes::ShapeRef.new(shape: StopResourceRequest)
|
1145
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1146
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
1147
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1148
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1149
|
+
end)
|
1150
|
+
|
1011
1151
|
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1012
1152
|
o.name = "TagResource"
|
1013
1153
|
o.http_method = "POST"
|
@@ -219,6 +219,9 @@ module Aws::ForecastService
|
|
219
219
|
# },
|
220
220
|
# },
|
221
221
|
# timestamp_format: "TimestampFormat",
|
222
|
+
# time_zone: "TimeZone",
|
223
|
+
# use_geolocation_for_time_zone: false,
|
224
|
+
# geolocation_format: "GeolocationFormat",
|
222
225
|
# tags: [
|
223
226
|
# {
|
224
227
|
# key: "TagKey", # required
|
@@ -270,6 +273,37 @@ module Aws::ForecastService
|
|
270
273
|
# to be "yyyy-MM-dd HH:mm:ss".
|
271
274
|
# @return [String]
|
272
275
|
#
|
276
|
+
# @!attribute [rw] time_zone
|
277
|
+
# A single time zone for every item in your dataset. This option is
|
278
|
+
# ideal for datasets with all timestamps within a single time zone, or
|
279
|
+
# if all timestamps are normalized to a single time zone.
|
280
|
+
#
|
281
|
+
# Refer to the [Joda-Time API][1] for a complete list of valid time
|
282
|
+
# zone names.
|
283
|
+
#
|
284
|
+
#
|
285
|
+
#
|
286
|
+
# [1]: http://joda-time.sourceforge.net/timezones.html
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] use_geolocation_for_time_zone
|
290
|
+
# Automatically derive time zone information from the geolocation
|
291
|
+
# attribute. This option is ideal for datasets that contain timestamps
|
292
|
+
# in multiple time zones and those timestamps are expressed in local
|
293
|
+
# time.
|
294
|
+
# @return [Boolean]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] geolocation_format
|
297
|
+
# The format of the geolocation attribute. The geolocation attribute
|
298
|
+
# can be formatted in one of two ways:
|
299
|
+
#
|
300
|
+
# * `LAT_LONG` - the latitude and longitude in decimal format
|
301
|
+
# (Example: 47.61\_-122.33).
|
302
|
+
#
|
303
|
+
# * `CC_POSTALCODE` (US Only) - the country code (US), followed by the
|
304
|
+
# 5-digit ZIP code (Example: US\_98121).
|
305
|
+
# @return [String]
|
306
|
+
#
|
273
307
|
# @!attribute [rw] tags
|
274
308
|
# The optional metadata that you apply to the dataset import job to
|
275
309
|
# help you categorize and organize them. Each tag consists of a key
|
@@ -310,6 +344,9 @@ module Aws::ForecastService
|
|
310
344
|
:dataset_arn,
|
311
345
|
:data_source,
|
312
346
|
:timestamp_format,
|
347
|
+
:time_zone,
|
348
|
+
:use_geolocation_for_time_zone,
|
349
|
+
:geolocation_format,
|
313
350
|
:tags)
|
314
351
|
SENSITIVE = []
|
315
352
|
include Aws::Structure
|
@@ -339,7 +376,7 @@ module Aws::ForecastService
|
|
339
376
|
# attributes: [
|
340
377
|
# {
|
341
378
|
# attribute_name: "Name",
|
342
|
-
# attribute_type: "string", # accepts string, integer, float, timestamp
|
379
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
343
380
|
# },
|
344
381
|
# ],
|
345
382
|
# },
|
@@ -645,6 +682,97 @@ module Aws::ForecastService
|
|
645
682
|
include Aws::Structure
|
646
683
|
end
|
647
684
|
|
685
|
+
# @note When making an API call, you may pass CreatePredictorBacktestExportJobRequest
|
686
|
+
# data as a hash:
|
687
|
+
#
|
688
|
+
# {
|
689
|
+
# predictor_backtest_export_job_name: "Name", # required
|
690
|
+
# predictor_arn: "Arn", # required
|
691
|
+
# destination: { # required
|
692
|
+
# s3_config: { # required
|
693
|
+
# path: "S3Path", # required
|
694
|
+
# role_arn: "Arn", # required
|
695
|
+
# kms_key_arn: "KMSKeyArn",
|
696
|
+
# },
|
697
|
+
# },
|
698
|
+
# tags: [
|
699
|
+
# {
|
700
|
+
# key: "TagKey", # required
|
701
|
+
# value: "TagValue", # required
|
702
|
+
# },
|
703
|
+
# ],
|
704
|
+
# }
|
705
|
+
#
|
706
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
707
|
+
# The name for the backtest export job.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] predictor_arn
|
711
|
+
# The Amazon Resource Name (ARN) of the predictor that you want to
|
712
|
+
# export.
|
713
|
+
# @return [String]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] destination
|
716
|
+
# The destination for an export job. Provide an S3 path, an AWS
|
717
|
+
# Identity and Access Management (IAM) role that allows Amazon
|
718
|
+
# Forecast to access the location, and an AWS Key Management Service
|
719
|
+
# (KMS) key (optional).
|
720
|
+
# @return [Types::DataDestination]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] tags
|
723
|
+
# Optional metadata to help you categorize and organize your
|
724
|
+
# backtests. Each tag consists of a key and an optional value, both of
|
725
|
+
# which you define. Tag keys and values are case sensitive.
|
726
|
+
#
|
727
|
+
# The following restrictions apply to tags:
|
728
|
+
#
|
729
|
+
# * For each resource, each tag key must be unique and each tag key
|
730
|
+
# must have one value.
|
731
|
+
#
|
732
|
+
# * Maximum number of tags per resource: 50.
|
733
|
+
#
|
734
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
735
|
+
#
|
736
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
737
|
+
#
|
738
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
739
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
740
|
+
# across other services and resources, the character restrictions of
|
741
|
+
# those services also apply.
|
742
|
+
#
|
743
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
744
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
745
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
746
|
+
# be a user tag and will count against the limit of 50 tags. Tags
|
747
|
+
# with only the key prefix of `aws` do not count against your tags
|
748
|
+
# per resource limit. You cannot edit or delete tag keys with this
|
749
|
+
# prefix.
|
750
|
+
# @return [Array<Types::Tag>]
|
751
|
+
#
|
752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobRequest AWS API Documentation
|
753
|
+
#
|
754
|
+
class CreatePredictorBacktestExportJobRequest < Struct.new(
|
755
|
+
:predictor_backtest_export_job_name,
|
756
|
+
:predictor_arn,
|
757
|
+
:destination,
|
758
|
+
:tags)
|
759
|
+
SENSITIVE = []
|
760
|
+
include Aws::Structure
|
761
|
+
end
|
762
|
+
|
763
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
764
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job
|
765
|
+
# that you want to export.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobResponse AWS API Documentation
|
769
|
+
#
|
770
|
+
class CreatePredictorBacktestExportJobResponse < Struct.new(
|
771
|
+
:predictor_backtest_export_job_arn)
|
772
|
+
SENSITIVE = []
|
773
|
+
include Aws::Structure
|
774
|
+
end
|
775
|
+
|
648
776
|
# @note When making an API call, you may pass CreatePredictorRequest
|
649
777
|
# data as a hash:
|
650
778
|
#
|
@@ -652,6 +780,7 @@ module Aws::ForecastService
|
|
652
780
|
# predictor_name: "Name", # required
|
653
781
|
# algorithm_arn: "Arn",
|
654
782
|
# forecast_horizon: 1, # required
|
783
|
+
# forecast_types: ["ForecastType"],
|
655
784
|
# perform_auto_ml: false,
|
656
785
|
# perform_hpo: false,
|
657
786
|
# training_parameters: {
|
@@ -737,9 +866,9 @@ module Aws::ForecastService
|
|
737
866
|
#
|
738
867
|
# * `arn:aws:forecast:::algorithm/ARIMA`
|
739
868
|
#
|
740
|
-
# * `arn:aws:forecast:::algorithm/
|
869
|
+
# * `arn:aws:forecast:::algorithm/CNN-QR`
|
741
870
|
#
|
742
|
-
#
|
871
|
+
# * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
|
743
872
|
#
|
744
873
|
# * `arn:aws:forecast:::algorithm/ETS`
|
745
874
|
#
|
@@ -761,6 +890,15 @@ module Aws::ForecastService
|
|
761
890
|
# of the TARGET\_TIME\_SERIES dataset length.
|
762
891
|
# @return [Integer]
|
763
892
|
#
|
893
|
+
# @!attribute [rw] forecast_types
|
894
|
+
# Specifies the forecast types used to train a predictor. You can
|
895
|
+
# specify up to five forecast types. Forecast types can be quantiles
|
896
|
+
# from 0.01 to 0.99, by increments of 0.01 or higher. You can also
|
897
|
+
# specify the mean forecast with `mean`.
|
898
|
+
#
|
899
|
+
# The default value is `["0.10", "0.50", "0.9"]`.
|
900
|
+
# @return [Array<String>]
|
901
|
+
#
|
764
902
|
# @!attribute [rw] perform_auto_ml
|
765
903
|
# Whether to perform AutoML. When Amazon Forecast performs AutoML, it
|
766
904
|
# evaluates the algorithms it provides and chooses the best algorithm
|
@@ -790,11 +928,11 @@ module Aws::ForecastService
|
|
790
928
|
# hyperparameter. In this case, you are required to specify an
|
791
929
|
# algorithm and `PerformAutoML` must be false.
|
792
930
|
#
|
793
|
-
# The following
|
931
|
+
# The following algorithms support HPO:
|
794
932
|
#
|
795
933
|
# * DeepAR+
|
796
934
|
#
|
797
|
-
#
|
935
|
+
# * CNN-QR
|
798
936
|
# @return [Boolean]
|
799
937
|
#
|
800
938
|
# @!attribute [rw] training_parameters
|
@@ -877,6 +1015,7 @@ module Aws::ForecastService
|
|
877
1015
|
:predictor_name,
|
878
1016
|
:algorithm_arn,
|
879
1017
|
:forecast_horizon,
|
1018
|
+
:forecast_types,
|
880
1019
|
:perform_auto_ml,
|
881
1020
|
:perform_hpo,
|
882
1021
|
:training_parameters,
|
@@ -902,10 +1041,9 @@ module Aws::ForecastService
|
|
902
1041
|
include Aws::Structure
|
903
1042
|
end
|
904
1043
|
|
905
|
-
# The destination for an
|
906
|
-
# Management (IAM) role that allows Amazon Forecast to access
|
907
|
-
# location and
|
908
|
-
# This object is submitted in the CreateForecastExportJob request.
|
1044
|
+
# The destination for an export job. Provide an S3 path, an AWS Identity
|
1045
|
+
# and Access Management (IAM) role that allows Amazon Forecast to access
|
1046
|
+
# the location, and an AWS Key Management Service (KMS) key (optional).
|
909
1047
|
#
|
910
1048
|
# @note When making an API call, you may pass DataDestination
|
911
1049
|
# data as a hash:
|
@@ -1020,16 +1158,15 @@ module Aws::ForecastService
|
|
1020
1158
|
# @return [Types::DataSource]
|
1021
1159
|
#
|
1022
1160
|
# @!attribute [rw] status
|
1023
|
-
# The status of the dataset import job.
|
1024
|
-
# status of the dataset. For example, when the import job status is
|
1025
|
-
# `CREATE_IN_PROGRESS`, the status of the dataset is
|
1026
|
-
# `UPDATE_IN_PROGRESS`. States include:
|
1161
|
+
# The status of the dataset import job. States include:
|
1027
1162
|
#
|
1028
1163
|
# * `ACTIVE`
|
1029
1164
|
#
|
1030
1165
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1031
1166
|
#
|
1032
1167
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1168
|
+
#
|
1169
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1033
1170
|
# @return [String]
|
1034
1171
|
#
|
1035
1172
|
# @!attribute [rw] message
|
@@ -1041,13 +1178,17 @@ module Aws::ForecastService
|
|
1041
1178
|
# @return [Time]
|
1042
1179
|
#
|
1043
1180
|
# @!attribute [rw] last_modification_time
|
1044
|
-
# The last time
|
1045
|
-
# status of the job
|
1181
|
+
# The last time the resource was modified. The timestamp depends on
|
1182
|
+
# the status of the job:
|
1046
1183
|
#
|
1047
|
-
# * `CREATE_PENDING` - The
|
1184
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
1048
1185
|
#
|
1049
1186
|
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
1050
1187
|
#
|
1188
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
1189
|
+
#
|
1190
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
1191
|
+
#
|
1051
1192
|
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1052
1193
|
# @return [Time]
|
1053
1194
|
#
|
@@ -1205,6 +1346,26 @@ module Aws::ForecastService
|
|
1205
1346
|
include Aws::Structure
|
1206
1347
|
end
|
1207
1348
|
|
1349
|
+
# @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
|
1350
|
+
# data as a hash:
|
1351
|
+
#
|
1352
|
+
# {
|
1353
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1354
|
+
# }
|
1355
|
+
#
|
1356
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1357
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job
|
1358
|
+
# to delete.
|
1359
|
+
# @return [String]
|
1360
|
+
#
|
1361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
|
1362
|
+
#
|
1363
|
+
class DeletePredictorBacktestExportJobRequest < Struct.new(
|
1364
|
+
:predictor_backtest_export_job_arn)
|
1365
|
+
SENSITIVE = []
|
1366
|
+
include Aws::Structure
|
1367
|
+
end
|
1368
|
+
|
1208
1369
|
# @note When making an API call, you may pass DeletePredictorRequest
|
1209
1370
|
# data as a hash:
|
1210
1371
|
#
|
@@ -1352,6 +1513,20 @@ module Aws::ForecastService
|
|
1352
1513
|
# optionally, for: Y, M, W, and D
|
1353
1514
|
# @return [String]
|
1354
1515
|
#
|
1516
|
+
# @!attribute [rw] time_zone
|
1517
|
+
# The single time zone applied to every item in the dataset
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] use_geolocation_for_time_zone
|
1521
|
+
# Whether `TimeZone` is automatically derived from the geolocation
|
1522
|
+
# attribute.
|
1523
|
+
# @return [Boolean]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] geolocation_format
|
1526
|
+
# The format of the geolocation attribute. Valid Values:`"LAT_LONG"`
|
1527
|
+
# and `"CC_POSTALCODE"`.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1355
1530
|
# @!attribute [rw] data_source
|
1356
1531
|
# The location of the training data to import and an AWS Identity and
|
1357
1532
|
# Access Management (IAM) role that Amazon Forecast can assume to
|
@@ -1371,16 +1546,15 @@ module Aws::ForecastService
|
|
1371
1546
|
# @return [Float]
|
1372
1547
|
#
|
1373
1548
|
# @!attribute [rw] status
|
1374
|
-
# The status of the dataset import job.
|
1375
|
-
# status of the dataset. For example, when the import job status is
|
1376
|
-
# `CREATE_IN_PROGRESS`, the status of the dataset is
|
1377
|
-
# `UPDATE_IN_PROGRESS`. States include:
|
1549
|
+
# The status of the dataset import job. States include:
|
1378
1550
|
#
|
1379
1551
|
# * `ACTIVE`
|
1380
1552
|
#
|
1381
1553
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1382
1554
|
#
|
1383
1555
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1556
|
+
#
|
1557
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1384
1558
|
# @return [String]
|
1385
1559
|
#
|
1386
1560
|
# @!attribute [rw] message
|
@@ -1392,13 +1566,17 @@ module Aws::ForecastService
|
|
1392
1566
|
# @return [Time]
|
1393
1567
|
#
|
1394
1568
|
# @!attribute [rw] last_modification_time
|
1395
|
-
# The last time
|
1396
|
-
# status of the job
|
1569
|
+
# The last time the resource was modified. The timestamp depends on
|
1570
|
+
# the status of the job:
|
1397
1571
|
#
|
1398
|
-
# * `CREATE_PENDING` - The
|
1572
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
1399
1573
|
#
|
1400
1574
|
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
1401
1575
|
#
|
1576
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
1577
|
+
#
|
1578
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
1579
|
+
#
|
1402
1580
|
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1403
1581
|
# @return [Time]
|
1404
1582
|
#
|
@@ -1409,6 +1587,9 @@ module Aws::ForecastService
|
|
1409
1587
|
:dataset_import_job_arn,
|
1410
1588
|
:dataset_arn,
|
1411
1589
|
:timestamp_format,
|
1590
|
+
:time_zone,
|
1591
|
+
:use_geolocation_for_time_zone,
|
1592
|
+
:geolocation_format,
|
1412
1593
|
:data_source,
|
1413
1594
|
:field_statistics,
|
1414
1595
|
:data_size,
|
@@ -1575,6 +1756,8 @@ module Aws::ForecastService
|
|
1575
1756
|
#
|
1576
1757
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1577
1758
|
#
|
1759
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1760
|
+
#
|
1578
1761
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1579
1762
|
#
|
1580
1763
|
# <note markdown="1"> The `Status` of the forecast export job must be `ACTIVE` before you
|
@@ -1588,7 +1771,18 @@ module Aws::ForecastService
|
|
1588
1771
|
# @return [Time]
|
1589
1772
|
#
|
1590
1773
|
# @!attribute [rw] last_modification_time
|
1591
|
-
#
|
1774
|
+
# The last time the resource was modified. The timestamp depends on
|
1775
|
+
# the status of the job:
|
1776
|
+
#
|
1777
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
1778
|
+
#
|
1779
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
1780
|
+
#
|
1781
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
1782
|
+
#
|
1783
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
1784
|
+
#
|
1785
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1592
1786
|
# @return [Time]
|
1593
1787
|
#
|
1594
1788
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJobResponse AWS API Documentation
|
@@ -1653,6 +1847,8 @@ module Aws::ForecastService
|
|
1653
1847
|
#
|
1654
1848
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1655
1849
|
#
|
1850
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1851
|
+
#
|
1656
1852
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1657
1853
|
#
|
1658
1854
|
# <note markdown="1"> The `Status` of the forecast must be `ACTIVE` before you can query
|
@@ -1670,11 +1866,18 @@ module Aws::ForecastService
|
|
1670
1866
|
# @return [Time]
|
1671
1867
|
#
|
1672
1868
|
# @!attribute [rw] last_modification_time
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
-
#
|
1869
|
+
# The last time the resource was modified. The timestamp depends on
|
1870
|
+
# the status of the job:
|
1871
|
+
#
|
1872
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
1873
|
+
#
|
1874
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
1875
|
+
#
|
1876
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
1877
|
+
#
|
1878
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
1879
|
+
#
|
1880
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1678
1881
|
# @return [Time]
|
1679
1882
|
#
|
1680
1883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastResponse AWS API Documentation
|
@@ -1693,6 +1896,95 @@ module Aws::ForecastService
|
|
1693
1896
|
include Aws::Structure
|
1694
1897
|
end
|
1695
1898
|
|
1899
|
+
# @note When making an API call, you may pass DescribePredictorBacktestExportJobRequest
|
1900
|
+
# data as a hash:
|
1901
|
+
#
|
1902
|
+
# {
|
1903
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1904
|
+
# }
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1907
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1908
|
+
# @return [String]
|
1909
|
+
#
|
1910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobRequest AWS API Documentation
|
1911
|
+
#
|
1912
|
+
class DescribePredictorBacktestExportJobRequest < Struct.new(
|
1913
|
+
:predictor_backtest_export_job_arn)
|
1914
|
+
SENSITIVE = []
|
1915
|
+
include Aws::Structure
|
1916
|
+
end
|
1917
|
+
|
1918
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
1919
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1920
|
+
# @return [String]
|
1921
|
+
#
|
1922
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
1923
|
+
# The name of the predictor backtest export job.
|
1924
|
+
# @return [String]
|
1925
|
+
#
|
1926
|
+
# @!attribute [rw] predictor_arn
|
1927
|
+
# The Amazon Resource Name (ARN) of the predictor.
|
1928
|
+
# @return [String]
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] destination
|
1931
|
+
# The destination for an export job. Provide an S3 path, an AWS
|
1932
|
+
# Identity and Access Management (IAM) role that allows Amazon
|
1933
|
+
# Forecast to access the location, and an AWS Key Management Service
|
1934
|
+
# (KMS) key (optional).
|
1935
|
+
# @return [Types::DataDestination]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] message
|
1938
|
+
# Information about any errors that may have occurred during the
|
1939
|
+
# backtest export.
|
1940
|
+
# @return [String]
|
1941
|
+
#
|
1942
|
+
# @!attribute [rw] status
|
1943
|
+
# The status of the predictor backtest export job. States include:
|
1944
|
+
#
|
1945
|
+
# * `ACTIVE`
|
1946
|
+
#
|
1947
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1948
|
+
#
|
1949
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1950
|
+
#
|
1951
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1952
|
+
# @return [String]
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] creation_time
|
1955
|
+
# When the predictor backtest export job was created.
|
1956
|
+
# @return [Time]
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] last_modification_time
|
1959
|
+
# The last time the resource was modified. The timestamp depends on
|
1960
|
+
# the status of the job:
|
1961
|
+
#
|
1962
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
1963
|
+
#
|
1964
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
1965
|
+
#
|
1966
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
1967
|
+
#
|
1968
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
1969
|
+
#
|
1970
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1971
|
+
# @return [Time]
|
1972
|
+
#
|
1973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobResponse AWS API Documentation
|
1974
|
+
#
|
1975
|
+
class DescribePredictorBacktestExportJobResponse < Struct.new(
|
1976
|
+
:predictor_backtest_export_job_arn,
|
1977
|
+
:predictor_backtest_export_job_name,
|
1978
|
+
:predictor_arn,
|
1979
|
+
:destination,
|
1980
|
+
:message,
|
1981
|
+
:status,
|
1982
|
+
:creation_time,
|
1983
|
+
:last_modification_time)
|
1984
|
+
SENSITIVE = []
|
1985
|
+
include Aws::Structure
|
1986
|
+
end
|
1987
|
+
|
1696
1988
|
# @note When making an API call, you may pass DescribePredictorRequest
|
1697
1989
|
# data as a hash:
|
1698
1990
|
#
|
@@ -1731,6 +2023,11 @@ module Aws::ForecastService
|
|
1731
2023
|
# also called the prediction length.
|
1732
2024
|
# @return [Integer]
|
1733
2025
|
#
|
2026
|
+
# @!attribute [rw] forecast_types
|
2027
|
+
# The forecast types used during predictor training. Default value is
|
2028
|
+
# `["0.1","0.5","0.9"]`
|
2029
|
+
# @return [Array<String>]
|
2030
|
+
#
|
1734
2031
|
# @!attribute [rw] perform_auto_ml
|
1735
2032
|
# Whether the predictor is set to perform AutoML.
|
1736
2033
|
# @return [Boolean]
|
@@ -1742,10 +2039,9 @@ module Aws::ForecastService
|
|
1742
2039
|
#
|
1743
2040
|
# @!attribute [rw] training_parameters
|
1744
2041
|
# The default training parameters or overrides selected during model
|
1745
|
-
# training.
|
1746
|
-
#
|
1747
|
-
#
|
1748
|
-
# aws-forecast-choosing-recipes.
|
2042
|
+
# training. When running AutoML or choosing HPO with CNN-QR or
|
2043
|
+
# DeepAR+, the optimized values for the chosen hyperparameters are
|
2044
|
+
# returned. For more information, see aws-forecast-choosing-recipes.
|
1749
2045
|
# @return [Hash<String,String>]
|
1750
2046
|
#
|
1751
2047
|
# @!attribute [rw] evaluation_parameters
|
@@ -1799,7 +2095,7 @@ module Aws::ForecastService
|
|
1799
2095
|
#
|
1800
2096
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1801
2097
|
#
|
1802
|
-
# * `
|
2098
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
1803
2099
|
#
|
1804
2100
|
# <note markdown="1"> The `Status` of the predictor must be `ACTIVE` before you can use
|
1805
2101
|
# the predictor to create a forecast.
|
@@ -1816,11 +2112,18 @@ module Aws::ForecastService
|
|
1816
2112
|
# @return [Time]
|
1817
2113
|
#
|
1818
2114
|
# @!attribute [rw] last_modification_time
|
1819
|
-
#
|
1820
|
-
#
|
1821
|
-
#
|
1822
|
-
#
|
1823
|
-
#
|
2115
|
+
# The last time the resource was modified. The timestamp depends on
|
2116
|
+
# the status of the job:
|
2117
|
+
#
|
2118
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
2119
|
+
#
|
2120
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
2121
|
+
#
|
2122
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
2123
|
+
#
|
2124
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
2125
|
+
#
|
2126
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
1824
2127
|
# @return [Time]
|
1825
2128
|
#
|
1826
2129
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorResponse AWS API Documentation
|
@@ -1830,6 +2133,7 @@ module Aws::ForecastService
|
|
1830
2133
|
:predictor_name,
|
1831
2134
|
:algorithm_arn,
|
1832
2135
|
:forecast_horizon,
|
2136
|
+
:forecast_types,
|
1833
2137
|
:perform_auto_ml,
|
1834
2138
|
:perform_hpo,
|
1835
2139
|
:training_parameters,
|
@@ -1884,6 +2188,31 @@ module Aws::ForecastService
|
|
1884
2188
|
include Aws::Structure
|
1885
2189
|
end
|
1886
2190
|
|
2191
|
+
# Provides detailed error metrics to evaluate the performance of a
|
2192
|
+
# predictor. This object is part of the Metrics object.
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] forecast_type
|
2195
|
+
# The Forecast type used to compute WAPE and RMSE.
|
2196
|
+
# @return [String]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] wape
|
2199
|
+
# The weighted absolute percentage error (WAPE).
|
2200
|
+
# @return [Float]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] rmse
|
2203
|
+
# The root-mean-square error (RMSE).
|
2204
|
+
# @return [Float]
|
2205
|
+
#
|
2206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
|
2207
|
+
#
|
2208
|
+
class ErrorMetric < Struct.new(
|
2209
|
+
:forecast_type,
|
2210
|
+
:wape,
|
2211
|
+
:rmse)
|
2212
|
+
SENSITIVE = []
|
2213
|
+
include Aws::Structure
|
2214
|
+
end
|
2215
|
+
|
1887
2216
|
# Parameters that define how to split a dataset into training data and
|
1888
2217
|
# testing data, and the number of iterations to perform. These
|
1889
2218
|
# parameters are specified in the predefined algorithms but you can
|
@@ -2146,6 +2475,11 @@ module Aws::ForecastService
|
|
2146
2475
|
# * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2147
2476
|
#
|
2148
2477
|
# * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
|
2478
|
+
#
|
2479
|
+
# To set a filling method to a specific value, set the fill parameter
|
2480
|
+
# to `value` and define the value in a corresponding `_value`
|
2481
|
+
# parameter. For example, to set backfilling to a value of 2, include
|
2482
|
+
# the following: `"backfill": "value"` and `"backfill_value":"2"`.
|
2149
2483
|
# @return [Hash<String,String>]
|
2150
2484
|
#
|
2151
2485
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationMethod AWS API Documentation
|
@@ -2221,6 +2555,8 @@ module Aws::ForecastService
|
|
2221
2555
|
#
|
2222
2556
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
2223
2557
|
#
|
2558
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
2559
|
+
#
|
2224
2560
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
2225
2561
|
#
|
2226
2562
|
# <note markdown="1"> The `Status` of the forecast export job must be `ACTIVE` before you
|
@@ -2238,7 +2574,18 @@ module Aws::ForecastService
|
|
2238
2574
|
# @return [Time]
|
2239
2575
|
#
|
2240
2576
|
# @!attribute [rw] last_modification_time
|
2241
|
-
#
|
2577
|
+
# The last time the resource was modified. The timestamp depends on
|
2578
|
+
# the status of the job:
|
2579
|
+
#
|
2580
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
2581
|
+
#
|
2582
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
2583
|
+
#
|
2584
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
2585
|
+
#
|
2586
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
2587
|
+
#
|
2588
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
2242
2589
|
# @return [Time]
|
2243
2590
|
#
|
2244
2591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ForecastExportJobSummary AWS API Documentation
|
@@ -2284,6 +2631,8 @@ module Aws::ForecastService
|
|
2284
2631
|
#
|
2285
2632
|
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
2286
2633
|
#
|
2634
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
2635
|
+
#
|
2287
2636
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
2288
2637
|
#
|
2289
2638
|
# <note markdown="1"> The `Status` of the forecast must be `ACTIVE` before you can query
|
@@ -2301,11 +2650,18 @@ module Aws::ForecastService
|
|
2301
2650
|
# @return [Time]
|
2302
2651
|
#
|
2303
2652
|
# @!attribute [rw] last_modification_time
|
2304
|
-
#
|
2305
|
-
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
#
|
2653
|
+
# The last time the resource was modified. The timestamp depends on
|
2654
|
+
# the status of the job:
|
2655
|
+
#
|
2656
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
2657
|
+
#
|
2658
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
2659
|
+
#
|
2660
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
2661
|
+
#
|
2662
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
2663
|
+
#
|
2664
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
2309
2665
|
# @return [Time]
|
2310
2666
|
#
|
2311
2667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ForecastSummary AWS API Documentation
|
@@ -2886,6 +3242,80 @@ module Aws::ForecastService
|
|
2886
3242
|
include Aws::Structure
|
2887
3243
|
end
|
2888
3244
|
|
3245
|
+
# @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
|
3246
|
+
# data as a hash:
|
3247
|
+
#
|
3248
|
+
# {
|
3249
|
+
# next_token: "NextToken",
|
3250
|
+
# max_results: 1,
|
3251
|
+
# filters: [
|
3252
|
+
# {
|
3253
|
+
# key: "String", # required
|
3254
|
+
# value: "Arn", # required
|
3255
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3256
|
+
# },
|
3257
|
+
# ],
|
3258
|
+
# }
|
3259
|
+
#
|
3260
|
+
# @!attribute [rw] next_token
|
3261
|
+
# If the result of the previous request was truncated, the response
|
3262
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
3263
|
+
# token in the next request. Tokens expire after 24 hours.
|
3264
|
+
# @return [String]
|
3265
|
+
#
|
3266
|
+
# @!attribute [rw] max_results
|
3267
|
+
# The number of items to return in the response.
|
3268
|
+
# @return [Integer]
|
3269
|
+
#
|
3270
|
+
# @!attribute [rw] filters
|
3271
|
+
# An array of filters. For each filter, provide a condition and a
|
3272
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
3273
|
+
# specifies whether to include or exclude the predictor backtest
|
3274
|
+
# export jobs that match the statement from the list. The match
|
3275
|
+
# statement consists of a key and a value.
|
3276
|
+
#
|
3277
|
+
# **Filter properties**
|
3278
|
+
#
|
3279
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3280
|
+
# `IS_NOT`. To include the predictor backtest export jobs that match
|
3281
|
+
# the statement, specify `IS`. To exclude matching predictor
|
3282
|
+
# backtest export jobs, specify `IS_NOT`.
|
3283
|
+
#
|
3284
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
3285
|
+
# `PredictorArn` and `Status`.
|
3286
|
+
#
|
3287
|
+
# * `Value` - The value to match.
|
3288
|
+
# @return [Array<Types::Filter>]
|
3289
|
+
#
|
3290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsRequest AWS API Documentation
|
3291
|
+
#
|
3292
|
+
class ListPredictorBacktestExportJobsRequest < Struct.new(
|
3293
|
+
:next_token,
|
3294
|
+
:max_results,
|
3295
|
+
:filters)
|
3296
|
+
SENSITIVE = []
|
3297
|
+
include Aws::Structure
|
3298
|
+
end
|
3299
|
+
|
3300
|
+
# @!attribute [rw] predictor_backtest_export_jobs
|
3301
|
+
# An array of objects that summarize the properties of each predictor
|
3302
|
+
# backtest export job.
|
3303
|
+
# @return [Array<Types::PredictorBacktestExportJobSummary>]
|
3304
|
+
#
|
3305
|
+
# @!attribute [rw] next_token
|
3306
|
+
# Returns this token if the response is truncated. To retrieve the
|
3307
|
+
# next set of results, use the token in the next request.
|
3308
|
+
# @return [String]
|
3309
|
+
#
|
3310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsResponse AWS API Documentation
|
3311
|
+
#
|
3312
|
+
class ListPredictorBacktestExportJobsResponse < Struct.new(
|
3313
|
+
:predictor_backtest_export_jobs,
|
3314
|
+
:next_token)
|
3315
|
+
SENSITIVE = []
|
3316
|
+
include Aws::Structure
|
3317
|
+
end
|
3318
|
+
|
2889
3319
|
# @note When making an API call, you may pass ListPredictorsRequest
|
2890
3320
|
# data as a hash:
|
2891
3321
|
#
|
@@ -3002,7 +3432,7 @@ module Aws::ForecastService
|
|
3002
3432
|
# predictor. This object is part of the WindowSummary object.
|
3003
3433
|
#
|
3004
3434
|
# @!attribute [rw] rmse
|
3005
|
-
# The root
|
3435
|
+
# The root-mean-square error (RMSE).
|
3006
3436
|
# @return [Float]
|
3007
3437
|
#
|
3008
3438
|
# @!attribute [rw] weighted_quantile_losses
|
@@ -3011,11 +3441,17 @@ module Aws::ForecastService
|
|
3011
3441
|
# this case is the loss function.
|
3012
3442
|
# @return [Array<Types::WeightedQuantileLoss>]
|
3013
3443
|
#
|
3444
|
+
# @!attribute [rw] error_metrics
|
3445
|
+
# Provides detailed error metrics on forecast type, root-mean
|
3446
|
+
# square-error (RMSE), and weighted average percentage error (WAPE).
|
3447
|
+
# @return [Array<Types::ErrorMetric>]
|
3448
|
+
#
|
3014
3449
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Metrics AWS API Documentation
|
3015
3450
|
#
|
3016
3451
|
class Metrics < Struct.new(
|
3017
3452
|
:rmse,
|
3018
|
-
:weighted_quantile_losses
|
3453
|
+
:weighted_quantile_losses,
|
3454
|
+
:error_metrics)
|
3019
3455
|
SENSITIVE = []
|
3020
3456
|
include Aws::Structure
|
3021
3457
|
end
|
@@ -3076,6 +3512,77 @@ module Aws::ForecastService
|
|
3076
3512
|
include Aws::Structure
|
3077
3513
|
end
|
3078
3514
|
|
3515
|
+
# Provides a summary of the predictor backtest export job properties
|
3516
|
+
# used in the ListPredictorBacktestExportJobs operation. To get a
|
3517
|
+
# complete set of properties, call the
|
3518
|
+
# DescribePredictorBacktestExportJob operation, and provide the listed
|
3519
|
+
# `PredictorBacktestExportJobArn`.
|
3520
|
+
#
|
3521
|
+
# @!attribute [rw] predictor_backtest_export_job_arn
|
3522
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
3523
|
+
# @return [String]
|
3524
|
+
#
|
3525
|
+
# @!attribute [rw] predictor_backtest_export_job_name
|
3526
|
+
# The name of the predictor backtest export job.
|
3527
|
+
# @return [String]
|
3528
|
+
#
|
3529
|
+
# @!attribute [rw] destination
|
3530
|
+
# The destination for an export job. Provide an S3 path, an AWS
|
3531
|
+
# Identity and Access Management (IAM) role that allows Amazon
|
3532
|
+
# Forecast to access the location, and an AWS Key Management Service
|
3533
|
+
# (KMS) key (optional).
|
3534
|
+
# @return [Types::DataDestination]
|
3535
|
+
#
|
3536
|
+
# @!attribute [rw] status
|
3537
|
+
# The status of the predictor backtest export job. States include:
|
3538
|
+
#
|
3539
|
+
# * `ACTIVE`
|
3540
|
+
#
|
3541
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
3542
|
+
#
|
3543
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
3544
|
+
#
|
3545
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
3546
|
+
# @return [String]
|
3547
|
+
#
|
3548
|
+
# @!attribute [rw] message
|
3549
|
+
# Information about any errors that may have occurred during the
|
3550
|
+
# backtest export.
|
3551
|
+
# @return [String]
|
3552
|
+
#
|
3553
|
+
# @!attribute [rw] creation_time
|
3554
|
+
# When the predictor backtest export job was created.
|
3555
|
+
# @return [Time]
|
3556
|
+
#
|
3557
|
+
# @!attribute [rw] last_modification_time
|
3558
|
+
# The last time the resource was modified. The timestamp depends on
|
3559
|
+
# the status of the job:
|
3560
|
+
#
|
3561
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
3562
|
+
#
|
3563
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
3564
|
+
#
|
3565
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
3566
|
+
#
|
3567
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
3568
|
+
#
|
3569
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
3570
|
+
# @return [Time]
|
3571
|
+
#
|
3572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorBacktestExportJobSummary AWS API Documentation
|
3573
|
+
#
|
3574
|
+
class PredictorBacktestExportJobSummary < Struct.new(
|
3575
|
+
:predictor_backtest_export_job_arn,
|
3576
|
+
:predictor_backtest_export_job_name,
|
3577
|
+
:destination,
|
3578
|
+
:status,
|
3579
|
+
:message,
|
3580
|
+
:creation_time,
|
3581
|
+
:last_modification_time)
|
3582
|
+
SENSITIVE = []
|
3583
|
+
include Aws::Structure
|
3584
|
+
end
|
3585
|
+
|
3079
3586
|
# The algorithm used to perform a backtest and the status of those
|
3080
3587
|
# tests.
|
3081
3588
|
#
|
@@ -3145,7 +3652,7 @@ module Aws::ForecastService
|
|
3145
3652
|
#
|
3146
3653
|
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
3147
3654
|
#
|
3148
|
-
# * `
|
3655
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
3149
3656
|
#
|
3150
3657
|
# <note markdown="1"> The `Status` of the predictor must be `ACTIVE` before you can use
|
3151
3658
|
# the predictor to create a forecast.
|
@@ -3162,10 +3669,18 @@ module Aws::ForecastService
|
|
3162
3669
|
# @return [Time]
|
3163
3670
|
#
|
3164
3671
|
# @!attribute [rw] last_modification_time
|
3165
|
-
#
|
3166
|
-
#
|
3167
|
-
#
|
3168
|
-
#
|
3672
|
+
# The last time the resource was modified. The timestamp depends on
|
3673
|
+
# the status of the job:
|
3674
|
+
#
|
3675
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
3676
|
+
#
|
3677
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
3678
|
+
#
|
3679
|
+
# * `CREATE_STOPPING` - The current timestamp.
|
3680
|
+
#
|
3681
|
+
# * `CREATE_STOPPED` - When the job stopped.
|
3682
|
+
#
|
3683
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
|
3169
3684
|
# @return [Time]
|
3170
3685
|
#
|
3171
3686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorSummary AWS API Documentation
|
@@ -3228,8 +3743,7 @@ module Aws::ForecastService
|
|
3228
3743
|
# Amazon Forecast can assume to access the file(s). Optionally, includes
|
3229
3744
|
# an AWS Key Management Service (KMS) key. This object is part of the
|
3230
3745
|
# DataSource object that is submitted in the CreateDatasetImportJob
|
3231
|
-
# request, and part of the DataDestination object
|
3232
|
-
# the CreateForecastExportJob request.
|
3746
|
+
# request, and part of the DataDestination object.
|
3233
3747
|
#
|
3234
3748
|
# @note When making an API call, you may pass S3Config
|
3235
3749
|
# data as a hash:
|
@@ -3281,7 +3795,7 @@ module Aws::ForecastService
|
|
3281
3795
|
# attributes: [
|
3282
3796
|
# {
|
3283
3797
|
# attribute_name: "Name",
|
3284
|
-
# attribute_type: "string", # accepts string, integer, float, timestamp
|
3798
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
3285
3799
|
# },
|
3286
3800
|
# ],
|
3287
3801
|
# }
|
@@ -3308,7 +3822,7 @@ module Aws::ForecastService
|
|
3308
3822
|
#
|
3309
3823
|
# {
|
3310
3824
|
# attribute_name: "Name",
|
3311
|
-
# attribute_type: "string", # accepts string, integer, float, timestamp
|
3825
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
3312
3826
|
# }
|
3313
3827
|
#
|
3314
3828
|
# @!attribute [rw] attribute_name
|
@@ -3378,46 +3892,53 @@ module Aws::ForecastService
|
|
3378
3892
|
include Aws::Structure
|
3379
3893
|
end
|
3380
3894
|
|
3381
|
-
#
|
3382
|
-
#
|
3383
|
-
#
|
3384
|
-
# The only supported feature is a holiday calendar. If you use the
|
3385
|
-
# calendar, all data in the datasets should belong to the same country
|
3386
|
-
# as the calendar. For the holiday calendar data, see the [Jollyday][1]
|
3387
|
-
# web site.
|
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**
|
3895
|
+
# @note When making an API call, you may pass StopResourceRequest
|
3896
|
+
# data as a hash:
|
3401
3897
|
#
|
3402
|
-
#
|
3898
|
+
# {
|
3899
|
+
# resource_arn: "Arn", # required
|
3900
|
+
# }
|
3403
3901
|
#
|
3404
|
-
#
|
3902
|
+
# @!attribute [rw] resource_arn
|
3903
|
+
# The Amazon Resource Name (ARN) that identifies the resource to stop.
|
3904
|
+
# The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
|
3905
|
+
# `PredictorBacktestExportJobArn`, `ForecastArn`, and
|
3906
|
+
# `ForecastExportJobArn`.
|
3907
|
+
# @return [String]
|
3405
3908
|
#
|
3406
|
-
#
|
3909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResourceRequest AWS API Documentation
|
3407
3910
|
#
|
3408
|
-
|
3911
|
+
class StopResourceRequest < Struct.new(
|
3912
|
+
:resource_arn)
|
3913
|
+
SENSITIVE = []
|
3914
|
+
include Aws::Structure
|
3915
|
+
end
|
3916
|
+
|
3917
|
+
# Describes a supplementary feature of a dataset group. This object is
|
3918
|
+
# part of the InputDataConfig object. Forecast supports the Weather
|
3919
|
+
# Index and Holidays built-in featurizations.
|
3409
3920
|
#
|
3410
|
-
#
|
3921
|
+
# **Weather Index**
|
3411
3922
|
#
|
3412
|
-
#
|
3923
|
+
# The Amazon Forecast Weather Index is a built-in featurization that
|
3924
|
+
# incorporates historical and projected weather information into your
|
3925
|
+
# model. The Weather Index supplements your datasets with over two years
|
3926
|
+
# of historical weather data and up to 14 days of projected weather
|
3927
|
+
# data. For more information, see [Amazon Forecast Weather Index][1].
|
3413
3928
|
#
|
3414
|
-
#
|
3929
|
+
# **Holidays**
|
3415
3930
|
#
|
3416
|
-
#
|
3931
|
+
# Holidays is a built-in featurization that incorporates a
|
3932
|
+
# feature-engineered dataset of national holiday information into your
|
3933
|
+
# model. It provides native support for the holiday calendars of 66
|
3934
|
+
# countries. To view the holiday calendars, refer to the [Jollyday][2]
|
3935
|
+
# library. For more information, see [Holidays Featurization][3].
|
3417
3936
|
#
|
3418
3937
|
#
|
3419
3938
|
#
|
3420
|
-
# [1]:
|
3939
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/weather.html
|
3940
|
+
# [2]: http://jollyday.sourceforge.net/data.html
|
3941
|
+
# [3]: https://docs.aws.amazon.com/forecast/latest/dg/holidays.html
|
3421
3942
|
#
|
3422
3943
|
# @note When making an API call, you may pass SupplementaryFeature
|
3423
3944
|
# data as a hash:
|
@@ -3428,11 +3949,20 @@ module Aws::ForecastService
|
|
3428
3949
|
# }
|
3429
3950
|
#
|
3430
3951
|
# @!attribute [rw] name
|
3431
|
-
# The name of the feature.
|
3952
|
+
# The name of the feature. Valid values: `"holiday"` and `"weather"`.
|
3432
3953
|
# @return [String]
|
3433
3954
|
#
|
3434
3955
|
# @!attribute [rw] value
|
3435
|
-
#
|
3956
|
+
# **Weather Index**
|
3957
|
+
#
|
3958
|
+
# To enable the Weather Index, set the value to `"true"`
|
3959
|
+
#
|
3960
|
+
# **Holidays**
|
3961
|
+
#
|
3962
|
+
# To enable Holidays, specify a country with one of the following
|
3963
|
+
# two-letter country codes:
|
3964
|
+
#
|
3965
|
+
# * "AL" - ALBANIA
|
3436
3966
|
#
|
3437
3967
|
# * "AR" - ARGENTINA
|
3438
3968
|
#
|
@@ -3440,13 +3970,27 @@ module Aws::ForecastService
|
|
3440
3970
|
#
|
3441
3971
|
# * "AU" - AUSTRALIA
|
3442
3972
|
#
|
3973
|
+
# * "BA" - BOSNIA HERZEGOVINA
|
3974
|
+
#
|
3443
3975
|
# * "BE" - BELGIUM
|
3444
3976
|
#
|
3977
|
+
# * "BG" - BULGARIA
|
3978
|
+
#
|
3979
|
+
# * "BO" - BOLIVIA
|
3980
|
+
#
|
3445
3981
|
# * "BR" - BRAZIL
|
3446
3982
|
#
|
3983
|
+
# * "BY" - BELARUS
|
3984
|
+
#
|
3447
3985
|
# * "CA" - CANADA
|
3448
3986
|
#
|
3449
|
-
# * "
|
3987
|
+
# * "CL" - CHILE
|
3988
|
+
#
|
3989
|
+
# * "CO" - COLOMBIA
|
3990
|
+
#
|
3991
|
+
# * "CR" - COSTA RICA
|
3992
|
+
#
|
3993
|
+
# * "HR" - CROATIA
|
3450
3994
|
#
|
3451
3995
|
# * "CZ" - CZECH REPUBLIC
|
3452
3996
|
#
|
@@ -3454,38 +3998,82 @@ module Aws::ForecastService
|
|
3454
3998
|
#
|
3455
3999
|
# * "EC" - ECUADOR
|
3456
4000
|
#
|
4001
|
+
# * "EE" - ESTONIA
|
4002
|
+
#
|
4003
|
+
# * "ET" - ETHIOPIA
|
4004
|
+
#
|
3457
4005
|
# * "FI" - FINLAND
|
3458
4006
|
#
|
3459
4007
|
# * "FR" - FRANCE
|
3460
4008
|
#
|
3461
4009
|
# * "DE" - GERMANY
|
3462
4010
|
#
|
4011
|
+
# * "GR" - GREECE
|
4012
|
+
#
|
3463
4013
|
# * "HU" - HUNGARY
|
3464
4014
|
#
|
3465
|
-
# * "
|
4015
|
+
# * "IS" - ICELAND
|
3466
4016
|
#
|
3467
4017
|
# * "IN" - INDIA
|
3468
4018
|
#
|
4019
|
+
# * "IE" - IRELAND
|
4020
|
+
#
|
3469
4021
|
# * "IT" - ITALY
|
3470
4022
|
#
|
3471
4023
|
# * "JP" - JAPAN
|
3472
4024
|
#
|
4025
|
+
# * "KZ" - KAZAKHSTAN
|
4026
|
+
#
|
3473
4027
|
# * "KR" - KOREA
|
3474
4028
|
#
|
4029
|
+
# * "LV" - LATVIA
|
4030
|
+
#
|
4031
|
+
# * "LI" - LIECHTENSTEIN
|
4032
|
+
#
|
4033
|
+
# * "LT" - LITHUANIA
|
4034
|
+
#
|
3475
4035
|
# * "LU" - LUXEMBOURG
|
3476
4036
|
#
|
4037
|
+
# * "MK" - MACEDONIA
|
4038
|
+
#
|
4039
|
+
# * "MT" - MALTA
|
4040
|
+
#
|
3477
4041
|
# * "MX" - MEXICO
|
3478
4042
|
#
|
4043
|
+
# * "MD" - MOLDOVA
|
4044
|
+
#
|
4045
|
+
# * "ME" - MONTENEGRO
|
4046
|
+
#
|
3479
4047
|
# * "NL" - NETHERLANDS
|
3480
4048
|
#
|
4049
|
+
# * "NZ" - NEW ZEALAND
|
4050
|
+
#
|
4051
|
+
# * "NI" - NICARAGUA
|
4052
|
+
#
|
4053
|
+
# * "NG" - NIGERIA
|
4054
|
+
#
|
3481
4055
|
# * "NO" - NORWAY
|
3482
4056
|
#
|
4057
|
+
# * "PA" - PANAMA
|
4058
|
+
#
|
4059
|
+
# * "PY" - PARAGUAY
|
4060
|
+
#
|
4061
|
+
# * "PE" - PERU
|
4062
|
+
#
|
3483
4063
|
# * "PL" - POLAND
|
3484
4064
|
#
|
3485
4065
|
# * "PT" - PORTUGAL
|
3486
4066
|
#
|
4067
|
+
# * "RO" - ROMANIA
|
4068
|
+
#
|
3487
4069
|
# * "RU" - RUSSIA
|
3488
4070
|
#
|
4071
|
+
# * "RS" - SERBIA
|
4072
|
+
#
|
4073
|
+
# * "SK" - SLOVAKIA
|
4074
|
+
#
|
4075
|
+
# * "SI" - SLOVENIA
|
4076
|
+
#
|
3489
4077
|
# * "ZA" - SOUTH AFRICA
|
3490
4078
|
#
|
3491
4079
|
# * "ES" - SPAIN
|
@@ -3494,9 +4082,17 @@ module Aws::ForecastService
|
|
3494
4082
|
#
|
3495
4083
|
# * "CH" - SWITZERLAND
|
3496
4084
|
#
|
4085
|
+
# * "UA" - UKRAINE
|
4086
|
+
#
|
4087
|
+
# * "AE" - UNITED ARAB EMIRATES
|
4088
|
+
#
|
3497
4089
|
# * "US" - UNITED STATES
|
3498
4090
|
#
|
3499
4091
|
# * "UK" - UNITED KINGDOM
|
4092
|
+
#
|
4093
|
+
# * "UY" - URUGUAY
|
4094
|
+
#
|
4095
|
+
# * "VE" - VENEZUELA
|
3500
4096
|
# @return [String]
|
3501
4097
|
#
|
3502
4098
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SupplementaryFeature AWS API Documentation
|
@@ -3563,7 +4159,7 @@ module Aws::ForecastService
|
|
3563
4159
|
class Tag < Struct.new(
|
3564
4160
|
:key,
|
3565
4161
|
:value)
|
3566
|
-
SENSITIVE = []
|
4162
|
+
SENSITIVE = [:key, :value]
|
3567
4163
|
include Aws::Structure
|
3568
4164
|
end
|
3569
4165
|
|