@aws-sdk/client-forecast 3.42.0 → 3.43.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/CHANGELOG.md +11 -0
- package/README.md +7 -7
- package/dist-cjs/Forecast.js +150 -0
- package/dist-cjs/commands/CreateAutoPredictorCommand.js +36 -0
- package/dist-cjs/commands/CreateExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/CreateExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/DeleteExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/DeleteExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/DescribeAutoPredictorCommand.js +36 -0
- package/dist-cjs/commands/DescribeExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/DescribeExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/ListExplainabilitiesCommand.js +36 -0
- package/dist-cjs/commands/ListExplainabilityExportsCommand.js +36 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/models/models_0.js +236 -61
- package/dist-cjs/protocols/Aws_json1_1.js +1280 -98
- package/dist-es/Forecast.js +150 -0
- package/dist-es/commands/CreateAutoPredictorCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DescribeAutoPredictorCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/ListExplainabilitiesCommand.js +39 -0
- package/dist-es/commands/ListExplainabilityExportsCommand.js +39 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +160 -40
- package/dist-es/protocols/Aws_json1_1.js +1364 -138
- package/dist-types/Forecast.d.ts +278 -19
- package/dist-types/ForecastClient.d.ts +12 -2
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +83 -0
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +153 -0
- package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +43 -0
- package/dist-types/commands/CreatePredictorCommand.d.ts +19 -18
- package/dist-types/commands/DeleteExplainabilityCommand.d.ts +37 -0
- package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +35 -0
- package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
- package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DescribePredictorCommand.d.ts +6 -1
- package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
- package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +1720 -271
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/Forecast.d.ts +50 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +12 -2
- package/dist-types/ts3.4/commands/CreateAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilityExportsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +484 -83
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +2 -2
|
@@ -1,83 +1,403 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
/**
|
|
3
|
+
* <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>
|
|
4
|
+
* <p>
|
|
5
|
+
* <b>Weather Index</b>
|
|
6
|
+
* </p>
|
|
7
|
+
* <p>The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and
|
|
8
|
+
* projected weather information into your model. The Weather Index supplements your
|
|
9
|
+
* datasets with over two years of historical weather data and up to 14 days of projected
|
|
10
|
+
* weather data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast
|
|
11
|
+
* Weather Index</a>.</p>
|
|
12
|
+
* <p>
|
|
13
|
+
* <b>Holidays</b>
|
|
14
|
+
* </p>
|
|
15
|
+
* <p>Holidays is a built-in dataset that incorporates national holiday information into
|
|
16
|
+
* your model. It provides native support for the holiday calendars of 66 countries. To
|
|
17
|
+
* view the holiday calendars, refer to the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> library. For more
|
|
18
|
+
* information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/holidays.html">Holidays
|
|
19
|
+
* Featurization</a>.</p>
|
|
20
|
+
*/
|
|
21
|
+
export interface AdditionalDataset {
|
|
22
|
+
/**
|
|
23
|
+
* <p>The name of the additional dataset. Valid names: <code>"holiday"</code> and
|
|
24
|
+
* <code>"weather"</code>.</p>
|
|
25
|
+
*/
|
|
26
|
+
Name: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* <p>
|
|
29
|
+
* <b>Weather Index</b>
|
|
30
|
+
* </p>
|
|
31
|
+
* <p>To enable the Weather Index, do not specify a value for
|
|
32
|
+
* <code>Configuration</code>.</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <b>Holidays</b>
|
|
35
|
+
* </p>
|
|
36
|
+
* <p>To enable Holidays, specify a country with one of the following two-letter country
|
|
37
|
+
* codes:</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>"AL" - ALBANIA</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>"AR" - ARGENTINA</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>"AT" - AUSTRIA</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>"AU" - AUSTRALIA</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>"BA" - BOSNIA HERZEGOVINA</p>
|
|
53
|
+
* </li>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>"BE" - BELGIUM</p>
|
|
56
|
+
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>"BG" - BULGARIA</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>"BO" - BOLIVIA</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>"BR" - BRAZIL</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>"BY" - BELARUS</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>"CA" - CANADA</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>"CL" - CHILE</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>"CO" - COLOMBIA</p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>"CR" - COSTA RICA</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>"HR" - CROATIA</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>"CZ" - CZECH REPUBLIC</p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>"DK" - DENMARK</p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>"EC" - ECUADOR</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>"EE" - ESTONIA</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>"ET" - ETHIOPIA</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>"FI" - FINLAND</p>
|
|
101
|
+
* </li>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>"FR" - FRANCE</p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>"DE" - GERMANY</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>"GR" - GREECE</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>"HU" - HUNGARY</p>
|
|
113
|
+
* </li>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p>"IS" - ICELAND</p>
|
|
116
|
+
* </li>
|
|
117
|
+
* <li>
|
|
118
|
+
* <p>"IN" - INDIA</p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>"IE" - IRELAND</p>
|
|
122
|
+
* </li>
|
|
123
|
+
* <li>
|
|
124
|
+
* <p>"IT" - ITALY</p>
|
|
125
|
+
* </li>
|
|
126
|
+
* <li>
|
|
127
|
+
* <p>"JP" - JAPAN</p>
|
|
128
|
+
* </li>
|
|
129
|
+
* <li>
|
|
130
|
+
* <p>"KZ" - KAZAKHSTAN</p>
|
|
131
|
+
* </li>
|
|
132
|
+
* <li>
|
|
133
|
+
* <p>"KR" - KOREA</p>
|
|
134
|
+
* </li>
|
|
135
|
+
* <li>
|
|
136
|
+
* <p>"LV" - LATVIA</p>
|
|
137
|
+
* </li>
|
|
138
|
+
* <li>
|
|
139
|
+
* <p>"LI" - LIECHTENSTEIN</p>
|
|
140
|
+
* </li>
|
|
141
|
+
* <li>
|
|
142
|
+
* <p>"LT" - LITHUANIA</p>
|
|
143
|
+
* </li>
|
|
144
|
+
* <li>
|
|
145
|
+
* <p>"LU" - LUXEMBOURG</p>
|
|
146
|
+
* </li>
|
|
147
|
+
* <li>
|
|
148
|
+
* <p>"MK" - MACEDONIA</p>
|
|
149
|
+
* </li>
|
|
150
|
+
* <li>
|
|
151
|
+
* <p>"MT" - MALTA</p>
|
|
152
|
+
* </li>
|
|
153
|
+
* <li>
|
|
154
|
+
* <p>"MX" - MEXICO</p>
|
|
155
|
+
* </li>
|
|
156
|
+
* <li>
|
|
157
|
+
* <p>"MD" - MOLDOVA</p>
|
|
158
|
+
* </li>
|
|
159
|
+
* <li>
|
|
160
|
+
* <p>"ME" - MONTENEGRO</p>
|
|
161
|
+
* </li>
|
|
162
|
+
* <li>
|
|
163
|
+
* <p>"NL" - NETHERLANDS</p>
|
|
164
|
+
* </li>
|
|
165
|
+
* <li>
|
|
166
|
+
* <p>"NZ" - NEW ZEALAND</p>
|
|
167
|
+
* </li>
|
|
168
|
+
* <li>
|
|
169
|
+
* <p>"NI" - NICARAGUA</p>
|
|
170
|
+
* </li>
|
|
171
|
+
* <li>
|
|
172
|
+
* <p>"NG" - NIGERIA</p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>"NO" - NORWAY</p>
|
|
176
|
+
* </li>
|
|
177
|
+
* <li>
|
|
178
|
+
* <p>"PA" - PANAMA</p>
|
|
179
|
+
* </li>
|
|
180
|
+
* <li>
|
|
181
|
+
* <p>"PY" - PARAGUAY</p>
|
|
182
|
+
* </li>
|
|
183
|
+
* <li>
|
|
184
|
+
* <p>"PE" - PERU</p>
|
|
185
|
+
* </li>
|
|
186
|
+
* <li>
|
|
187
|
+
* <p>"PL" - POLAND</p>
|
|
188
|
+
* </li>
|
|
189
|
+
* <li>
|
|
190
|
+
* <p>"PT" - PORTUGAL</p>
|
|
191
|
+
* </li>
|
|
192
|
+
* <li>
|
|
193
|
+
* <p>"RO" - ROMANIA</p>
|
|
194
|
+
* </li>
|
|
195
|
+
* <li>
|
|
196
|
+
* <p>"RU" - RUSSIA</p>
|
|
197
|
+
* </li>
|
|
198
|
+
* <li>
|
|
199
|
+
* <p>"RS" - SERBIA</p>
|
|
200
|
+
* </li>
|
|
201
|
+
* <li>
|
|
202
|
+
* <p>"SK" - SLOVAKIA</p>
|
|
203
|
+
* </li>
|
|
204
|
+
* <li>
|
|
205
|
+
* <p>"SI" - SLOVENIA</p>
|
|
206
|
+
* </li>
|
|
207
|
+
* <li>
|
|
208
|
+
* <p>"ZA" - SOUTH AFRICA</p>
|
|
209
|
+
* </li>
|
|
210
|
+
* <li>
|
|
211
|
+
* <p>"ES" - SPAIN</p>
|
|
212
|
+
* </li>
|
|
213
|
+
* <li>
|
|
214
|
+
* <p>"SE" - SWEDEN</p>
|
|
215
|
+
* </li>
|
|
216
|
+
* <li>
|
|
217
|
+
* <p>"CH" - SWITZERLAND</p>
|
|
218
|
+
* </li>
|
|
219
|
+
* <li>
|
|
220
|
+
* <p>"UA" - UKRAINE</p>
|
|
221
|
+
* </li>
|
|
222
|
+
* <li>
|
|
223
|
+
* <p>"AE" - UNITED ARAB EMIRATES</p>
|
|
224
|
+
* </li>
|
|
225
|
+
* <li>
|
|
226
|
+
* <p>"US" - UNITED STATES</p>
|
|
227
|
+
* </li>
|
|
228
|
+
* <li>
|
|
229
|
+
* <p>"UK" - UNITED KINGDOM</p>
|
|
230
|
+
* </li>
|
|
231
|
+
* <li>
|
|
232
|
+
* <p>"UY" - URUGUAY</p>
|
|
233
|
+
* </li>
|
|
234
|
+
* <li>
|
|
235
|
+
* <p>"VE" - VENEZUELA</p>
|
|
236
|
+
* </li>
|
|
237
|
+
* </ul>
|
|
238
|
+
*/
|
|
239
|
+
Configuration?: {
|
|
240
|
+
[key: string]: string[];
|
|
241
|
+
};
|
|
6
242
|
}
|
|
7
|
-
export declare
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
RETAIL = "RETAIL",
|
|
13
|
-
WEB_TRAFFIC = "WEB_TRAFFIC",
|
|
14
|
-
WORK_FORCE = "WORK_FORCE"
|
|
243
|
+
export declare namespace AdditionalDataset {
|
|
244
|
+
/**
|
|
245
|
+
* @internal
|
|
246
|
+
*/
|
|
247
|
+
const filterSensitiveLog: (obj: AdditionalDataset) => any;
|
|
15
248
|
}
|
|
16
249
|
/**
|
|
17
|
-
* <p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
250
|
+
* <p>Provides information about the method used to transform attributes.</p>
|
|
251
|
+
* <p>The following is an example using the RETAIL domain:</p>
|
|
252
|
+
* <p>
|
|
253
|
+
* <code>{</code>
|
|
254
|
+
* </p>
|
|
255
|
+
* <p>
|
|
256
|
+
* <code>"AttributeName": "demand",</code>
|
|
257
|
+
* </p>
|
|
258
|
+
* <p>
|
|
259
|
+
* <code>"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill":
|
|
260
|
+
* "zero"}</code>
|
|
261
|
+
* </p>
|
|
262
|
+
* <p>
|
|
263
|
+
* <code>}</code>
|
|
264
|
+
* </p>
|
|
20
265
|
*/
|
|
21
|
-
export interface
|
|
266
|
+
export interface AttributeConfig {
|
|
22
267
|
/**
|
|
23
|
-
* <p>The
|
|
24
|
-
*
|
|
25
|
-
*
|
|
268
|
+
* <p>The name of the attribute as specified in the schema. Amazon Forecast supports the
|
|
269
|
+
* target field of the target time series and the related time series datasets. For
|
|
270
|
+
* example, for the RETAIL domain, the target is <code>demand</code>.</p>
|
|
26
271
|
*/
|
|
27
|
-
|
|
272
|
+
AttributeName: string | undefined;
|
|
28
273
|
/**
|
|
29
|
-
* <p>The
|
|
274
|
+
* <p>The method parameters (key-value pairs), which are a map of override parameters.
|
|
275
|
+
* Specify these parameters to override the default values. Related Time Series attributes
|
|
276
|
+
* do not accept aggregation parameters.</p>
|
|
277
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
278
|
+
* featurization method for a <b>Target Time Series</b> dataset.
|
|
279
|
+
* Default values are bolded.</p>
|
|
280
|
+
* <ul>
|
|
281
|
+
* <li>
|
|
282
|
+
* <p>
|
|
283
|
+
* <code>aggregation</code>: <b>sum</b>,
|
|
284
|
+
* <code>avg</code>, <code>first</code>, <code>min</code>,
|
|
285
|
+
* <code>max</code>
|
|
286
|
+
* </p>
|
|
287
|
+
* </li>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>
|
|
290
|
+
* <code>frontfill</code>: <b>none</b>
|
|
291
|
+
* </p>
|
|
292
|
+
* </li>
|
|
293
|
+
* <li>
|
|
294
|
+
* <p>
|
|
295
|
+
* <code>middlefill</code>: <b>zero</b>,
|
|
296
|
+
* <code>nan</code> (not a number), <code>value</code>, <code>median</code>,
|
|
297
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
298
|
+
* </p>
|
|
299
|
+
* </li>
|
|
300
|
+
* <li>
|
|
301
|
+
* <p>
|
|
302
|
+
* <code>backfill</code>: <b>zero</b>,
|
|
303
|
+
* <code>nan</code>, <code>value</code>, <code>median</code>, <code>mean</code>,
|
|
304
|
+
* <code>min</code>, <code>max</code>
|
|
305
|
+
* </p>
|
|
306
|
+
* </li>
|
|
307
|
+
* </ul>
|
|
308
|
+
*
|
|
309
|
+
* <p>The following list shows the parameters and their valid values for a <b>Related Time Series</b> featurization method (there are no
|
|
310
|
+
* defaults):</p>
|
|
311
|
+
* <ul>
|
|
312
|
+
* <li>
|
|
313
|
+
* <p>
|
|
314
|
+
* <code>middlefill</code>: <code>zero</code>, <code>value</code>,
|
|
315
|
+
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
316
|
+
* <code>max</code>
|
|
317
|
+
* </p>
|
|
318
|
+
* </li>
|
|
319
|
+
* <li>
|
|
320
|
+
* <p>
|
|
321
|
+
* <code>backfill</code>: <code>zero</code>, <code>value</code>,
|
|
322
|
+
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
323
|
+
* <code>max</code>
|
|
324
|
+
* </p>
|
|
325
|
+
* </li>
|
|
326
|
+
* <li>
|
|
327
|
+
* <p>
|
|
328
|
+
* <code>futurefill</code>: <code>zero</code>, <code>value</code>,
|
|
329
|
+
* <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
330
|
+
* <code>max</code>
|
|
331
|
+
* </p>
|
|
332
|
+
* </li>
|
|
333
|
+
* </ul>
|
|
334
|
+
* <p>To set a filling method to a specific value, set the fill parameter to
|
|
335
|
+
* <code>value</code> and define the value in a corresponding <code>_value</code>
|
|
336
|
+
* parameter. For example, to set backfilling to a value of 2, include the following:
|
|
337
|
+
* <code>"backfill": "value"</code> and <code>"backfill_value":"2"</code>. </p>
|
|
30
338
|
*/
|
|
31
|
-
|
|
339
|
+
Transformations: {
|
|
340
|
+
[key: string]: string;
|
|
341
|
+
} | undefined;
|
|
32
342
|
}
|
|
33
|
-
export declare namespace
|
|
343
|
+
export declare namespace AttributeConfig {
|
|
34
344
|
/**
|
|
35
345
|
* @internal
|
|
36
346
|
*/
|
|
37
|
-
const filterSensitiveLog: (obj:
|
|
38
|
-
}
|
|
39
|
-
export declare enum AttributeType {
|
|
40
|
-
FLOAT = "float",
|
|
41
|
-
GEOLOCATION = "geolocation",
|
|
42
|
-
INTEGER = "integer",
|
|
43
|
-
STRING = "string",
|
|
44
|
-
TIMESTAMP = "timestamp"
|
|
347
|
+
const filterSensitiveLog: (obj: AttributeConfig) => any;
|
|
45
348
|
}
|
|
46
349
|
/**
|
|
47
|
-
* <p>
|
|
48
|
-
* for every field in a dataset. The <a>Schema</a> object contains an array of
|
|
49
|
-
* <code>SchemaAttribute</code> objects.</p>
|
|
350
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
50
351
|
*/
|
|
51
|
-
export interface
|
|
352
|
+
export interface DataConfig {
|
|
52
353
|
/**
|
|
53
|
-
* <p>The
|
|
354
|
+
* <p>The ARN of the dataset group used to train the predictor.</p>
|
|
54
355
|
*/
|
|
55
|
-
|
|
356
|
+
DatasetGroupArn: string | undefined;
|
|
56
357
|
/**
|
|
57
|
-
* <p>
|
|
358
|
+
* <p>Aggregation and filling options for attributes in your dataset group.</p>
|
|
58
359
|
*/
|
|
59
|
-
|
|
360
|
+
AttributeConfigs?: AttributeConfig[];
|
|
361
|
+
/**
|
|
362
|
+
* <p>Additional built-in datasets like Holidays and the Weather Index.</p>
|
|
363
|
+
*/
|
|
364
|
+
AdditionalDatasets?: AdditionalDataset[];
|
|
60
365
|
}
|
|
61
|
-
export declare namespace
|
|
366
|
+
export declare namespace DataConfig {
|
|
62
367
|
/**
|
|
63
368
|
* @internal
|
|
64
369
|
*/
|
|
65
|
-
const filterSensitiveLog: (obj:
|
|
370
|
+
const filterSensitiveLog: (obj: DataConfig) => any;
|
|
66
371
|
}
|
|
67
372
|
/**
|
|
68
|
-
* <p>
|
|
373
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
374
|
+
* access the key. You can specify this optional object in the
|
|
375
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
69
376
|
*/
|
|
70
|
-
export interface
|
|
377
|
+
export interface EncryptionConfig {
|
|
71
378
|
/**
|
|
72
|
-
* <p>
|
|
379
|
+
* <p>The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.</p>
|
|
380
|
+
* <p>Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your
|
|
381
|
+
* account, you get an <code>InvalidInputException</code> error.</p>
|
|
73
382
|
*/
|
|
74
|
-
|
|
383
|
+
RoleArn: string | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key.</p>
|
|
386
|
+
*/
|
|
387
|
+
KMSKeyArn: string | undefined;
|
|
75
388
|
}
|
|
76
|
-
export declare namespace
|
|
389
|
+
export declare namespace EncryptionConfig {
|
|
77
390
|
/**
|
|
78
391
|
* @internal
|
|
79
392
|
*/
|
|
80
|
-
const filterSensitiveLog: (obj:
|
|
393
|
+
const filterSensitiveLog: (obj: EncryptionConfig) => any;
|
|
394
|
+
}
|
|
395
|
+
export declare enum OptimizationMetric {
|
|
396
|
+
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
397
|
+
MAPE = "MAPE",
|
|
398
|
+
MASE = "MASE",
|
|
399
|
+
RMSE = "RMSE",
|
|
400
|
+
WAPE = "WAPE"
|
|
81
401
|
}
|
|
82
402
|
/**
|
|
83
403
|
* <p>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.</p>
|
|
@@ -122,6 +442,248 @@ export declare namespace Tag {
|
|
|
122
442
|
*/
|
|
123
443
|
const filterSensitiveLog: (obj: Tag) => any;
|
|
124
444
|
}
|
|
445
|
+
export interface CreateAutoPredictorRequest {
|
|
446
|
+
/**
|
|
447
|
+
* <p>A unique name for the predictor</p>
|
|
448
|
+
*/
|
|
449
|
+
PredictorName: string | undefined;
|
|
450
|
+
/**
|
|
451
|
+
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
452
|
+
* the prediction length.</p>
|
|
453
|
+
*/
|
|
454
|
+
ForecastHorizon?: number;
|
|
455
|
+
/**
|
|
456
|
+
* <p>The forecast types used to train a predictor. You can specify up to five forecast
|
|
457
|
+
* types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
458
|
+
* higher. You can also specify the mean forecast with <code>mean</code>.</p>
|
|
459
|
+
*/
|
|
460
|
+
ForecastTypes?: string[];
|
|
461
|
+
/**
|
|
462
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
463
|
+
* forecast.</p>
|
|
464
|
+
* <p>For example, if you are generating forecasts for item sales across all your stores,
|
|
465
|
+
* and your dataset contains a <code>store_id</code> field, you would specify
|
|
466
|
+
* <code>store_id</code> as a dimension to group sales forecasts for each store.</p>
|
|
467
|
+
*/
|
|
468
|
+
ForecastDimensions?: string[];
|
|
469
|
+
/**
|
|
470
|
+
* <p>The frequency of predictions in a forecast.</p>
|
|
471
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
472
|
+
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
473
|
+
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
474
|
+
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
475
|
+
* frequency.</p>
|
|
476
|
+
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
477
|
+
* RELATED_TIME_SERIES dataset frequency.</p>
|
|
478
|
+
*/
|
|
479
|
+
ForecastFrequency?: string;
|
|
480
|
+
/**
|
|
481
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
482
|
+
*/
|
|
483
|
+
DataConfig?: DataConfig;
|
|
484
|
+
/**
|
|
485
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
486
|
+
* access the key. You can specify this optional object in the
|
|
487
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
488
|
+
*/
|
|
489
|
+
EncryptionConfig?: EncryptionConfig;
|
|
490
|
+
/**
|
|
491
|
+
* <p>The ARN of the predictor to retrain or upgrade. This parameter is only used when
|
|
492
|
+
* retraining or upgrading a predictor. When creating a new predictor, do not specify a
|
|
493
|
+
* value for this parameter.</p>
|
|
494
|
+
* <p>When upgrading or retraining a predictor, only specify values for the
|
|
495
|
+
* <code>ReferencePredictorArn</code> and <code>PredictorName</code>. The value for
|
|
496
|
+
* <code>PredictorName</code> must be a unique predictor name.</p>
|
|
497
|
+
*/
|
|
498
|
+
ReferencePredictorArn?: string;
|
|
499
|
+
/**
|
|
500
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
501
|
+
*/
|
|
502
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
503
|
+
ExplainPredictor?: boolean;
|
|
504
|
+
/**
|
|
505
|
+
* <p>Optional metadata to help you categorize and organize your predictors. Each tag
|
|
506
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
507
|
+
* are case sensitive.</p>
|
|
508
|
+
* <p>The following restrictions apply to tags:</p>
|
|
509
|
+
* <ul>
|
|
510
|
+
* <li>
|
|
511
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
512
|
+
* value.</p>
|
|
513
|
+
* </li>
|
|
514
|
+
* <li>
|
|
515
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
516
|
+
* </li>
|
|
517
|
+
* <li>
|
|
518
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
519
|
+
* </li>
|
|
520
|
+
* <li>
|
|
521
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
522
|
+
* </li>
|
|
523
|
+
* <li>
|
|
524
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
525
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
526
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
527
|
+
* </li>
|
|
528
|
+
* <li>
|
|
529
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
530
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
531
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
532
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
533
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
534
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
535
|
+
* </li>
|
|
536
|
+
* </ul>
|
|
537
|
+
*/
|
|
538
|
+
Tags?: Tag[];
|
|
539
|
+
}
|
|
540
|
+
export declare namespace CreateAutoPredictorRequest {
|
|
541
|
+
/**
|
|
542
|
+
* @internal
|
|
543
|
+
*/
|
|
544
|
+
const filterSensitiveLog: (obj: CreateAutoPredictorRequest) => any;
|
|
545
|
+
}
|
|
546
|
+
export interface CreateAutoPredictorResponse {
|
|
547
|
+
/**
|
|
548
|
+
* <p>The Amazon Resource Name (ARN) of the predictor.</p>
|
|
549
|
+
*/
|
|
550
|
+
PredictorArn?: string;
|
|
551
|
+
}
|
|
552
|
+
export declare namespace CreateAutoPredictorResponse {
|
|
553
|
+
/**
|
|
554
|
+
* @internal
|
|
555
|
+
*/
|
|
556
|
+
const filterSensitiveLog: (obj: CreateAutoPredictorResponse) => any;
|
|
557
|
+
}
|
|
558
|
+
/**
|
|
559
|
+
* <p>We can't process the request because it includes an invalid value or a value that exceeds
|
|
560
|
+
* the valid range.</p>
|
|
561
|
+
*/
|
|
562
|
+
export interface InvalidInputException extends __SmithyException, $MetadataBearer {
|
|
563
|
+
name: "InvalidInputException";
|
|
564
|
+
$fault: "client";
|
|
565
|
+
Message?: string;
|
|
566
|
+
}
|
|
567
|
+
export declare namespace InvalidInputException {
|
|
568
|
+
/**
|
|
569
|
+
* @internal
|
|
570
|
+
*/
|
|
571
|
+
const filterSensitiveLog: (obj: InvalidInputException) => any;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* <p>The limit on the number of resources per account has been exceeded.</p>
|
|
575
|
+
*/
|
|
576
|
+
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
577
|
+
name: "LimitExceededException";
|
|
578
|
+
$fault: "client";
|
|
579
|
+
Message?: string;
|
|
580
|
+
}
|
|
581
|
+
export declare namespace LimitExceededException {
|
|
582
|
+
/**
|
|
583
|
+
* @internal
|
|
584
|
+
*/
|
|
585
|
+
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
586
|
+
}
|
|
587
|
+
/**
|
|
588
|
+
* <p>There is already a resource with this name. Try again with a different name.</p>
|
|
589
|
+
*/
|
|
590
|
+
export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
|
|
591
|
+
name: "ResourceAlreadyExistsException";
|
|
592
|
+
$fault: "client";
|
|
593
|
+
Message?: string;
|
|
594
|
+
}
|
|
595
|
+
export declare namespace ResourceAlreadyExistsException {
|
|
596
|
+
/**
|
|
597
|
+
* @internal
|
|
598
|
+
*/
|
|
599
|
+
const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* <p>The specified resource is in use.</p>
|
|
603
|
+
*/
|
|
604
|
+
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
|
|
605
|
+
name: "ResourceInUseException";
|
|
606
|
+
$fault: "client";
|
|
607
|
+
Message?: string;
|
|
608
|
+
}
|
|
609
|
+
export declare namespace ResourceInUseException {
|
|
610
|
+
/**
|
|
611
|
+
* @internal
|
|
612
|
+
*/
|
|
613
|
+
const filterSensitiveLog: (obj: ResourceInUseException) => any;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
* <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
|
|
617
|
+
* again.</p>
|
|
618
|
+
*/
|
|
619
|
+
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
620
|
+
name: "ResourceNotFoundException";
|
|
621
|
+
$fault: "client";
|
|
622
|
+
Message?: string;
|
|
623
|
+
}
|
|
624
|
+
export declare namespace ResourceNotFoundException {
|
|
625
|
+
/**
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
629
|
+
}
|
|
630
|
+
export declare enum DatasetType {
|
|
631
|
+
ITEM_METADATA = "ITEM_METADATA",
|
|
632
|
+
RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
|
|
633
|
+
TARGET_TIME_SERIES = "TARGET_TIME_SERIES"
|
|
634
|
+
}
|
|
635
|
+
export declare enum Domain {
|
|
636
|
+
CUSTOM = "CUSTOM",
|
|
637
|
+
EC2_CAPACITY = "EC2_CAPACITY",
|
|
638
|
+
INVENTORY_PLANNING = "INVENTORY_PLANNING",
|
|
639
|
+
METRICS = "METRICS",
|
|
640
|
+
RETAIL = "RETAIL",
|
|
641
|
+
WEB_TRAFFIC = "WEB_TRAFFIC",
|
|
642
|
+
WORK_FORCE = "WORK_FORCE"
|
|
643
|
+
}
|
|
644
|
+
export declare enum AttributeType {
|
|
645
|
+
FLOAT = "float",
|
|
646
|
+
GEOLOCATION = "geolocation",
|
|
647
|
+
INTEGER = "integer",
|
|
648
|
+
STRING = "string",
|
|
649
|
+
TIMESTAMP = "timestamp"
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* <p>An attribute of a schema, which defines a dataset field. A schema attribute is required
|
|
653
|
+
* for every field in a dataset. The <a>Schema</a> object contains an array of
|
|
654
|
+
* <code>SchemaAttribute</code> objects.</p>
|
|
655
|
+
*/
|
|
656
|
+
export interface SchemaAttribute {
|
|
657
|
+
/**
|
|
658
|
+
* <p>The name of the dataset field.</p>
|
|
659
|
+
*/
|
|
660
|
+
AttributeName?: string;
|
|
661
|
+
/**
|
|
662
|
+
* <p>The data type of the field.</p>
|
|
663
|
+
*/
|
|
664
|
+
AttributeType?: AttributeType | string;
|
|
665
|
+
}
|
|
666
|
+
export declare namespace SchemaAttribute {
|
|
667
|
+
/**
|
|
668
|
+
* @internal
|
|
669
|
+
*/
|
|
670
|
+
const filterSensitiveLog: (obj: SchemaAttribute) => any;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* <p>Defines the fields of a dataset. You specify this object in the <a>CreateDataset</a> request.</p>
|
|
674
|
+
*/
|
|
675
|
+
export interface Schema {
|
|
676
|
+
/**
|
|
677
|
+
* <p>An array of attributes specifying the name and type of each field in a dataset.</p>
|
|
678
|
+
*/
|
|
679
|
+
Attributes?: SchemaAttribute[];
|
|
680
|
+
}
|
|
681
|
+
export declare namespace Schema {
|
|
682
|
+
/**
|
|
683
|
+
* @internal
|
|
684
|
+
*/
|
|
685
|
+
const filterSensitiveLog: (obj: Schema) => any;
|
|
686
|
+
}
|
|
125
687
|
export interface CreateDatasetRequest {
|
|
126
688
|
/**
|
|
127
689
|
* <p>A name for the dataset.</p>
|
|
@@ -208,49 +770,6 @@ export declare namespace CreateDatasetResponse {
|
|
|
208
770
|
*/
|
|
209
771
|
const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
|
|
210
772
|
}
|
|
211
|
-
/**
|
|
212
|
-
* <p>We can't process the request because it includes an invalid value or a value that exceeds
|
|
213
|
-
* the valid range.</p>
|
|
214
|
-
*/
|
|
215
|
-
export interface InvalidInputException extends __SmithyException, $MetadataBearer {
|
|
216
|
-
name: "InvalidInputException";
|
|
217
|
-
$fault: "client";
|
|
218
|
-
Message?: string;
|
|
219
|
-
}
|
|
220
|
-
export declare namespace InvalidInputException {
|
|
221
|
-
/**
|
|
222
|
-
* @internal
|
|
223
|
-
*/
|
|
224
|
-
const filterSensitiveLog: (obj: InvalidInputException) => any;
|
|
225
|
-
}
|
|
226
|
-
/**
|
|
227
|
-
* <p>The limit on the number of resources per account has been exceeded.</p>
|
|
228
|
-
*/
|
|
229
|
-
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
230
|
-
name: "LimitExceededException";
|
|
231
|
-
$fault: "client";
|
|
232
|
-
Message?: string;
|
|
233
|
-
}
|
|
234
|
-
export declare namespace LimitExceededException {
|
|
235
|
-
/**
|
|
236
|
-
* @internal
|
|
237
|
-
*/
|
|
238
|
-
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
239
|
-
}
|
|
240
|
-
/**
|
|
241
|
-
* <p>There is already a resource with this name. Try again with a different name.</p>
|
|
242
|
-
*/
|
|
243
|
-
export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
|
|
244
|
-
name: "ResourceAlreadyExistsException";
|
|
245
|
-
$fault: "client";
|
|
246
|
-
Message?: string;
|
|
247
|
-
}
|
|
248
|
-
export declare namespace ResourceAlreadyExistsException {
|
|
249
|
-
/**
|
|
250
|
-
* @internal
|
|
251
|
-
*/
|
|
252
|
-
const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
|
|
253
|
-
}
|
|
254
773
|
export interface CreateDatasetGroupRequest {
|
|
255
774
|
/**
|
|
256
775
|
* <p>A name for the dataset group.</p>
|
|
@@ -320,195 +839,386 @@ export declare namespace CreateDatasetGroupResponse {
|
|
|
320
839
|
const filterSensitiveLog: (obj: CreateDatasetGroupResponse) => any;
|
|
321
840
|
}
|
|
322
841
|
/**
|
|
323
|
-
* <p>The
|
|
842
|
+
* <p>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
|
|
843
|
+
* Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This
|
|
844
|
+
* 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>
|
|
324
845
|
*/
|
|
325
|
-
export interface
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
846
|
+
export interface S3Config {
|
|
847
|
+
/**
|
|
848
|
+
* <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</p>
|
|
849
|
+
*/
|
|
850
|
+
Path: string | undefined;
|
|
851
|
+
/**
|
|
852
|
+
* <p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
|
|
853
|
+
* bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must
|
|
854
|
+
* allow access to the key.</p>
|
|
855
|
+
* <p>Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your
|
|
856
|
+
* account, you get an <code>InvalidInputException</code> error.</p>
|
|
857
|
+
*/
|
|
858
|
+
RoleArn: string | undefined;
|
|
859
|
+
/**
|
|
860
|
+
* <p>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</p>
|
|
861
|
+
*/
|
|
862
|
+
KMSKeyArn?: string;
|
|
329
863
|
}
|
|
330
|
-
export declare namespace
|
|
864
|
+
export declare namespace S3Config {
|
|
331
865
|
/**
|
|
332
866
|
* @internal
|
|
333
867
|
*/
|
|
334
|
-
const filterSensitiveLog: (obj:
|
|
868
|
+
const filterSensitiveLog: (obj: S3Config) => any;
|
|
335
869
|
}
|
|
336
870
|
/**
|
|
337
|
-
* <p>
|
|
338
|
-
*
|
|
871
|
+
* <p>The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
872
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the
|
|
873
|
+
* <a>CreateDatasetImportJob</a> request.</p>
|
|
339
874
|
*/
|
|
340
|
-
export interface
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
875
|
+
export interface DataSource {
|
|
876
|
+
/**
|
|
877
|
+
* <p>The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
|
|
878
|
+
* credentials to access the data.</p>
|
|
879
|
+
*/
|
|
880
|
+
S3Config: S3Config | undefined;
|
|
344
881
|
}
|
|
345
|
-
export declare namespace
|
|
882
|
+
export declare namespace DataSource {
|
|
346
883
|
/**
|
|
347
884
|
* @internal
|
|
348
885
|
*/
|
|
349
|
-
const filterSensitiveLog: (obj:
|
|
886
|
+
const filterSensitiveLog: (obj: DataSource) => any;
|
|
887
|
+
}
|
|
888
|
+
export interface CreateDatasetImportJobRequest {
|
|
889
|
+
/**
|
|
890
|
+
* <p>The name for the dataset import job. We recommend including the current timestamp in the
|
|
891
|
+
* name, for example, <code>20190721DatasetImport</code>. This can help you avoid getting a
|
|
892
|
+
* <code>ResourceAlreadyExistsException</code> exception.</p>
|
|
893
|
+
*/
|
|
894
|
+
DatasetImportJobName: string | undefined;
|
|
895
|
+
/**
|
|
896
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data
|
|
897
|
+
* to.</p>
|
|
898
|
+
*/
|
|
899
|
+
DatasetArn: string | undefined;
|
|
900
|
+
/**
|
|
901
|
+
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
902
|
+
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
903
|
+
* <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
|
|
904
|
+
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
905
|
+
* match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a> operation.</p>
|
|
906
|
+
*/
|
|
907
|
+
DataSource: DataSource | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* <p>The format of timestamps in the dataset. The format that you specify depends on the
|
|
910
|
+
* <code>DataFrequency</code> specified when the dataset was created. The following formats are
|
|
911
|
+
* supported</p>
|
|
912
|
+
* <ul>
|
|
913
|
+
* <li>
|
|
914
|
+
* <p>"yyyy-MM-dd"</p>
|
|
915
|
+
* <p>For the following data frequencies: Y, M, W, and D</p>
|
|
916
|
+
* </li>
|
|
917
|
+
* <li>
|
|
918
|
+
* <p>"yyyy-MM-dd HH:mm:ss"</p>
|
|
919
|
+
* <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,
|
|
920
|
+
* M, W, and D</p>
|
|
921
|
+
* </li>
|
|
922
|
+
* </ul>
|
|
923
|
+
* <p>If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd
|
|
924
|
+
* HH:mm:ss".</p>
|
|
925
|
+
*/
|
|
926
|
+
TimestampFormat?: string;
|
|
927
|
+
/**
|
|
928
|
+
* <p>A single time zone for every item in your dataset. This option is ideal for datasets
|
|
929
|
+
* with all timestamps within a single time zone, or if all timestamps are normalized to a
|
|
930
|
+
* single time zone. </p>
|
|
931
|
+
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
|
|
932
|
+
* API</a> for a complete list of valid time zone names.</p>
|
|
933
|
+
*/
|
|
934
|
+
TimeZone?: string;
|
|
935
|
+
/**
|
|
936
|
+
* <p>Automatically derive time zone information from the geolocation attribute. This option
|
|
937
|
+
* is ideal for datasets that contain timestamps in multiple time zones and those
|
|
938
|
+
* timestamps are expressed in local time.</p>
|
|
939
|
+
*/
|
|
940
|
+
UseGeolocationForTimeZone?: boolean;
|
|
941
|
+
/**
|
|
942
|
+
* <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
|
|
943
|
+
* one of two ways:</p>
|
|
944
|
+
* <ul>
|
|
945
|
+
* <li>
|
|
946
|
+
* <p>
|
|
947
|
+
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
|
|
948
|
+
* </li>
|
|
949
|
+
* <li>
|
|
950
|
+
* <p>
|
|
951
|
+
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
|
|
952
|
+
* </li>
|
|
953
|
+
* </ul>
|
|
954
|
+
*/
|
|
955
|
+
GeolocationFormat?: string;
|
|
956
|
+
/**
|
|
957
|
+
* <p>The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
958
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
959
|
+
* <ul>
|
|
960
|
+
* <li>
|
|
961
|
+
* <p>Maximum number of tags per resource - 50.</p>
|
|
962
|
+
* </li>
|
|
963
|
+
* <li>
|
|
964
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
|
|
965
|
+
* </li>
|
|
966
|
+
* <li>
|
|
967
|
+
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
968
|
+
* </li>
|
|
969
|
+
* <li>
|
|
970
|
+
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
971
|
+
* </li>
|
|
972
|
+
* <li>
|
|
973
|
+
* <p>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: + - = . _ : / @.</p>
|
|
974
|
+
* </li>
|
|
975
|
+
* <li>
|
|
976
|
+
* <p>Tag keys and values are case sensitive.</p>
|
|
977
|
+
* </li>
|
|
978
|
+
* <li>
|
|
979
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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 <code>aws</code> 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 <code>aws</code> do not count against your tags per resource limit.</p>
|
|
980
|
+
* </li>
|
|
981
|
+
* </ul>
|
|
982
|
+
*/
|
|
983
|
+
Tags?: Tag[];
|
|
984
|
+
}
|
|
985
|
+
export declare namespace CreateDatasetImportJobRequest {
|
|
986
|
+
/**
|
|
987
|
+
* @internal
|
|
988
|
+
*/
|
|
989
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobRequest) => any;
|
|
990
|
+
}
|
|
991
|
+
export interface CreateDatasetImportJobResponse {
|
|
992
|
+
/**
|
|
993
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
|
|
994
|
+
*/
|
|
995
|
+
DatasetImportJobArn?: string;
|
|
996
|
+
}
|
|
997
|
+
export declare namespace CreateDatasetImportJobResponse {
|
|
998
|
+
/**
|
|
999
|
+
* @internal
|
|
1000
|
+
*/
|
|
1001
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobResponse) => any;
|
|
1002
|
+
}
|
|
1003
|
+
export declare enum TimePointGranularity {
|
|
1004
|
+
ALL = "ALL",
|
|
1005
|
+
SPECIFIC = "SPECIFIC"
|
|
1006
|
+
}
|
|
1007
|
+
export declare enum TimeSeriesGranularity {
|
|
1008
|
+
ALL = "ALL",
|
|
1009
|
+
SPECIFIC = "SPECIFIC"
|
|
350
1010
|
}
|
|
351
1011
|
/**
|
|
352
|
-
* <p>The
|
|
353
|
-
*
|
|
354
|
-
*
|
|
1012
|
+
* <p>The ExplainabilityConfig data type defines the number of time series and time points
|
|
1013
|
+
* included in <a>CreateExplainability</a>.</p>
|
|
1014
|
+
* <p>If you provide a predictor ARN for <code>ResourceArn</code>, you must set both
|
|
1015
|
+
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
|
|
1016
|
+
* When creating Predictor Explainability, Amazon Forecast considers all time series and
|
|
1017
|
+
* time points.</p>
|
|
1018
|
+
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set <code>TimePointGranularity</code> and
|
|
1019
|
+
* <code>TimeSeriesGranularity</code> to either “ALL” or “Specific”.</p>
|
|
355
1020
|
*/
|
|
356
|
-
export interface
|
|
1021
|
+
export interface ExplainabilityConfig {
|
|
357
1022
|
/**
|
|
358
|
-
* <p>
|
|
1023
|
+
* <p>To create an Explainability for all time series in your datasets, use
|
|
1024
|
+
* <code>ALL</code>. To create an Explainability for specific time series in your datasets,
|
|
1025
|
+
* use <code>SPECIFIC</code>.</p>
|
|
1026
|
+
* <p>Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location
|
|
1027
|
+
* within the <a>DataDestination</a> data type.</p>
|
|
1028
|
+
*/
|
|
1029
|
+
TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>To create an Explainability for all time points in your forecast horizon, use
|
|
1032
|
+
* <code>ALL</code>. To create an Explainability for specific time points in your
|
|
1033
|
+
* forecast horizon, use <code>SPECIFIC</code>.</p>
|
|
1034
|
+
* <p>Specify time points with the <code>StartDateTime</code> and <code>EndDateTime</code>
|
|
1035
|
+
* parameters within the <a>CreateExplainability</a> operation.</p>
|
|
1036
|
+
*/
|
|
1037
|
+
TimePointGranularity: TimePointGranularity | string | undefined;
|
|
1038
|
+
}
|
|
1039
|
+
export declare namespace ExplainabilityConfig {
|
|
1040
|
+
/**
|
|
1041
|
+
* @internal
|
|
1042
|
+
*/
|
|
1043
|
+
const filterSensitiveLog: (obj: ExplainabilityConfig) => any;
|
|
1044
|
+
}
|
|
1045
|
+
export interface CreateExplainabilityRequest {
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>A unique name for the Explainability.</p>
|
|
1048
|
+
*/
|
|
1049
|
+
ExplainabilityName: string | undefined;
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
1052
|
+
* Explainability.</p>
|
|
1053
|
+
*/
|
|
1054
|
+
ResourceArn: string | undefined;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
1057
|
+
* for the Explainability.</p>
|
|
1058
|
+
*/
|
|
1059
|
+
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1062
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the
|
|
1063
|
+
* <a>CreateDatasetImportJob</a> request.</p>
|
|
1064
|
+
*/
|
|
1065
|
+
DataSource?: DataSource;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>Defines the fields of a dataset. You specify this object in the <a>CreateDataset</a> request.</p>
|
|
1068
|
+
*/
|
|
1069
|
+
Schema?: Schema;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>Create an Expainability visualization that is viewable within the AWS console.</p>
|
|
1072
|
+
*/
|
|
1073
|
+
EnableVisualization?: boolean;
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1076
|
+
* point for the Explainability.</p>
|
|
1077
|
+
*/
|
|
1078
|
+
StartDateTime?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1081
|
+
* time point for the Explainability.</p>
|
|
1082
|
+
*/
|
|
1083
|
+
EndDateTime?: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1086
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1087
|
+
* are case sensitive.</p>
|
|
1088
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1089
|
+
* <ul>
|
|
1090
|
+
* <li>
|
|
1091
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1092
|
+
* value.</p>
|
|
1093
|
+
* </li>
|
|
1094
|
+
* <li>
|
|
1095
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
1096
|
+
* </li>
|
|
1097
|
+
* <li>
|
|
1098
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1099
|
+
* </li>
|
|
1100
|
+
* <li>
|
|
1101
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1102
|
+
* </li>
|
|
1103
|
+
* <li>
|
|
1104
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1105
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1106
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
1107
|
+
* </li>
|
|
1108
|
+
* <li>
|
|
1109
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1110
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1111
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1112
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1113
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1114
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
1115
|
+
* </li>
|
|
1116
|
+
* </ul>
|
|
359
1117
|
*/
|
|
360
|
-
|
|
1118
|
+
Tags?: Tag[];
|
|
1119
|
+
}
|
|
1120
|
+
export declare namespace CreateExplainabilityRequest {
|
|
361
1121
|
/**
|
|
362
|
-
*
|
|
363
|
-
* bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must
|
|
364
|
-
* allow access to the key.</p>
|
|
365
|
-
* <p>Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your
|
|
366
|
-
* account, you get an <code>InvalidInputException</code> error.</p>
|
|
1122
|
+
* @internal
|
|
367
1123
|
*/
|
|
368
|
-
|
|
1124
|
+
const filterSensitiveLog: (obj: CreateExplainabilityRequest) => any;
|
|
1125
|
+
}
|
|
1126
|
+
export interface CreateExplainabilityResponse {
|
|
369
1127
|
/**
|
|
370
|
-
* <p>The Amazon Resource Name (ARN) of
|
|
1128
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
371
1129
|
*/
|
|
372
|
-
|
|
1130
|
+
ExplainabilityArn?: string;
|
|
373
1131
|
}
|
|
374
|
-
export declare namespace
|
|
1132
|
+
export declare namespace CreateExplainabilityResponse {
|
|
375
1133
|
/**
|
|
376
1134
|
* @internal
|
|
377
1135
|
*/
|
|
378
|
-
const filterSensitiveLog: (obj:
|
|
1136
|
+
const filterSensitiveLog: (obj: CreateExplainabilityResponse) => any;
|
|
379
1137
|
}
|
|
380
1138
|
/**
|
|
381
|
-
* <p>The
|
|
382
|
-
* access the
|
|
383
|
-
* <a>CreateDatasetImportJob</a> request.</p>
|
|
1139
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1140
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
384
1141
|
*/
|
|
385
|
-
export interface
|
|
1142
|
+
export interface DataDestination {
|
|
386
1143
|
/**
|
|
387
|
-
* <p>The path to
|
|
388
|
-
*
|
|
1144
|
+
* <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the
|
|
1145
|
+
* bucket.</p>
|
|
389
1146
|
*/
|
|
390
1147
|
S3Config: S3Config | undefined;
|
|
391
1148
|
}
|
|
392
|
-
export declare namespace
|
|
1149
|
+
export declare namespace DataDestination {
|
|
393
1150
|
/**
|
|
394
1151
|
* @internal
|
|
395
1152
|
*/
|
|
396
|
-
const filterSensitiveLog: (obj:
|
|
1153
|
+
const filterSensitiveLog: (obj: DataDestination) => any;
|
|
397
1154
|
}
|
|
398
|
-
export interface
|
|
399
|
-
/**
|
|
400
|
-
* <p>The name for the dataset import job. We recommend including the current timestamp in the
|
|
401
|
-
* name, for example, <code>20190721DatasetImport</code>. This can help you avoid getting a
|
|
402
|
-
* <code>ResourceAlreadyExistsException</code> exception.</p>
|
|
403
|
-
*/
|
|
404
|
-
DatasetImportJobName: string | undefined;
|
|
405
|
-
/**
|
|
406
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data
|
|
407
|
-
* to.</p>
|
|
408
|
-
*/
|
|
409
|
-
DatasetArn: string | undefined;
|
|
1155
|
+
export interface CreateExplainabilityExportRequest {
|
|
410
1156
|
/**
|
|
411
|
-
* <p>
|
|
412
|
-
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
413
|
-
* <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
|
|
414
|
-
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
415
|
-
* match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a> operation.</p>
|
|
416
|
-
*/
|
|
417
|
-
DataSource: DataSource | undefined;
|
|
418
|
-
/**
|
|
419
|
-
* <p>The format of timestamps in the dataset. The format that you specify depends on the
|
|
420
|
-
* <code>DataFrequency</code> specified when the dataset was created. The following formats are
|
|
421
|
-
* supported</p>
|
|
422
|
-
* <ul>
|
|
423
|
-
* <li>
|
|
424
|
-
* <p>"yyyy-MM-dd"</p>
|
|
425
|
-
* <p>For the following data frequencies: Y, M, W, and D</p>
|
|
426
|
-
* </li>
|
|
427
|
-
* <li>
|
|
428
|
-
* <p>"yyyy-MM-dd HH:mm:ss"</p>
|
|
429
|
-
* <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,
|
|
430
|
-
* M, W, and D</p>
|
|
431
|
-
* </li>
|
|
432
|
-
* </ul>
|
|
433
|
-
* <p>If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd
|
|
434
|
-
* HH:mm:ss".</p>
|
|
1157
|
+
* <p>A unique name for the Explainability export.</p>
|
|
435
1158
|
*/
|
|
436
|
-
|
|
1159
|
+
ExplainabilityExportName: string | undefined;
|
|
437
1160
|
/**
|
|
438
|
-
* <p>
|
|
439
|
-
* with all timestamps within a single time zone, or if all timestamps are normalized to a
|
|
440
|
-
* single time zone. </p>
|
|
441
|
-
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
|
|
442
|
-
* API</a> for a complete list of valid time zone names.</p>
|
|
1161
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
|
|
443
1162
|
*/
|
|
444
|
-
|
|
1163
|
+
ExplainabilityArn: string | undefined;
|
|
445
1164
|
/**
|
|
446
|
-
* <p>
|
|
447
|
-
*
|
|
448
|
-
* timestamps are expressed in local time.</p>
|
|
1165
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1166
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
449
1167
|
*/
|
|
450
|
-
|
|
1168
|
+
Destination: DataDestination | undefined;
|
|
451
1169
|
/**
|
|
452
|
-
* <p>
|
|
453
|
-
*
|
|
1170
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1171
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1172
|
+
* are case sensitive.</p>
|
|
1173
|
+
* <p>The following restrictions apply to tags:</p>
|
|
454
1174
|
* <ul>
|
|
455
1175
|
* <li>
|
|
456
|
-
* <p>
|
|
457
|
-
*
|
|
458
|
-
* </li>
|
|
459
|
-
* <li>
|
|
460
|
-
* <p>
|
|
461
|
-
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
|
|
462
|
-
* </li>
|
|
463
|
-
* </ul>
|
|
464
|
-
*/
|
|
465
|
-
GeolocationFormat?: string;
|
|
466
|
-
/**
|
|
467
|
-
* <p>The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
468
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
469
|
-
* <ul>
|
|
470
|
-
* <li>
|
|
471
|
-
* <p>Maximum number of tags per resource - 50.</p>
|
|
472
|
-
* </li>
|
|
473
|
-
* <li>
|
|
474
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
|
|
1176
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1177
|
+
* value.</p>
|
|
475
1178
|
* </li>
|
|
476
1179
|
* <li>
|
|
477
|
-
*
|
|
1180
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
478
1181
|
* </li>
|
|
479
1182
|
* <li>
|
|
480
|
-
*
|
|
1183
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
481
1184
|
* </li>
|
|
482
1185
|
* <li>
|
|
483
|
-
*
|
|
1186
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
484
1187
|
* </li>
|
|
485
1188
|
* <li>
|
|
486
|
-
*
|
|
1189
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1190
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1191
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
487
1192
|
* </li>
|
|
488
1193
|
* <li>
|
|
489
|
-
*
|
|
1194
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1195
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1196
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1197
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1198
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1199
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
490
1200
|
* </li>
|
|
491
1201
|
* </ul>
|
|
492
1202
|
*/
|
|
493
1203
|
Tags?: Tag[];
|
|
494
1204
|
}
|
|
495
|
-
export declare namespace
|
|
1205
|
+
export declare namespace CreateExplainabilityExportRequest {
|
|
496
1206
|
/**
|
|
497
1207
|
* @internal
|
|
498
1208
|
*/
|
|
499
|
-
const filterSensitiveLog: (obj:
|
|
1209
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportRequest) => any;
|
|
500
1210
|
}
|
|
501
|
-
export interface
|
|
1211
|
+
export interface CreateExplainabilityExportResponse {
|
|
502
1212
|
/**
|
|
503
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1213
|
+
* <p>The Amazon Resource Name (ARN) of the export.</p>
|
|
504
1214
|
*/
|
|
505
|
-
|
|
1215
|
+
ExplainabilityExportArn?: string;
|
|
506
1216
|
}
|
|
507
|
-
export declare namespace
|
|
1217
|
+
export declare namespace CreateExplainabilityExportResponse {
|
|
508
1218
|
/**
|
|
509
1219
|
* @internal
|
|
510
1220
|
*/
|
|
511
|
-
const filterSensitiveLog: (obj:
|
|
1221
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
|
|
512
1222
|
}
|
|
513
1223
|
export interface CreateForecastRequest {
|
|
514
1224
|
/**
|
|
@@ -574,23 +1284,6 @@ export declare namespace CreateForecastResponse {
|
|
|
574
1284
|
*/
|
|
575
1285
|
const filterSensitiveLog: (obj: CreateForecastResponse) => any;
|
|
576
1286
|
}
|
|
577
|
-
/**
|
|
578
|
-
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
579
|
-
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
580
|
-
*/
|
|
581
|
-
export interface DataDestination {
|
|
582
|
-
/**
|
|
583
|
-
* <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the
|
|
584
|
-
* bucket.</p>
|
|
585
|
-
*/
|
|
586
|
-
S3Config: S3Config | undefined;
|
|
587
|
-
}
|
|
588
|
-
export declare namespace DataDestination {
|
|
589
|
-
/**
|
|
590
|
-
* @internal
|
|
591
|
-
*/
|
|
592
|
-
const filterSensitiveLog: (obj: DataDestination) => any;
|
|
593
|
-
}
|
|
594
1287
|
export interface CreateForecastExportJobRequest {
|
|
595
1288
|
/**
|
|
596
1289
|
* <p>The name for the forecast export job.</p>
|
|
@@ -656,6 +1349,7 @@ export declare namespace CreateForecastExportJobResponse {
|
|
|
656
1349
|
const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
|
|
657
1350
|
}
|
|
658
1351
|
export declare enum AutoMLOverrideStrategy {
|
|
1352
|
+
AccuracyOptimized = "AccuracyOptimized",
|
|
659
1353
|
LatencyOptimized = "LatencyOptimized"
|
|
660
1354
|
}
|
|
661
1355
|
/**
|
|
@@ -1065,7 +1759,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1065
1759
|
* <p>The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and
|
|
1066
1760
|
* projected weather information into your model. The Weather Index supplements your datasets
|
|
1067
1761
|
* with over two years of historical weather data and up to 14 days of projected weather data.
|
|
1068
|
-
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast Weather
|
|
1762
|
+
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast Weather
|
|
1763
|
+
* Index</a>.</p>
|
|
1069
1764
|
* <p>
|
|
1070
1765
|
* <b>Holidays</b>
|
|
1071
1766
|
* </p>
|
|
@@ -1076,7 +1771,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1076
1771
|
*/
|
|
1077
1772
|
export interface SupplementaryFeature {
|
|
1078
1773
|
/**
|
|
1079
|
-
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1774
|
+
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1775
|
+
* <code>"weather"</code>.</p>
|
|
1080
1776
|
*/
|
|
1081
1777
|
Name: string | undefined;
|
|
1082
1778
|
/**
|
|
@@ -1321,13 +2017,6 @@ export declare namespace InputDataConfig {
|
|
|
1321
2017
|
*/
|
|
1322
2018
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
1323
2019
|
}
|
|
1324
|
-
export declare enum OptimizationMetric {
|
|
1325
|
-
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
1326
|
-
MAPE = "MAPE",
|
|
1327
|
-
MASE = "MASE",
|
|
1328
|
-
RMSE = "RMSE",
|
|
1329
|
-
WAPE = "WAPE"
|
|
1330
|
-
}
|
|
1331
2020
|
export interface CreatePredictorRequest {
|
|
1332
2021
|
/**
|
|
1333
2022
|
* <p>A name for the predictor.</p>
|
|
@@ -1384,10 +2073,9 @@ export interface CreatePredictorRequest {
|
|
|
1384
2073
|
*/
|
|
1385
2074
|
ForecastHorizon: number | undefined;
|
|
1386
2075
|
/**
|
|
1387
|
-
* <p>Specifies the forecast types used to train a predictor. You can specify up to five
|
|
1388
|
-
* Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
1389
|
-
* the mean forecast with <code>mean</code>.
|
|
1390
|
-
* </p>
|
|
2076
|
+
* <p>Specifies the forecast types used to train a predictor. You can specify up to five
|
|
2077
|
+
* forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
2078
|
+
* higher. You can also specify the mean forecast with <code>mean</code>. </p>
|
|
1391
2079
|
* <p>The default value is <code>["0.10", "0.50", "0.9"]</code>.</p>
|
|
1392
2080
|
*/
|
|
1393
2081
|
ForecastTypes?: string[];
|
|
@@ -1626,6 +2314,30 @@ export declare namespace DeleteDatasetImportJobRequest {
|
|
|
1626
2314
|
*/
|
|
1627
2315
|
const filterSensitiveLog: (obj: DeleteDatasetImportJobRequest) => any;
|
|
1628
2316
|
}
|
|
2317
|
+
export interface DeleteExplainabilityRequest {
|
|
2318
|
+
/**
|
|
2319
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability resource to delete.</p>
|
|
2320
|
+
*/
|
|
2321
|
+
ExplainabilityArn: string | undefined;
|
|
2322
|
+
}
|
|
2323
|
+
export declare namespace DeleteExplainabilityRequest {
|
|
2324
|
+
/**
|
|
2325
|
+
* @internal
|
|
2326
|
+
*/
|
|
2327
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityRequest) => any;
|
|
2328
|
+
}
|
|
2329
|
+
export interface DeleteExplainabilityExportRequest {
|
|
2330
|
+
/**
|
|
2331
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export to delete. </p>
|
|
2332
|
+
*/
|
|
2333
|
+
ExplainabilityExportArn: string | undefined;
|
|
2334
|
+
}
|
|
2335
|
+
export declare namespace DeleteExplainabilityExportRequest {
|
|
2336
|
+
/**
|
|
2337
|
+
* @internal
|
|
2338
|
+
*/
|
|
2339
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityExportRequest) => any;
|
|
2340
|
+
}
|
|
1629
2341
|
export interface DeleteForecastRequest {
|
|
1630
2342
|
/**
|
|
1631
2343
|
* <p>The Amazon Resource Name (ARN) of the forecast to delete.</p>
|
|
@@ -1654,38 +2366,211 @@ export interface DeletePredictorRequest {
|
|
|
1654
2366
|
/**
|
|
1655
2367
|
* <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
|
|
1656
2368
|
*/
|
|
1657
|
-
PredictorArn: string | undefined;
|
|
1658
|
-
}
|
|
1659
|
-
export declare namespace DeletePredictorRequest {
|
|
2369
|
+
PredictorArn: string | undefined;
|
|
2370
|
+
}
|
|
2371
|
+
export declare namespace DeletePredictorRequest {
|
|
2372
|
+
/**
|
|
2373
|
+
* @internal
|
|
2374
|
+
*/
|
|
2375
|
+
const filterSensitiveLog: (obj: DeletePredictorRequest) => any;
|
|
2376
|
+
}
|
|
2377
|
+
export interface DeletePredictorBacktestExportJobRequest {
|
|
2378
|
+
/**
|
|
2379
|
+
* <p>The Amazon Resource Name (ARN) of the predictor backtest export job to delete.</p>
|
|
2380
|
+
*/
|
|
2381
|
+
PredictorBacktestExportJobArn: string | undefined;
|
|
2382
|
+
}
|
|
2383
|
+
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2384
|
+
/**
|
|
2385
|
+
* @internal
|
|
2386
|
+
*/
|
|
2387
|
+
const filterSensitiveLog: (obj: DeletePredictorBacktestExportJobRequest) => any;
|
|
2388
|
+
}
|
|
2389
|
+
export interface DeleteResourceTreeRequest {
|
|
2390
|
+
/**
|
|
2391
|
+
* <p>The Amazon Resource Name (ARN) of the parent resource to delete. All child resources
|
|
2392
|
+
* of the parent resource will also be deleted.</p>
|
|
2393
|
+
*/
|
|
2394
|
+
ResourceArn: string | undefined;
|
|
2395
|
+
}
|
|
2396
|
+
export declare namespace DeleteResourceTreeRequest {
|
|
2397
|
+
/**
|
|
2398
|
+
* @internal
|
|
2399
|
+
*/
|
|
2400
|
+
const filterSensitiveLog: (obj: DeleteResourceTreeRequest) => any;
|
|
2401
|
+
}
|
|
2402
|
+
export interface DescribeAutoPredictorRequest {
|
|
2403
|
+
/**
|
|
2404
|
+
* <p>The Amazon Resource Name (ARN) of the predictor.</p>
|
|
2405
|
+
*/
|
|
2406
|
+
PredictorArn: string | undefined;
|
|
2407
|
+
}
|
|
2408
|
+
export declare namespace DescribeAutoPredictorRequest {
|
|
2409
|
+
/**
|
|
2410
|
+
* @internal
|
|
2411
|
+
*/
|
|
2412
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
|
|
2413
|
+
}
|
|
2414
|
+
export interface ExplainabilityInfo {
|
|
2415
|
+
ExplainabilityArn?: string;
|
|
2416
|
+
Status?: string;
|
|
2417
|
+
}
|
|
2418
|
+
export declare namespace ExplainabilityInfo {
|
|
2419
|
+
/**
|
|
2420
|
+
* @internal
|
|
2421
|
+
*/
|
|
2422
|
+
const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
|
|
2423
|
+
}
|
|
2424
|
+
export declare enum State {
|
|
2425
|
+
Active = "Active",
|
|
2426
|
+
Deleted = "Deleted"
|
|
2427
|
+
}
|
|
2428
|
+
/**
|
|
2429
|
+
* <p>Provides a summary of the reference predictor used when retraining or upgrading a
|
|
2430
|
+
* predictor.</p>
|
|
2431
|
+
*/
|
|
2432
|
+
export interface ReferencePredictorSummary {
|
|
2433
|
+
/**
|
|
2434
|
+
* <p>The ARN of the reference predictor.</p>
|
|
2435
|
+
*/
|
|
2436
|
+
Arn?: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* <p>Whether the reference predictor is <code>Active</code> or <code>Deleted</code>.</p>
|
|
2439
|
+
*/
|
|
2440
|
+
State?: State | string;
|
|
2441
|
+
}
|
|
2442
|
+
export declare namespace ReferencePredictorSummary {
|
|
2443
|
+
/**
|
|
2444
|
+
* @internal
|
|
2445
|
+
*/
|
|
2446
|
+
const filterSensitiveLog: (obj: ReferencePredictorSummary) => any;
|
|
2447
|
+
}
|
|
2448
|
+
export interface DescribeAutoPredictorResponse {
|
|
2449
|
+
/**
|
|
2450
|
+
* <p>The Amazon Resource Name (ARN) of the predictor</p>
|
|
2451
|
+
*/
|
|
2452
|
+
PredictorArn?: string;
|
|
2453
|
+
/**
|
|
2454
|
+
* <p>The name of the predictor.</p>
|
|
2455
|
+
*/
|
|
2456
|
+
PredictorName?: string;
|
|
2457
|
+
/**
|
|
2458
|
+
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
2459
|
+
* the prediction length.</p>
|
|
2460
|
+
*/
|
|
2461
|
+
ForecastHorizon?: number;
|
|
2462
|
+
/**
|
|
2463
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
2464
|
+
* ["0.1","0.5","0.9"].</p>
|
|
2465
|
+
*/
|
|
2466
|
+
ForecastTypes?: string[];
|
|
2467
|
+
/**
|
|
2468
|
+
* <p>The frequency of predictions in a forecast.</p>
|
|
2469
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
2470
|
+
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
2471
|
+
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2472
|
+
*/
|
|
2473
|
+
ForecastFrequency?: string;
|
|
2474
|
+
/**
|
|
2475
|
+
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2476
|
+
* predictor.</p>
|
|
2477
|
+
*/
|
|
2478
|
+
DatasetImportJobArns?: string[];
|
|
2479
|
+
/**
|
|
2480
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
2481
|
+
*/
|
|
2482
|
+
DataConfig?: DataConfig;
|
|
2483
|
+
/**
|
|
2484
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
2485
|
+
* access the key. You can specify this optional object in the
|
|
2486
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
2487
|
+
*/
|
|
2488
|
+
EncryptionConfig?: EncryptionConfig;
|
|
2489
|
+
/**
|
|
2490
|
+
* <p>The ARN and state of the reference predictor. This parameter is only valid for
|
|
2491
|
+
* retrained or upgraded predictors.</p>
|
|
2492
|
+
*/
|
|
2493
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
2494
|
+
/**
|
|
2495
|
+
* <p>The estimated time remaining in minutes for the predictor training job to
|
|
2496
|
+
* complete.</p>
|
|
2497
|
+
*/
|
|
2498
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
2499
|
+
/**
|
|
2500
|
+
* <p>The status of the predictor. States include: </p>
|
|
2501
|
+
* <ul>
|
|
2502
|
+
* <li>
|
|
2503
|
+
* <p>
|
|
2504
|
+
* <code>ACTIVE</code>
|
|
2505
|
+
* </p>
|
|
2506
|
+
* </li>
|
|
2507
|
+
* <li>
|
|
2508
|
+
* <p>
|
|
2509
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2510
|
+
* <code>CREATE_FAILED</code>
|
|
2511
|
+
* </p>
|
|
2512
|
+
* </li>
|
|
2513
|
+
* <li>
|
|
2514
|
+
* <p>
|
|
2515
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2516
|
+
* </p>
|
|
2517
|
+
* </li>
|
|
2518
|
+
* <li>
|
|
2519
|
+
* <p>
|
|
2520
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2521
|
+
* <code>DELETE_FAILED</code>
|
|
2522
|
+
* </p>
|
|
2523
|
+
* </li>
|
|
2524
|
+
* </ul>
|
|
2525
|
+
*/
|
|
2526
|
+
Status?: string;
|
|
1660
2527
|
/**
|
|
1661
|
-
*
|
|
2528
|
+
* <p>In the event of an error, a message detailing the cause of the error.</p>
|
|
1662
2529
|
*/
|
|
1663
|
-
|
|
1664
|
-
}
|
|
1665
|
-
export interface DeletePredictorBacktestExportJobRequest {
|
|
2530
|
+
Message?: string;
|
|
1666
2531
|
/**
|
|
1667
|
-
* <p>The
|
|
2532
|
+
* <p>The timestamp of the CreateAutoPredictor request.</p>
|
|
1668
2533
|
*/
|
|
1669
|
-
|
|
1670
|
-
}
|
|
1671
|
-
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2534
|
+
CreationTime?: Date;
|
|
1672
2535
|
/**
|
|
1673
|
-
*
|
|
2536
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
2537
|
+
* job:</p>
|
|
2538
|
+
* <ul>
|
|
2539
|
+
* <li>
|
|
2540
|
+
* <p>
|
|
2541
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
2542
|
+
* </li>
|
|
2543
|
+
* <li>
|
|
2544
|
+
* <p>
|
|
2545
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
2546
|
+
* </li>
|
|
2547
|
+
* <li>
|
|
2548
|
+
* <p>
|
|
2549
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
2550
|
+
* </li>
|
|
2551
|
+
* <li>
|
|
2552
|
+
* <p>
|
|
2553
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
2554
|
+
* </li>
|
|
2555
|
+
* <li>
|
|
2556
|
+
* <p>
|
|
2557
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
2558
|
+
* failed.</p>
|
|
2559
|
+
* </li>
|
|
2560
|
+
* </ul>
|
|
1674
2561
|
*/
|
|
1675
|
-
|
|
1676
|
-
}
|
|
1677
|
-
export interface DeleteResourceTreeRequest {
|
|
2562
|
+
LastModificationTime?: Date;
|
|
1678
2563
|
/**
|
|
1679
|
-
* <p>The
|
|
1680
|
-
* of the parent resource will also be deleted.</p>
|
|
2564
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
1681
2565
|
*/
|
|
1682
|
-
|
|
2566
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
2567
|
+
ExplainabilityInfo?: ExplainabilityInfo;
|
|
1683
2568
|
}
|
|
1684
|
-
export declare namespace
|
|
2569
|
+
export declare namespace DescribeAutoPredictorResponse {
|
|
1685
2570
|
/**
|
|
1686
2571
|
* @internal
|
|
1687
2572
|
*/
|
|
1688
|
-
const filterSensitiveLog: (obj:
|
|
2573
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorResponse) => any;
|
|
1689
2574
|
}
|
|
1690
2575
|
export interface DescribeDatasetRequest {
|
|
1691
2576
|
/**
|
|
@@ -2086,6 +2971,238 @@ export declare namespace DescribeDatasetImportJobResponse {
|
|
|
2086
2971
|
*/
|
|
2087
2972
|
const filterSensitiveLog: (obj: DescribeDatasetImportJobResponse) => any;
|
|
2088
2973
|
}
|
|
2974
|
+
export interface DescribeExplainabilityRequest {
|
|
2975
|
+
/**
|
|
2976
|
+
* <p>The Amazon Resource Name (ARN) of the Explaianability to describe.</p>
|
|
2977
|
+
*/
|
|
2978
|
+
ExplainabilityArn: string | undefined;
|
|
2979
|
+
}
|
|
2980
|
+
export declare namespace DescribeExplainabilityRequest {
|
|
2981
|
+
/**
|
|
2982
|
+
* @internal
|
|
2983
|
+
*/
|
|
2984
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityRequest) => any;
|
|
2985
|
+
}
|
|
2986
|
+
export interface DescribeExplainabilityResponse {
|
|
2987
|
+
/**
|
|
2988
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
2989
|
+
*/
|
|
2990
|
+
ExplainabilityArn?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* <p>The name of the Explainability.</p>
|
|
2993
|
+
*/
|
|
2994
|
+
ExplainabilityName?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
2997
|
+
* Explainability resource.</p>
|
|
2998
|
+
*/
|
|
2999
|
+
ResourceArn?: string;
|
|
3000
|
+
/**
|
|
3001
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
3002
|
+
* for the Explainability.</p>
|
|
3003
|
+
*/
|
|
3004
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
3005
|
+
/**
|
|
3006
|
+
* <p>Whether the visualization was enabled for the Explainability resource.</p>
|
|
3007
|
+
*/
|
|
3008
|
+
EnableVisualization?: boolean;
|
|
3009
|
+
/**
|
|
3010
|
+
* <p>The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3011
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the
|
|
3012
|
+
* <a>CreateDatasetImportJob</a> request.</p>
|
|
3013
|
+
*/
|
|
3014
|
+
DataSource?: DataSource;
|
|
3015
|
+
/**
|
|
3016
|
+
* <p>Defines the fields of a dataset. You specify this object in the <a>CreateDataset</a> request.</p>
|
|
3017
|
+
*/
|
|
3018
|
+
Schema?: Schema;
|
|
3019
|
+
/**
|
|
3020
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time
|
|
3021
|
+
* point in the Explainability.</p>
|
|
3022
|
+
*/
|
|
3023
|
+
StartDateTime?: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time
|
|
3026
|
+
* point in the Explainability.</p>
|
|
3027
|
+
*/
|
|
3028
|
+
EndDateTime?: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* <p>The estimated time remaining in minutes for the <a>CreateExplainability</a>
|
|
3031
|
+
* job to complete.</p>
|
|
3032
|
+
*/
|
|
3033
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
3034
|
+
/**
|
|
3035
|
+
* <p>If an error occurred, a message about the error.</p>
|
|
3036
|
+
*/
|
|
3037
|
+
Message?: string;
|
|
3038
|
+
/**
|
|
3039
|
+
* <p>The status of the Explainability resource. States include: </p>
|
|
3040
|
+
* <ul>
|
|
3041
|
+
* <li>
|
|
3042
|
+
* <p>
|
|
3043
|
+
* <code>ACTIVE</code>
|
|
3044
|
+
* </p>
|
|
3045
|
+
* </li>
|
|
3046
|
+
* <li>
|
|
3047
|
+
* <p>
|
|
3048
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3049
|
+
* <code>CREATE_FAILED</code>
|
|
3050
|
+
* </p>
|
|
3051
|
+
* </li>
|
|
3052
|
+
* <li>
|
|
3053
|
+
* <p>
|
|
3054
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3055
|
+
* </p>
|
|
3056
|
+
* </li>
|
|
3057
|
+
* <li>
|
|
3058
|
+
* <p>
|
|
3059
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3060
|
+
* <code>DELETE_FAILED</code>
|
|
3061
|
+
* </p>
|
|
3062
|
+
* </li>
|
|
3063
|
+
* </ul>
|
|
3064
|
+
*/
|
|
3065
|
+
Status?: string;
|
|
3066
|
+
/**
|
|
3067
|
+
* <p>When the Explainability resource was created.</p>
|
|
3068
|
+
*/
|
|
3069
|
+
CreationTime?: Date;
|
|
3070
|
+
/**
|
|
3071
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3072
|
+
* job:</p>
|
|
3073
|
+
* <ul>
|
|
3074
|
+
* <li>
|
|
3075
|
+
* <p>
|
|
3076
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3077
|
+
* </li>
|
|
3078
|
+
* <li>
|
|
3079
|
+
* <p>
|
|
3080
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3081
|
+
* </li>
|
|
3082
|
+
* <li>
|
|
3083
|
+
* <p>
|
|
3084
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3085
|
+
* </li>
|
|
3086
|
+
* <li>
|
|
3087
|
+
* <p>
|
|
3088
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3089
|
+
* </li>
|
|
3090
|
+
* <li>
|
|
3091
|
+
* <p>
|
|
3092
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3093
|
+
* failed.</p>
|
|
3094
|
+
* </li>
|
|
3095
|
+
* </ul>
|
|
3096
|
+
*/
|
|
3097
|
+
LastModificationTime?: Date;
|
|
3098
|
+
}
|
|
3099
|
+
export declare namespace DescribeExplainabilityResponse {
|
|
3100
|
+
/**
|
|
3101
|
+
* @internal
|
|
3102
|
+
*/
|
|
3103
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityResponse) => any;
|
|
3104
|
+
}
|
|
3105
|
+
export interface DescribeExplainabilityExportRequest {
|
|
3106
|
+
/**
|
|
3107
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3108
|
+
*/
|
|
3109
|
+
ExplainabilityExportArn: string | undefined;
|
|
3110
|
+
}
|
|
3111
|
+
export declare namespace DescribeExplainabilityExportRequest {
|
|
3112
|
+
/**
|
|
3113
|
+
* @internal
|
|
3114
|
+
*/
|
|
3115
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportRequest) => any;
|
|
3116
|
+
}
|
|
3117
|
+
export interface DescribeExplainabilityExportResponse {
|
|
3118
|
+
/**
|
|
3119
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3120
|
+
*/
|
|
3121
|
+
ExplainabilityExportArn?: string;
|
|
3122
|
+
/**
|
|
3123
|
+
* <p>The name of the Explainability export.</p>
|
|
3124
|
+
*/
|
|
3125
|
+
ExplainabilityExportName?: string;
|
|
3126
|
+
/**
|
|
3127
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3128
|
+
*/
|
|
3129
|
+
ExplainabilityArn?: string;
|
|
3130
|
+
/**
|
|
3131
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
3132
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
3133
|
+
*/
|
|
3134
|
+
Destination?: DataDestination;
|
|
3135
|
+
/**
|
|
3136
|
+
* <p>Information about any errors that occurred during the export.</p>
|
|
3137
|
+
*/
|
|
3138
|
+
Message?: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
3141
|
+
* <ul>
|
|
3142
|
+
* <li>
|
|
3143
|
+
* <p>
|
|
3144
|
+
* <code>ACTIVE</code>
|
|
3145
|
+
* </p>
|
|
3146
|
+
* </li>
|
|
3147
|
+
* <li>
|
|
3148
|
+
* <p>
|
|
3149
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3150
|
+
* <code>CREATE_FAILED</code>
|
|
3151
|
+
* </p>
|
|
3152
|
+
* </li>
|
|
3153
|
+
* <li>
|
|
3154
|
+
* <p>
|
|
3155
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3156
|
+
* </p>
|
|
3157
|
+
* </li>
|
|
3158
|
+
* <li>
|
|
3159
|
+
* <p>
|
|
3160
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3161
|
+
* <code>DELETE_FAILED</code>
|
|
3162
|
+
* </p>
|
|
3163
|
+
* </li>
|
|
3164
|
+
* </ul>
|
|
3165
|
+
*/
|
|
3166
|
+
Status?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* <p>When the Explainability export was created.</p>
|
|
3169
|
+
*/
|
|
3170
|
+
CreationTime?: Date;
|
|
3171
|
+
/**
|
|
3172
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3173
|
+
* job:</p>
|
|
3174
|
+
* <ul>
|
|
3175
|
+
* <li>
|
|
3176
|
+
* <p>
|
|
3177
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3178
|
+
* </li>
|
|
3179
|
+
* <li>
|
|
3180
|
+
* <p>
|
|
3181
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3182
|
+
* </li>
|
|
3183
|
+
* <li>
|
|
3184
|
+
* <p>
|
|
3185
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3186
|
+
* </li>
|
|
3187
|
+
* <li>
|
|
3188
|
+
* <p>
|
|
3189
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3190
|
+
* </li>
|
|
3191
|
+
* <li>
|
|
3192
|
+
* <p>
|
|
3193
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3194
|
+
* failed.</p>
|
|
3195
|
+
* </li>
|
|
3196
|
+
* </ul>
|
|
3197
|
+
*/
|
|
3198
|
+
LastModificationTime?: Date;
|
|
3199
|
+
}
|
|
3200
|
+
export declare namespace DescribeExplainabilityExportResponse {
|
|
3201
|
+
/**
|
|
3202
|
+
* @internal
|
|
3203
|
+
*/
|
|
3204
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportResponse) => any;
|
|
3205
|
+
}
|
|
2089
3206
|
export interface DescribeForecastRequest {
|
|
2090
3207
|
/**
|
|
2091
3208
|
* <p>The Amazon Resource Name (ARN) of the forecast.</p>
|
|
@@ -2410,13 +3527,18 @@ export interface DescribePredictorResponse {
|
|
|
2410
3527
|
* <p>The Amazon Resource Name (ARN) of the algorithm used for model training.</p>
|
|
2411
3528
|
*/
|
|
2412
3529
|
AlgorithmArn?: string;
|
|
3530
|
+
/**
|
|
3531
|
+
* <p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>
|
|
3532
|
+
*/
|
|
3533
|
+
AutoMLAlgorithmArns?: string[];
|
|
2413
3534
|
/**
|
|
2414
3535
|
* <p>The number of time-steps of the forecast. The forecast horizon is also called the
|
|
2415
3536
|
* prediction length.</p>
|
|
2416
3537
|
*/
|
|
2417
3538
|
ForecastHorizon?: number;
|
|
2418
3539
|
/**
|
|
2419
|
-
* <p>The forecast types used during predictor training. Default value is
|
|
3540
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
3541
|
+
* <code>["0.1","0.5","0.9"]</code>
|
|
2420
3542
|
* </p>
|
|
2421
3543
|
*/
|
|
2422
3544
|
ForecastTypes?: string[];
|
|
@@ -2480,14 +3602,14 @@ export interface DescribePredictorResponse {
|
|
|
2480
3602
|
*/
|
|
2481
3603
|
EstimatedTimeRemainingInMinutes?: number;
|
|
2482
3604
|
/**
|
|
2483
|
-
* <p>
|
|
2484
|
-
* predictor.</p>
|
|
3605
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
2485
3606
|
*/
|
|
2486
|
-
|
|
3607
|
+
IsAutoPredictor?: boolean;
|
|
2487
3608
|
/**
|
|
2488
|
-
* <p>
|
|
3609
|
+
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
3610
|
+
* predictor.</p>
|
|
2489
3611
|
*/
|
|
2490
|
-
|
|
3612
|
+
DatasetImportJobArns?: string[];
|
|
2491
3613
|
/**
|
|
2492
3614
|
* <p>The status of the predictor. States include:</p>
|
|
2493
3615
|
* <ul>
|
|
@@ -2499,13 +3621,13 @@ export interface DescribePredictorResponse {
|
|
|
2499
3621
|
* <li>
|
|
2500
3622
|
* <p>
|
|
2501
3623
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2502
|
-
*
|
|
3624
|
+
* <code>CREATE_FAILED</code>
|
|
2503
3625
|
* </p>
|
|
2504
3626
|
* </li>
|
|
2505
3627
|
* <li>
|
|
2506
3628
|
* <p>
|
|
2507
3629
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2508
|
-
*
|
|
3630
|
+
* <code>DELETE_FAILED</code>
|
|
2509
3631
|
* </p>
|
|
2510
3632
|
* </li>
|
|
2511
3633
|
* <li>
|
|
@@ -2529,7 +3651,8 @@ export interface DescribePredictorResponse {
|
|
|
2529
3651
|
*/
|
|
2530
3652
|
CreationTime?: Date;
|
|
2531
3653
|
/**
|
|
2532
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3654
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3655
|
+
* job:</p>
|
|
2533
3656
|
* <ul>
|
|
2534
3657
|
* <li>
|
|
2535
3658
|
* <p>
|
|
@@ -2839,6 +3962,10 @@ export interface GetAccuracyMetricsResponse {
|
|
|
2839
3962
|
* <p>An array of results from evaluating the predictor.</p>
|
|
2840
3963
|
*/
|
|
2841
3964
|
PredictorEvaluationResults?: EvaluationResult[];
|
|
3965
|
+
/**
|
|
3966
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
3967
|
+
*/
|
|
3968
|
+
IsAutoPredictor?: boolean;
|
|
2842
3969
|
/**
|
|
2843
3970
|
* <note>
|
|
2844
3971
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
@@ -3208,6 +4335,317 @@ export declare namespace ListDatasetsResponse {
|
|
|
3208
4335
|
*/
|
|
3209
4336
|
const filterSensitiveLog: (obj: ListDatasetsResponse) => any;
|
|
3210
4337
|
}
|
|
4338
|
+
export interface ListExplainabilitiesRequest {
|
|
4339
|
+
/**
|
|
4340
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4341
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4342
|
+
* Tokens expire after 24 hours.</p>
|
|
4343
|
+
*/
|
|
4344
|
+
NextToken?: string;
|
|
4345
|
+
/**
|
|
4346
|
+
* <p>The number of items returned in the response.</p>
|
|
4347
|
+
*/
|
|
4348
|
+
MaxResults?: number;
|
|
4349
|
+
/**
|
|
4350
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4351
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4352
|
+
* include or exclude the resources that match the statement from the list. The match
|
|
4353
|
+
* statement consists of a key and a value.</p>
|
|
4354
|
+
* <p>
|
|
4355
|
+
* <b>Filter properties</b>
|
|
4356
|
+
* </p>
|
|
4357
|
+
* <ul>
|
|
4358
|
+
* <li>
|
|
4359
|
+
* <p>
|
|
4360
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4361
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4362
|
+
* </li>
|
|
4363
|
+
* <li>
|
|
4364
|
+
* <p>
|
|
4365
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4366
|
+
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
4367
|
+
* </li>
|
|
4368
|
+
* <li>
|
|
4369
|
+
* <p>
|
|
4370
|
+
* <code>Value</code> - The value to match.</p>
|
|
4371
|
+
* </li>
|
|
4372
|
+
* </ul>
|
|
4373
|
+
*/
|
|
4374
|
+
Filters?: Filter[];
|
|
4375
|
+
}
|
|
4376
|
+
export declare namespace ListExplainabilitiesRequest {
|
|
4377
|
+
/**
|
|
4378
|
+
* @internal
|
|
4379
|
+
*/
|
|
4380
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesRequest) => any;
|
|
4381
|
+
}
|
|
4382
|
+
/**
|
|
4383
|
+
* <p>Provides a summary of the Explainability properties used in the <a>ListExplainabilities</a> operation. To get a complete set of properties,
|
|
4384
|
+
* call the <a>DescribeExplainability</a> operation, and provide the listed
|
|
4385
|
+
* <code>ExplainabilityArn</code>.</p>
|
|
4386
|
+
*/
|
|
4387
|
+
export interface ExplainabilitySummary {
|
|
4388
|
+
/**
|
|
4389
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
4390
|
+
*/
|
|
4391
|
+
ExplainabilityArn?: string;
|
|
4392
|
+
/**
|
|
4393
|
+
* <p>The name of the Explainability.</p>
|
|
4394
|
+
*/
|
|
4395
|
+
ExplainabilityName?: string;
|
|
4396
|
+
/**
|
|
4397
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
4398
|
+
* Explainability.</p>
|
|
4399
|
+
*/
|
|
4400
|
+
ResourceArn?: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
4403
|
+
* for the Explainability.</p>
|
|
4404
|
+
*/
|
|
4405
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
4406
|
+
/**
|
|
4407
|
+
* <p>The status of the Explainability. States include: </p>
|
|
4408
|
+
* <ul>
|
|
4409
|
+
* <li>
|
|
4410
|
+
* <p>
|
|
4411
|
+
* <code>ACTIVE</code>
|
|
4412
|
+
* </p>
|
|
4413
|
+
* </li>
|
|
4414
|
+
* <li>
|
|
4415
|
+
* <p>
|
|
4416
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4417
|
+
* <code>CREATE_FAILED</code>
|
|
4418
|
+
* </p>
|
|
4419
|
+
* </li>
|
|
4420
|
+
* <li>
|
|
4421
|
+
* <p>
|
|
4422
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4423
|
+
* </p>
|
|
4424
|
+
* </li>
|
|
4425
|
+
* <li>
|
|
4426
|
+
* <p>
|
|
4427
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4428
|
+
* <code>DELETE_FAILED</code>
|
|
4429
|
+
* </p>
|
|
4430
|
+
* </li>
|
|
4431
|
+
* </ul>
|
|
4432
|
+
*/
|
|
4433
|
+
Status?: string;
|
|
4434
|
+
/**
|
|
4435
|
+
* <p>Information about any errors that may have occurred during the Explainability creation
|
|
4436
|
+
* process.</p>
|
|
4437
|
+
*/
|
|
4438
|
+
Message?: string;
|
|
4439
|
+
/**
|
|
4440
|
+
* <p>When the Explainability was created.</p>
|
|
4441
|
+
*/
|
|
4442
|
+
CreationTime?: Date;
|
|
4443
|
+
/**
|
|
4444
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4445
|
+
* job:</p>
|
|
4446
|
+
* <ul>
|
|
4447
|
+
* <li>
|
|
4448
|
+
* <p>
|
|
4449
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4450
|
+
* </li>
|
|
4451
|
+
* <li>
|
|
4452
|
+
* <p>
|
|
4453
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4454
|
+
* </li>
|
|
4455
|
+
* <li>
|
|
4456
|
+
* <p>
|
|
4457
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4458
|
+
* </li>
|
|
4459
|
+
* <li>
|
|
4460
|
+
* <p>
|
|
4461
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4462
|
+
* </li>
|
|
4463
|
+
* <li>
|
|
4464
|
+
* <p>
|
|
4465
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4466
|
+
* failed.</p>
|
|
4467
|
+
* </li>
|
|
4468
|
+
* </ul>
|
|
4469
|
+
*/
|
|
4470
|
+
LastModificationTime?: Date;
|
|
4471
|
+
}
|
|
4472
|
+
export declare namespace ExplainabilitySummary {
|
|
4473
|
+
/**
|
|
4474
|
+
* @internal
|
|
4475
|
+
*/
|
|
4476
|
+
const filterSensitiveLog: (obj: ExplainabilitySummary) => any;
|
|
4477
|
+
}
|
|
4478
|
+
export interface ListExplainabilitiesResponse {
|
|
4479
|
+
/**
|
|
4480
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4481
|
+
* resource.</p>
|
|
4482
|
+
*/
|
|
4483
|
+
Explainabilities?: ExplainabilitySummary[];
|
|
4484
|
+
/**
|
|
4485
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4486
|
+
* use the token in the next request.</p>
|
|
4487
|
+
*/
|
|
4488
|
+
NextToken?: string;
|
|
4489
|
+
}
|
|
4490
|
+
export declare namespace ListExplainabilitiesResponse {
|
|
4491
|
+
/**
|
|
4492
|
+
* @internal
|
|
4493
|
+
*/
|
|
4494
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesResponse) => any;
|
|
4495
|
+
}
|
|
4496
|
+
export interface ListExplainabilityExportsRequest {
|
|
4497
|
+
/**
|
|
4498
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4499
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4500
|
+
* Tokens expire after 24 hours.</p>
|
|
4501
|
+
*/
|
|
4502
|
+
NextToken?: string;
|
|
4503
|
+
/**
|
|
4504
|
+
* <p>The number of items to return in the response.</p>
|
|
4505
|
+
*/
|
|
4506
|
+
MaxResults?: number;
|
|
4507
|
+
/**
|
|
4508
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4509
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4510
|
+
* include or exclude resources that match the statement from the list. The match statement
|
|
4511
|
+
* consists of a key and a value.</p>
|
|
4512
|
+
* <p>
|
|
4513
|
+
* <b>Filter properties</b>
|
|
4514
|
+
* </p>
|
|
4515
|
+
* <ul>
|
|
4516
|
+
* <li>
|
|
4517
|
+
* <p>
|
|
4518
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4519
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4520
|
+
* </li>
|
|
4521
|
+
* <li>
|
|
4522
|
+
* <p>
|
|
4523
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4524
|
+
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
4525
|
+
* </li>
|
|
4526
|
+
* <li>
|
|
4527
|
+
* <p>
|
|
4528
|
+
* <code>Value</code> - The value to match.</p>
|
|
4529
|
+
* </li>
|
|
4530
|
+
* </ul>
|
|
4531
|
+
*/
|
|
4532
|
+
Filters?: Filter[];
|
|
4533
|
+
}
|
|
4534
|
+
export declare namespace ListExplainabilityExportsRequest {
|
|
4535
|
+
/**
|
|
4536
|
+
* @internal
|
|
4537
|
+
*/
|
|
4538
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsRequest) => any;
|
|
4539
|
+
}
|
|
4540
|
+
/**
|
|
4541
|
+
* <p>Provides a summary of the Explainability export properties used in the <a>ListExplainabilityExports</a> operation. To get a complete set of
|
|
4542
|
+
* properties, call the <a>DescribeExplainabilityExport</a> operation, and
|
|
4543
|
+
* provide the <code>ExplainabilityExportArn</code>.</p>
|
|
4544
|
+
*/
|
|
4545
|
+
export interface ExplainabilityExportSummary {
|
|
4546
|
+
/**
|
|
4547
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
4548
|
+
*/
|
|
4549
|
+
ExplainabilityExportArn?: string;
|
|
4550
|
+
/**
|
|
4551
|
+
* <p>The name of the Explainability export</p>
|
|
4552
|
+
*/
|
|
4553
|
+
ExplainabilityExportName?: string;
|
|
4554
|
+
/**
|
|
4555
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
4556
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
4557
|
+
*/
|
|
4558
|
+
Destination?: DataDestination;
|
|
4559
|
+
/**
|
|
4560
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
4561
|
+
* <ul>
|
|
4562
|
+
* <li>
|
|
4563
|
+
* <p>
|
|
4564
|
+
* <code>ACTIVE</code>
|
|
4565
|
+
* </p>
|
|
4566
|
+
* </li>
|
|
4567
|
+
* <li>
|
|
4568
|
+
* <p>
|
|
4569
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4570
|
+
* <code>CREATE_FAILED</code>
|
|
4571
|
+
* </p>
|
|
4572
|
+
* </li>
|
|
4573
|
+
* <li>
|
|
4574
|
+
* <p>
|
|
4575
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4576
|
+
* </p>
|
|
4577
|
+
* </li>
|
|
4578
|
+
* <li>
|
|
4579
|
+
* <p>
|
|
4580
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4581
|
+
* <code>DELETE_FAILED</code>
|
|
4582
|
+
* </p>
|
|
4583
|
+
* </li>
|
|
4584
|
+
* </ul>
|
|
4585
|
+
*/
|
|
4586
|
+
Status?: string;
|
|
4587
|
+
/**
|
|
4588
|
+
* <p>Information about any errors that may have occurred during the Explainability
|
|
4589
|
+
* export.</p>
|
|
4590
|
+
*/
|
|
4591
|
+
Message?: string;
|
|
4592
|
+
/**
|
|
4593
|
+
* <p>When the Explainability was created.</p>
|
|
4594
|
+
*/
|
|
4595
|
+
CreationTime?: Date;
|
|
4596
|
+
/**
|
|
4597
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4598
|
+
* job:</p>
|
|
4599
|
+
* <ul>
|
|
4600
|
+
* <li>
|
|
4601
|
+
* <p>
|
|
4602
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4603
|
+
* </li>
|
|
4604
|
+
* <li>
|
|
4605
|
+
* <p>
|
|
4606
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4607
|
+
* </li>
|
|
4608
|
+
* <li>
|
|
4609
|
+
* <p>
|
|
4610
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4611
|
+
* </li>
|
|
4612
|
+
* <li>
|
|
4613
|
+
* <p>
|
|
4614
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4615
|
+
* </li>
|
|
4616
|
+
* <li>
|
|
4617
|
+
* <p>
|
|
4618
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4619
|
+
* failed.</p>
|
|
4620
|
+
* </li>
|
|
4621
|
+
* </ul>
|
|
4622
|
+
*/
|
|
4623
|
+
LastModificationTime?: Date;
|
|
4624
|
+
}
|
|
4625
|
+
export declare namespace ExplainabilityExportSummary {
|
|
4626
|
+
/**
|
|
4627
|
+
* @internal
|
|
4628
|
+
*/
|
|
4629
|
+
const filterSensitiveLog: (obj: ExplainabilityExportSummary) => any;
|
|
4630
|
+
}
|
|
4631
|
+
export interface ListExplainabilityExportsResponse {
|
|
4632
|
+
/**
|
|
4633
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4634
|
+
* export.</p>
|
|
4635
|
+
*/
|
|
4636
|
+
ExplainabilityExports?: ExplainabilityExportSummary[];
|
|
4637
|
+
/**
|
|
4638
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4639
|
+
* use the token in the next request.</p>
|
|
4640
|
+
*/
|
|
4641
|
+
NextToken?: string;
|
|
4642
|
+
}
|
|
4643
|
+
export declare namespace ListExplainabilityExportsResponse {
|
|
4644
|
+
/**
|
|
4645
|
+
* @internal
|
|
4646
|
+
*/
|
|
4647
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsResponse) => any;
|
|
4648
|
+
}
|
|
3211
4649
|
export interface ListForecastExportJobsRequest {
|
|
3212
4650
|
/**
|
|
3213
4651
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
@@ -3437,6 +4875,7 @@ export interface ForecastSummary {
|
|
|
3437
4875
|
* <p>The ARN of the predictor used to generate the forecast.</p>
|
|
3438
4876
|
*/
|
|
3439
4877
|
PredictorArn?: string;
|
|
4878
|
+
CreatedUsingAutoPredictor?: boolean;
|
|
3440
4879
|
/**
|
|
3441
4880
|
* <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
|
|
3442
4881
|
* the predictor.</p>
|
|
@@ -3754,6 +5193,15 @@ export interface PredictorSummary {
|
|
|
3754
5193
|
* the predictor.</p>
|
|
3755
5194
|
*/
|
|
3756
5195
|
DatasetGroupArn?: string;
|
|
5196
|
+
/**
|
|
5197
|
+
* <p>Whether AutoPredictor was used to create the predictor.</p>
|
|
5198
|
+
*/
|
|
5199
|
+
IsAutoPredictor?: boolean;
|
|
5200
|
+
/**
|
|
5201
|
+
* <p>A summary of the reference predictor used if the predictor was retrained or
|
|
5202
|
+
* upgraded.</p>
|
|
5203
|
+
*/
|
|
5204
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
3757
5205
|
/**
|
|
3758
5206
|
* <p>The status of the predictor. States include:</p>
|
|
3759
5207
|
* <ul>
|
|
@@ -3765,13 +5213,13 @@ export interface PredictorSummary {
|
|
|
3765
5213
|
* <li>
|
|
3766
5214
|
* <p>
|
|
3767
5215
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3768
|
-
*
|
|
5216
|
+
* <code>CREATE_FAILED</code>
|
|
3769
5217
|
* </p>
|
|
3770
5218
|
* </li>
|
|
3771
5219
|
* <li>
|
|
3772
5220
|
* <p>
|
|
3773
5221
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3774
|
-
*
|
|
5222
|
+
* <code>DELETE_FAILED</code>
|
|
3775
5223
|
* </p>
|
|
3776
5224
|
* </li>
|
|
3777
5225
|
* <li>
|
|
@@ -3795,7 +5243,8 @@ export interface PredictorSummary {
|
|
|
3795
5243
|
*/
|
|
3796
5244
|
CreationTime?: Date;
|
|
3797
5245
|
/**
|
|
3798
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5246
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5247
|
+
* job:</p>
|
|
3799
5248
|
* <ul>
|
|
3800
5249
|
* <li>
|
|
3801
5250
|
* <p>
|