@aws-sdk/client-forecast 3.262.0 → 3.263.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +9 -4
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/Forecast.d.ts +102 -108
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +16 -18
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +39 -39
- package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +4 -4
- package/dist-types/commands/CreateForecastExportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +7 -7
- package/dist-types/commands/CreatePredictorCommand.d.ts +0 -3
- package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +7 -6
- package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExplainabilityCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceTreeCommand.d.ts +9 -10
- package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +12 -12
- package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +0 -1
- package/dist-types/commands/ListExplainabilitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +1 -1
- package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +448 -369
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/package.json +1 -1
|
@@ -43,18 +43,18 @@ export interface Action {
|
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* <p>Describes an additional dataset. This object is part of the <a>DataConfig</a> object. Forecast supports the Weather Index and Holidays additional datasets.</p>
|
|
46
|
-
*
|
|
46
|
+
* <p>
|
|
47
47
|
* <b>Weather Index</b>
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* </p>
|
|
49
|
+
* <p>The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and
|
|
50
50
|
* projected weather information into your model. The Weather Index supplements your
|
|
51
51
|
* datasets with over two years of historical weather data and up to 14 days of projected
|
|
52
52
|
* weather data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast
|
|
53
53
|
* Weather Index</a>.</p>
|
|
54
|
-
*
|
|
54
|
+
* <p>
|
|
55
55
|
* <b>Holidays</b>
|
|
56
|
-
*
|
|
57
|
-
*
|
|
56
|
+
* </p>
|
|
57
|
+
* <p>Holidays is a built-in dataset that incorporates national holiday information into
|
|
58
58
|
* your model. It provides native support for the holiday calendars of 66 countries. To
|
|
59
59
|
* view the holiday calendars, refer to the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> library. For more
|
|
60
60
|
* information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/holidays.html">Holidays
|
|
@@ -69,216 +69,215 @@ export interface AdditionalDataset {
|
|
|
69
69
|
/**
|
|
70
70
|
* <p>
|
|
71
71
|
* <b>Weather Index</b>
|
|
72
|
-
*
|
|
73
|
-
*
|
|
72
|
+
* </p>
|
|
73
|
+
* <p>To enable the Weather Index, do not specify a value for
|
|
74
74
|
* <code>Configuration</code>.</p>
|
|
75
|
-
*
|
|
75
|
+
* <p>
|
|
76
76
|
* <b>Holidays</b>
|
|
77
77
|
* </p>
|
|
78
|
-
*
|
|
79
|
-
* <p>
|
|
78
|
+
* <p>
|
|
80
79
|
* <b>Holidays</b>
|
|
81
|
-
*
|
|
82
|
-
*
|
|
80
|
+
* </p>
|
|
81
|
+
* <p>To enable Holidays, set <code>CountryCode</code> to one of the following two-letter
|
|
83
82
|
* country codes:</p>
|
|
84
|
-
*
|
|
83
|
+
* <ul>
|
|
85
84
|
* <li>
|
|
86
|
-
*
|
|
85
|
+
* <p>"AL" - ALBANIA</p>
|
|
87
86
|
* </li>
|
|
88
87
|
* <li>
|
|
89
|
-
*
|
|
88
|
+
* <p>"AR" - ARGENTINA</p>
|
|
90
89
|
* </li>
|
|
91
90
|
* <li>
|
|
92
|
-
*
|
|
91
|
+
* <p>"AT" - AUSTRIA</p>
|
|
93
92
|
* </li>
|
|
94
93
|
* <li>
|
|
95
|
-
*
|
|
94
|
+
* <p>"AU" - AUSTRALIA</p>
|
|
96
95
|
* </li>
|
|
97
96
|
* <li>
|
|
98
|
-
*
|
|
97
|
+
* <p>"BA" - BOSNIA HERZEGOVINA</p>
|
|
99
98
|
* </li>
|
|
100
99
|
* <li>
|
|
101
|
-
*
|
|
100
|
+
* <p>"BE" - BELGIUM</p>
|
|
102
101
|
* </li>
|
|
103
102
|
* <li>
|
|
104
|
-
*
|
|
103
|
+
* <p>"BG" - BULGARIA</p>
|
|
105
104
|
* </li>
|
|
106
105
|
* <li>
|
|
107
|
-
*
|
|
106
|
+
* <p>"BO" - BOLIVIA</p>
|
|
108
107
|
* </li>
|
|
109
108
|
* <li>
|
|
110
|
-
*
|
|
109
|
+
* <p>"BR" - BRAZIL</p>
|
|
111
110
|
* </li>
|
|
112
111
|
* <li>
|
|
113
|
-
*
|
|
112
|
+
* <p>"BY" - BELARUS</p>
|
|
114
113
|
* </li>
|
|
115
114
|
* <li>
|
|
116
|
-
*
|
|
115
|
+
* <p>"CA" - CANADA</p>
|
|
117
116
|
* </li>
|
|
118
117
|
* <li>
|
|
119
|
-
*
|
|
118
|
+
* <p>"CL" - CHILE</p>
|
|
120
119
|
* </li>
|
|
121
120
|
* <li>
|
|
122
|
-
*
|
|
121
|
+
* <p>"CO" - COLOMBIA</p>
|
|
123
122
|
* </li>
|
|
124
123
|
* <li>
|
|
125
|
-
*
|
|
124
|
+
* <p>"CR" - COSTA RICA</p>
|
|
126
125
|
* </li>
|
|
127
126
|
* <li>
|
|
128
|
-
*
|
|
127
|
+
* <p>"HR" - CROATIA</p>
|
|
129
128
|
* </li>
|
|
130
129
|
* <li>
|
|
131
|
-
*
|
|
130
|
+
* <p>"CZ" - CZECH REPUBLIC</p>
|
|
132
131
|
* </li>
|
|
133
132
|
* <li>
|
|
134
|
-
*
|
|
133
|
+
* <p>"DK" - DENMARK</p>
|
|
135
134
|
* </li>
|
|
136
135
|
* <li>
|
|
137
|
-
*
|
|
136
|
+
* <p>"EC" - ECUADOR</p>
|
|
138
137
|
* </li>
|
|
139
138
|
* <li>
|
|
140
|
-
*
|
|
139
|
+
* <p>"EE" - ESTONIA</p>
|
|
141
140
|
* </li>
|
|
142
141
|
* <li>
|
|
143
|
-
*
|
|
142
|
+
* <p>"ET" - ETHIOPIA</p>
|
|
144
143
|
* </li>
|
|
145
144
|
* <li>
|
|
146
|
-
*
|
|
145
|
+
* <p>"FI" - FINLAND</p>
|
|
147
146
|
* </li>
|
|
148
147
|
* <li>
|
|
149
|
-
*
|
|
148
|
+
* <p>"FR" - FRANCE</p>
|
|
150
149
|
* </li>
|
|
151
150
|
* <li>
|
|
152
|
-
*
|
|
151
|
+
* <p>"DE" - GERMANY</p>
|
|
153
152
|
* </li>
|
|
154
153
|
* <li>
|
|
155
|
-
*
|
|
154
|
+
* <p>"GR" - GREECE</p>
|
|
156
155
|
* </li>
|
|
157
156
|
* <li>
|
|
158
|
-
*
|
|
157
|
+
* <p>"HU" - HUNGARY</p>
|
|
159
158
|
* </li>
|
|
160
159
|
* <li>
|
|
161
|
-
*
|
|
160
|
+
* <p>"IS" - ICELAND</p>
|
|
162
161
|
* </li>
|
|
163
162
|
* <li>
|
|
164
|
-
*
|
|
163
|
+
* <p>"IN" - INDIA</p>
|
|
165
164
|
* </li>
|
|
166
165
|
* <li>
|
|
167
|
-
*
|
|
166
|
+
* <p>"IE" - IRELAND</p>
|
|
168
167
|
* </li>
|
|
169
168
|
* <li>
|
|
170
|
-
*
|
|
169
|
+
* <p>"IT" - ITALY</p>
|
|
171
170
|
* </li>
|
|
172
171
|
* <li>
|
|
173
|
-
*
|
|
172
|
+
* <p>"JP" - JAPAN</p>
|
|
174
173
|
* </li>
|
|
175
174
|
* <li>
|
|
176
|
-
*
|
|
175
|
+
* <p>"KZ" - KAZAKHSTAN</p>
|
|
177
176
|
* </li>
|
|
178
177
|
* <li>
|
|
179
|
-
*
|
|
178
|
+
* <p>"KR" - KOREA</p>
|
|
180
179
|
* </li>
|
|
181
180
|
* <li>
|
|
182
|
-
*
|
|
181
|
+
* <p>"LV" - LATVIA</p>
|
|
183
182
|
* </li>
|
|
184
183
|
* <li>
|
|
185
|
-
*
|
|
184
|
+
* <p>"LI" - LIECHTENSTEIN</p>
|
|
186
185
|
* </li>
|
|
187
186
|
* <li>
|
|
188
|
-
*
|
|
187
|
+
* <p>"LT" - LITHUANIA</p>
|
|
189
188
|
* </li>
|
|
190
189
|
* <li>
|
|
191
|
-
*
|
|
190
|
+
* <p>"LU" - LUXEMBOURG</p>
|
|
192
191
|
* </li>
|
|
193
192
|
* <li>
|
|
194
|
-
*
|
|
193
|
+
* <p>"MK" - MACEDONIA</p>
|
|
195
194
|
* </li>
|
|
196
195
|
* <li>
|
|
197
|
-
*
|
|
196
|
+
* <p>"MT" - MALTA</p>
|
|
198
197
|
* </li>
|
|
199
198
|
* <li>
|
|
200
|
-
*
|
|
199
|
+
* <p>"MX" - MEXICO</p>
|
|
201
200
|
* </li>
|
|
202
201
|
* <li>
|
|
203
|
-
*
|
|
202
|
+
* <p>"MD" - MOLDOVA</p>
|
|
204
203
|
* </li>
|
|
205
204
|
* <li>
|
|
206
|
-
*
|
|
205
|
+
* <p>"ME" - MONTENEGRO</p>
|
|
207
206
|
* </li>
|
|
208
207
|
* <li>
|
|
209
|
-
*
|
|
208
|
+
* <p>"NL" - NETHERLANDS</p>
|
|
210
209
|
* </li>
|
|
211
210
|
* <li>
|
|
212
|
-
*
|
|
211
|
+
* <p>"NZ" - NEW ZEALAND</p>
|
|
213
212
|
* </li>
|
|
214
213
|
* <li>
|
|
215
|
-
*
|
|
214
|
+
* <p>"NI" - NICARAGUA</p>
|
|
216
215
|
* </li>
|
|
217
216
|
* <li>
|
|
218
|
-
*
|
|
217
|
+
* <p>"NG" - NIGERIA</p>
|
|
219
218
|
* </li>
|
|
220
219
|
* <li>
|
|
221
|
-
*
|
|
220
|
+
* <p>"NO" - NORWAY</p>
|
|
222
221
|
* </li>
|
|
223
222
|
* <li>
|
|
224
|
-
*
|
|
223
|
+
* <p>"PA" - PANAMA</p>
|
|
225
224
|
* </li>
|
|
226
225
|
* <li>
|
|
227
|
-
*
|
|
226
|
+
* <p>"PY" - PARAGUAY</p>
|
|
228
227
|
* </li>
|
|
229
228
|
* <li>
|
|
230
|
-
*
|
|
229
|
+
* <p>"PE" - PERU</p>
|
|
231
230
|
* </li>
|
|
232
231
|
* <li>
|
|
233
|
-
*
|
|
232
|
+
* <p>"PL" - POLAND</p>
|
|
234
233
|
* </li>
|
|
235
234
|
* <li>
|
|
236
|
-
*
|
|
235
|
+
* <p>"PT" - PORTUGAL</p>
|
|
237
236
|
* </li>
|
|
238
237
|
* <li>
|
|
239
|
-
*
|
|
238
|
+
* <p>"RO" - ROMANIA</p>
|
|
240
239
|
* </li>
|
|
241
240
|
* <li>
|
|
242
|
-
*
|
|
241
|
+
* <p>"RU" - RUSSIA</p>
|
|
243
242
|
* </li>
|
|
244
243
|
* <li>
|
|
245
|
-
*
|
|
244
|
+
* <p>"RS" - SERBIA</p>
|
|
246
245
|
* </li>
|
|
247
246
|
* <li>
|
|
248
|
-
*
|
|
247
|
+
* <p>"SK" - SLOVAKIA</p>
|
|
249
248
|
* </li>
|
|
250
249
|
* <li>
|
|
251
|
-
*
|
|
250
|
+
* <p>"SI" - SLOVENIA</p>
|
|
252
251
|
* </li>
|
|
253
252
|
* <li>
|
|
254
|
-
*
|
|
253
|
+
* <p>"ZA" - SOUTH AFRICA</p>
|
|
255
254
|
* </li>
|
|
256
255
|
* <li>
|
|
257
|
-
*
|
|
256
|
+
* <p>"ES" - SPAIN</p>
|
|
258
257
|
* </li>
|
|
259
258
|
* <li>
|
|
260
|
-
*
|
|
259
|
+
* <p>"SE" - SWEDEN</p>
|
|
261
260
|
* </li>
|
|
262
261
|
* <li>
|
|
263
|
-
*
|
|
262
|
+
* <p>"CH" - SWITZERLAND</p>
|
|
264
263
|
* </li>
|
|
265
264
|
* <li>
|
|
266
|
-
*
|
|
265
|
+
* <p>"UA" - UKRAINE</p>
|
|
267
266
|
* </li>
|
|
268
267
|
* <li>
|
|
269
|
-
*
|
|
268
|
+
* <p>"AE" - UNITED ARAB EMIRATES</p>
|
|
270
269
|
* </li>
|
|
271
270
|
* <li>
|
|
272
|
-
*
|
|
271
|
+
* <p>"US" - UNITED STATES</p>
|
|
273
272
|
* </li>
|
|
274
273
|
* <li>
|
|
275
|
-
*
|
|
274
|
+
* <p>"UK" - UNITED KINGDOM</p>
|
|
276
275
|
* </li>
|
|
277
276
|
* <li>
|
|
278
|
-
*
|
|
277
|
+
* <p>"UY" - URUGUAY</p>
|
|
279
278
|
* </li>
|
|
280
279
|
* <li>
|
|
281
|
-
*
|
|
280
|
+
* <p>"VE" - VENEZUELA</p>
|
|
282
281
|
* </li>
|
|
283
282
|
* </ul>
|
|
284
283
|
*/
|
|
@@ -286,20 +285,20 @@ export interface AdditionalDataset {
|
|
|
286
285
|
}
|
|
287
286
|
/**
|
|
288
287
|
* <p>Provides information about the method used to transform attributes.</p>
|
|
289
|
-
*
|
|
290
|
-
*
|
|
288
|
+
* <p>The following is an example using the RETAIL domain:</p>
|
|
289
|
+
* <p>
|
|
291
290
|
* <code>{</code>
|
|
292
|
-
*
|
|
293
|
-
*
|
|
291
|
+
* </p>
|
|
292
|
+
* <p>
|
|
294
293
|
* <code>"AttributeName": "demand",</code>
|
|
295
|
-
*
|
|
296
|
-
*
|
|
294
|
+
* </p>
|
|
295
|
+
* <p>
|
|
297
296
|
* <code>"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill":
|
|
298
297
|
* "zero"}</code>
|
|
299
|
-
*
|
|
300
|
-
*
|
|
298
|
+
* </p>
|
|
299
|
+
* <p>
|
|
301
300
|
* <code>}</code>
|
|
302
|
-
*
|
|
301
|
+
* </p>
|
|
303
302
|
*/
|
|
304
303
|
export interface AttributeConfig {
|
|
305
304
|
/**
|
|
@@ -312,64 +311,63 @@ export interface AttributeConfig {
|
|
|
312
311
|
* <p>The method parameters (key-value pairs), which are a map of override parameters.
|
|
313
312
|
* Specify these parameters to override the default values. Related Time Series attributes
|
|
314
313
|
* do not accept aggregation parameters.</p>
|
|
315
|
-
*
|
|
314
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
316
315
|
* featurization method for a <b>Target Time Series</b> dataset.
|
|
317
316
|
* Default values are bolded.</p>
|
|
318
|
-
*
|
|
317
|
+
* <ul>
|
|
319
318
|
* <li>
|
|
320
|
-
*
|
|
319
|
+
* <p>
|
|
321
320
|
* <code>aggregation</code>: <b>sum</b>,
|
|
322
321
|
* <code>avg</code>, <code>first</code>, <code>min</code>,
|
|
323
322
|
* <code>max</code>
|
|
324
323
|
* </p>
|
|
325
324
|
* </li>
|
|
326
325
|
* <li>
|
|
327
|
-
*
|
|
326
|
+
* <p>
|
|
328
327
|
* <code>frontfill</code>: <b>none</b>
|
|
329
328
|
* </p>
|
|
330
329
|
* </li>
|
|
331
330
|
* <li>
|
|
332
|
-
*
|
|
331
|
+
* <p>
|
|
333
332
|
* <code>middlefill</code>: <b>zero</b>,
|
|
334
333
|
* <code>nan</code> (not a number), <code>value</code>, <code>median</code>,
|
|
335
334
|
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
336
335
|
* </p>
|
|
337
336
|
* </li>
|
|
338
337
|
* <li>
|
|
339
|
-
*
|
|
338
|
+
* <p>
|
|
340
339
|
* <code>backfill</code>: <b>zero</b>,
|
|
341
340
|
* <code>nan</code>, <code>value</code>, <code>median</code>, <code>mean</code>,
|
|
342
341
|
* <code>min</code>, <code>max</code>
|
|
343
342
|
* </p>
|
|
344
343
|
* </li>
|
|
345
344
|
* </ul>
|
|
346
|
-
*
|
|
347
|
-
* <p>The following list shows the parameters and their valid values for a <b>Related Time Series</b> featurization method (there are no
|
|
345
|
+
* <p>The following list shows the parameters and their valid values for a <b>Related Time Series</b> featurization method (there are no
|
|
348
346
|
* defaults):</p>
|
|
349
|
-
*
|
|
347
|
+
* <ul>
|
|
350
348
|
* <li>
|
|
351
|
-
*
|
|
349
|
+
* <p>
|
|
352
350
|
* <code>middlefill</code>: <code>zero</code>, <code>value</code>,
|
|
353
351
|
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
354
352
|
* <code>max</code>
|
|
355
353
|
* </p>
|
|
356
354
|
* </li>
|
|
357
355
|
* <li>
|
|
358
|
-
*
|
|
356
|
+
* <p>
|
|
359
357
|
* <code>backfill</code>: <code>zero</code>, <code>value</code>,
|
|
360
358
|
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
361
359
|
* <code>max</code>
|
|
362
360
|
* </p>
|
|
363
361
|
* </li>
|
|
364
362
|
* <li>
|
|
365
|
-
*
|
|
363
|
+
* <p>
|
|
366
364
|
* <code>futurefill</code>: <code>zero</code>, <code>value</code>,
|
|
367
365
|
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
368
366
|
* <code>max</code>
|
|
369
367
|
* </p>
|
|
370
368
|
* </li>
|
|
371
369
|
* </ul>
|
|
372
|
-
*
|
|
370
|
+
* <p>To set a filling method to a specific value, set the fill parameter to
|
|
373
371
|
* <code>value</code> and define the value in a corresponding <code>_value</code>
|
|
374
372
|
* parameter. For example, to set backfilling to a value of 2, include the following:
|
|
375
373
|
* <code>"backfill": "value"</code> and <code>"backfill_value":"2"</code>. </p>
|
|
@@ -394,14 +392,14 @@ export interface DataConfig {
|
|
|
394
392
|
AdditionalDatasets?: AdditionalDataset[];
|
|
395
393
|
}
|
|
396
394
|
/**
|
|
397
|
-
* <p>An
|
|
395
|
+
* <p>An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
398
396
|
* access the key. You can specify this optional object in the
|
|
399
397
|
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
400
398
|
*/
|
|
401
399
|
export interface EncryptionConfig {
|
|
402
400
|
/**
|
|
403
|
-
* <p>The ARN of the IAM role that Amazon Forecast can assume to access the
|
|
404
|
-
* <p>Passing a role across
|
|
401
|
+
* <p>The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.</p>
|
|
402
|
+
* <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your
|
|
405
403
|
* account, you get an <code>InvalidInputException</code> error.</p>
|
|
406
404
|
*/
|
|
407
405
|
RoleArn: string | undefined;
|
|
@@ -455,7 +453,7 @@ export declare enum OptimizationMetric {
|
|
|
455
453
|
* </li>
|
|
456
454
|
* <li>
|
|
457
455
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
458
|
-
* of such as a prefix for keys as it is reserved for
|
|
456
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
459
457
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
460
458
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
461
459
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -502,8 +500,7 @@ export declare enum Month {
|
|
|
502
500
|
* <p>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
|
|
503
501
|
* don't provide a time boundary, Forecast uses a set of <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries">Default Time Boundaries</a>.
|
|
504
502
|
* </p>
|
|
505
|
-
*
|
|
506
|
-
* <p>For more information about aggregation,
|
|
503
|
+
* <p>For more information about aggregation,
|
|
507
504
|
* see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html">Data Aggregation for Different Forecast Frequencies</a>.
|
|
508
505
|
* For more information setting a custom time boundary,
|
|
509
506
|
* see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary">Specifying a Time Boundary</a>.
|
|
@@ -536,11 +533,11 @@ export interface CreateAutoPredictorRequest {
|
|
|
536
533
|
/**
|
|
537
534
|
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
538
535
|
* the prediction length.</p>
|
|
539
|
-
*
|
|
536
|
+
* <p>The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the
|
|
540
537
|
* TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then
|
|
541
538
|
* the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the
|
|
542
539
|
* TARGET_TIME_SERIES dataset length.</p>
|
|
543
|
-
*
|
|
540
|
+
* <p>If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you
|
|
544
541
|
* cannot update the forecast horizon parameter. You can meet this requirement by providing
|
|
545
542
|
* longer time-series in the dataset.</p>
|
|
546
543
|
*/
|
|
@@ -554,19 +551,39 @@ export interface CreateAutoPredictorRequest {
|
|
|
554
551
|
/**
|
|
555
552
|
* <p>An array of dimension (field) names that specify how to group the generated
|
|
556
553
|
* forecast.</p>
|
|
557
|
-
*
|
|
554
|
+
* <p>For example, if you are generating forecasts for item sales across all your stores,
|
|
558
555
|
* and your dataset contains a <code>store_id</code> field, you would specify
|
|
559
556
|
* <code>store_id</code> as a dimension to group sales forecasts for each store.</p>
|
|
560
557
|
*/
|
|
561
558
|
ForecastDimensions?: string[];
|
|
562
559
|
/**
|
|
563
560
|
* <p>The frequency of predictions in a forecast.</p>
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
561
|
+
* <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
|
|
562
|
+
* "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:</p>
|
|
563
|
+
* <ul>
|
|
564
|
+
* <li>
|
|
565
|
+
* <p>Minute - 1-59</p>
|
|
566
|
+
* </li>
|
|
567
|
+
* <li>
|
|
568
|
+
* <p>Hour - 1-23</p>
|
|
569
|
+
* </li>
|
|
570
|
+
* <li>
|
|
571
|
+
* <p>Day - 1-6</p>
|
|
572
|
+
* </li>
|
|
573
|
+
* <li>
|
|
574
|
+
* <p>Week - 1-4</p>
|
|
575
|
+
* </li>
|
|
576
|
+
* <li>
|
|
577
|
+
* <p>Month - 1-11</p>
|
|
578
|
+
* </li>
|
|
579
|
+
* <li>
|
|
580
|
+
* <p>Year - 1</p>
|
|
581
|
+
* </li>
|
|
582
|
+
* </ul>
|
|
583
|
+
* <p>Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".</p>
|
|
584
|
+
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
568
585
|
* frequency.</p>
|
|
569
|
-
*
|
|
586
|
+
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
570
587
|
* RELATED_TIME_SERIES dataset frequency.</p>
|
|
571
588
|
*/
|
|
572
589
|
ForecastFrequency?: string;
|
|
@@ -575,7 +592,7 @@ export interface CreateAutoPredictorRequest {
|
|
|
575
592
|
*/
|
|
576
593
|
DataConfig?: DataConfig;
|
|
577
594
|
/**
|
|
578
|
-
* <p>An
|
|
595
|
+
* <p>An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
579
596
|
* access the key. You can specify this optional object in the
|
|
580
597
|
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
581
598
|
*/
|
|
@@ -584,7 +601,7 @@ export interface CreateAutoPredictorRequest {
|
|
|
584
601
|
* <p>The ARN of the predictor to retrain or upgrade. This parameter is only used when
|
|
585
602
|
* retraining or upgrading a predictor. When creating a new predictor, do not specify a
|
|
586
603
|
* value for this parameter.</p>
|
|
587
|
-
*
|
|
604
|
+
* <p>When upgrading or retraining a predictor, only specify values for the
|
|
588
605
|
* <code>ReferencePredictorArn</code> and <code>PredictorName</code>. The value for
|
|
589
606
|
* <code>PredictorName</code> must be a unique predictor name.</p>
|
|
590
607
|
*/
|
|
@@ -601,28 +618,28 @@ export interface CreateAutoPredictorRequest {
|
|
|
601
618
|
* <p>Optional metadata to help you categorize and organize your predictors. Each tag
|
|
602
619
|
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
603
620
|
* are case sensitive.</p>
|
|
604
|
-
*
|
|
605
|
-
*
|
|
621
|
+
* <p>The following restrictions apply to tags:</p>
|
|
622
|
+
* <ul>
|
|
606
623
|
* <li>
|
|
607
|
-
*
|
|
624
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
608
625
|
* value.</p>
|
|
609
626
|
* </li>
|
|
610
627
|
* <li>
|
|
611
|
-
*
|
|
628
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
612
629
|
* </li>
|
|
613
630
|
* <li>
|
|
614
|
-
*
|
|
631
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
615
632
|
* </li>
|
|
616
633
|
* <li>
|
|
617
|
-
*
|
|
634
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
618
635
|
* </li>
|
|
619
636
|
* <li>
|
|
620
|
-
*
|
|
637
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
621
638
|
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
622
639
|
* resources, the character restrictions of those services also apply. </p>
|
|
623
640
|
* </li>
|
|
624
641
|
* <li>
|
|
625
|
-
*
|
|
642
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
626
643
|
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
627
644
|
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
628
645
|
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
@@ -783,9 +800,29 @@ export interface CreateDatasetRequest {
|
|
|
783
800
|
/**
|
|
784
801
|
* <p>The frequency of data collection. This parameter is required for RELATED_TIME_SERIES
|
|
785
802
|
* datasets.</p>
|
|
786
|
-
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
|
|
787
|
-
* 15min
|
|
788
|
-
*
|
|
803
|
+
* <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
|
|
804
|
+
* "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:</p>
|
|
805
|
+
* <ul>
|
|
806
|
+
* <li>
|
|
807
|
+
* <p>Minute - 1-59</p>
|
|
808
|
+
* </li>
|
|
809
|
+
* <li>
|
|
810
|
+
* <p>Hour - 1-23</p>
|
|
811
|
+
* </li>
|
|
812
|
+
* <li>
|
|
813
|
+
* <p>Day - 1-6</p>
|
|
814
|
+
* </li>
|
|
815
|
+
* <li>
|
|
816
|
+
* <p>Week - 1-4</p>
|
|
817
|
+
* </li>
|
|
818
|
+
* <li>
|
|
819
|
+
* <p>Month - 1-11</p>
|
|
820
|
+
* </li>
|
|
821
|
+
* <li>
|
|
822
|
+
* <p>Year - 1</p>
|
|
823
|
+
* </li>
|
|
824
|
+
* </ul>
|
|
825
|
+
* <p>Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".</p>
|
|
789
826
|
*/
|
|
790
827
|
DataFrequency?: string;
|
|
791
828
|
/**
|
|
@@ -797,7 +834,7 @@ export interface CreateDatasetRequest {
|
|
|
797
834
|
*/
|
|
798
835
|
Schema: Schema | undefined;
|
|
799
836
|
/**
|
|
800
|
-
* <p>An
|
|
837
|
+
* <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
|
|
801
838
|
* the key.</p>
|
|
802
839
|
*/
|
|
803
840
|
EncryptionConfig?: EncryptionConfig;
|
|
@@ -830,7 +867,7 @@ export interface CreateDatasetRequest {
|
|
|
830
867
|
* </li>
|
|
831
868
|
* <li>
|
|
832
869
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
833
|
-
* of such as a prefix for keys as it is reserved for
|
|
870
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
834
871
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
835
872
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
836
873
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -898,7 +935,7 @@ export interface CreateDatasetGroupRequest {
|
|
|
898
935
|
* </li>
|
|
899
936
|
* <li>
|
|
900
937
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
901
|
-
* of such as a prefix for keys as it is reserved for
|
|
938
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
902
939
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
903
940
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
904
941
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -915,8 +952,8 @@ export interface CreateDatasetGroupResponse {
|
|
|
915
952
|
DatasetGroupArn?: string;
|
|
916
953
|
}
|
|
917
954
|
/**
|
|
918
|
-
* <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an
|
|
919
|
-
* Amazon Forecast can assume to access the file(s). Optionally, includes an
|
|
955
|
+
* <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that
|
|
956
|
+
* Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This
|
|
920
957
|
* object is part of the <a>DataSource</a> object that is submitted in the <a>CreateDatasetImportJob</a> request, and part of the <a>DataDestination</a> object.</p>
|
|
921
958
|
*/
|
|
922
959
|
export interface S3Config {
|
|
@@ -925,21 +962,21 @@ export interface S3Config {
|
|
|
925
962
|
*/
|
|
926
963
|
Path: string | undefined;
|
|
927
964
|
/**
|
|
928
|
-
* <p>The ARN of the
|
|
965
|
+
* <p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
|
|
929
966
|
* bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must
|
|
930
967
|
* allow access to the key.</p>
|
|
931
|
-
* <p>Passing a role across
|
|
968
|
+
* <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your
|
|
932
969
|
* account, you get an <code>InvalidInputException</code> error.</p>
|
|
933
970
|
*/
|
|
934
971
|
RoleArn: string | undefined;
|
|
935
972
|
/**
|
|
936
|
-
* <p>The Amazon Resource Name (ARN) of an
|
|
973
|
+
* <p>The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.</p>
|
|
937
974
|
*/
|
|
938
975
|
KMSKeyArn?: string;
|
|
939
976
|
}
|
|
940
977
|
/**
|
|
941
|
-
* <p>The source of your data, an
|
|
942
|
-
* access the data and, optionally, an
|
|
978
|
+
* <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
979
|
+
* access the data and, optionally, an Key Management Service (KMS) key.</p>
|
|
943
980
|
*/
|
|
944
981
|
export interface DataSource {
|
|
945
982
|
/**
|
|
@@ -948,6 +985,10 @@ export interface DataSource {
|
|
|
948
985
|
*/
|
|
949
986
|
S3Config: S3Config | undefined;
|
|
950
987
|
}
|
|
988
|
+
export declare enum ImportMode {
|
|
989
|
+
FULL = "FULL",
|
|
990
|
+
INCREMENTAL = "INCREMENTAL"
|
|
991
|
+
}
|
|
951
992
|
export interface CreateDatasetImportJobRequest {
|
|
952
993
|
/**
|
|
953
994
|
* <p>The name for the dataset import job. We recommend including the current timestamp in the
|
|
@@ -961,9 +1002,9 @@ export interface CreateDatasetImportJobRequest {
|
|
|
961
1002
|
*/
|
|
962
1003
|
DatasetArn: string | undefined;
|
|
963
1004
|
/**
|
|
964
|
-
* <p>The location of the training data to import and an
|
|
1005
|
+
* <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
|
|
965
1006
|
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
966
|
-
* <p>If encryption is used, <code>DataSource</code> must include an
|
|
1007
|
+
* <p>If encryption is used, <code>DataSource</code> must include an Key Management Service (KMS) key and the
|
|
967
1008
|
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
968
1009
|
* match those specified in the <code>EncryptionConfig</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
969
1010
|
* operation.</p>
|
|
@@ -992,7 +1033,7 @@ export interface CreateDatasetImportJobRequest {
|
|
|
992
1033
|
* <p>A single time zone for every item in your dataset. This option is ideal for datasets
|
|
993
1034
|
* with all timestamps within a single time zone, or if all timestamps are normalized to a
|
|
994
1035
|
* single time zone. </p>
|
|
995
|
-
*
|
|
1036
|
+
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
|
|
996
1037
|
* API</a> for a complete list of valid time zone names.</p>
|
|
997
1038
|
*/
|
|
998
1039
|
TimeZone?: string;
|
|
@@ -1005,13 +1046,13 @@ export interface CreateDatasetImportJobRequest {
|
|
|
1005
1046
|
/**
|
|
1006
1047
|
* <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
|
|
1007
1048
|
* one of two ways:</p>
|
|
1008
|
-
*
|
|
1049
|
+
* <ul>
|
|
1009
1050
|
* <li>
|
|
1010
|
-
*
|
|
1051
|
+
* <p>
|
|
1011
1052
|
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
|
|
1012
1053
|
* </li>
|
|
1013
1054
|
* <li>
|
|
1014
|
-
*
|
|
1055
|
+
* <p>
|
|
1015
1056
|
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
|
|
1016
1057
|
* </li>
|
|
1017
1058
|
* </ul>
|
|
@@ -1047,7 +1088,7 @@ export interface CreateDatasetImportJobRequest {
|
|
|
1047
1088
|
* </li>
|
|
1048
1089
|
* <li>
|
|
1049
1090
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1050
|
-
* of such as a prefix for keys as it is reserved for
|
|
1091
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
1051
1092
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1052
1093
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1053
1094
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -1060,6 +1101,10 @@ export interface CreateDatasetImportJobRequest {
|
|
|
1060
1101
|
* <p>The format of the imported data, CSV or PARQUET. The default value is CSV.</p>
|
|
1061
1102
|
*/
|
|
1062
1103
|
Format?: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* <p>Specifies whether the dataset import job is a <code>FULL</code> or <code>INCREMENTAL</code> import. A <code>FULL</code> dataset import replaces all of the existing data with the newly imported data. An <code>INCREMENTAL</code> import appends the imported data to the existing data.</p>
|
|
1106
|
+
*/
|
|
1107
|
+
ImportMode?: ImportMode | string;
|
|
1063
1108
|
}
|
|
1064
1109
|
export interface CreateDatasetImportJobResponse {
|
|
1065
1110
|
/**
|
|
@@ -1078,11 +1123,11 @@ export declare enum TimeSeriesGranularity {
|
|
|
1078
1123
|
/**
|
|
1079
1124
|
* <p>The ExplainabilityConfig data type defines the number of time series and time points
|
|
1080
1125
|
* included in <a>CreateExplainability</a>.</p>
|
|
1081
|
-
*
|
|
1126
|
+
* <p>If you provide a predictor ARN for <code>ResourceArn</code>, you must set both
|
|
1082
1127
|
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
|
|
1083
1128
|
* When creating Predictor Explainability, Amazon Forecast considers all time series and
|
|
1084
1129
|
* time points.</p>
|
|
1085
|
-
*
|
|
1130
|
+
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set
|
|
1086
1131
|
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to either
|
|
1087
1132
|
* “ALL” or “Specific”.</p>
|
|
1088
1133
|
*/
|
|
@@ -1091,7 +1136,7 @@ export interface ExplainabilityConfig {
|
|
|
1091
1136
|
* <p>To create an Explainability for all time series in your datasets, use
|
|
1092
1137
|
* <code>ALL</code>. To create an Explainability for specific time series in your datasets,
|
|
1093
1138
|
* use <code>SPECIFIC</code>.</p>
|
|
1094
|
-
*
|
|
1139
|
+
* <p>Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location
|
|
1095
1140
|
* within the <a>DataDestination</a> data type.</p>
|
|
1096
1141
|
*/
|
|
1097
1142
|
TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
|
|
@@ -1099,7 +1144,7 @@ export interface ExplainabilityConfig {
|
|
|
1099
1144
|
* <p>To create an Explainability for all time points in your forecast horizon, use
|
|
1100
1145
|
* <code>ALL</code>. To create an Explainability for specific time points in your
|
|
1101
1146
|
* forecast horizon, use <code>SPECIFIC</code>.</p>
|
|
1102
|
-
*
|
|
1147
|
+
* <p>Specify time points with the <code>StartDateTime</code> and <code>EndDateTime</code>
|
|
1103
1148
|
* parameters within the <a>CreateExplainability</a> operation.</p>
|
|
1104
1149
|
*/
|
|
1105
1150
|
TimePointGranularity: TimePointGranularity | string | undefined;
|
|
@@ -1120,8 +1165,8 @@ export interface CreateExplainabilityRequest {
|
|
|
1120
1165
|
*/
|
|
1121
1166
|
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1122
1167
|
/**
|
|
1123
|
-
* <p>The source of your data, an
|
|
1124
|
-
* access the data and, optionally, an
|
|
1168
|
+
* <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1169
|
+
* access the data and, optionally, an Key Management Service (KMS) key.</p>
|
|
1125
1170
|
*/
|
|
1126
1171
|
DataSource?: DataSource;
|
|
1127
1172
|
/**
|
|
@@ -1129,20 +1174,20 @@ export interface CreateExplainabilityRequest {
|
|
|
1129
1174
|
*/
|
|
1130
1175
|
Schema?: Schema;
|
|
1131
1176
|
/**
|
|
1132
|
-
* <p>Create an Explainability visualization that is viewable within the
|
|
1177
|
+
* <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
|
|
1133
1178
|
*/
|
|
1134
1179
|
EnableVisualization?: boolean;
|
|
1135
1180
|
/**
|
|
1136
1181
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1137
1182
|
* point for the Explainability.</p>
|
|
1138
|
-
*
|
|
1183
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1139
1184
|
* 2015-01-01T20:00:00)</p>
|
|
1140
1185
|
*/
|
|
1141
1186
|
StartDateTime?: string;
|
|
1142
1187
|
/**
|
|
1143
1188
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1144
1189
|
* time point for the Explainability.</p>
|
|
1145
|
-
*
|
|
1190
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1146
1191
|
* 2015-01-01T20:00:00)</p>
|
|
1147
1192
|
*/
|
|
1148
1193
|
EndDateTime?: string;
|
|
@@ -1150,28 +1195,28 @@ export interface CreateExplainabilityRequest {
|
|
|
1150
1195
|
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1151
1196
|
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1152
1197
|
* are case sensitive.</p>
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
1198
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1199
|
+
* <ul>
|
|
1155
1200
|
* <li>
|
|
1156
|
-
*
|
|
1201
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1157
1202
|
* value.</p>
|
|
1158
1203
|
* </li>
|
|
1159
1204
|
* <li>
|
|
1160
|
-
*
|
|
1205
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
1161
1206
|
* </li>
|
|
1162
1207
|
* <li>
|
|
1163
|
-
*
|
|
1208
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1164
1209
|
* </li>
|
|
1165
1210
|
* <li>
|
|
1166
|
-
*
|
|
1211
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1167
1212
|
* </li>
|
|
1168
1213
|
* <li>
|
|
1169
|
-
*
|
|
1214
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1170
1215
|
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1171
1216
|
* resources, the character restrictions of those services also apply. </p>
|
|
1172
1217
|
* </li>
|
|
1173
1218
|
* <li>
|
|
1174
|
-
*
|
|
1219
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1175
1220
|
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1176
1221
|
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1177
1222
|
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
@@ -1189,8 +1234,8 @@ export interface CreateExplainabilityResponse {
|
|
|
1189
1234
|
ExplainabilityArn?: string;
|
|
1190
1235
|
}
|
|
1191
1236
|
/**
|
|
1192
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
1193
|
-
* to access the location, and an
|
|
1237
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1238
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
1194
1239
|
*/
|
|
1195
1240
|
export interface DataDestination {
|
|
1196
1241
|
/**
|
|
@@ -1209,36 +1254,36 @@ export interface CreateExplainabilityExportRequest {
|
|
|
1209
1254
|
*/
|
|
1210
1255
|
ExplainabilityArn: string | undefined;
|
|
1211
1256
|
/**
|
|
1212
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
1213
|
-
* to access the location, and an
|
|
1257
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1258
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
1214
1259
|
*/
|
|
1215
1260
|
Destination: DataDestination | undefined;
|
|
1216
1261
|
/**
|
|
1217
1262
|
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1218
1263
|
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1219
1264
|
* are case sensitive.</p>
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1265
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1266
|
+
* <ul>
|
|
1222
1267
|
* <li>
|
|
1223
|
-
*
|
|
1268
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1224
1269
|
* value.</p>
|
|
1225
1270
|
* </li>
|
|
1226
1271
|
* <li>
|
|
1227
|
-
*
|
|
1272
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
1228
1273
|
* </li>
|
|
1229
1274
|
* <li>
|
|
1230
|
-
*
|
|
1275
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1231
1276
|
* </li>
|
|
1232
1277
|
* <li>
|
|
1233
|
-
*
|
|
1278
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1234
1279
|
* </li>
|
|
1235
1280
|
* <li>
|
|
1236
|
-
*
|
|
1281
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1237
1282
|
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1238
1283
|
* resources, the character restrictions of those services also apply. </p>
|
|
1239
1284
|
* </li>
|
|
1240
1285
|
* <li>
|
|
1241
|
-
*
|
|
1286
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1242
1287
|
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1243
1288
|
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1244
1289
|
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
@@ -1264,8 +1309,8 @@ export interface CreateExplainabilityExportResponse {
|
|
|
1264
1309
|
*/
|
|
1265
1310
|
export interface TimeSeriesIdentifiers {
|
|
1266
1311
|
/**
|
|
1267
|
-
* <p>The source of your data, an
|
|
1268
|
-
* access the data and, optionally, an
|
|
1312
|
+
* <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1313
|
+
* access the data and, optionally, an Key Management Service (KMS) key.</p>
|
|
1269
1314
|
*/
|
|
1270
1315
|
DataSource?: DataSource;
|
|
1271
1316
|
/**
|
|
@@ -1354,7 +1399,7 @@ export interface CreateForecastRequest {
|
|
|
1354
1399
|
* </li>
|
|
1355
1400
|
* <li>
|
|
1356
1401
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1357
|
-
* of such as a prefix for keys as it is reserved for
|
|
1402
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
1358
1403
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1359
1404
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1360
1405
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -1402,10 +1447,10 @@ export interface CreateForecastExportJobRequest {
|
|
|
1402
1447
|
*/
|
|
1403
1448
|
ForecastArn: string | undefined;
|
|
1404
1449
|
/**
|
|
1405
|
-
* <p>The location where you want to save the forecast and an
|
|
1450
|
+
* <p>The location where you want to save the forecast and an Identity and Access Management (IAM) role that
|
|
1406
1451
|
* Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3
|
|
1407
1452
|
* bucket.</p>
|
|
1408
|
-
* <p>If encryption is used, <code>Destination</code> must include an
|
|
1453
|
+
* <p>If encryption is used, <code>Destination</code> must include an Key Management Service (KMS) key. The
|
|
1409
1454
|
* IAM role must allow Amazon Forecast permission to access the key.</p>
|
|
1410
1455
|
*/
|
|
1411
1456
|
Destination: DataDestination | undefined;
|
|
@@ -1439,7 +1484,7 @@ export interface CreateForecastExportJobRequest {
|
|
|
1439
1484
|
* </li>
|
|
1440
1485
|
* <li>
|
|
1441
1486
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1442
|
-
* of such as a prefix for keys as it is reserved for
|
|
1487
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
1443
1488
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1444
1489
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1445
1490
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -1567,7 +1612,6 @@ export interface FeaturizationMethod {
|
|
|
1567
1612
|
* </p>
|
|
1568
1613
|
* </li>
|
|
1569
1614
|
* </ul>
|
|
1570
|
-
*
|
|
1571
1615
|
* <p>The following list shows the parameters and their valid values for a <b>Related Time Series</b> featurization method (there are no defaults):</p>
|
|
1572
1616
|
* <ul>
|
|
1573
1617
|
* <li>
|
|
@@ -1613,7 +1657,6 @@ export interface FeaturizationMethod {
|
|
|
1613
1657
|
* <p>
|
|
1614
1658
|
* <code>FeaturizationPipeline [ {</code>
|
|
1615
1659
|
* </p>
|
|
1616
|
-
*
|
|
1617
1660
|
* <p>
|
|
1618
1661
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
1619
1662
|
* </p>
|
|
@@ -1664,13 +1707,33 @@ export interface Featurization {
|
|
|
1664
1707
|
export interface FeaturizationConfig {
|
|
1665
1708
|
/**
|
|
1666
1709
|
* <p>The frequency of predictions in a forecast.</p>
|
|
1667
|
-
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
|
|
1668
|
-
* 15min
|
|
1669
|
-
*
|
|
1710
|
+
* <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
|
|
1711
|
+
* "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:</p>
|
|
1712
|
+
* <ul>
|
|
1713
|
+
* <li>
|
|
1714
|
+
* <p>Minute - 1-59</p>
|
|
1715
|
+
* </li>
|
|
1716
|
+
* <li>
|
|
1717
|
+
* <p>Hour - 1-23</p>
|
|
1718
|
+
* </li>
|
|
1719
|
+
* <li>
|
|
1720
|
+
* <p>Day - 1-6</p>
|
|
1721
|
+
* </li>
|
|
1722
|
+
* <li>
|
|
1723
|
+
* <p>Week - 1-4</p>
|
|
1724
|
+
* </li>
|
|
1725
|
+
* <li>
|
|
1726
|
+
* <p>Month - 1-11</p>
|
|
1727
|
+
* </li>
|
|
1728
|
+
* <li>
|
|
1729
|
+
* <p>Year - 1</p>
|
|
1730
|
+
* </li>
|
|
1731
|
+
* </ul>
|
|
1732
|
+
* <p>Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".</p>
|
|
1670
1733
|
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
1671
1734
|
* frequency.</p>
|
|
1672
1735
|
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
1673
|
-
*
|
|
1736
|
+
* TARGET_TIME_SERIES dataset frequency.</p>
|
|
1674
1737
|
*/
|
|
1675
1738
|
ForecastFrequency: string | undefined;
|
|
1676
1739
|
/**
|
|
@@ -2185,13 +2248,13 @@ export interface CreatePredictorRequest {
|
|
|
2185
2248
|
/**
|
|
2186
2249
|
* <note>
|
|
2187
2250
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
2188
|
-
* Contact
|
|
2251
|
+
* Contact Amazon Web Services Support or your account manager to learn more about access privileges.
|
|
2189
2252
|
* </p>
|
|
2190
|
-
*
|
|
2191
|
-
*
|
|
2253
|
+
* </note>
|
|
2254
|
+
* <p>Used to overide the default AutoML strategy, which is to optimize predictor accuracy.
|
|
2192
2255
|
* To apply an AutoML strategy that minimizes training time, use
|
|
2193
2256
|
* <code>LatencyOptimized</code>.</p>
|
|
2194
|
-
*
|
|
2257
|
+
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
2195
2258
|
*/
|
|
2196
2259
|
AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
|
|
2197
2260
|
/**
|
|
@@ -2245,7 +2308,7 @@ export interface CreatePredictorRequest {
|
|
|
2245
2308
|
*/
|
|
2246
2309
|
FeaturizationConfig: FeaturizationConfig | undefined;
|
|
2247
2310
|
/**
|
|
2248
|
-
* <p>An
|
|
2311
|
+
* <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
|
|
2249
2312
|
* the key.</p>
|
|
2250
2313
|
*/
|
|
2251
2314
|
EncryptionConfig?: EncryptionConfig;
|
|
@@ -2278,7 +2341,7 @@ export interface CreatePredictorRequest {
|
|
|
2278
2341
|
* </li>
|
|
2279
2342
|
* <li>
|
|
2280
2343
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2281
|
-
* of such as a prefix for keys as it is reserved for
|
|
2344
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
2282
2345
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
2283
2346
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
2284
2347
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
@@ -2308,36 +2371,36 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2308
2371
|
*/
|
|
2309
2372
|
PredictorArn: string | undefined;
|
|
2310
2373
|
/**
|
|
2311
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
2312
|
-
* to access the location, and an
|
|
2374
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
2375
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
2313
2376
|
*/
|
|
2314
2377
|
Destination: DataDestination | undefined;
|
|
2315
2378
|
/**
|
|
2316
2379
|
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2317
2380
|
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
2318
2381
|
* are case sensitive.</p>
|
|
2319
|
-
*
|
|
2320
|
-
*
|
|
2382
|
+
* <p>The following restrictions apply to tags:</p>
|
|
2383
|
+
* <ul>
|
|
2321
2384
|
* <li>
|
|
2322
|
-
*
|
|
2385
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
2323
2386
|
* value.</p>
|
|
2324
2387
|
* </li>
|
|
2325
2388
|
* <li>
|
|
2326
|
-
*
|
|
2389
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
2327
2390
|
* </li>
|
|
2328
2391
|
* <li>
|
|
2329
|
-
*
|
|
2392
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
2330
2393
|
* </li>
|
|
2331
2394
|
* <li>
|
|
2332
|
-
*
|
|
2395
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2333
2396
|
* </li>
|
|
2334
2397
|
* <li>
|
|
2335
|
-
*
|
|
2398
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2336
2399
|
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
2337
2400
|
* resources, the character restrictions of those services also apply. </p>
|
|
2338
2401
|
* </li>
|
|
2339
2402
|
* <li>
|
|
2340
|
-
*
|
|
2403
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
2341
2404
|
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
2342
2405
|
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2343
2406
|
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
@@ -2403,12 +2466,16 @@ export interface CreateWhatIfAnalysisResponse {
|
|
|
2403
2466
|
WhatIfAnalysisArn?: string;
|
|
2404
2467
|
}
|
|
2405
2468
|
/**
|
|
2406
|
-
* <p>A replacement dataset is a modified version of the baseline related time series that contains only the values
|
|
2469
|
+
* <p>A replacement dataset is a modified version of the baseline related time series that contains only the values
|
|
2470
|
+
* that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and
|
|
2471
|
+
* item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is
|
|
2472
|
+
* merged with the baseline related time series to create a transformed dataset that is used for the what-if
|
|
2473
|
+
* forecast.</p>
|
|
2407
2474
|
*/
|
|
2408
2475
|
export interface TimeSeriesReplacementsDataSource {
|
|
2409
2476
|
/**
|
|
2410
|
-
* <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an
|
|
2411
|
-
* Amazon Forecast can assume to access the file(s). Optionally, includes an
|
|
2477
|
+
* <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that
|
|
2478
|
+
* Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This
|
|
2412
2479
|
* object is part of the <a>DataSource</a> object that is submitted in the <a>CreateDatasetImportJob</a> request, and part of the <a>DataDestination</a> object.</p>
|
|
2413
2480
|
*/
|
|
2414
2481
|
S3Config: S3Config | undefined;
|
|
@@ -2477,9 +2544,11 @@ export interface CreateWhatIfForecastRequest {
|
|
|
2477
2544
|
*/
|
|
2478
2545
|
TimeSeriesTransformations?: TimeSeriesTransformation[];
|
|
2479
2546
|
/**
|
|
2480
|
-
* <p>The replacement time series dataset, which contains the rows that you want to change in the related time
|
|
2481
|
-
* series does not need to contain all rows that are in the baseline related time
|
|
2482
|
-
* (measure-dimension combinations) that you want to include in the what-if
|
|
2547
|
+
* <p>The replacement time series dataset, which contains the rows that you want to change in the related time
|
|
2548
|
+
* series dataset. A replacement time series does not need to contain all rows that are in the baseline related time
|
|
2549
|
+
* series. Include only the rows (measure-dimension combinations) that you want to include in the what-if
|
|
2550
|
+
* forecast.</p>
|
|
2551
|
+
* <p>This dataset is merged with the
|
|
2483
2552
|
* original time series to create a transformed dataset that is used for the what-if analysis.</p>
|
|
2484
2553
|
* <p>This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.</p>
|
|
2485
2554
|
* <p>Timestamps and item_ids not included in this dataset are not included in the what-if analysis. </p>
|
|
@@ -2506,10 +2575,10 @@ export interface CreateWhatIfForecastExportRequest {
|
|
|
2506
2575
|
*/
|
|
2507
2576
|
WhatIfForecastArns: string[] | undefined;
|
|
2508
2577
|
/**
|
|
2509
|
-
* <p>The location where you want to save the forecast and an
|
|
2578
|
+
* <p>The location where you want to save the forecast and an Identity and Access Management (IAM) role that
|
|
2510
2579
|
* Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3
|
|
2511
2580
|
* bucket.</p>
|
|
2512
|
-
* <p>If encryption is used, <code>Destination</code> must include an
|
|
2581
|
+
* <p>If encryption is used, <code>Destination</code> must include an Key Management Service (KMS) key. The
|
|
2513
2582
|
* IAM role must allow Amazon Forecast permission to access the key.</p>
|
|
2514
2583
|
*/
|
|
2515
2584
|
Destination: DataDestination | undefined;
|
|
@@ -2629,25 +2698,25 @@ export interface ExplainabilityInfo {
|
|
|
2629
2698
|
ExplainabilityArn?: string;
|
|
2630
2699
|
/**
|
|
2631
2700
|
* <p>The status of the Explainability. States include: </p>
|
|
2632
|
-
*
|
|
2701
|
+
* <ul>
|
|
2633
2702
|
* <li>
|
|
2634
|
-
*
|
|
2635
|
-
*
|
|
2636
|
-
*
|
|
2703
|
+
* <p>
|
|
2704
|
+
* <code>ACTIVE</code>
|
|
2705
|
+
* </p>
|
|
2637
2706
|
* </li>
|
|
2638
2707
|
* <li>
|
|
2639
|
-
*
|
|
2708
|
+
* <p>
|
|
2640
2709
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2641
2710
|
* <code>CREATE_FAILED</code>
|
|
2642
2711
|
* </p>
|
|
2643
2712
|
* </li>
|
|
2644
2713
|
* <li>
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2647
|
-
*
|
|
2714
|
+
* <p>
|
|
2715
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2716
|
+
* </p>
|
|
2648
2717
|
* </li>
|
|
2649
2718
|
* <li>
|
|
2650
|
-
*
|
|
2719
|
+
* <p>
|
|
2651
2720
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2652
2721
|
* <code>DELETE_FAILED</code>
|
|
2653
2722
|
* </p>
|
|
@@ -2735,7 +2804,7 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2735
2804
|
ForecastTypes?: string[];
|
|
2736
2805
|
/**
|
|
2737
2806
|
* <p>The frequency of predictions in a forecast.</p>
|
|
2738
|
-
*
|
|
2807
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
2739
2808
|
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
2740
2809
|
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2741
2810
|
*/
|
|
@@ -2755,7 +2824,7 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2755
2824
|
*/
|
|
2756
2825
|
DataConfig?: DataConfig;
|
|
2757
2826
|
/**
|
|
2758
|
-
* <p>An
|
|
2827
|
+
* <p>An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
2759
2828
|
* access the key. You can specify this optional object in the
|
|
2760
2829
|
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
2761
2830
|
*/
|
|
@@ -2772,25 +2841,25 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2772
2841
|
EstimatedTimeRemainingInMinutes?: number;
|
|
2773
2842
|
/**
|
|
2774
2843
|
* <p>The status of the predictor. States include: </p>
|
|
2775
|
-
*
|
|
2844
|
+
* <ul>
|
|
2776
2845
|
* <li>
|
|
2777
|
-
*
|
|
2778
|
-
*
|
|
2779
|
-
*
|
|
2846
|
+
* <p>
|
|
2847
|
+
* <code>ACTIVE</code>
|
|
2848
|
+
* </p>
|
|
2780
2849
|
* </li>
|
|
2781
2850
|
* <li>
|
|
2782
|
-
*
|
|
2851
|
+
* <p>
|
|
2783
2852
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2784
2853
|
* <code>CREATE_FAILED</code>
|
|
2785
2854
|
* </p>
|
|
2786
2855
|
* </li>
|
|
2787
2856
|
* <li>
|
|
2788
|
-
*
|
|
2789
|
-
*
|
|
2790
|
-
*
|
|
2857
|
+
* <p>
|
|
2858
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2859
|
+
* </p>
|
|
2791
2860
|
* </li>
|
|
2792
2861
|
* <li>
|
|
2793
|
-
*
|
|
2862
|
+
* <p>
|
|
2794
2863
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2795
2864
|
* <code>DELETE_FAILED</code>
|
|
2796
2865
|
* </p>
|
|
@@ -2809,25 +2878,25 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2809
2878
|
/**
|
|
2810
2879
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
2811
2880
|
* job:</p>
|
|
2812
|
-
*
|
|
2881
|
+
* <ul>
|
|
2813
2882
|
* <li>
|
|
2814
|
-
*
|
|
2883
|
+
* <p>
|
|
2815
2884
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
2816
2885
|
* </li>
|
|
2817
2886
|
* <li>
|
|
2818
|
-
*
|
|
2887
|
+
* <p>
|
|
2819
2888
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
2820
2889
|
* </li>
|
|
2821
2890
|
* <li>
|
|
2822
|
-
*
|
|
2891
|
+
* <p>
|
|
2823
2892
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
2824
2893
|
* </li>
|
|
2825
2894
|
* <li>
|
|
2826
|
-
*
|
|
2895
|
+
* <p>
|
|
2827
2896
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
2828
2897
|
* </li>
|
|
2829
2898
|
* <li>
|
|
2830
|
-
*
|
|
2899
|
+
* <p>
|
|
2831
2900
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
2832
2901
|
* failed.</p>
|
|
2833
2902
|
* </li>
|
|
@@ -2887,7 +2956,7 @@ export interface DescribeDatasetResponse {
|
|
|
2887
2956
|
*/
|
|
2888
2957
|
Schema?: Schema;
|
|
2889
2958
|
/**
|
|
2890
|
-
* <p>The
|
|
2959
|
+
* <p>The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
|
|
2891
2960
|
* the key.</p>
|
|
2892
2961
|
*/
|
|
2893
2962
|
EncryptionConfig?: EncryptionConfig;
|
|
@@ -3126,9 +3195,9 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
3126
3195
|
*/
|
|
3127
3196
|
GeolocationFormat?: string;
|
|
3128
3197
|
/**
|
|
3129
|
-
* <p>The location of the training data to import and an
|
|
3198
|
+
* <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
|
|
3130
3199
|
* can assume to access the data.</p>
|
|
3131
|
-
* <p>If encryption is used, <code>DataSource</code> includes an
|
|
3200
|
+
* <p>If encryption is used, <code>DataSource</code> includes an Key Management Service (KMS) key.</p>
|
|
3132
3201
|
*/
|
|
3133
3202
|
DataSource?: DataSource;
|
|
3134
3203
|
/**
|
|
@@ -3211,6 +3280,10 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
3211
3280
|
* <p>The format of the imported data, CSV or PARQUET.</p>
|
|
3212
3281
|
*/
|
|
3213
3282
|
Format?: string;
|
|
3283
|
+
/**
|
|
3284
|
+
* <p>The import mode of the dataset import job, FULL or INCREMENTAL.</p>
|
|
3285
|
+
*/
|
|
3286
|
+
ImportMode?: ImportMode | string;
|
|
3214
3287
|
}
|
|
3215
3288
|
export interface DescribeExplainabilityRequest {
|
|
3216
3289
|
/**
|
|
@@ -3242,8 +3315,8 @@ export interface DescribeExplainabilityResponse {
|
|
|
3242
3315
|
*/
|
|
3243
3316
|
EnableVisualization?: boolean;
|
|
3244
3317
|
/**
|
|
3245
|
-
* <p>The source of your data, an
|
|
3246
|
-
* access the data and, optionally, an
|
|
3318
|
+
* <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3319
|
+
* access the data and, optionally, an Key Management Service (KMS) key.</p>
|
|
3247
3320
|
*/
|
|
3248
3321
|
DataSource?: DataSource;
|
|
3249
3322
|
/**
|
|
@@ -3271,25 +3344,25 @@ export interface DescribeExplainabilityResponse {
|
|
|
3271
3344
|
Message?: string;
|
|
3272
3345
|
/**
|
|
3273
3346
|
* <p>The status of the Explainability resource. States include: </p>
|
|
3274
|
-
*
|
|
3347
|
+
* <ul>
|
|
3275
3348
|
* <li>
|
|
3276
|
-
*
|
|
3277
|
-
*
|
|
3278
|
-
*
|
|
3349
|
+
* <p>
|
|
3350
|
+
* <code>ACTIVE</code>
|
|
3351
|
+
* </p>
|
|
3279
3352
|
* </li>
|
|
3280
3353
|
* <li>
|
|
3281
|
-
*
|
|
3354
|
+
* <p>
|
|
3282
3355
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3283
3356
|
* <code>CREATE_FAILED</code>
|
|
3284
3357
|
* </p>
|
|
3285
3358
|
* </li>
|
|
3286
3359
|
* <li>
|
|
3287
|
-
*
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3360
|
+
* <p>
|
|
3361
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3362
|
+
* </p>
|
|
3290
3363
|
* </li>
|
|
3291
3364
|
* <li>
|
|
3292
|
-
*
|
|
3365
|
+
* <p>
|
|
3293
3366
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3294
3367
|
* <code>DELETE_FAILED</code>
|
|
3295
3368
|
* </p>
|
|
@@ -3304,25 +3377,25 @@ export interface DescribeExplainabilityResponse {
|
|
|
3304
3377
|
/**
|
|
3305
3378
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3306
3379
|
* job:</p>
|
|
3307
|
-
*
|
|
3380
|
+
* <ul>
|
|
3308
3381
|
* <li>
|
|
3309
|
-
*
|
|
3382
|
+
* <p>
|
|
3310
3383
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3311
3384
|
* </li>
|
|
3312
3385
|
* <li>
|
|
3313
|
-
*
|
|
3386
|
+
* <p>
|
|
3314
3387
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3315
3388
|
* </li>
|
|
3316
3389
|
* <li>
|
|
3317
|
-
*
|
|
3390
|
+
* <p>
|
|
3318
3391
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3319
3392
|
* </li>
|
|
3320
3393
|
* <li>
|
|
3321
|
-
*
|
|
3394
|
+
* <p>
|
|
3322
3395
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3323
3396
|
* </li>
|
|
3324
3397
|
* <li>
|
|
3325
|
-
*
|
|
3398
|
+
* <p>
|
|
3326
3399
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3327
3400
|
* failed.</p>
|
|
3328
3401
|
* </li>
|
|
@@ -3350,8 +3423,8 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3350
3423
|
*/
|
|
3351
3424
|
ExplainabilityArn?: string;
|
|
3352
3425
|
/**
|
|
3353
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
3354
|
-
* to access the location, and an
|
|
3426
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
3427
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
3355
3428
|
*/
|
|
3356
3429
|
Destination?: DataDestination;
|
|
3357
3430
|
/**
|
|
@@ -3360,25 +3433,25 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3360
3433
|
Message?: string;
|
|
3361
3434
|
/**
|
|
3362
3435
|
* <p>The status of the Explainability export. States include: </p>
|
|
3363
|
-
*
|
|
3436
|
+
* <ul>
|
|
3364
3437
|
* <li>
|
|
3365
|
-
*
|
|
3366
|
-
*
|
|
3367
|
-
*
|
|
3438
|
+
* <p>
|
|
3439
|
+
* <code>ACTIVE</code>
|
|
3440
|
+
* </p>
|
|
3368
3441
|
* </li>
|
|
3369
3442
|
* <li>
|
|
3370
|
-
*
|
|
3443
|
+
* <p>
|
|
3371
3444
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3372
3445
|
* <code>CREATE_FAILED</code>
|
|
3373
3446
|
* </p>
|
|
3374
3447
|
* </li>
|
|
3375
3448
|
* <li>
|
|
3376
|
-
*
|
|
3377
|
-
*
|
|
3378
|
-
*
|
|
3449
|
+
* <p>
|
|
3450
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3451
|
+
* </p>
|
|
3379
3452
|
* </li>
|
|
3380
3453
|
* <li>
|
|
3381
|
-
*
|
|
3454
|
+
* <p>
|
|
3382
3455
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3383
3456
|
* <code>DELETE_FAILED</code>
|
|
3384
3457
|
* </p>
|
|
@@ -3393,25 +3466,25 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3393
3466
|
/**
|
|
3394
3467
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3395
3468
|
* job:</p>
|
|
3396
|
-
*
|
|
3469
|
+
* <ul>
|
|
3397
3470
|
* <li>
|
|
3398
|
-
*
|
|
3471
|
+
* <p>
|
|
3399
3472
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3400
3473
|
* </li>
|
|
3401
3474
|
* <li>
|
|
3402
|
-
*
|
|
3475
|
+
* <p>
|
|
3403
3476
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3404
3477
|
* </li>
|
|
3405
3478
|
* <li>
|
|
3406
|
-
*
|
|
3479
|
+
* <p>
|
|
3407
3480
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3408
3481
|
* </li>
|
|
3409
3482
|
* <li>
|
|
3410
|
-
*
|
|
3483
|
+
* <p>
|
|
3411
3484
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3412
3485
|
* </li>
|
|
3413
3486
|
* <li>
|
|
3414
|
-
*
|
|
3487
|
+
* <p>
|
|
3415
3488
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3416
3489
|
* failed.</p>
|
|
3417
3490
|
* </li>
|
|
@@ -3814,12 +3887,12 @@ export interface DescribePredictorResponse {
|
|
|
3814
3887
|
/**
|
|
3815
3888
|
* <note>
|
|
3816
3889
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
3817
|
-
* Contact
|
|
3890
|
+
* Contact Amazon Web Services Support or your account manager to learn more about access privileges.
|
|
3818
3891
|
* </p>
|
|
3819
|
-
*
|
|
3820
|
-
*
|
|
3892
|
+
* </note>
|
|
3893
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
3821
3894
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
3822
|
-
*
|
|
3895
|
+
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
3823
3896
|
*/
|
|
3824
3897
|
AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
|
|
3825
3898
|
/**
|
|
@@ -3851,7 +3924,7 @@ export interface DescribePredictorResponse {
|
|
|
3851
3924
|
*/
|
|
3852
3925
|
FeaturizationConfig?: FeaturizationConfig;
|
|
3853
3926
|
/**
|
|
3854
|
-
* <p>An
|
|
3927
|
+
* <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
|
|
3855
3928
|
* the key.</p>
|
|
3856
3929
|
*/
|
|
3857
3930
|
EncryptionConfig?: EncryptionConfig;
|
|
@@ -3966,8 +4039,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3966
4039
|
*/
|
|
3967
4040
|
PredictorArn?: string;
|
|
3968
4041
|
/**
|
|
3969
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
3970
|
-
* to access the location, and an
|
|
4042
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
4043
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
3971
4044
|
*/
|
|
3972
4045
|
Destination?: DataDestination;
|
|
3973
4046
|
/**
|
|
@@ -3976,25 +4049,25 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3976
4049
|
Message?: string;
|
|
3977
4050
|
/**
|
|
3978
4051
|
* <p>The status of the predictor backtest export job. States include: </p>
|
|
3979
|
-
*
|
|
4052
|
+
* <ul>
|
|
3980
4053
|
* <li>
|
|
3981
|
-
*
|
|
4054
|
+
* <p>
|
|
3982
4055
|
* <code>ACTIVE</code>
|
|
3983
4056
|
* </p>
|
|
3984
4057
|
* </li>
|
|
3985
4058
|
* <li>
|
|
3986
|
-
*
|
|
4059
|
+
* <p>
|
|
3987
4060
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3988
4061
|
* <code>CREATE_FAILED</code>
|
|
3989
4062
|
* </p>
|
|
3990
4063
|
* </li>
|
|
3991
4064
|
* <li>
|
|
3992
|
-
*
|
|
3993
|
-
*
|
|
3994
|
-
*
|
|
4065
|
+
* <p>
|
|
4066
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4067
|
+
* </p>
|
|
3995
4068
|
* </li>
|
|
3996
4069
|
* <li>
|
|
3997
|
-
*
|
|
4070
|
+
* <p>
|
|
3998
4071
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3999
4072
|
* <code>DELETE_FAILED</code>
|
|
4000
4073
|
* </p>
|
|
@@ -4009,25 +4082,25 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
4009
4082
|
/**
|
|
4010
4083
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4011
4084
|
* job:</p>
|
|
4012
|
-
*
|
|
4085
|
+
* <ul>
|
|
4013
4086
|
* <li>
|
|
4014
|
-
*
|
|
4087
|
+
* <p>
|
|
4015
4088
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4016
4089
|
* </li>
|
|
4017
4090
|
* <li>
|
|
4018
|
-
*
|
|
4091
|
+
* <p>
|
|
4019
4092
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4020
4093
|
* </li>
|
|
4021
4094
|
* <li>
|
|
4022
|
-
*
|
|
4095
|
+
* <p>
|
|
4023
4096
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4024
4097
|
* </li>
|
|
4025
4098
|
* <li>
|
|
4026
|
-
*
|
|
4099
|
+
* <p>
|
|
4027
4100
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4028
4101
|
* </li>
|
|
4029
4102
|
* <li>
|
|
4030
|
-
*
|
|
4103
|
+
* <p>
|
|
4031
4104
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4032
4105
|
* failed.</p>
|
|
4033
4106
|
* </li>
|
|
@@ -4251,7 +4324,9 @@ export interface DescribeWhatIfForecastResponse {
|
|
|
4251
4324
|
*/
|
|
4252
4325
|
TimeSeriesReplacementsDataSource?: TimeSeriesReplacementsDataSource;
|
|
4253
4326
|
/**
|
|
4254
|
-
* <p>The quantiles at which probabilistic forecasts are generated. You can specify up to
|
|
4327
|
+
* <p>The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if
|
|
4328
|
+
* forecast in the <a>CreateWhatIfForecast</a> operation. If you didn't specify quantiles, the default
|
|
4329
|
+
* values are <code>["0.1", "0.5", "0.9"]</code>. </p>
|
|
4255
4330
|
*/
|
|
4256
4331
|
ForecastTypes?: string[];
|
|
4257
4332
|
}
|
|
@@ -4276,8 +4351,8 @@ export interface DescribeWhatIfForecastExportResponse {
|
|
|
4276
4351
|
*/
|
|
4277
4352
|
WhatIfForecastArns?: string[];
|
|
4278
4353
|
/**
|
|
4279
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
4280
|
-
* to access the location, and an
|
|
4354
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
4355
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
4281
4356
|
*/
|
|
4282
4357
|
Destination?: DataDestination;
|
|
4283
4358
|
/**
|
|
@@ -4500,12 +4575,12 @@ export interface GetAccuracyMetricsResponse {
|
|
|
4500
4575
|
/**
|
|
4501
4576
|
* <note>
|
|
4502
4577
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
4503
|
-
* Contact
|
|
4578
|
+
* Contact Amazon Web Services Support or your account manager to learn more about access privileges.
|
|
4504
4579
|
* </p>
|
|
4505
|
-
*
|
|
4506
|
-
*
|
|
4580
|
+
* </note>
|
|
4581
|
+
* <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
|
|
4507
4582
|
* is specified, the AutoML strategy optimizes predictor accuracy.</p>
|
|
4508
|
-
*
|
|
4583
|
+
* <p>This parameter is only valid for predictors trained using AutoML.</p>
|
|
4509
4584
|
*/
|
|
4510
4585
|
AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
|
|
4511
4586
|
/**
|
|
@@ -4658,9 +4733,9 @@ export interface DatasetImportJobSummary {
|
|
|
4658
4733
|
*/
|
|
4659
4734
|
DatasetImportJobName?: string;
|
|
4660
4735
|
/**
|
|
4661
|
-
* <p>The location of the training data to import and an
|
|
4736
|
+
* <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
|
|
4662
4737
|
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
4663
|
-
* <p>If encryption is used, <code>DataSource</code> includes an
|
|
4738
|
+
* <p>If encryption is used, <code>DataSource</code> includes an Key Management Service (KMS) key.</p>
|
|
4664
4739
|
*/
|
|
4665
4740
|
DataSource?: DataSource;
|
|
4666
4741
|
/**
|
|
@@ -4727,6 +4802,10 @@ export interface DatasetImportJobSummary {
|
|
|
4727
4802
|
* </ul>
|
|
4728
4803
|
*/
|
|
4729
4804
|
LastModificationTime?: Date;
|
|
4805
|
+
/**
|
|
4806
|
+
* <p>The import mode of the dataset import job, FULL or INCREMENTAL.</p>
|
|
4807
|
+
*/
|
|
4808
|
+
ImportMode?: ImportMode | string;
|
|
4730
4809
|
}
|
|
4731
4810
|
export interface ListDatasetImportJobsResponse {
|
|
4732
4811
|
/**
|
|
@@ -4813,22 +4892,22 @@ export interface ListExplainabilitiesRequest {
|
|
|
4813
4892
|
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4814
4893
|
* include or exclude the resources that match the statement from the list. The match
|
|
4815
4894
|
* statement consists of a key and a value.</p>
|
|
4816
|
-
*
|
|
4895
|
+
* <p>
|
|
4817
4896
|
* <b>Filter properties</b>
|
|
4818
|
-
*
|
|
4819
|
-
*
|
|
4897
|
+
* </p>
|
|
4898
|
+
* <ul>
|
|
4820
4899
|
* <li>
|
|
4821
|
-
*
|
|
4900
|
+
* <p>
|
|
4822
4901
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4823
4902
|
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4824
4903
|
* </li>
|
|
4825
4904
|
* <li>
|
|
4826
|
-
*
|
|
4905
|
+
* <p>
|
|
4827
4906
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4828
4907
|
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4829
4908
|
* </li>
|
|
4830
4909
|
* <li>
|
|
4831
|
-
*
|
|
4910
|
+
* <p>
|
|
4832
4911
|
* <code>Value</code> - The value to match.</p>
|
|
4833
4912
|
* </li>
|
|
4834
4913
|
* </ul>
|
|
@@ -4861,25 +4940,25 @@ export interface ExplainabilitySummary {
|
|
|
4861
4940
|
ExplainabilityConfig?: ExplainabilityConfig;
|
|
4862
4941
|
/**
|
|
4863
4942
|
* <p>The status of the Explainability. States include: </p>
|
|
4864
|
-
*
|
|
4943
|
+
* <ul>
|
|
4865
4944
|
* <li>
|
|
4866
|
-
*
|
|
4867
|
-
*
|
|
4868
|
-
*
|
|
4945
|
+
* <p>
|
|
4946
|
+
* <code>ACTIVE</code>
|
|
4947
|
+
* </p>
|
|
4869
4948
|
* </li>
|
|
4870
4949
|
* <li>
|
|
4871
|
-
*
|
|
4950
|
+
* <p>
|
|
4872
4951
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4873
4952
|
* <code>CREATE_FAILED</code>
|
|
4874
4953
|
* </p>
|
|
4875
4954
|
* </li>
|
|
4876
4955
|
* <li>
|
|
4877
|
-
*
|
|
4878
|
-
*
|
|
4879
|
-
*
|
|
4956
|
+
* <p>
|
|
4957
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4958
|
+
* </p>
|
|
4880
4959
|
* </li>
|
|
4881
4960
|
* <li>
|
|
4882
|
-
*
|
|
4961
|
+
* <p>
|
|
4883
4962
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4884
4963
|
* <code>DELETE_FAILED</code>
|
|
4885
4964
|
* </p>
|
|
@@ -4899,25 +4978,25 @@ export interface ExplainabilitySummary {
|
|
|
4899
4978
|
/**
|
|
4900
4979
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4901
4980
|
* job:</p>
|
|
4902
|
-
*
|
|
4981
|
+
* <ul>
|
|
4903
4982
|
* <li>
|
|
4904
|
-
*
|
|
4983
|
+
* <p>
|
|
4905
4984
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4906
4985
|
* </li>
|
|
4907
4986
|
* <li>
|
|
4908
|
-
*
|
|
4987
|
+
* <p>
|
|
4909
4988
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4910
4989
|
* </li>
|
|
4911
4990
|
* <li>
|
|
4912
|
-
*
|
|
4991
|
+
* <p>
|
|
4913
4992
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4914
4993
|
* </li>
|
|
4915
4994
|
* <li>
|
|
4916
|
-
*
|
|
4995
|
+
* <p>
|
|
4917
4996
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4918
4997
|
* </li>
|
|
4919
4998
|
* <li>
|
|
4920
|
-
*
|
|
4999
|
+
* <p>
|
|
4921
5000
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4922
5001
|
* failed.</p>
|
|
4923
5002
|
* </li>
|
|
@@ -4953,22 +5032,22 @@ export interface ListExplainabilityExportsRequest {
|
|
|
4953
5032
|
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4954
5033
|
* include or exclude resources that match the statement from the list. The match statement
|
|
4955
5034
|
* consists of a key and a value.</p>
|
|
4956
|
-
*
|
|
5035
|
+
* <p>
|
|
4957
5036
|
* <b>Filter properties</b>
|
|
4958
|
-
*
|
|
4959
|
-
*
|
|
5037
|
+
* </p>
|
|
5038
|
+
* <ul>
|
|
4960
5039
|
* <li>
|
|
4961
|
-
*
|
|
5040
|
+
* <p>
|
|
4962
5041
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4963
5042
|
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4964
5043
|
* </li>
|
|
4965
5044
|
* <li>
|
|
4966
|
-
*
|
|
5045
|
+
* <p>
|
|
4967
5046
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4968
5047
|
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4969
5048
|
* </li>
|
|
4970
5049
|
* <li>
|
|
4971
|
-
*
|
|
5050
|
+
* <p>
|
|
4972
5051
|
* <code>Value</code> - The value to match.</p>
|
|
4973
5052
|
* </li>
|
|
4974
5053
|
* </ul>
|
|
@@ -4990,31 +5069,31 @@ export interface ExplainabilityExportSummary {
|
|
|
4990
5069
|
*/
|
|
4991
5070
|
ExplainabilityExportName?: string;
|
|
4992
5071
|
/**
|
|
4993
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
4994
|
-
* to access the location, and an
|
|
5072
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
5073
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
4995
5074
|
*/
|
|
4996
5075
|
Destination?: DataDestination;
|
|
4997
5076
|
/**
|
|
4998
5077
|
* <p>The status of the Explainability export. States include: </p>
|
|
4999
|
-
*
|
|
5078
|
+
* <ul>
|
|
5000
5079
|
* <li>
|
|
5001
|
-
*
|
|
5002
|
-
*
|
|
5003
|
-
*
|
|
5080
|
+
* <p>
|
|
5081
|
+
* <code>ACTIVE</code>
|
|
5082
|
+
* </p>
|
|
5004
5083
|
* </li>
|
|
5005
5084
|
* <li>
|
|
5006
|
-
*
|
|
5085
|
+
* <p>
|
|
5007
5086
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
5008
5087
|
* <code>CREATE_FAILED</code>
|
|
5009
5088
|
* </p>
|
|
5010
5089
|
* </li>
|
|
5011
5090
|
* <li>
|
|
5012
|
-
*
|
|
5013
|
-
*
|
|
5014
|
-
*
|
|
5091
|
+
* <p>
|
|
5092
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
5093
|
+
* </p>
|
|
5015
5094
|
* </li>
|
|
5016
5095
|
* <li>
|
|
5017
|
-
*
|
|
5096
|
+
* <p>
|
|
5018
5097
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
5019
5098
|
* <code>DELETE_FAILED</code>
|
|
5020
5099
|
* </p>
|
|
@@ -5034,25 +5113,25 @@ export interface ExplainabilityExportSummary {
|
|
|
5034
5113
|
/**
|
|
5035
5114
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5036
5115
|
* job:</p>
|
|
5037
|
-
*
|
|
5116
|
+
* <ul>
|
|
5038
5117
|
* <li>
|
|
5039
|
-
*
|
|
5118
|
+
* <p>
|
|
5040
5119
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
5041
5120
|
* </li>
|
|
5042
5121
|
* <li>
|
|
5043
|
-
*
|
|
5122
|
+
* <p>
|
|
5044
5123
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
5045
5124
|
* </li>
|
|
5046
5125
|
* <li>
|
|
5047
|
-
*
|
|
5126
|
+
* <p>
|
|
5048
5127
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
5049
5128
|
* </li>
|
|
5050
5129
|
* <li>
|
|
5051
|
-
*
|
|
5130
|
+
* <p>
|
|
5052
5131
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
5053
5132
|
* </li>
|
|
5054
5133
|
* <li>
|
|
5055
|
-
*
|
|
5134
|
+
* <p>
|
|
5056
5135
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
5057
5136
|
* failed.</p>
|
|
5058
5137
|
* </li>
|
|
@@ -5664,24 +5743,24 @@ export interface ListPredictorBacktestExportJobsRequest {
|
|
|
5664
5743
|
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5665
5744
|
* include or exclude the predictor backtest export jobs that match the statement from the
|
|
5666
5745
|
* list. The match statement consists of a key and a value.</p>
|
|
5667
|
-
*
|
|
5746
|
+
* <p>
|
|
5668
5747
|
* <b>Filter properties</b>
|
|
5669
|
-
*
|
|
5670
|
-
*
|
|
5748
|
+
* </p>
|
|
5749
|
+
* <ul>
|
|
5671
5750
|
* <li>
|
|
5672
|
-
*
|
|
5751
|
+
* <p>
|
|
5673
5752
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
5674
5753
|
* <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
|
|
5675
5754
|
* export jobs that match the statement, specify <code>IS</code>. To exclude
|
|
5676
5755
|
* matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
|
|
5677
5756
|
* </li>
|
|
5678
5757
|
* <li>
|
|
5679
|
-
*
|
|
5758
|
+
* <p>
|
|
5680
5759
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
5681
5760
|
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
5682
5761
|
* </li>
|
|
5683
5762
|
* <li>
|
|
5684
|
-
*
|
|
5763
|
+
* <p>
|
|
5685
5764
|
* <code>Value</code> - The value to match.</p>
|
|
5686
5765
|
* </li>
|
|
5687
5766
|
* </ul>
|
|
@@ -5703,31 +5782,31 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5703
5782
|
*/
|
|
5704
5783
|
PredictorBacktestExportJobName?: string;
|
|
5705
5784
|
/**
|
|
5706
|
-
* <p>The destination for an export job. Provide an S3 path, an
|
|
5707
|
-
* to access the location, and an
|
|
5785
|
+
* <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
5786
|
+
* to access the location, and an Key Management Service (KMS) key (optional). </p>
|
|
5708
5787
|
*/
|
|
5709
5788
|
Destination?: DataDestination;
|
|
5710
5789
|
/**
|
|
5711
5790
|
* <p>The status of the predictor backtest export job. States include: </p>
|
|
5712
|
-
*
|
|
5791
|
+
* <ul>
|
|
5713
5792
|
* <li>
|
|
5714
|
-
*
|
|
5793
|
+
* <p>
|
|
5715
5794
|
* <code>ACTIVE</code>
|
|
5716
5795
|
* </p>
|
|
5717
5796
|
* </li>
|
|
5718
5797
|
* <li>
|
|
5719
|
-
*
|
|
5798
|
+
* <p>
|
|
5720
5799
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
5721
5800
|
* <code>CREATE_FAILED</code>
|
|
5722
5801
|
* </p>
|
|
5723
5802
|
* </li>
|
|
5724
5803
|
* <li>
|
|
5725
|
-
*
|
|
5726
|
-
*
|
|
5727
|
-
*
|
|
5804
|
+
* <p>
|
|
5805
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
5806
|
+
* </p>
|
|
5728
5807
|
* </li>
|
|
5729
5808
|
* <li>
|
|
5730
|
-
*
|
|
5809
|
+
* <p>
|
|
5731
5810
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
5732
5811
|
* <code>DELETE_FAILED</code>
|
|
5733
5812
|
* </p>
|
|
@@ -5746,25 +5825,25 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5746
5825
|
/**
|
|
5747
5826
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5748
5827
|
* job:</p>
|
|
5749
|
-
*
|
|
5828
|
+
* <ul>
|
|
5750
5829
|
* <li>
|
|
5751
|
-
*
|
|
5830
|
+
* <p>
|
|
5752
5831
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
5753
5832
|
* </li>
|
|
5754
5833
|
* <li>
|
|
5755
|
-
*
|
|
5834
|
+
* <p>
|
|
5756
5835
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
5757
5836
|
* </li>
|
|
5758
5837
|
* <li>
|
|
5759
|
-
*
|
|
5838
|
+
* <p>
|
|
5760
5839
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
5761
5840
|
* </li>
|
|
5762
5841
|
* <li>
|
|
5763
|
-
*
|
|
5842
|
+
* <p>
|
|
5764
5843
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
5765
5844
|
* </li>
|
|
5766
5845
|
* <li>
|
|
5767
|
-
*
|
|
5846
|
+
* <p>
|
|
5768
5847
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
5769
5848
|
* failed.</p>
|
|
5770
5849
|
* </li>
|
|
@@ -6419,7 +6498,7 @@ export interface TagResourceRequest {
|
|
|
6419
6498
|
* </li>
|
|
6420
6499
|
* <li>
|
|
6421
6500
|
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
6422
|
-
* of such as a prefix for keys as it is reserved for
|
|
6501
|
+
* of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag
|
|
6423
6502
|
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
6424
6503
|
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
6425
6504
|
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|