SupplementaryFeature

Note

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig 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.

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 and Jollyday API to generate holiday calendars. For more information, see Holidays Featurization.

Name

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

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

SupplementaryFeature

Note

Contents

See Also