Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon Forecast Service:
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

The following data types are supported by Amazon Forecast Query Service:
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

# Amazon Forecast Service
<a name="API_Types_Amazon_Forecast_Service"></a>

The following data types are supported by Amazon Forecast Service:
+  [Action](API_Action.md) 
+  [AdditionalDataset](API_AdditionalDataset.md) 
+  [AttributeConfig](API_AttributeConfig.md) 
+  [Baseline](API_Baseline.md) 
+  [BaselineMetric](API_BaselineMetric.md) 
+  [CategoricalParameterRange](API_CategoricalParameterRange.md) 
+  [ContinuousParameterRange](API_ContinuousParameterRange.md) 
+  [DataConfig](API_DataConfig.md) 
+  [DataDestination](API_DataDestination.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [EncryptionConfig](API_EncryptionConfig.md) 
+  [ErrorMetric](API_ErrorMetric.md) 
+  [EvaluationParameters](API_EvaluationParameters.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [ExplainabilityConfig](API_ExplainabilityConfig.md) 
+  [ExplainabilityExportSummary](API_ExplainabilityExportSummary.md) 
+  [ExplainabilityInfo](API_ExplainabilityInfo.md) 
+  [ExplainabilitySummary](API_ExplainabilitySummary.md) 
+  [Featurization](API_Featurization.md) 
+  [FeaturizationConfig](API_FeaturizationConfig.md) 
+  [FeaturizationMethod](API_FeaturizationMethod.md) 
+  [Filter](API_Filter.md) 
+  [ForecastExportJobSummary](API_ForecastExportJobSummary.md) 
+  [ForecastSummary](API_ForecastSummary.md) 
+  [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) 
+  [InputDataConfig](API_InputDataConfig.md) 
+  [IntegerParameterRange](API_IntegerParameterRange.md) 
+  [MetricResult](API_MetricResult.md) 
+  [Metrics](API_Metrics.md) 
+  [MonitorConfig](API_MonitorConfig.md) 
+  [MonitorDataSource](API_MonitorDataSource.md) 
+  [MonitorInfo](API_MonitorInfo.md) 
+  [MonitorSummary](API_MonitorSummary.md) 
+  [ParameterRanges](API_ParameterRanges.md) 
+  [PredictorBacktestExportJobSummary](API_PredictorBacktestExportJobSummary.md) 
+  [PredictorBaseline](API_PredictorBaseline.md) 
+  [PredictorEvent](API_PredictorEvent.md) 
+  [PredictorExecution](API_PredictorExecution.md) 
+  [PredictorExecutionDetails](API_PredictorExecutionDetails.md) 
+  [PredictorMonitorEvaluation](API_PredictorMonitorEvaluation.md) 
+  [PredictorSummary](API_PredictorSummary.md) 
+  [ReferencePredictorSummary](API_ReferencePredictorSummary.md) 
+  [S3Config](API_S3Config.md) 
+  [Schema](API_Schema.md) 
+  [SchemaAttribute](API_SchemaAttribute.md) 
+  [Statistics](API_Statistics.md) 
+  [SupplementaryFeature](API_SupplementaryFeature.md) 
+  [Tag](API_Tag.md) 
+  [TestWindowSummary](API_TestWindowSummary.md) 
+  [TimeAlignmentBoundary](API_TimeAlignmentBoundary.md) 
+  [TimeSeriesCondition](API_TimeSeriesCondition.md) 
+  [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) 
+  [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) 
+  [TimeSeriesSelector](API_TimeSeriesSelector.md) 
+  [TimeSeriesTransformation](API_TimeSeriesTransformation.md) 
+  [WeightedQuantileLoss](API_WeightedQuantileLoss.md) 
+  [WhatIfAnalysisSummary](API_WhatIfAnalysisSummary.md) 
+  [WhatIfForecastExportSummary](API_WhatIfForecastExportSummary.md) 
+  [WhatIfForecastSummary](API_WhatIfForecastSummary.md) 
+  [WindowSummary](API_WindowSummary.md) 

# Action
<a name="API_Action"></a>

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify `"AttributeName": "shoes"`, `"Operation": "MULTIPLY"`, and `"Value": "0.90"`. Pair this operation with the [TimeSeriesCondition](API_TimeSeriesCondition.md) operation within the [CreateWhatIfForecast:TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) operation to define a subset of attribute items that are modified.

## Contents
<a name="API_Action_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Action-AttributeName"></a>
The related time series that you are modifying. This value is case insensitive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** Operation **   <a name="forecast-Type-Action-Operation"></a>
The operation that is applied to the provided attribute. Operations include:  
+  `ADD` - adds `Value` to all rows of `AttributeName`.
+  `SUBTRACT` - subtracts `Value` from all rows of `AttributeName`.
+  `MULTIPLY` - multiplies all rows of `AttributeName` by `Value`.
+  `DIVIDE` - divides all rows of `AttributeName` by `Value`.
Type: String  
Valid Values: `ADD | SUBTRACT | MULTIPLY | DIVIDE`   
Required: Yes

 ** Value **   <a name="forecast-Type-Action-Value"></a>
The value that is applied for the chosen `Operation`.  
Type: Double  
Required: Yes

## See Also
<a name="API_Action_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Action) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Action) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Action) 

# AdditionalDataset
<a name="API_AdditionalDataset"></a>

Describes an additional dataset. This object is part of the [DataConfig](API_DataConfig.md) object. Forecast supports the Weather Index and Holidays additional datasets.

 **Weather Index** 

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see [Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

 **Holidays** 

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of over 250 countries. Amazon Forecast incorporates both the [Holiday API library](https://holidayapi.com/countries) and [Jollyday API](https://jollyday.sourceforge.net/data.html) to generate holiday calendars. For more information, see [Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

## Contents
<a name="API_AdditionalDataset_Contents"></a>

 ** Name **   <a name="forecast-Type-AdditionalDataset-Name"></a>
The name of the additional dataset. Valid names: `"holiday"` and `"weather"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** Configuration **   <a name="forecast-Type-AdditionalDataset-Configuration"></a>
 **Weather Index**   
To enable the Weather Index, do not specify a value for `Configuration`.  
 **Holidays**   
 **Holidays**   
To enable Holidays, set `CountryCode` to one of the following two-letter country codes:  
+  Afghanistan - AF 
+  Åland Islands - AX 
+  Albania - AL 
+  Algeria - DZ 
+  American Samoa - AS 
+  Andorra - AD 
+  Angola - AO 
+  Anguilla - AI 
+  Antartica - AQ 
+  Antigua and Barbuda - AG 
+  Argentina - AR 
+  Armenia - AM 
+  Aruba - AW 
+  Australia - AU 
+  Austria - AT 
+  Azerbaijan - AZ 
+  Bahamas - BS 
+  Bahrain - BH 
+  Bangladesh - BD 
+  Barbados - BB 
+  Belarus - BY 
+  Belgium - BE 
+  Belize - BZ 
+  Benin - BJ 
+  Bermuda - BM 
+  Bhutan - BT 
+  Bolivia - BO 
+  Bosnia and Herzegovina - BA 
+  Botswana - BW 
+  Bouvet Island - BV 
+  Brazil - BR 
+  British Indian Ocean Territory - IO 
+  British Virgin Islands - VG 
+  Brunei Darussalam - BN 
+  Bulgaria - BG 
+  Burkina Faso - BF 
+  Burundi - BI 
+  Cambodia - KH 
+  Cameroon - CM 
+  Canada - CA 
+  Cape Verde - CV 
+  Caribbean Netherlands - BQ 
+  Cayman Islands - KY 
+  Central African Republic - CF 
+  Chad - TD 
+  Chile - CL 
+  China - CN 
+  Christmas Island - CX 
+  Cocos (Keeling) Islands - CC 
+  Colombia - CO 
+  Comoros - KM 
+  Cook Islands - CK 
+  Costa Rica - CR 
+  Croatia - HR 
+  Cuba - CU 
+  Curaçao - CW 
+  Cyprus - CY 
+  Czechia - CZ 
+  Democratic Republic of the Congo - CD 
+  Denmark - DK 
+  Djibouti - DJ 
+  Dominica - DM 
+  Dominican Republic - DO 
+  Ecuador - EC 
+  Egypt - EG 
+  El Salvador - SV 
+  Equatorial Guinea - GQ 
+  Eritrea - ER 
+  Estonia - EE 
+  Eswatini - SZ 
+  Ethiopia - ET 
+  Falkland Islands - FK 
+  Faroe Islands - FO 
+  Fiji - FJ 
+  Finland - FI 
+  France - FR 
+  French Guiana - GF 
+  French Polynesia - PF 
+  French Southern Territories - TF 
+  Gabon - GA 
+  Gambia - GM 
+  Georgia - GE 
+  Germany - DE 
+  Ghana - GH 
+  Gibraltar - GI 
+  Greece - GR 
+  Greenland - GL 
+  Grenada - GD 
+  Guadeloupe - GP 
+  Guam - GU 
+  Guatemala - GT 
+  Guernsey - GG 
+  Guinea - GN 
+  Guinea-Bissau - GW 
+  Guyana - GY 
+  Haiti - HT 
+  Heard Island and McDonald Islands - HM 
+  Honduras - HN 
+  Hong Kong - HK 
+  Hungary - HU 
+  Iceland - IS 
+  India - IN 
+  Indonesia - ID 
+  Iran - IR 
+  Iraq - IQ 
+  Ireland - IE 
+  Isle of Man - IM 
+  Israel - IL 
+  Italy - IT 
+  Ivory Coast - CI 
+  Jamaica - JM 
+  Japan - JP 
+  Jersey - JE 
+  Jordan - JO 
+  Kazakhstan - KZ 
+  Kenya - KE 
+  Kiribati - KI 
+  Kosovo - XK 
+  Kuwait - KW 
+  Kyrgyzstan - KG 
+  Laos - LA 
+  Latvia - LV 
+  Lebanon - LB 
+  Lesotho - LS 
+  Liberia - LR 
+  Libya - LY 
+  Liechtenstein - LI 
+  Lithuania - LT 
+  Luxembourg - LU 
+  Macao - MO 
+  Madagascar - MG 
+  Malawi - MW 
+  Malaysia - MY 
+  Maldives - MV 
+  Mali - ML 
+  Malta - MT 
+  Marshall Islands - MH 
+  Martinique - MQ 
+  Mauritania - MR 
+  Mauritius - MU 
+  Mayotte - YT 
+  Mexico - MX 
+  Micronesia - FM 
+  Moldova - MD 
+  Monaco - MC 
+  Mongolia - MN 
+  Montenegro - ME 
+  Montserrat - MS 
+  Morocco - MA 
+  Mozambique - MZ 
+  Myanmar - MM 
+  Namibia - NA 
+  Nauru - NR 
+  Nepal - NP 
+  Netherlands - NL 
+  New Caledonia - NC 
+  New Zealand - NZ 
+  Nicaragua - NI 
+  Niger - NE 
+  Nigeria - NG 
+  Niue - NU 
+  Norfolk Island - NF 
+  North Korea - KP 
+  North Macedonia - MK 
+  Northern Mariana Islands - MP 
+  Norway - NO 
+  Oman - OM 
+  Pakistan - PK 
+  Palau - PW 
+  Palestine - PS 
+  Panama - PA 
+  Papua New Guinea - PG 
+  Paraguay - PY 
+  Peru - PE 
+  Philippines - PH 
+  Pitcairn Islands - PN 
+  Poland - PL 
+  Portugal - PT 
+  Puerto Rico - PR 
+  Qatar - QA 
+  Republic of the Congo - CG 
+  Réunion - RE 
+  Romania - RO 
+  Russian Federation - RU 
+  Rwanda - RW 
+  Saint Barthélemy - BL 
+  "Saint Helena, Ascension and Tristan da Cunha " - SH 
+  Saint Kitts and Nevis - KN 
+  Saint Lucia - LC 
+  Saint Martin - MF 
+  Saint Pierre and Miquelon - PM 
+  Saint Vincent and the Grenadines - VC 
+  Samoa - WS 
+  San Marino - SM 
+  Sao Tome and Principe - ST 
+  Saudi Arabia - SA 
+  Senegal - SN 
+  Serbia - RS 
+  Seychelles - SC 
+  Sierra Leone - SL 
+  Singapore - SG 
+  Sint Maarten - SX 
+  Slovakia - SK 
+  Slovenia - SI 
+  Solomon Islands - SB 
+  Somalia - SO 
+  South Africa - ZA 
+  South Georgia and the South Sandwich Islands - GS 
+  South Korea - KR 
+  South Sudan - SS 
+  Spain - ES 
+  Sri Lanka - LK 
+  Sudan - SD 
+  Suriname - SR 
+  Svalbard and Jan Mayen - SJ 
+  Sweden - SE 
+  Switzerland - CH 
+  Syrian Arab Republic - SY 
+  Taiwan - TW 
+  Tajikistan - TJ 
+  Tanzania - TZ 
+  Thailand - TH 
+  Timor-Leste - TL 
+  Togo - TG 
+  Tokelau - TK 
+  Tonga - TO 
+  Trinidad and Tobago - TT 
+  Tunisia - TN 
+  Turkey - TR 
+  Turkmenistan - TM 
+  Turks and Caicos Islands - TC 
+  Tuvalu - TV 
+  Uganda - UG 
+  Ukraine - UA 
+  United Arab Emirates - AE 
+  United Kingdom - GB 
+  United Nations - UN 
+  United States - US 
+  United States Minor Outlying Islands - UM 
+  United States Virgin Islands - VI 
+  Uruguay - UY 
+  Uzbekistan - UZ 
+  Vanuatu - VU 
+  Vatican City - VA 
+  Venezuela - VE 
+  Vietnam - VN 
+  Wallis and Futuna - WF 
+  Western Sahara - EH 
+  Yemen - YE 
+  Zambia - ZM 
+  Zimbabwe - ZW 
Type: String to array of strings map  
Key Length Constraints: Minimum length of 1. Maximum length of 63.  
Key Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_\-]+$`   
Required: No

## See Also
<a name="API_AdditionalDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AdditionalDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AdditionalDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AdditionalDataset) 

# AttributeConfig
<a name="API_AttributeConfig"></a>

Provides information about the method used to transform attributes.

The following is an example using the RETAIL domain:

 `{` 

 `"AttributeName": "demand",` 

 `"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## Contents
<a name="API_AttributeConfig_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-AttributeConfig-AttributeName"></a>
The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the target time series and the related time series datasets. For example, for the RETAIL domain, the target is `demand`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** Transformations **   <a name="forecast-Type-AttributeConfig-Transformations"></a>
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.  
The following list shows the parameters and their valid values for the "filling" featurization method for a **Target Time Series** dataset. Default values are bolded.  
+  `aggregation`: **sum**, `avg`, `first`, `min`, `max` 
+  `frontfill`: **none** 
+  `middlefill`: **zero**, `nan` (not a number), `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`, `max` 
The following list shows the parameters and their valid values for a **Related Time Series** featurization method (there are no defaults):  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
To set a filling method to a specific value, set the fill parameter to `value` and define the value in a corresponding `_value` parameter. For example, to set backfilling to a value of 2, include the following: `"backfill": "value"` and `"backfill_value":"2"`.   
Type: String to string map  
Map Entries: Maximum number of 20 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 63.  
Key Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[a-zA-Z0-9\_\-]+$`   
Required: Yes

## See Also
<a name="API_AttributeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/AttributeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/AttributeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/AttributeConfig) 

# Baseline
<a name="API_Baseline"></a>

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

## Contents
<a name="API_Baseline_Contents"></a>

 ** PredictorBaseline **   <a name="forecast-Type-Baseline-PredictorBaseline"></a>
The initial [accuracy metrics](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.  
Type: [PredictorBaseline](API_PredictorBaseline.md) object  
Required: No

## See Also
<a name="API_Baseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Baseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Baseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Baseline) 

# BaselineMetric
<a name="API_BaselineMetric"></a>

An individual metric that you can use for comparison as you evaluate your monitoring results.

## Contents
<a name="API_BaselineMetric_Contents"></a>

 ** Name **   <a name="forecast-Type-BaselineMetric-Name"></a>
The name of the metric.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** Value **   <a name="forecast-Type-BaselineMetric-Value"></a>
The value for the metric.  
Type: Double  
Required: No

## See Also
<a name="API_BaselineMetric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/BaselineMetric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/BaselineMetric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/BaselineMetric) 

# CategoricalParameterRange
<a name="API_CategoricalParameterRange"></a>

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the [ParameterRanges](API_ParameterRanges.md) object.

## Contents
<a name="API_CategoricalParameterRange_Contents"></a>

 ** Name **   <a name="forecast-Type-CategoricalParameterRange-Name"></a>
The name of the categorical hyperparameter to tune.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** Values **   <a name="forecast-Type-CategoricalParameterRange-Values"></a>
A list of the tunable categories for the hyperparameter.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_\-]+$`   
Required: Yes

## See Also
<a name="API_CategoricalParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/CategoricalParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/CategoricalParameterRange) 

# ContinuousParameterRange
<a name="API_ContinuousParameterRange"></a>

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the [ParameterRanges](API_ParameterRanges.md) object.

## Contents
<a name="API_ContinuousParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-ContinuousParameterRange-MaxValue"></a>
The maximum tunable value of the hyperparameter.  
Type: Double  
Required: Yes

 ** MinValue **   <a name="forecast-Type-ContinuousParameterRange-MinValue"></a>
The minimum tunable value of the hyperparameter.  
Type: Double  
Required: Yes

 ** Name **   <a name="forecast-Type-ContinuousParameterRange-Name"></a>
The name of the hyperparameter to tune.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** ScalingType **   <a name="forecast-Type-ContinuousParameterRange-ScalingType"></a>
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:    
Auto  
Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.  
Linear  
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.  
Logarithmic  
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.  
Logarithmic scaling works only for ranges that have values greater than 0.  
ReverseLogarithmic  
hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.  
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see [Hyperparameter Scaling](http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). One of the following values:  
Type: String  
Valid Values: `Auto | Linear | Logarithmic | ReverseLogarithmic`   
Required: No

## See Also
<a name="API_ContinuousParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ContinuousParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ContinuousParameterRange) 

# DataConfig
<a name="API_DataConfig"></a>

The data configuration for your dataset group and any additional datasets.

## Contents
<a name="API_DataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-DataConfig-DatasetGroupArn"></a>
The ARN of the dataset group used to train the predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: Yes

 ** AdditionalDatasets **   <a name="forecast-Type-DataConfig-AdditionalDatasets"></a>
Additional built-in datasets like Holidays and the Weather Index.  
Type: Array of [AdditionalDataset](API_AdditionalDataset.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: No

 ** AttributeConfigs **   <a name="forecast-Type-DataConfig-AttributeConfigs"></a>
Aggregation and filling options for attributes in your dataset group.  
Type: Array of [AttributeConfig](API_AttributeConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## See Also
<a name="API_DataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataConfig) 

# DataDestination
<a name="API_DataDestination"></a>

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional). 

## Contents
<a name="API_DataDestination_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataDestination-S3Config"></a>
The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.  
Type: [S3Config](API_S3Config.md) object  
Required: Yes

## See Also
<a name="API_DataDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataDestination) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

Provides a summary of the dataset group properties used in the [ListDatasetGroups](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) operation. To get the complete set of properties, call the [DescribeDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) operation, and provide the `DatasetGroupArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_DatasetGroupSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetGroupSummary-CreationTime"></a>
When the dataset group was created.  
Type: Timestamp  
Required: No

 ** DatasetGroupArn **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** DatasetGroupName **   <a name="forecast-Type-DatasetGroupSummary-DatasetGroupName"></a>
The name of the dataset group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-DatasetGroupSummary-LastModificationTime"></a>
When the dataset group was created or last updated from a call to the [UpdateDatasetGroup](https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) operation. While the dataset group is being updated, `LastModificationTime` is the current time of the `ListDatasetGroups` call.  
Type: Timestamp  
Required: No

## See Also
<a name="API_DatasetGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetGroupSummary) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

Provides a summary of the dataset import job properties used in the [ListDatasetImportJobs](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) operation. To get the complete set of properties, call the [DescribeDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) operation, and provide the `DatasetImportJobArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetImportJobSummary-CreationTime"></a>
When the dataset import job was created.  
Type: Timestamp  
Required: No

 ** DatasetImportJobArn **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobArn"></a>
The Amazon Resource Name (ARN) of the dataset import job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** DatasetImportJobName **   <a name="forecast-Type-DatasetImportJobSummary-DatasetImportJobName"></a>
The name of the dataset import job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** DataSource **   <a name="forecast-Type-DatasetImportJobSummary-DataSource"></a>
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.  
If encryption is used, `DataSource` includes an AWS Key Management Service (KMS) key.  
Type: [DataSource](API_DataSource.md) object  
Required: No

 ** ImportMode **   <a name="forecast-Type-DatasetImportJobSummary-ImportMode"></a>
The import mode of the dataset import job, FULL or INCREMENTAL.  
Type: String  
Valid Values: `FULL | INCREMENTAL`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-DatasetImportJobSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-DatasetImportJobSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-DatasetImportJobSummary-Status"></a>
The status of the dataset import job. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetImportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetImportJobSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

Provides a summary of the dataset properties used in the [ListDatasets](https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) operation. To get the complete set of properties, call the [DescribeDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) operation, and provide the `DatasetArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_DatasetSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-DatasetSummary-CreationTime"></a>
When the dataset was created.  
Type: Timestamp  
Required: No

 ** DatasetArn **   <a name="forecast-Type-DatasetSummary-DatasetArn"></a>
The Amazon Resource Name (ARN) of the dataset.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** DatasetName **   <a name="forecast-Type-DatasetSummary-DatasetName"></a>
The name of the dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** DatasetType **   <a name="forecast-Type-DatasetSummary-DatasetType"></a>
The dataset type.  
Type: String  
Valid Values: `TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA`   
Required: No

 ** Domain **   <a name="forecast-Type-DatasetSummary-Domain"></a>
The domain associated with the dataset.  
Type: String  
Valid Values: `RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-DatasetSummary-LastModificationTime"></a>
When you create a dataset, `LastModificationTime` is the same as `CreationTime`. While data is being imported to the dataset, `LastModificationTime` is the current time of the `ListDatasets` call. After a [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation has finished, `LastModificationTime` is when the import job completed or failed.  
Type: Timestamp  
Required: No

## See Also
<a name="API_DatasetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DatasetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DatasetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DatasetSummary) 

# DataSource
<a name="API_DataSource"></a>

The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.

## Contents
<a name="API_DataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-DataSource-S3Config"></a>
The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.  
Type: [S3Config](API_S3Config.md) object  
Required: Yes

## See Also
<a name="API_DataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DataSource) 

# EncryptionConfig
<a name="API_EncryptionConfig"></a>

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the [CreateDataset](API_CreateDataset.md) and [CreatePredictor](API_CreatePredictor.md) requests.

## Contents
<a name="API_EncryptionConfig_Contents"></a>

 ** KMSKeyArn **   <a name="forecast-Type-EncryptionConfig-KMSKeyArn"></a>
The Amazon Resource Name (ARN) of the KMS key.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:aws:kms:.*:key/.*`   
Required: Yes

 ** RoleArn **   <a name="forecast-Type-EncryptionConfig-RoleArn"></a>
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.  
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: Yes

## See Also
<a name="API_EncryptionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EncryptionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EncryptionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EncryptionConfig) 

# ErrorMetric
<a name="API_ErrorMetric"></a>

 Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the [Metrics](API_Metrics.md) object. 

## Contents
<a name="API_ErrorMetric_Contents"></a>

 ** ForecastType **   <a name="forecast-Type-ErrorMetric-ForecastType"></a>
 The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 4.  
Pattern: `(^0?\.\d\d?$|^mean$)`   
Required: No

 ** MAPE **   <a name="forecast-Type-ErrorMetric-MAPE"></a>
The Mean Absolute Percentage Error (MAPE)  
Type: Double  
Required: No

 ** MASE **   <a name="forecast-Type-ErrorMetric-MASE"></a>
The Mean Absolute Scaled Error (MASE)  
Type: Double  
Required: No

 ** RMSE **   <a name="forecast-Type-ErrorMetric-RMSE"></a>
 The root-mean-square error (RMSE).   
Type: Double  
Required: No

 ** WAPE **   <a name="forecast-Type-ErrorMetric-WAPE"></a>
 The weighted absolute percentage error (WAPE).   
Type: Double  
Required: No

## See Also
<a name="API_ErrorMetric_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ErrorMetric) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ErrorMetric) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ErrorMetric) 

# EvaluationParameters
<a name="API_EvaluationParameters"></a>

Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the [CreatePredictor](API_CreatePredictor.md) request.

## Contents
<a name="API_EvaluationParameters_Contents"></a>

 ** BackTestWindowOffset **   <a name="forecast-Type-EvaluationParameters-BackTestWindowOffset"></a>
The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. `BackTestWindowOffset` can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET\$1TIME\$1SERIES dataset length.  
 `ForecastHorizon` <= `BackTestWindowOffset` < 1/2 \$1 TARGET\$1TIME\$1SERIES dataset length  
Type: Integer  
Required: No

 ** NumberOfBacktestWindows **   <a name="forecast-Type-EvaluationParameters-NumberOfBacktestWindows"></a>
The number of times to split the input data. The default is 1. Valid values are 1 through 5.  
Type: Integer  
Required: No

## See Also
<a name="API_EvaluationParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationParameters) 

# EvaluationResult
<a name="API_EvaluationResult"></a>

The results of evaluating an algorithm. Returned as part of the [GetAccuracyMetrics](API_GetAccuracyMetrics.md) response.

## Contents
<a name="API_EvaluationResult_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-EvaluationResult-AlgorithmArn"></a>
The Amazon Resource Name (ARN) of the algorithm that was evaluated.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** TestWindows **   <a name="forecast-Type-EvaluationResult-TestWindows"></a>
The array of test windows used for evaluating the algorithm. The `NumberOfBacktestWindows` from the [EvaluationParameters](API_EvaluationParameters.md) object determines the number of windows in the array.  
Type: Array of [WindowSummary](API_WindowSummary.md) objects  
Required: No

## See Also
<a name="API_EvaluationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/EvaluationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/EvaluationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/EvaluationResult) 

# ExplainabilityConfig
<a name="API_ExplainabilityConfig"></a>

The ExplainabilityConfig data type defines the number of time series and time points included in [CreateExplainability](API_CreateExplainability.md).

If you provide a predictor ARN for `ResourceArn`, you must set both `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for `ResourceArn`, you can set `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or “Specific”.

## Contents
<a name="API_ExplainabilityConfig_Contents"></a>

 ** TimePointGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimePointGranularity"></a>
To create an Explainability for all time points in your forecast horizon, use `ALL`. To create an Explainability for specific time points in your forecast horizon, use `SPECIFIC`.  
Specify time points with the `StartDateTime` and `EndDateTime` parameters within the [CreateExplainability](API_CreateExplainability.md) operation.  
Type: String  
Valid Values: `ALL | SPECIFIC`   
Required: Yes

 ** TimeSeriesGranularity **   <a name="forecast-Type-ExplainabilityConfig-TimeSeriesGranularity"></a>
To create an Explainability for all time series in your datasets, use `ALL`. To create an Explainability for specific time series in your datasets, use `SPECIFIC`.  
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the [DataDestination](API_DataDestination.md) data type.  
Type: String  
Valid Values: `ALL | SPECIFIC`   
Required: Yes

## See Also
<a name="API_ExplainabilityConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityConfig) 

# ExplainabilityExportSummary
<a name="API_ExplainabilityExportSummary"></a>

Provides a summary of the Explainability export properties used in the [ListExplainabilityExports](API_ListExplainabilityExports.md) operation. To get a complete set of properties, call the [DescribeExplainabilityExport](API_DescribeExplainabilityExport.md) operation, and provide the `ExplainabilityExportArn`.

## Contents
<a name="API_ExplainabilityExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilityExportSummary-CreationTime"></a>
When the Explainability was created.  
Type: Timestamp  
Required: No

 ** Destination **   <a name="forecast-Type-ExplainabilityExportSummary-Destination"></a>
The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).   
Type: [DataDestination](API_DataDestination.md) object  
Required: No

 ** ExplainabilityExportArn **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportArn"></a>
The Amazon Resource Name (ARN) of the Explainability export.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** ExplainabilityExportName **   <a name="forecast-Type-ExplainabilityExportSummary-ExplainabilityExportName"></a>
The name of the Explainability export  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilityExportSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-ExplainabilityExportSummary-Message"></a>
Information about any errors that may have occurred during the Explainability export.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-ExplainabilityExportSummary-Status"></a>
The status of the Explainability export. States include:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ExplainabilityExportSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityExportSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityExportSummary) 

# ExplainabilityInfo
<a name="API_ExplainabilityInfo"></a>

Provides information about the Explainability resource.

## Contents
<a name="API_ExplainabilityInfo_Contents"></a>

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilityInfo-ExplainabilityArn"></a>
The Amazon Resource Name (ARN) of the Explainability.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** Status **   <a name="forecast-Type-ExplainabilityInfo-Status"></a>
The status of the Explainability. States include:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ExplainabilityInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilityInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilityInfo) 

# ExplainabilitySummary
<a name="API_ExplainabilitySummary"></a>

Provides a summary of the Explainability properties used in the [ListExplainabilities](API_ListExplainabilities.md) operation. To get a complete set of properties, call the [DescribeExplainability](API_DescribeExplainability.md) operation, and provide the listed `ExplainabilityArn`.

## Contents
<a name="API_ExplainabilitySummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ExplainabilitySummary-CreationTime"></a>
When the Explainability was created.  
Type: Timestamp  
Required: No

 ** ExplainabilityArn **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityArn"></a>
The Amazon Resource Name (ARN) of the Explainability.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** ExplainabilityConfig **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityConfig"></a>
The configuration settings that define the granularity of time series and time points for the Explainability.  
Type: [ExplainabilityConfig](API_ExplainabilityConfig.md) object  
Required: No

 ** ExplainabilityName **   <a name="forecast-Type-ExplainabilitySummary-ExplainabilityName"></a>
The name of the Explainability.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-ExplainabilitySummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-ExplainabilitySummary-Message"></a>
Information about any errors that may have occurred during the Explainability creation process.  
Type: String  
Required: No

 ** ResourceArn **   <a name="forecast-Type-ExplainabilitySummary-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** Status **   <a name="forecast-Type-ExplainabilitySummary-Status"></a>
The status of the Explainability. States include:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ExplainabilitySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ExplainabilitySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ExplainabilitySummary) 

# Featurization
<a name="API_Featurization"></a>

**Note**  
This object belongs to the [CreatePredictor](API_CreatePredictor.md) operation. If you created your predictor with [CreateAutoPredictor](API_CreateAutoPredictor.md), see [AttributeConfig](API_AttributeConfig.md).

Provides featurization (transformation) information for a dataset field. This object is part of the [FeaturizationConfig](API_FeaturizationConfig.md) object.

For example:

 `{` 

 `"AttributeName": "demand",` 

 `FeaturizationPipeline [ {` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}` 

 `} ]` 

 `}` 

## Contents
<a name="API_Featurization_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-Featurization-AttributeName"></a>
The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the `TARGET_TIME_SERIES` and the `RELATED_TIME_SERIES` datasets. For example, for the `RETAIL` domain, the target is `demand`, and for the `CUSTOM` domain, the target is `target_value`. For more information, see [Handling Missing Values](howitworks-missing-values.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** FeaturizationPipeline **   <a name="forecast-Type-Featurization-FeaturizationPipeline"></a>
An array of one `FeaturizationMethod` object that specifies the feature transformation method.  
Type: Array of [FeaturizationMethod](API_FeaturizationMethod.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

## See Also
<a name="API_Featurization_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Featurization) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Featurization) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Featurization) 

# FeaturizationConfig
<a name="API_FeaturizationConfig"></a>

**Note**  
This object belongs to the [CreatePredictor](API_CreatePredictor.md) operation. If you created your predictor with [CreateAutoPredictor](API_CreateAutoPredictor.md), see [AttributeConfig](API_AttributeConfig.md).

In a [CreatePredictor](API_CreatePredictor.md) operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as *featurization*.

You define featurization using the `FeaturizationConfig` object. You specify an array of transformations, one for each field that you want to featurize. You then include the `FeaturizationConfig` object in your `CreatePredictor` request. Amazon Forecast applies the featurization to the `TARGET_TIME_SERIES` and `RELATED_TIME_SERIES` datasets before model training.

You can create multiple featurization configurations. For example, you might call the `CreatePredictor` operation twice by specifying different featurization configurations.

## Contents
<a name="API_FeaturizationConfig_Contents"></a>

 ** ForecastFrequency **   <a name="forecast-Type-FeaturizationConfig-ForecastFrequency"></a>
The frequency of predictions in a forecast.  
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:  
+ Minute - 1-59
+ Hour - 1-23
+ Day - 1-6
+ Week - 1-4
+ Month - 1-11
+ Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".  
The frequency must be greater than or equal to the TARGET\$1TIME\$1SERIES dataset frequency.  
When a RELATED\$1TIME\$1SERIES dataset is provided, the frequency must be equal to the TARGET\$1TIME\$1SERIES dataset frequency.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5.  
Pattern: `^Y|M|W|D|H|30min|15min|10min|5min|1min$`   
Required: Yes

 ** Featurizations **   <a name="forecast-Type-FeaturizationConfig-Featurizations"></a>
An array of featurization (transformation) information for the fields of a dataset.  
Type: Array of [Featurization](API_Featurization.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** ForecastDimensions **   <a name="forecast-Type-FeaturizationConfig-ForecastDimensions"></a>
An array of dimension (field) names that specify how to group the generated forecast.  
For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a `store_id` field. If you want the sales forecast for each item by store, you would specify `store_id` as the dimension.  
All forecast dimensions specified in the `TARGET_TIME_SERIES` dataset don't need to be specified in the `CreatePredictor` request. All forecast dimensions specified in the `RELATED_TIME_SERIES` dataset must be specified in the `CreatePredictor` request.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

## See Also
<a name="API_FeaturizationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationConfig) 

# FeaturizationMethod
<a name="API_FeaturizationMethod"></a>

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the `FeaturizationPipeline` of the [Featurization](API_Featurization.md) object. 

The following is an example of how you specify a `FeaturizationMethod` object.

 `{` 

 `"FeaturizationMethodName": "filling",` 

 `"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}` 

 `}` 

## Contents
<a name="API_FeaturizationMethod_Contents"></a>

 ** FeaturizationMethodName **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodName"></a>
The name of the method. The "filling" method is the only supported method.  
Type: String  
Valid Values: `filling`   
Required: Yes

 ** FeaturizationMethodParameters **   <a name="forecast-Type-FeaturizationMethod-FeaturizationMethodParameters"></a>
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.  
The following list shows the parameters and their valid values for the "filling" featurization method for a **Target Time Series** dataset. Bold signifies the default value.  
+  `aggregation`: **sum**, `avg`, `first`, `min`, `max` 
+  `frontfill`: **none** 
+  `middlefill`: **zero**, `nan` (not a number), `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`, `max` 
The following list shows the parameters and their valid values for a **Related Time Series** featurization method (there are no defaults):  
+  `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
+  `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max` 
To set a filling method to a specific value, set the fill parameter to `value` and define the value in a corresponding `_value` parameter. For example, to set backfilling to a value of 2, include the following: `"backfill": "value"` and `"backfill_value":"2"`.   
Type: String to string map  
Map Entries: Maximum number of 20 items.  
Key Length Constraints: Maximum length of 256.  
Key Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$`   
Required: No

## See Also
<a name="API_FeaturizationMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/FeaturizationMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/FeaturizationMethod) 

# Filter
<a name="API_Filter"></a>

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either `IS` or `IS_NOT`, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

## Contents
<a name="API_Filter_Contents"></a>

 ** Condition **   <a name="forecast-Type-Filter-Condition"></a>
The condition to apply. To include the objects that match the statement, specify `IS`. To exclude matching objects, specify `IS_NOT`.  
Type: String  
Valid Values: `IS | IS_NOT`   
Required: Yes

 ** Key **   <a name="forecast-Type-Filter-Key"></a>
The name of the parameter to filter on.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_]+$`   
Required: Yes

 ** Value **   <a name="forecast-Type-Filter-Value"></a>
The value to match.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: Yes

## See Also
<a name="API_Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Filter) 

# ForecastExportJobSummary
<a name="API_ForecastExportJobSummary"></a>

Provides a summary of the forecast export job properties used in the [ListForecastExportJobs](API_ListForecastExportJobs.md) operation. To get the complete set of properties, call the [DescribeForecastExportJob](API_DescribeForecastExportJob.md) operation, and provide the listed `ForecastExportJobArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_ForecastExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-ForecastExportJobSummary-CreationTime"></a>
When the forecast export job was created.  
Type: Timestamp  
Required: No

 ** Destination **   <a name="forecast-Type-ForecastExportJobSummary-Destination"></a>
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.  
Type: [DataDestination](API_DataDestination.md) object  
Required: No

 ** ForecastExportJobArn **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobArn"></a>
The Amazon Resource Name (ARN) of the forecast export job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** ForecastExportJobName **   <a name="forecast-Type-ForecastExportJobSummary-ForecastExportJobName"></a>
The name of the forecast export job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-ForecastExportJobSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-ForecastExportJobSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-ForecastExportJobSummary-Status"></a>
The status of the forecast export job. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
The `Status` of the forecast export job must be `ACTIVE` before you can access the forecast in your S3 bucket.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ForecastExportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastExportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastExportJobSummary) 

# ForecastSummary
<a name="API_ForecastSummary"></a>

Provides a summary of the forecast properties used in the [ListForecasts](API_ListForecasts.md) operation. To get the complete set of properties, call the [DescribeForecast](API_DescribeForecast.md) operation, and provide the `ForecastArn` that is listed in the summary.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_ForecastSummary_Contents"></a>

 ** CreatedUsingAutoPredictor **   <a name="forecast-Type-ForecastSummary-CreatedUsingAutoPredictor"></a>
Whether the Forecast was created from an AutoPredictor.  
Type: Boolean  
Required: No

 ** CreationTime **   <a name="forecast-Type-ForecastSummary-CreationTime"></a>
When the forecast creation task was created.  
Type: Timestamp  
Required: No

 ** DatasetGroupArn **   <a name="forecast-Type-ForecastSummary-DatasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_]+$`   
Required: No

 ** ForecastArn **   <a name="forecast-Type-ForecastSummary-ForecastArn"></a>
The ARN of the forecast.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** ForecastName **   <a name="forecast-Type-ForecastSummary-ForecastName"></a>
The name of the forecast.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-ForecastSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-ForecastSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** PredictorArn **   <a name="forecast-Type-ForecastSummary-PredictorArn"></a>
The ARN of the predictor used to generate the forecast.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_]+$`   
Required: No

 ** Status **   <a name="forecast-Type-ForecastSummary-Status"></a>
The status of the forecast. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
The `Status` of the forecast must be `ACTIVE` before you can query or export the forecast.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_ForecastSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ForecastSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ForecastSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ForecastSummary) 

# HyperParameterTuningJobConfig
<a name="API_HyperParameterTuningJobConfig"></a>

Configuration information for a hyperparameter tuning job. You specify this object in the [CreatePredictor](API_CreatePredictor.md) request.

A *hyperparameter* is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.

In a *hyperparameter tuning job*, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.

## Contents
<a name="API_HyperParameterTuningJobConfig_Contents"></a>

 ** ParameterRanges **   <a name="forecast-Type-HyperParameterTuningJobConfig-ParameterRanges"></a>
Specifies the ranges of valid values for the hyperparameters.  
Type: [ParameterRanges](API_ParameterRanges.md) object  
Required: No

## See Also
<a name="API_HyperParameterTuningJobConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/HyperParameterTuningJobConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/HyperParameterTuningJobConfig) 

# InputDataConfig
<a name="API_InputDataConfig"></a>

**Note**  
This object belongs to the [CreatePredictor](API_CreatePredictor.md) operation. If you created your predictor with [CreateAutoPredictor](API_CreateAutoPredictor.md), see [DataConfig](API_DataConfig.md).

The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the [CreatePredictor](API_CreatePredictor.md) request.

## Contents
<a name="API_InputDataConfig_Contents"></a>

 ** DatasetGroupArn **   <a name="forecast-Type-InputDataConfig-DatasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: Yes

 ** SupplementaryFeatures **   <a name="forecast-Type-InputDataConfig-SupplementaryFeatures"></a>
An array of supplementary features. The only supported feature is a holiday calendar.  
Type: Array of [SupplementaryFeature](API_SupplementaryFeature.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Required: No

## See Also
<a name="API_InputDataConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/InputDataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/InputDataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/InputDataConfig) 

# IntegerParameterRange
<a name="API_IntegerParameterRange"></a>

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the [ParameterRanges](API_ParameterRanges.md) object.

## Contents
<a name="API_IntegerParameterRange_Contents"></a>

 ** MaxValue **   <a name="forecast-Type-IntegerParameterRange-MaxValue"></a>
The maximum tunable value of the hyperparameter.  
Type: Integer  
Required: Yes

 ** MinValue **   <a name="forecast-Type-IntegerParameterRange-MinValue"></a>
The minimum tunable value of the hyperparameter.  
Type: Integer  
Required: Yes

 ** Name **   <a name="forecast-Type-IntegerParameterRange-Name"></a>
The name of the hyperparameter to tune.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** ScalingType **   <a name="forecast-Type-IntegerParameterRange-ScalingType"></a>
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:    
Auto  
Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.  
Linear  
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.  
Logarithmic  
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.  
Logarithmic scaling works only for ranges that have values greater than 0.  
ReverseLogarithmic  
Not supported for `IntegerParameterRange`.  
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see [Hyperparameter Scaling](http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). One of the following values:  
Type: String  
Valid Values: `Auto | Linear | Logarithmic | ReverseLogarithmic`   
Required: No

## See Also
<a name="API_IntegerParameterRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/IntegerParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/IntegerParameterRange) 

# MetricResult
<a name="API_MetricResult"></a>

An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the [Baseline](API_Baseline.md) to see how your predictor's performance is changing.

For more information about metrics generated by Forecast see [Evaluating Predictor Accuracy](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) 

## Contents
<a name="API_MetricResult_Contents"></a>

 ** MetricName **   <a name="forecast-Type-MetricResult-MetricName"></a>
The name of the metric.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** MetricValue **   <a name="forecast-Type-MetricResult-MetricValue"></a>
The value for the metric.  
Type: Double  
Required: No

## See Also
<a name="API_MetricResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MetricResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MetricResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MetricResult) 

# Metrics
<a name="API_Metrics"></a>

Provides metrics that are used to evaluate the performance of a predictor. This object is part of the [WindowSummary](API_WindowSummary.md) object.

## Contents
<a name="API_Metrics_Contents"></a>

 ** AverageWeightedQuantileLoss **   <a name="forecast-Type-Metrics-AverageWeightedQuantileLoss"></a>
The average value of all weighted quantile losses.  
Type: Double  
Required: No

 ** ErrorMetrics **   <a name="forecast-Type-Metrics-ErrorMetrics"></a>
 Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).   
Type: Array of [ErrorMetric](API_ErrorMetric.md) objects  
Required: No

 ** RMSE **   <a name="forecast-Type-Metrics-RMSE"></a>
 *This member has been deprecated.*   
The root-mean-square error (RMSE).  
Type: Double  
Required: No

 ** WeightedQuantileLosses **   <a name="forecast-Type-Metrics-WeightedQuantileLosses"></a>
An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.  
Type: Array of [WeightedQuantileLoss](API_WeightedQuantileLoss.md) objects  
Required: No

## See Also
<a name="API_Metrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Metrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Metrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Metrics) 

# MonitorConfig
<a name="API_MonitorConfig"></a>

The configuration details for the predictor monitor.

## Contents
<a name="API_MonitorConfig_Contents"></a>

 ** MonitorName **   <a name="forecast-Type-MonitorConfig-MonitorName"></a>
The name of the monitor resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

## See Also
<a name="API_MonitorConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorConfig) 

# MonitorDataSource
<a name="API_MonitorDataSource"></a>

The source of the data the monitor used during the evaluation.

## Contents
<a name="API_MonitorDataSource_Contents"></a>

 ** DatasetImportJobArn **   <a name="forecast-Type-MonitorDataSource-DatasetImportJobArn"></a>
The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** ForecastArn **   <a name="forecast-Type-MonitorDataSource-ForecastArn"></a>
The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** PredictorArn **   <a name="forecast-Type-MonitorDataSource-PredictorArn"></a>
The Amazon Resource Name (ARN) of the predictor resource you are monitoring.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

## See Also
<a name="API_MonitorDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorDataSource) 

# MonitorInfo
<a name="API_MonitorInfo"></a>

Provides information about the monitor resource.

## Contents
<a name="API_MonitorInfo_Contents"></a>

 ** MonitorArn **   <a name="forecast-Type-MonitorInfo-MonitorArn"></a>
The Amazon Resource Name (ARN) of the monitor resource.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** Status **   <a name="forecast-Type-MonitorInfo-Status"></a>
The status of the monitor. States include:  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_MonitorInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorInfo) 

# MonitorSummary
<a name="API_MonitorSummary"></a>

Provides a summary of the monitor properties used in the [ListMonitors](API_ListMonitors.md) operation. To get a complete set of properties, call the [DescribeMonitor](API_DescribeMonitor.md) operation, and provide the listed `MonitorArn`.

## Contents
<a name="API_MonitorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-MonitorSummary-CreationTime"></a>
When the monitor resource was created.  
Type: Timestamp  
Required: No

 ** LastModificationTime **   <a name="forecast-Type-MonitorSummary-LastModificationTime"></a>
The last time the monitor resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `STOPPED` - When the resource stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the monitor creation finished or failed.
Type: Timestamp  
Required: No

 ** MonitorArn **   <a name="forecast-Type-MonitorSummary-MonitorArn"></a>
The Amazon Resource Name (ARN) of the monitor resource.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** MonitorName **   <a name="forecast-Type-MonitorSummary-MonitorName"></a>
The name of the monitor resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** ResourceArn **   <a name="forecast-Type-MonitorSummary-ResourceArn"></a>
The Amazon Resource Name (ARN) of the predictor being monitored.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** Status **   <a name="forecast-Type-MonitorSummary-Status"></a>
The status of the monitor. States include:  
+  `ACTIVE` 
+  `ACTIVE_STOPPING`, `ACTIVE_STOPPED` 
+  `UPDATE_IN_PROGRESS` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_MonitorSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/MonitorSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/MonitorSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/MonitorSummary) 

# ParameterRanges
<a name="API_ParameterRanges"></a>

Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the [HyperParameterTuningJobConfig](API_HyperParameterTuningJobConfig.md) object.

## Contents
<a name="API_ParameterRanges_Contents"></a>

 ** CategoricalParameterRanges **   <a name="forecast-Type-ParameterRanges-CategoricalParameterRanges"></a>
Specifies the tunable range for each categorical hyperparameter.  
Type: Array of [CategoricalParameterRange](API_CategoricalParameterRange.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: No

 ** ContinuousParameterRanges **   <a name="forecast-Type-ParameterRanges-ContinuousParameterRanges"></a>
Specifies the tunable range for each continuous hyperparameter.  
Type: Array of [ContinuousParameterRange](API_ContinuousParameterRange.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: No

 ** IntegerParameterRanges **   <a name="forecast-Type-ParameterRanges-IntegerParameterRanges"></a>
Specifies the tunable range for each integer hyperparameter.  
Type: Array of [IntegerParameterRange](API_IntegerParameterRange.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: No

## See Also
<a name="API_ParameterRanges_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ParameterRanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ParameterRanges) 

# PredictorBacktestExportJobSummary
<a name="API_PredictorBacktestExportJobSummary"></a>

Provides a summary of the predictor backtest export job properties used in the [ListPredictorBacktestExportJobs](API_ListPredictorBacktestExportJobs.md) operation. To get a complete set of properties, call the [DescribePredictorBacktestExportJob](API_DescribePredictorBacktestExportJob.md) operation, and provide the listed `PredictorBacktestExportJobArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_PredictorBacktestExportJobSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-CreationTime"></a>
When the predictor backtest export job was created.  
Type: Timestamp  
Required: No

 ** Destination **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Destination"></a>
The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).   
Type: [DataDestination](API_DataDestination.md) object  
Required: No

 ** LastModificationTime **   <a name="forecast-Type-PredictorBacktestExportJobSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Message"></a>
Information about any errors that may have occurred during the backtest export.  
Type: String  
Required: No

 ** PredictorBacktestExportJobArn **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobArn"></a>
The Amazon Resource Name (ARN) of the predictor backtest export job.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** PredictorBacktestExportJobName **   <a name="forecast-Type-PredictorBacktestExportJobSummary-PredictorBacktestExportJobName"></a>
The name of the predictor backtest export job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** Status **   <a name="forecast-Type-PredictorBacktestExportJobSummary-Status"></a>
The status of the predictor backtest export job. States include:   
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_PredictorBacktestExportJobSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBacktestExportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBacktestExportJobSummary) 

# PredictorBaseline
<a name="API_PredictorBaseline"></a>

Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.

## Contents
<a name="API_PredictorBaseline_Contents"></a>

 ** BaselineMetrics **   <a name="forecast-Type-PredictorBaseline-BaselineMetrics"></a>
The initial [accuracy metrics](https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.  
Type: Array of [BaselineMetric](API_BaselineMetric.md) objects  
Required: No

## See Also
<a name="API_PredictorBaseline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorBaseline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorBaseline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorBaseline) 

# PredictorEvent
<a name="API_PredictorEvent"></a>

Provides details about a predictor event, such as a retraining.

## Contents
<a name="API_PredictorEvent_Contents"></a>

 ** Datetime **   <a name="forecast-Type-PredictorEvent-Datetime"></a>
The timestamp for when the event occurred.  
Type: Timestamp  
Required: No

 ** Detail **   <a name="forecast-Type-PredictorEvent-Detail"></a>
The type of event. For example, `Retrain`. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the `Datetime` are from the previous predictor. Any new metrics are for the newly retrained predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_PredictorEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorEvent) 

# PredictorExecution
<a name="API_PredictorExecution"></a>

The algorithm used to perform a backtest and the status of those tests.

## Contents
<a name="API_PredictorExecution_Contents"></a>

 ** AlgorithmArn **   <a name="forecast-Type-PredictorExecution-AlgorithmArn"></a>
The ARN of the algorithm used to test the predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** TestWindows **   <a name="forecast-Type-PredictorExecution-TestWindows"></a>
An array of test windows used to evaluate the algorithm. The `NumberOfBacktestWindows` from the [EvaluationParameters](API_EvaluationParameters.md) object determines the number of windows in the array.  
Type: Array of [TestWindowSummary](API_TestWindowSummary.md) objects  
Required: No

## See Also
<a name="API_PredictorExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecution) 

# PredictorExecutionDetails
<a name="API_PredictorExecutionDetails"></a>

Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the [CreatePredictor](API_CreatePredictor.md) operation.

## Contents
<a name="API_PredictorExecutionDetails_Contents"></a>

 ** PredictorExecutions **   <a name="forecast-Type-PredictorExecutionDetails-PredictorExecutions"></a>
An array of the backtests performed to evaluate the accuracy of the predictor against a particular algorithm. The `NumberOfBacktestWindows` from the [EvaluationParameters](API_EvaluationParameters.md) object determines the number of windows in the array.  
Type: Array of [PredictorExecution](API_PredictorExecution.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

## See Also
<a name="API_PredictorExecutionDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorExecutionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorExecutionDetails) 

# PredictorMonitorEvaluation
<a name="API_PredictorMonitorEvaluation"></a>

Describes the results of a monitor evaluation.

## Contents
<a name="API_PredictorMonitorEvaluation_Contents"></a>

 ** EvaluationState **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationState"></a>
The status of the monitor evaluation. The state can be `SUCCESS` or `FAILURE`.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** EvaluationTime **   <a name="forecast-Type-PredictorMonitorEvaluation-EvaluationTime"></a>
The timestamp that indicates when the monitor evaluation was started.   
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-PredictorMonitorEvaluation-Message"></a>
Information about any errors that may have occurred during the monitor evaluation.  
Type: String  
Required: No

 ** MetricResults **   <a name="forecast-Type-PredictorMonitorEvaluation-MetricResults"></a>
A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the [Baseline](API_Baseline.md) to see how your predictor's performance is changing.  
Type: Array of [MetricResult](API_MetricResult.md) objects  
Required: No

 ** MonitorArn **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorArn"></a>
The Amazon Resource Name (ARN) of the monitor resource.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** MonitorDataSource **   <a name="forecast-Type-PredictorMonitorEvaluation-MonitorDataSource"></a>
The source of the data the monitor resource used during the evaluation.  
Type: [MonitorDataSource](API_MonitorDataSource.md) object  
Required: No

 ** NumItemsEvaluated **   <a name="forecast-Type-PredictorMonitorEvaluation-NumItemsEvaluated"></a>
The number of items considered during the evaluation.  
Type: Long  
Required: No

 ** PredictorEvent **   <a name="forecast-Type-PredictorMonitorEvaluation-PredictorEvent"></a>
Provides details about a predictor event, such as a retraining.  
Type: [PredictorEvent](API_PredictorEvent.md) object  
Required: No

 ** ResourceArn **   <a name="forecast-Type-PredictorMonitorEvaluation-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to monitor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WindowEndDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowEndDatetime"></a>
The timestamp that indicates the end of the window that is used for monitor evaluation.  
Type: Timestamp  
Required: No

 ** WindowStartDatetime **   <a name="forecast-Type-PredictorMonitorEvaluation-WindowStartDatetime"></a>
The timestamp that indicates the start of the window that is used for monitor evaluation.  
Type: Timestamp  
Required: No

## See Also
<a name="API_PredictorMonitorEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorMonitorEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorMonitorEvaluation) 

# PredictorSummary
<a name="API_PredictorSummary"></a>

Provides a summary of the predictor properties that are used in the [ListPredictors](API_ListPredictors.md) operation. To get the complete set of properties, call the [DescribePredictor](API_DescribePredictor.md) operation, and provide the listed `PredictorArn`.

**Important**  
Amazon Forecast is no longer available to new customers. Existing customers of Amazon Forecast can continue to use the service as normal. [Learn more"](http://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

## Contents
<a name="API_PredictorSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-PredictorSummary-CreationTime"></a>
When the model training task was created.  
Type: Timestamp  
Required: No

 ** DatasetGroupArn **   <a name="forecast-Type-PredictorSummary-DatasetGroupArn"></a>
The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** IsAutoPredictor **   <a name="forecast-Type-PredictorSummary-IsAutoPredictor"></a>
Whether AutoPredictor was used to create the predictor.  
Type: Boolean  
Required: No

 ** LastModificationTime **   <a name="forecast-Type-PredictorSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-PredictorSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** PredictorArn **   <a name="forecast-Type-PredictorSummary-PredictorArn"></a>
The ARN of the predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** PredictorName **   <a name="forecast-Type-PredictorSummary-PredictorName"></a>
The name of the predictor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** ReferencePredictorSummary **   <a name="forecast-Type-PredictorSummary-ReferencePredictorSummary"></a>
A summary of the reference predictor used if the predictor was retrained or upgraded.  
Type: [ReferencePredictorSummary](API_ReferencePredictorSummary.md) object  
Required: No

 ** Status **   <a name="forecast-Type-PredictorSummary-Status"></a>
The status of the predictor. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
The `Status` of the predictor must be `ACTIVE` before you can use the predictor to create a forecast.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_PredictorSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/PredictorSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/PredictorSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/PredictorSummary) 

# ReferencePredictorSummary
<a name="API_ReferencePredictorSummary"></a>

Provides a summary of the reference predictor used when retraining or upgrading a predictor.

## Contents
<a name="API_ReferencePredictorSummary_Contents"></a>

 ** Arn **   <a name="forecast-Type-ReferencePredictorSummary-Arn"></a>
The ARN of the reference predictor.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** State **   <a name="forecast-Type-ReferencePredictorSummary-State"></a>
Whether the reference predictor is `Active` or `Deleted`.  
Type: String  
Valid Values: `Active | Deleted`   
Required: No

## See Also
<a name="API_ReferencePredictorSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ReferencePredictorSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ReferencePredictorSummary) 

# S3Config
<a name="API_S3Config"></a>

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the [DataSource](API_DataSource.md) object that is submitted in the [CreateDatasetImportJob](API_CreateDatasetImportJob.md) request, and part of the [DataDestination](API_DataDestination.md) object.

## Contents
<a name="API_S3Config_Contents"></a>

 ** Path **   <a name="forecast-Type-S3Config-Path"></a>
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 4096.  
Pattern: `^s3://[a-z0-9].+$`   
Required: Yes

 ** RoleArn **   <a name="forecast-Type-S3Config-RoleArn"></a>
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the `KMSKeyArn` key, the role must allow access to the key.  
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an `InvalidInputException` error.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: Yes

 ** KMSKeyArn **   <a name="forecast-Type-S3Config-KMSKeyArn"></a>
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:aws:kms:.*:key/.*`   
Required: No

## See Also
<a name="API_S3Config_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/S3Config) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/S3Config) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/S3Config) 

# Schema
<a name="API_Schema"></a>

Defines the fields of a dataset.

## Contents
<a name="API_Schema_Contents"></a>

 ** Attributes **   <a name="forecast-Type-Schema-Attributes"></a>
An array of attributes specifying the name and type of each field in a dataset.  
Type: Array of [SchemaAttribute](API_SchemaAttribute.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

## See Also
<a name="API_Schema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Schema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Schema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Schema) 

# SchemaAttribute
<a name="API_SchemaAttribute"></a>

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The [Schema](https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) object contains an array of `SchemaAttribute` objects.

## Contents
<a name="API_SchemaAttribute_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-SchemaAttribute-AttributeName"></a>
The name of the dataset field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

 ** AttributeType **   <a name="forecast-Type-SchemaAttribute-AttributeType"></a>
The data type of the field.  
For a related time series dataset, other than date, item\$1id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).  
Type: String  
Valid Values: `string | integer | float | timestamp | geolocation`   
Required: No

## See Also
<a name="API_SchemaAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SchemaAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SchemaAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SchemaAttribute) 

# Statistics
<a name="API_Statistics"></a>

Provides statistics for each data field imported into to an Amazon Forecast dataset with the [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation.

## Contents
<a name="API_Statistics_Contents"></a>

 ** Avg **   <a name="forecast-Type-Statistics-Avg"></a>
For a numeric field, the average value in the field.  
Type: Double  
Required: No

 ** Count **   <a name="forecast-Type-Statistics-Count"></a>
The number of values in the field. If the response value is -1, refer to `CountLong`.  
Type: Integer  
Required: No

 ** CountDistinct **   <a name="forecast-Type-Statistics-CountDistinct"></a>
The number of distinct values in the field. If the response value is -1, refer to `CountDistinctLong`.  
Type: Integer  
Required: No

 ** CountDistinctLong **   <a name="forecast-Type-Statistics-CountDistinctLong"></a>
The number of distinct values in the field. `CountDistinctLong` is used instead of `CountDistinct` if the value is greater than 2,147,483,647.  
Type: Long  
Required: No

 ** CountLong **   <a name="forecast-Type-Statistics-CountLong"></a>
The number of values in the field. `CountLong` is used instead of `Count` if the value is greater than 2,147,483,647.  
Type: Long  
Required: No

 ** CountNan **   <a name="forecast-Type-Statistics-CountNan"></a>
The number of NAN (not a number) values in the field. If the response value is -1, refer to `CountNanLong`.  
Type: Integer  
Required: No

 ** CountNanLong **   <a name="forecast-Type-Statistics-CountNanLong"></a>
The number of NAN (not a number) values in the field. `CountNanLong` is used instead of `CountNan` if the value is greater than 2,147,483,647.  
Type: Long  
Required: No

 ** CountNull **   <a name="forecast-Type-Statistics-CountNull"></a>
The number of null values in the field. If the response value is -1, refer to `CountNullLong`.  
Type: Integer  
Required: No

 ** CountNullLong **   <a name="forecast-Type-Statistics-CountNullLong"></a>
The number of null values in the field. `CountNullLong` is used instead of `CountNull` if the value is greater than 2,147,483,647.  
Type: Long  
Required: No

 ** Max **   <a name="forecast-Type-Statistics-Max"></a>
For a numeric field, the maximum value in the field.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_]+$`   
Required: No

 ** Min **   <a name="forecast-Type-Statistics-Min"></a>
For a numeric field, the minimum value in the field.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_]+$`   
Required: No

 ** Stddev **   <a name="forecast-Type-Statistics-Stddev"></a>
For a numeric field, the standard deviation.  
Type: Double  
Required: No

## See Also
<a name="API_Statistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Statistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Statistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Statistics) 

# SupplementaryFeature
<a name="API_SupplementaryFeature"></a>

**Note**  
This object belongs to the [CreatePredictor](API_CreatePredictor.md) operation. If you created your predictor with [CreateAutoPredictor](API_CreateAutoPredictor.md), see [AdditionalDataset](API_AdditionalDataset.md).

Describes a supplementary feature of a dataset group. This object is part of the [InputDataConfig](API_InputDataConfig.md) object. Forecast supports the Weather Index and Holidays built-in featurizations.

 **Weather Index** 

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see [Amazon Forecast Weather Index](https://docs.aws.amazon.com/forecast/latest/dg/weather.html).

 **Holidays** 

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of over 250 countries. Amazon Forecast incorporates both the [Holiday API library](https://holidayapi.com/countries) and [Jollyday API](https://jollyday.sourceforge.net/data.html) to generate holiday calendars. For more information, see [Holidays Featurization](https://docs.aws.amazon.com/forecast/latest/dg/holidays.html).

## Contents
<a name="API_SupplementaryFeature_Contents"></a>

 ** Name **   <a name="forecast-Type-SupplementaryFeature-Name"></a>
The name of the feature. Valid values: `"holiday"` and `"weather"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** Value **   <a name="forecast-Type-SupplementaryFeature-Value"></a>
 **Weather Index**   
To enable the Weather Index, set the value to `"true"`   
 **Holidays**   
To enable Holidays, specify a country with one of the following two-letter country codes:  
+  Afghanistan - AF 
+  Åland Islands - AX 
+  Albania - AL 
+  Algeria - DZ 
+  American Samoa - AS 
+  Andorra - AD 
+  Angola - AO 
+  Anguilla - AI 
+  Antartica - AQ 
+  Antigua and Barbuda - AG 
+  Argentina - AR 
+  Armenia - AM 
+  Aruba - AW 
+  Australia - AU 
+  Austria - AT 
+  Azerbaijan - AZ 
+  Bahamas - BS 
+  Bahrain - BH 
+  Bangladesh - BD 
+  Barbados - BB 
+  Belarus - BY 
+  Belgium - BE 
+  Belize - BZ 
+  Benin - BJ 
+  Bermuda - BM 
+  Bhutan - BT 
+  Bolivia - BO 
+  Bosnia and Herzegovina - BA 
+  Botswana - BW 
+  Bouvet Island - BV 
+  Brazil - BR 
+  British Indian Ocean Territory - IO 
+  British Virgin Islands - VG 
+  Brunei Darussalam - BN 
+  Bulgaria - BG 
+  Burkina Faso - BF 
+  Burundi - BI 
+  Cambodia - KH 
+  Cameroon - CM 
+  Canada - CA 
+  Cape Verde - CV 
+  Caribbean Netherlands - BQ 
+  Cayman Islands - KY 
+  Central African Republic - CF 
+  Chad - TD 
+  Chile - CL 
+  China - CN 
+  Christmas Island - CX 
+  Cocos (Keeling) Islands - CC 
+  Colombia - CO 
+  Comoros - KM 
+  Cook Islands - CK 
+  Costa Rica - CR 
+  Croatia - HR 
+  Cuba - CU 
+  Curaçao - CW 
+  Cyprus - CY 
+  Czechia - CZ 
+  Democratic Republic of the Congo - CD 
+  Denmark - DK 
+  Djibouti - DJ 
+  Dominica - DM 
+  Dominican Republic - DO 
+  Ecuador - EC 
+  Egypt - EG 
+  El Salvador - SV 
+  Equatorial Guinea - GQ 
+  Eritrea - ER 
+  Estonia - EE 
+  Eswatini - SZ 
+  Ethiopia - ET 
+  Falkland Islands - FK 
+  Faroe Islands - FO 
+  Fiji - FJ 
+  Finland - FI 
+  France - FR 
+  French Guiana - GF 
+  French Polynesia - PF 
+  French Southern Territories - TF 
+  Gabon - GA 
+  Gambia - GM 
+  Georgia - GE 
+  Germany - DE 
+  Ghana - GH 
+  Gibraltar - GI 
+  Greece - GR 
+  Greenland - GL 
+  Grenada - GD 
+  Guadeloupe - GP 
+  Guam - GU 
+  Guatemala - GT 
+  Guernsey - GG 
+  Guinea - GN 
+  Guinea-Bissau - GW 
+  Guyana - GY 
+  Haiti - HT 
+  Heard Island and McDonald Islands - HM 
+  Honduras - HN 
+  Hong Kong - HK 
+  Hungary - HU 
+  Iceland - IS 
+  India - IN 
+  Indonesia - ID 
+  Iran - IR 
+  Iraq - IQ 
+  Ireland - IE 
+  Isle of Man - IM 
+  Israel - IL 
+  Italy - IT 
+  Ivory Coast - CI 
+  Jamaica - JM 
+  Japan - JP 
+  Jersey - JE 
+  Jordan - JO 
+  Kazakhstan - KZ 
+  Kenya - KE 
+  Kiribati - KI 
+  Kosovo - XK 
+  Kuwait - KW 
+  Kyrgyzstan - KG 
+  Laos - LA 
+  Latvia - LV 
+  Lebanon - LB 
+  Lesotho - LS 
+  Liberia - LR 
+  Libya - LY 
+  Liechtenstein - LI 
+  Lithuania - LT 
+  Luxembourg - LU 
+  Macao - MO 
+  Madagascar - MG 
+  Malawi - MW 
+  Malaysia - MY 
+  Maldives - MV 
+  Mali - ML 
+  Malta - MT 
+  Marshall Islands - MH 
+  Martinique - MQ 
+  Mauritania - MR 
+  Mauritius - MU 
+  Mayotte - YT 
+  Mexico - MX 
+  Micronesia - FM 
+  Moldova - MD 
+  Monaco - MC 
+  Mongolia - MN 
+  Montenegro - ME 
+  Montserrat - MS 
+  Morocco - MA 
+  Mozambique - MZ 
+  Myanmar - MM 
+  Namibia - NA 
+  Nauru - NR 
+  Nepal - NP 
+  Netherlands - NL 
+  New Caledonia - NC 
+  New Zealand - NZ 
+  Nicaragua - NI 
+  Niger - NE 
+  Nigeria - NG 
+  Niue - NU 
+  Norfolk Island - NF 
+  North Korea - KP 
+  North Macedonia - MK 
+  Northern Mariana Islands - MP 
+  Norway - NO 
+  Oman - OM 
+  Pakistan - PK 
+  Palau - PW 
+  Palestine - PS 
+  Panama - PA 
+  Papua New Guinea - PG 
+  Paraguay - PY 
+  Peru - PE 
+  Philippines - PH 
+  Pitcairn Islands - PN 
+  Poland - PL 
+  Portugal - PT 
+  Puerto Rico - PR 
+  Qatar - QA 
+  Republic of the Congo - CG 
+  Réunion - RE 
+  Romania - RO 
+  Russian Federation - RU 
+  Rwanda - RW 
+  Saint Barthélemy - BL 
+  "Saint Helena, Ascension and Tristan da Cunha " - SH 
+  Saint Kitts and Nevis - KN 
+  Saint Lucia - LC 
+  Saint Martin - MF 
+  Saint Pierre and Miquelon - PM 
+  Saint Vincent and the Grenadines - VC 
+  Samoa - WS 
+  San Marino - SM 
+  Sao Tome and Principe - ST 
+  Saudi Arabia - SA 
+  Senegal - SN 
+  Serbia - RS 
+  Seychelles - SC 
+  Sierra Leone - SL 
+  Singapore - SG 
+  Sint Maarten - SX 
+  Slovakia - SK 
+  Slovenia - SI 
+  Solomon Islands - SB 
+  Somalia - SO 
+  South Africa - ZA 
+  South Georgia and the South Sandwich Islands - GS 
+  South Korea - KR 
+  South Sudan - SS 
+  Spain - ES 
+  Sri Lanka - LK 
+  Sudan - SD 
+  Suriname - SR 
+  Svalbard and Jan Mayen - SJ 
+  Sweden - SE 
+  Switzerland - CH 
+  Syrian Arab Republic - SY 
+  Taiwan - TW 
+  Tajikistan - TJ 
+  Tanzania - TZ 
+  Thailand - TH 
+  Timor-Leste - TL 
+  Togo - TG 
+  Tokelau - TK 
+  Tonga - TO 
+  Trinidad and Tobago - TT 
+  Tunisia - TN 
+  Turkey - TR 
+  Turkmenistan - TM 
+  Turks and Caicos Islands - TC 
+  Tuvalu - TV 
+  Uganda - UG 
+  Ukraine - UA 
+  United Arab Emirates - AE 
+  United Kingdom - GB 
+  United Nations - UN 
+  United States - US 
+  United States Minor Outlying Islands - UM 
+  United States Virgin Islands - VI 
+  Uruguay - UY 
+  Uzbekistan - UZ 
+  Vanuatu - VU 
+  Vatican City - VA 
+  Venezuela - VE 
+  Vietnam - VN 
+  Wallis and Futuna - WF 
+  Western Sahara - EH 
+  Yemen - YE 
+  Zambia - ZM 
+  Zimbabwe - ZW 
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\_\-]+$`   
Required: Yes

## See Also
<a name="API_SupplementaryFeature_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/SupplementaryFeature) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/SupplementaryFeature) 

# Tag
<a name="API_Tag"></a>

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:
+ Maximum number of tags per resource - 50.
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length - 128 Unicode characters in UTF-8.
+ Maximum value length - 256 Unicode characters in UTF-8.
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: \$1 - = . \$1 : / @.
+ Tag keys and values are case sensitive.
+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has `aws` as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of `aws` do not count against your tags per resource limit.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="forecast-Type-Tag-Key"></a>
One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="forecast-Type-Tag-Value"></a>
The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/Tag) 

# TestWindowSummary
<a name="API_TestWindowSummary"></a>

The status, start time, and end time of a backtest, as well as a failure reason if applicable.

## Contents
<a name="API_TestWindowSummary_Contents"></a>

 ** Message **   <a name="forecast-Type-TestWindowSummary-Message"></a>
If the test failed, the reason why it failed.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-TestWindowSummary-Status"></a>
The status of the test. Possible status values are:  
+  `ACTIVE` 
+  `CREATE_IN_PROGRESS` 
+  `CREATE_FAILED` 
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** TestWindowEnd **   <a name="forecast-Type-TestWindowSummary-TestWindowEnd"></a>
The time at which the test ended.  
Type: Timestamp  
Required: No

 ** TestWindowStart **   <a name="forecast-Type-TestWindowSummary-TestWindowStart"></a>
The time at which the test began.  
Type: Timestamp  
Required: No

## See Also
<a name="API_TestWindowSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TestWindowSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TestWindowSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TestWindowSummary) 

# TimeAlignmentBoundary
<a name="API_TimeAlignmentBoundary"></a>

The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of [Default Time Boundaries](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). 

For more information about aggregation, see [Data Aggregation for Different Forecast Frequencies](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). For more information setting a custom time boundary, see [Specifying a Time Boundary](https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). 

## Contents
<a name="API_TimeAlignmentBoundary_Contents"></a>

 ** DayOfMonth **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfMonth"></a>
The day of the month to use for time alignment during aggregation.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 28.  
Required: No

 ** DayOfWeek **   <a name="forecast-Type-TimeAlignmentBoundary-DayOfWeek"></a>
The day of week to use for time alignment during aggregation. The day must be in uppercase.  
Type: String  
Valid Values: `MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY`   
Required: No

 ** Hour **   <a name="forecast-Type-TimeAlignmentBoundary-Hour"></a>
The hour of day to use for time alignment during aggregation.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** Month **   <a name="forecast-Type-TimeAlignmentBoundary-Month"></a>
The month to use for time alignment during aggregation. The month must be in uppercase.  
Type: String  
Valid Values: `JANUARY | FEBRUARY | MARCH | APRIL | MAY | JUNE | JULY | AUGUST | SEPTEMBER | OCTOBER | NOVEMBER | DECEMBER`   
Required: No

## See Also
<a name="API_TimeAlignmentBoundary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeAlignmentBoundary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeAlignmentBoundary) 

# TimeSeriesCondition
<a name="API_TimeSeriesCondition"></a>

Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost \$15 or less. To do this, you specify `"AttributeName": "price"`, `"AttributeValue": "5"`, and `"Condition": "LESS_THAN"`. Pair this operation with the [Action](API_Action.md) operation within the [CreateWhatIfForecast:TimeSeriesTransformations](API_CreateWhatIfForecast.md#forecast-CreateWhatIfForecast-request-TimeSeriesTransformations) operation to define how the attribute is modified.

## Contents
<a name="API_TimeSeriesCondition_Contents"></a>

 ** AttributeName **   <a name="forecast-Type-TimeSeriesCondition-AttributeName"></a>
The item\$1id, dimension name, IM name, or timestamp that you are modifying.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: Yes

 ** AttributeValue **   <a name="forecast-Type-TimeSeriesCondition-AttributeValue"></a>
The value that is applied for the chosen `Condition`.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `.+`   
Required: Yes

 ** Condition **   <a name="forecast-Type-TimeSeriesCondition-Condition"></a>
The condition to apply. Valid values are `EQUALS`, `NOT_EQUALS`, `LESS_THAN` and `GREATER_THAN`.  
Type: String  
Valid Values: `EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN`   
Required: Yes

## See Also
<a name="API_TimeSeriesCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesCondition) 

# TimeSeriesIdentifiers
<a name="API_TimeSeriesIdentifiers"></a>

Details about the import file that contains the time series for which you want to create forecasts.

## Contents
<a name="API_TimeSeriesIdentifiers_Contents"></a>

 ** DataSource **   <a name="forecast-Type-TimeSeriesIdentifiers-DataSource"></a>
The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.  
Type: [DataSource](API_DataSource.md) object  
Required: No

 ** Format **   <a name="forecast-Type-TimeSeriesIdentifiers-Format"></a>
The format of the data, either CSV or PARQUET.  
Type: String  
Length Constraints: Maximum length of 7.  
Pattern: `^CSV|PARQUET$`   
Required: No

 ** Schema **   <a name="forecast-Type-TimeSeriesIdentifiers-Schema"></a>
Defines the fields of a dataset.  
Type: [Schema](API_Schema.md) object  
Required: No

## See Also
<a name="API_TimeSeriesIdentifiers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesIdentifiers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesIdentifiers) 

# TimeSeriesReplacementsDataSource
<a name="API_TimeSeriesReplacementsDataSource"></a>

A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.

## Contents
<a name="API_TimeSeriesReplacementsDataSource_Contents"></a>

 ** S3Config **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-S3Config"></a>
The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the [DataSource](API_DataSource.md) object that is submitted in the [CreateDatasetImportJob](API_CreateDatasetImportJob.md) request, and part of the [DataDestination](API_DataDestination.md) object.  
Type: [S3Config](API_S3Config.md) object  
Required: Yes

 ** Schema **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Schema"></a>
Defines the fields of a dataset.  
Type: [Schema](API_Schema.md) object  
Required: Yes

 ** Format **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-Format"></a>
The format of the replacement data, which must be CSV.  
Type: String  
Length Constraints: Maximum length of 7.  
Pattern: `^CSV|PARQUET$`   
Required: No

 ** TimestampFormat **   <a name="forecast-Type-TimeSeriesReplacementsDataSource-TimestampFormat"></a>
The timestamp format of the replacement data.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\-\:\.\,\'\s]+$`   
Required: No

## See Also
<a name="API_TimeSeriesReplacementsDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesReplacementsDataSource) 

# TimeSeriesSelector
<a name="API_TimeSeriesSelector"></a>

Defines the set of time series that are used to create the forecasts in a `TimeSeriesIdentifiers` object.

The `TimeSeriesIdentifiers` object needs the following information:
+  `DataSource` 
+  `Format` 
+  `Schema` 

## Contents
<a name="API_TimeSeriesSelector_Contents"></a>

 ** TimeSeriesIdentifiers **   <a name="forecast-Type-TimeSeriesSelector-TimeSeriesIdentifiers"></a>
Details about the import file that contains the time series for which you want to create forecasts.  
Type: [TimeSeriesIdentifiers](API_TimeSeriesIdentifiers.md) object  
Required: No

## See Also
<a name="API_TimeSeriesSelector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesSelector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesSelector) 

# TimeSeriesTransformation
<a name="API_TimeSeriesTransformation"></a>

A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.

## Contents
<a name="API_TimeSeriesTransformation_Contents"></a>

 ** Action **   <a name="forecast-Type-TimeSeriesTransformation-Action"></a>
An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.  
Type: [Action](API_Action.md) object  
Required: No

 ** TimeSeriesConditions **   <a name="forecast-Type-TimeSeriesTransformation-TimeSeriesConditions"></a>
An array of conditions that define which members of the related time series are transformed.  
Type: Array of [TimeSeriesCondition](API_TimeSeriesCondition.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_TimeSeriesTransformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/TimeSeriesTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/TimeSeriesTransformation) 

# WeightedQuantileLoss
<a name="API_WeightedQuantileLoss"></a>

The weighted loss value for a quantile. This object is part of the [Metrics](API_Metrics.md) object.

## Contents
<a name="API_WeightedQuantileLoss_Contents"></a>

 ** LossValue **   <a name="forecast-Type-WeightedQuantileLoss-LossValue"></a>
The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.  
Type: Double  
Required: No

 ** Quantile **   <a name="forecast-Type-WeightedQuantileLoss-Quantile"></a>
The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.  
Type: Double  
Required: No

## See Also
<a name="API_WeightedQuantileLoss_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WeightedQuantileLoss) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WeightedQuantileLoss) 

# WhatIfAnalysisSummary
<a name="API_WhatIfAnalysisSummary"></a>

Provides a summary of the what-if analysis properties used in the [ListWhatIfAnalyses](API_ListWhatIfAnalyses.md) operation. To get the complete set of properties, call the [DescribeWhatIfAnalysis](API_DescribeWhatIfAnalysis.md) operation, and provide the `WhatIfAnalysisArn` that is listed in the summary.

## Contents
<a name="API_WhatIfAnalysisSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-CreationTime"></a>
When the what-if analysis was created.  
Type: Timestamp  
Required: No

 ** ForecastArn **   <a name="forecast-Type-WhatIfAnalysisSummary-ForecastArn"></a>
The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** LastModificationTime **   <a name="forecast-Type-WhatIfAnalysisSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-WhatIfAnalysisSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-WhatIfAnalysisSummary-Status"></a>
The status of the what-if analysis. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** WhatIfAnalysisArn **   <a name="forecast-Type-WhatIfAnalysisSummary-WhatIfAnalysisArn"></a>
The Amazon Resource Name (ARN) of the what-if analysis.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WhatIfAnalysisName **   <a name="forecast-Type-WhatIfAnalysisSummary-WhatIfAnalysisName"></a>
The name of the what-if analysis.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

## See Also
<a name="API_WhatIfAnalysisSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfAnalysisSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfAnalysisSummary) 

# WhatIfForecastExportSummary
<a name="API_WhatIfForecastExportSummary"></a>

Provides a summary of the what-if forecast export properties used in the [ListWhatIfForecastExports](API_ListWhatIfForecastExports.md) operation. To get the complete set of properties, call the [DescribeWhatIfForecastExport](API_DescribeWhatIfForecastExport.md) operation, and provide the `WhatIfForecastExportArn` that is listed in the summary.

## Contents
<a name="API_WhatIfForecastExportSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-CreationTime"></a>
When the what-if forecast export was created.  
Type: Timestamp  
Required: No

 ** Destination **   <a name="forecast-Type-WhatIfForecastExportSummary-Destination"></a>
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.  
Type: [DataDestination](API_DataDestination.md) object  
Required: No

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastExportSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-WhatIfForecastExportSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-WhatIfForecastExportSummary-Status"></a>
The status of the what-if forecast export. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** WhatIfForecastArns **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastArns"></a>
An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Maximum length of 300.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WhatIfForecastExportArn **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportArn"></a>
The Amazon Resource Name (ARN) of the what-if forecast export.  
Type: String  
Length Constraints: Maximum length of 300.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WhatIfForecastExportName **   <a name="forecast-Type-WhatIfForecastExportSummary-WhatIfForecastExportName"></a>
The what-if forecast export name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

## See Also
<a name="API_WhatIfForecastExportSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastExportSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastExportSummary) 

# WhatIfForecastSummary
<a name="API_WhatIfForecastSummary"></a>

Provides a summary of the what-if forecast properties used in the [ListWhatIfForecasts](API_ListWhatIfForecasts.md) operation. To get the complete set of properties, call the [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) operation, and provide the `WhatIfForecastArn` that is listed in the summary.

## Contents
<a name="API_WhatIfForecastSummary_Contents"></a>

 ** CreationTime **   <a name="forecast-Type-WhatIfForecastSummary-CreationTime"></a>
When the what-if forecast was created.  
Type: Timestamp  
Required: No

 ** LastModificationTime **   <a name="forecast-Type-WhatIfForecastSummary-LastModificationTime"></a>
The last time the resource was modified. The timestamp depends on the status of the job:  
+  `CREATE_PENDING` - The `CreationTime`.
+  `CREATE_IN_PROGRESS` - The current timestamp.
+  `CREATE_STOPPING` - The current timestamp.
+  `CREATE_STOPPED` - When the job stopped.
+  `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
Type: Timestamp  
Required: No

 ** Message **   <a name="forecast-Type-WhatIfForecastSummary-Message"></a>
If an error occurred, an informational message about the error.  
Type: String  
Required: No

 ** Status **   <a name="forecast-Type-WhatIfForecastSummary-Status"></a>
The status of the what-if forecast. States include:  
+  `ACTIVE` 
+  `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED` 
+  `CREATE_STOPPING`, `CREATE_STOPPED` 
+  `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED` 
The `Status` of the what-if analysis must be `ACTIVE` before you can access the analysis.
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** WhatIfAnalysisArn **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfAnalysisArn"></a>
The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WhatIfForecastArn **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfForecastArn"></a>
The Amazon Resource Name (ARN) of the what-if forecast.  
Type: String  
Length Constraints: Maximum length of 300.  
Pattern: `arn:([a-z\d-]+):forecast:.*:.*:.+`   
Required: No

 ** WhatIfForecastName **   <a name="forecast-Type-WhatIfForecastSummary-WhatIfForecastName"></a>
The name of the what-if forecast.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-zA-Z][a-zA-Z0-9_]*`   
Required: No

## See Also
<a name="API_WhatIfForecastSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WhatIfForecastSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WhatIfForecastSummary) 

# WindowSummary
<a name="API_WindowSummary"></a>

The metrics for a time range within the evaluation portion of a dataset. This object is part of the [EvaluationResult](API_EvaluationResult.md) object.

The `TestWindowStart` and `TestWindowEnd` parameters are determined by the `BackTestWindowOffset` parameter of the [EvaluationParameters](API_EvaluationParameters.md) object.

## Contents
<a name="API_WindowSummary_Contents"></a>

 ** EvaluationType **   <a name="forecast-Type-WindowSummary-EvaluationType"></a>
The type of evaluation.  
+  `SUMMARY` - The average metrics across all windows.
+  `COMPUTED` - The metrics for the specified window.
Type: String  
Valid Values: `SUMMARY | COMPUTED`   
Required: No

 ** ItemCount **   <a name="forecast-Type-WindowSummary-ItemCount"></a>
The number of data points within the window.  
Type: Integer  
Required: No

 ** Metrics **   <a name="forecast-Type-WindowSummary-Metrics"></a>
Provides metrics used to evaluate the performance of a predictor.  
Type: [Metrics](API_Metrics.md) object  
Required: No

 ** TestWindowEnd **   <a name="forecast-Type-WindowSummary-TestWindowEnd"></a>
The timestamp that defines the end of the window.  
Type: Timestamp  
Required: No

 ** TestWindowStart **   <a name="forecast-Type-WindowSummary-TestWindowStart"></a>
The timestamp that defines the start of the window.  
Type: Timestamp  
Required: No

## See Also
<a name="API_WindowSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/WindowSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/WindowSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/WindowSummary) 

# Amazon Forecast Query Service
<a name="API_Types_Amazon_Forecast_Query_Service"></a>

The following data types are supported by Amazon Forecast Query Service:
+  [DataPoint](API_forecastquery_DataPoint.md) 
+  [Forecast](API_forecastquery_Forecast.md) 

# DataPoint
<a name="API_forecastquery_DataPoint"></a>

The forecast value for a specific date. Part of the [Forecast](API_forecastquery_Forecast.md) object.

## Contents
<a name="API_forecastquery_DataPoint_Contents"></a>

 ** Timestamp **   <a name="forecast-Type-forecastquery_DataPoint-Timestamp"></a>
The timestamp of the specific forecast.  
Type: String  
Required: No

 ** Value **   <a name="forecast-Type-forecastquery_DataPoint-Value"></a>
The forecast value.  
Type: Double  
Required: No

## See Also
<a name="API_forecastquery_DataPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/DataPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/DataPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/DataPoint) 

# Forecast
<a name="API_forecastquery_Forecast"></a>

Provides information about a forecast. Returned as part of the [QueryForecast](API_forecastquery_QueryForecast.md) response.

## Contents
<a name="API_forecastquery_Forecast_Contents"></a>

 ** Predictions **   <a name="forecast-Type-forecastquery_Forecast-Predictions"></a>
The forecast.  
The *string* of the string-to-array map is one of the following values:  
+ p10
+ p50
+ p90
The default setting is `["0.1", "0.5", "0.9"]`. Use the optional `ForecastTypes` parameter of the [CreateForecast](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) operation to change the values. The values will vary depending on how this is set, with a minimum of `1` and a maximum of `5.`   
Type: String to array of [DataPoint](API_forecastquery_DataPoint.md) objects map  
Key Length Constraints: Maximum length of 4.  
Required: No

## See Also
<a name="API_forecastquery_Forecast_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecastquery-2018-06-26/Forecast) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecastquery-2018-06-26/Forecast) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecastquery-2018-06-26/Forecast)