@aws-sdk/client-forecast 3.41.0 → 3.46.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 +47 -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/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +236 -61
- package/dist-cjs/protocols/Aws_json1_1.js +1283 -98
- package/dist-cjs/runtimeConfig.js +0 -2
- 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/endpoints.js +1 -0
- package/dist-es/models/models_0.js +160 -40
- package/dist-es/protocols/Aws_json1_1.js +1367 -138
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/Forecast.d.ts +306 -40
- 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/CreatePredictorBacktestExportJobCommand.d.ts +4 -4
- 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/DeletePredictorCommand.d.ts +2 -3
- 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/DescribePredictorBacktestExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribePredictorCommand.d.ts +5 -1
- package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
- package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
- package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +4 -4
- package/dist-types/commands/ListPredictorsCommand.d.ts +5 -5
- package/dist-types/commands/StopResourceCommand.d.ts +9 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +2109 -495
- 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 +492 -83
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +36 -43
|
@@ -1,93 +1,415 @@
|
|
|
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, set <code>CountryCode</code> to 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
|
-
* <p>The optional metadata that you apply to a resource to help you categorize and organize
|
|
403
|
+
* <p>The optional metadata that you apply to a resource to help you categorize and organize
|
|
404
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
84
405
|
* <p>The following basic restrictions apply to tags:</p>
|
|
85
406
|
* <ul>
|
|
86
407
|
* <li>
|
|
87
408
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
88
409
|
* </li>
|
|
89
410
|
* <li>
|
|
90
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
411
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
412
|
+
* value.</p>
|
|
91
413
|
* </li>
|
|
92
414
|
* <li>
|
|
93
415
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -96,31 +418,286 @@ export declare namespace Schema {
|
|
|
96
418
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
97
419
|
* </li>
|
|
98
420
|
* <li>
|
|
99
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
421
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
422
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
423
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
424
|
+
* - = . _ : / @.</p>
|
|
100
425
|
* </li>
|
|
101
426
|
* <li>
|
|
102
427
|
* <p>Tag keys and values are case sensitive.</p>
|
|
103
428
|
* </li>
|
|
104
429
|
* <li>
|
|
105
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
430
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
431
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
432
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
433
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
434
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
435
|
+
* not count against your tags per resource limit.</p>
|
|
106
436
|
* </li>
|
|
107
437
|
* </ul>
|
|
108
438
|
*/
|
|
109
439
|
export interface Tag {
|
|
110
440
|
/**
|
|
111
|
-
* <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label
|
|
441
|
+
* <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label
|
|
442
|
+
* that acts like a category for more specific tag values.</p>
|
|
443
|
+
*/
|
|
444
|
+
Key: string | undefined;
|
|
445
|
+
/**
|
|
446
|
+
* <p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a
|
|
447
|
+
* descriptor within a tag category (key).</p>
|
|
448
|
+
*/
|
|
449
|
+
Value: string | undefined;
|
|
450
|
+
}
|
|
451
|
+
export declare namespace Tag {
|
|
452
|
+
/**
|
|
453
|
+
* @internal
|
|
454
|
+
*/
|
|
455
|
+
const filterSensitiveLog: (obj: Tag) => any;
|
|
456
|
+
}
|
|
457
|
+
export interface CreateAutoPredictorRequest {
|
|
458
|
+
/**
|
|
459
|
+
* <p>A unique name for the predictor</p>
|
|
460
|
+
*/
|
|
461
|
+
PredictorName: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
464
|
+
* the prediction length.</p>
|
|
465
|
+
*/
|
|
466
|
+
ForecastHorizon?: number;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The forecast types used to train a predictor. You can specify up to five forecast
|
|
469
|
+
* types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
470
|
+
* higher. You can also specify the mean forecast with <code>mean</code>.</p>
|
|
471
|
+
*/
|
|
472
|
+
ForecastTypes?: string[];
|
|
473
|
+
/**
|
|
474
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
475
|
+
* forecast.</p>
|
|
476
|
+
* <p>For example, if you are generating forecasts for item sales across all your stores,
|
|
477
|
+
* and your dataset contains a <code>store_id</code> field, you would specify
|
|
478
|
+
* <code>store_id</code> as a dimension to group sales forecasts for each store.</p>
|
|
479
|
+
*/
|
|
480
|
+
ForecastDimensions?: string[];
|
|
481
|
+
/**
|
|
482
|
+
* <p>The frequency of predictions in a forecast.</p>
|
|
483
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
484
|
+
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
485
|
+
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
486
|
+
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
487
|
+
* frequency.</p>
|
|
488
|
+
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
489
|
+
* RELATED_TIME_SERIES dataset frequency.</p>
|
|
490
|
+
*/
|
|
491
|
+
ForecastFrequency?: string;
|
|
492
|
+
/**
|
|
493
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
494
|
+
*/
|
|
495
|
+
DataConfig?: DataConfig;
|
|
496
|
+
/**
|
|
497
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
498
|
+
* access the key. You can specify this optional object in the
|
|
499
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
500
|
+
*/
|
|
501
|
+
EncryptionConfig?: EncryptionConfig;
|
|
502
|
+
/**
|
|
503
|
+
* <p>The ARN of the predictor to retrain or upgrade. This parameter is only used when
|
|
504
|
+
* retraining or upgrading a predictor. When creating a new predictor, do not specify a
|
|
505
|
+
* value for this parameter.</p>
|
|
506
|
+
* <p>When upgrading or retraining a predictor, only specify values for the
|
|
507
|
+
* <code>ReferencePredictorArn</code> and <code>PredictorName</code>. The value for
|
|
508
|
+
* <code>PredictorName</code> must be a unique predictor name.</p>
|
|
509
|
+
*/
|
|
510
|
+
ReferencePredictorArn?: string;
|
|
511
|
+
/**
|
|
512
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
513
|
+
*/
|
|
514
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
515
|
+
/**
|
|
516
|
+
* <p>Create an Explainability resource for the predictor.</p>
|
|
517
|
+
*/
|
|
518
|
+
ExplainPredictor?: boolean;
|
|
519
|
+
/**
|
|
520
|
+
* <p>Optional metadata to help you categorize and organize your predictors. Each tag
|
|
521
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
522
|
+
* are case sensitive.</p>
|
|
523
|
+
* <p>The following restrictions apply to tags:</p>
|
|
524
|
+
* <ul>
|
|
525
|
+
* <li>
|
|
526
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
527
|
+
* value.</p>
|
|
528
|
+
* </li>
|
|
529
|
+
* <li>
|
|
530
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
531
|
+
* </li>
|
|
532
|
+
* <li>
|
|
533
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
534
|
+
* </li>
|
|
535
|
+
* <li>
|
|
536
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
537
|
+
* </li>
|
|
538
|
+
* <li>
|
|
539
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
540
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
541
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
542
|
+
* </li>
|
|
543
|
+
* <li>
|
|
544
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
545
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
546
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
547
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
548
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
549
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
550
|
+
* </li>
|
|
551
|
+
* </ul>
|
|
552
|
+
*/
|
|
553
|
+
Tags?: Tag[];
|
|
554
|
+
}
|
|
555
|
+
export declare namespace CreateAutoPredictorRequest {
|
|
556
|
+
/**
|
|
557
|
+
* @internal
|
|
558
|
+
*/
|
|
559
|
+
const filterSensitiveLog: (obj: CreateAutoPredictorRequest) => any;
|
|
560
|
+
}
|
|
561
|
+
export interface CreateAutoPredictorResponse {
|
|
562
|
+
/**
|
|
563
|
+
* <p>The Amazon Resource Name (ARN) of the predictor.</p>
|
|
564
|
+
*/
|
|
565
|
+
PredictorArn?: string;
|
|
566
|
+
}
|
|
567
|
+
export declare namespace CreateAutoPredictorResponse {
|
|
568
|
+
/**
|
|
569
|
+
* @internal
|
|
570
|
+
*/
|
|
571
|
+
const filterSensitiveLog: (obj: CreateAutoPredictorResponse) => any;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* <p>We can't process the request because it includes an invalid value or a value that exceeds
|
|
575
|
+
* the valid range.</p>
|
|
576
|
+
*/
|
|
577
|
+
export interface InvalidInputException extends __SmithyException, $MetadataBearer {
|
|
578
|
+
name: "InvalidInputException";
|
|
579
|
+
$fault: "client";
|
|
580
|
+
Message?: string;
|
|
581
|
+
}
|
|
582
|
+
export declare namespace InvalidInputException {
|
|
583
|
+
/**
|
|
584
|
+
* @internal
|
|
585
|
+
*/
|
|
586
|
+
const filterSensitiveLog: (obj: InvalidInputException) => any;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* <p>The limit on the number of resources per account has been exceeded.</p>
|
|
590
|
+
*/
|
|
591
|
+
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
592
|
+
name: "LimitExceededException";
|
|
593
|
+
$fault: "client";
|
|
594
|
+
Message?: string;
|
|
595
|
+
}
|
|
596
|
+
export declare namespace LimitExceededException {
|
|
597
|
+
/**
|
|
598
|
+
* @internal
|
|
599
|
+
*/
|
|
600
|
+
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* <p>There is already a resource with this name. Try again with a different name.</p>
|
|
604
|
+
*/
|
|
605
|
+
export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
|
|
606
|
+
name: "ResourceAlreadyExistsException";
|
|
607
|
+
$fault: "client";
|
|
608
|
+
Message?: string;
|
|
609
|
+
}
|
|
610
|
+
export declare namespace ResourceAlreadyExistsException {
|
|
611
|
+
/**
|
|
612
|
+
* @internal
|
|
613
|
+
*/
|
|
614
|
+
const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* <p>The specified resource is in use.</p>
|
|
618
|
+
*/
|
|
619
|
+
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
|
|
620
|
+
name: "ResourceInUseException";
|
|
621
|
+
$fault: "client";
|
|
622
|
+
Message?: string;
|
|
623
|
+
}
|
|
624
|
+
export declare namespace ResourceInUseException {
|
|
625
|
+
/**
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
const filterSensitiveLog: (obj: ResourceInUseException) => any;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
|
|
632
|
+
* again.</p>
|
|
633
|
+
*/
|
|
634
|
+
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
635
|
+
name: "ResourceNotFoundException";
|
|
636
|
+
$fault: "client";
|
|
637
|
+
Message?: string;
|
|
638
|
+
}
|
|
639
|
+
export declare namespace ResourceNotFoundException {
|
|
640
|
+
/**
|
|
641
|
+
* @internal
|
|
642
|
+
*/
|
|
643
|
+
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
644
|
+
}
|
|
645
|
+
export declare enum DatasetType {
|
|
646
|
+
ITEM_METADATA = "ITEM_METADATA",
|
|
647
|
+
RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
|
|
648
|
+
TARGET_TIME_SERIES = "TARGET_TIME_SERIES"
|
|
649
|
+
}
|
|
650
|
+
export declare enum Domain {
|
|
651
|
+
CUSTOM = "CUSTOM",
|
|
652
|
+
EC2_CAPACITY = "EC2_CAPACITY",
|
|
653
|
+
INVENTORY_PLANNING = "INVENTORY_PLANNING",
|
|
654
|
+
METRICS = "METRICS",
|
|
655
|
+
RETAIL = "RETAIL",
|
|
656
|
+
WEB_TRAFFIC = "WEB_TRAFFIC",
|
|
657
|
+
WORK_FORCE = "WORK_FORCE"
|
|
658
|
+
}
|
|
659
|
+
export declare enum AttributeType {
|
|
660
|
+
FLOAT = "float",
|
|
661
|
+
GEOLOCATION = "geolocation",
|
|
662
|
+
INTEGER = "integer",
|
|
663
|
+
STRING = "string",
|
|
664
|
+
TIMESTAMP = "timestamp"
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* <p>An attribute of a schema, which defines a dataset field. A schema attribute is required
|
|
668
|
+
* for every field in a dataset. The <a>Schema</a> object contains an array of
|
|
669
|
+
* <code>SchemaAttribute</code> objects.</p>
|
|
670
|
+
*/
|
|
671
|
+
export interface SchemaAttribute {
|
|
672
|
+
/**
|
|
673
|
+
* <p>The name of the dataset field.</p>
|
|
674
|
+
*/
|
|
675
|
+
AttributeName?: string;
|
|
676
|
+
/**
|
|
677
|
+
* <p>The data type of the field.</p>
|
|
678
|
+
*/
|
|
679
|
+
AttributeType?: AttributeType | string;
|
|
680
|
+
}
|
|
681
|
+
export declare namespace SchemaAttribute {
|
|
682
|
+
/**
|
|
683
|
+
* @internal
|
|
112
684
|
*/
|
|
113
|
-
|
|
685
|
+
const filterSensitiveLog: (obj: SchemaAttribute) => any;
|
|
686
|
+
}
|
|
687
|
+
/**
|
|
688
|
+
* <p>Defines the fields of a dataset.</p>
|
|
689
|
+
*/
|
|
690
|
+
export interface Schema {
|
|
114
691
|
/**
|
|
115
|
-
* <p>
|
|
692
|
+
* <p>An array of attributes specifying the name and type of each field in a dataset.</p>
|
|
116
693
|
*/
|
|
117
|
-
|
|
694
|
+
Attributes?: SchemaAttribute[];
|
|
118
695
|
}
|
|
119
|
-
export declare namespace
|
|
696
|
+
export declare namespace Schema {
|
|
120
697
|
/**
|
|
121
698
|
* @internal
|
|
122
699
|
*/
|
|
123
|
-
const filterSensitiveLog: (obj:
|
|
700
|
+
const filterSensitiveLog: (obj: Schema) => any;
|
|
124
701
|
}
|
|
125
702
|
export interface CreateDatasetRequest {
|
|
126
703
|
/**
|
|
@@ -162,14 +739,16 @@ export interface CreateDatasetRequest {
|
|
|
162
739
|
*/
|
|
163
740
|
EncryptionConfig?: EncryptionConfig;
|
|
164
741
|
/**
|
|
165
|
-
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
742
|
+
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
743
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
166
744
|
* <p>The following basic restrictions apply to tags:</p>
|
|
167
745
|
* <ul>
|
|
168
746
|
* <li>
|
|
169
747
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
170
748
|
* </li>
|
|
171
749
|
* <li>
|
|
172
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
750
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
751
|
+
* value.</p>
|
|
173
752
|
* </li>
|
|
174
753
|
* <li>
|
|
175
754
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -178,13 +757,21 @@ export interface CreateDatasetRequest {
|
|
|
178
757
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
179
758
|
* </li>
|
|
180
759
|
* <li>
|
|
181
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
760
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
761
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
762
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
763
|
+
* - = . _ : / @.</p>
|
|
182
764
|
* </li>
|
|
183
765
|
* <li>
|
|
184
766
|
* <p>Tag keys and values are case sensitive.</p>
|
|
185
767
|
* </li>
|
|
186
768
|
* <li>
|
|
187
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
769
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
770
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
771
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
772
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
773
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
774
|
+
* not count against your tags per resource limit.</p>
|
|
188
775
|
* </li>
|
|
189
776
|
* </ul>
|
|
190
777
|
*/
|
|
@@ -208,49 +795,6 @@ export declare namespace CreateDatasetResponse {
|
|
|
208
795
|
*/
|
|
209
796
|
const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
|
|
210
797
|
}
|
|
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
798
|
export interface CreateDatasetGroupRequest {
|
|
255
799
|
/**
|
|
256
800
|
* <p>A name for the dataset group.</p>
|
|
@@ -273,14 +817,17 @@ export interface CreateDatasetGroupRequest {
|
|
|
273
817
|
*/
|
|
274
818
|
DatasetArns?: string[];
|
|
275
819
|
/**
|
|
276
|
-
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
820
|
+
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
821
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
822
|
+
* define.</p>
|
|
277
823
|
* <p>The following basic restrictions apply to tags:</p>
|
|
278
824
|
* <ul>
|
|
279
825
|
* <li>
|
|
280
826
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
281
827
|
* </li>
|
|
282
828
|
* <li>
|
|
283
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
829
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
830
|
+
* value.</p>
|
|
284
831
|
* </li>
|
|
285
832
|
* <li>
|
|
286
833
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -289,13 +836,21 @@ export interface CreateDatasetGroupRequest {
|
|
|
289
836
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
290
837
|
* </li>
|
|
291
838
|
* <li>
|
|
292
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
839
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
840
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
841
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
842
|
+
* - = . _ : / @.</p>
|
|
293
843
|
* </li>
|
|
294
844
|
* <li>
|
|
295
845
|
* <p>Tag keys and values are case sensitive.</p>
|
|
296
846
|
* </li>
|
|
297
847
|
* <li>
|
|
298
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
848
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
849
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
850
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
851
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
852
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
853
|
+
* not count against your tags per resource limit.</p>
|
|
299
854
|
* </li>
|
|
300
855
|
* </ul>
|
|
301
856
|
*/
|
|
@@ -319,35 +874,6 @@ export declare namespace CreateDatasetGroupResponse {
|
|
|
319
874
|
*/
|
|
320
875
|
const filterSensitiveLog: (obj: CreateDatasetGroupResponse) => any;
|
|
321
876
|
}
|
|
322
|
-
/**
|
|
323
|
-
* <p>The specified resource is in use.</p>
|
|
324
|
-
*/
|
|
325
|
-
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
|
|
326
|
-
name: "ResourceInUseException";
|
|
327
|
-
$fault: "client";
|
|
328
|
-
Message?: string;
|
|
329
|
-
}
|
|
330
|
-
export declare namespace ResourceInUseException {
|
|
331
|
-
/**
|
|
332
|
-
* @internal
|
|
333
|
-
*/
|
|
334
|
-
const filterSensitiveLog: (obj: ResourceInUseException) => any;
|
|
335
|
-
}
|
|
336
|
-
/**
|
|
337
|
-
* <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
|
|
338
|
-
* again.</p>
|
|
339
|
-
*/
|
|
340
|
-
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
341
|
-
name: "ResourceNotFoundException";
|
|
342
|
-
$fault: "client";
|
|
343
|
-
Message?: string;
|
|
344
|
-
}
|
|
345
|
-
export declare namespace ResourceNotFoundException {
|
|
346
|
-
/**
|
|
347
|
-
* @internal
|
|
348
|
-
*/
|
|
349
|
-
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
350
|
-
}
|
|
351
877
|
/**
|
|
352
878
|
* <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
|
|
353
879
|
* Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This
|
|
@@ -378,13 +904,12 @@ export declare namespace S3Config {
|
|
|
378
904
|
const filterSensitiveLog: (obj: S3Config) => any;
|
|
379
905
|
}
|
|
380
906
|
/**
|
|
381
|
-
* <p>The source of your
|
|
382
|
-
* access the data and, optionally, an AWS Key Management Service (KMS) key
|
|
383
|
-
* <a>CreateDatasetImportJob</a> request.</p>
|
|
907
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
908
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
384
909
|
*/
|
|
385
910
|
export interface DataSource {
|
|
386
911
|
/**
|
|
387
|
-
* <p>The path to the
|
|
912
|
+
* <p>The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
|
|
388
913
|
* credentials to access the data.</p>
|
|
389
914
|
*/
|
|
390
915
|
S3Config: S3Config | undefined;
|
|
@@ -408,107 +933,339 @@ export interface CreateDatasetImportJobRequest {
|
|
|
408
933
|
*/
|
|
409
934
|
DatasetArn: string | undefined;
|
|
410
935
|
/**
|
|
411
|
-
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
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>
|
|
936
|
+
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
937
|
+
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
938
|
+
* <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
|
|
939
|
+
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
940
|
+
* match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a> operation.</p>
|
|
941
|
+
*/
|
|
942
|
+
DataSource: DataSource | undefined;
|
|
943
|
+
/**
|
|
944
|
+
* <p>The format of timestamps in the dataset. The format that you specify depends on the
|
|
945
|
+
* <code>DataFrequency</code> specified when the dataset was created. The following formats are
|
|
946
|
+
* supported</p>
|
|
947
|
+
* <ul>
|
|
948
|
+
* <li>
|
|
949
|
+
* <p>"yyyy-MM-dd"</p>
|
|
950
|
+
* <p>For the following data frequencies: Y, M, W, and D</p>
|
|
951
|
+
* </li>
|
|
952
|
+
* <li>
|
|
953
|
+
* <p>"yyyy-MM-dd HH:mm:ss"</p>
|
|
954
|
+
* <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,
|
|
955
|
+
* M, W, and D</p>
|
|
956
|
+
* </li>
|
|
957
|
+
* </ul>
|
|
958
|
+
* <p>If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd
|
|
959
|
+
* HH:mm:ss".</p>
|
|
960
|
+
*/
|
|
961
|
+
TimestampFormat?: string;
|
|
962
|
+
/**
|
|
963
|
+
* <p>A single time zone for every item in your dataset. This option is ideal for datasets
|
|
964
|
+
* with all timestamps within a single time zone, or if all timestamps are normalized to a
|
|
965
|
+
* single time zone. </p>
|
|
966
|
+
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
|
|
967
|
+
* API</a> for a complete list of valid time zone names.</p>
|
|
968
|
+
*/
|
|
969
|
+
TimeZone?: string;
|
|
970
|
+
/**
|
|
971
|
+
* <p>Automatically derive time zone information from the geolocation attribute. This option
|
|
972
|
+
* is ideal for datasets that contain timestamps in multiple time zones and those
|
|
973
|
+
* timestamps are expressed in local time.</p>
|
|
974
|
+
*/
|
|
975
|
+
UseGeolocationForTimeZone?: boolean;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
|
|
978
|
+
* one of two ways:</p>
|
|
979
|
+
* <ul>
|
|
980
|
+
* <li>
|
|
981
|
+
* <p>
|
|
982
|
+
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
|
|
983
|
+
* </li>
|
|
984
|
+
* <li>
|
|
985
|
+
* <p>
|
|
986
|
+
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
|
|
987
|
+
* </li>
|
|
988
|
+
* </ul>
|
|
989
|
+
*/
|
|
990
|
+
GeolocationFormat?: string;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
993
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
994
|
+
* define.</p>
|
|
995
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
996
|
+
* <ul>
|
|
997
|
+
* <li>
|
|
998
|
+
* <p>Maximum number of tags per resource - 50.</p>
|
|
999
|
+
* </li>
|
|
1000
|
+
* <li>
|
|
1001
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1002
|
+
* value.</p>
|
|
1003
|
+
* </li>
|
|
1004
|
+
* <li>
|
|
1005
|
+
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
1006
|
+
* </li>
|
|
1007
|
+
* <li>
|
|
1008
|
+
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1009
|
+
* </li>
|
|
1010
|
+
* <li>
|
|
1011
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1012
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1013
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1014
|
+
* - = . _ : / @.</p>
|
|
1015
|
+
* </li>
|
|
1016
|
+
* <li>
|
|
1017
|
+
* <p>Tag keys and values are case sensitive.</p>
|
|
1018
|
+
* </li>
|
|
1019
|
+
* <li>
|
|
1020
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1021
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1022
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1023
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1024
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1025
|
+
* not count against your tags per resource limit.</p>
|
|
1026
|
+
* </li>
|
|
1027
|
+
* </ul>
|
|
1028
|
+
*/
|
|
1029
|
+
Tags?: Tag[];
|
|
1030
|
+
}
|
|
1031
|
+
export declare namespace CreateDatasetImportJobRequest {
|
|
1032
|
+
/**
|
|
1033
|
+
* @internal
|
|
1034
|
+
*/
|
|
1035
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobRequest) => any;
|
|
1036
|
+
}
|
|
1037
|
+
export interface CreateDatasetImportJobResponse {
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
|
|
1040
|
+
*/
|
|
1041
|
+
DatasetImportJobArn?: string;
|
|
1042
|
+
}
|
|
1043
|
+
export declare namespace CreateDatasetImportJobResponse {
|
|
1044
|
+
/**
|
|
1045
|
+
* @internal
|
|
1046
|
+
*/
|
|
1047
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobResponse) => any;
|
|
1048
|
+
}
|
|
1049
|
+
export declare enum TimePointGranularity {
|
|
1050
|
+
ALL = "ALL",
|
|
1051
|
+
SPECIFIC = "SPECIFIC"
|
|
1052
|
+
}
|
|
1053
|
+
export declare enum TimeSeriesGranularity {
|
|
1054
|
+
ALL = "ALL",
|
|
1055
|
+
SPECIFIC = "SPECIFIC"
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The ExplainabilityConfig data type defines the number of time series and time points
|
|
1059
|
+
* included in <a>CreateExplainability</a>.</p>
|
|
1060
|
+
* <p>If you provide a predictor ARN for <code>ResourceArn</code>, you must set both
|
|
1061
|
+
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
|
|
1062
|
+
* When creating Predictor Explainability, Amazon Forecast considers all time series and
|
|
1063
|
+
* time points.</p>
|
|
1064
|
+
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set <code>TimePointGranularity</code> and
|
|
1065
|
+
* <code>TimeSeriesGranularity</code> to either “ALL” or “Specific”.</p>
|
|
1066
|
+
*/
|
|
1067
|
+
export interface ExplainabilityConfig {
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>To create an Explainability for all time series in your datasets, use
|
|
1070
|
+
* <code>ALL</code>. To create an Explainability for specific time series in your datasets,
|
|
1071
|
+
* use <code>SPECIFIC</code>.</p>
|
|
1072
|
+
* <p>Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location
|
|
1073
|
+
* within the <a>DataDestination</a> data type.</p>
|
|
1074
|
+
*/
|
|
1075
|
+
TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>To create an Explainability for all time points in your forecast horizon, use
|
|
1078
|
+
* <code>ALL</code>. To create an Explainability for specific time points in your
|
|
1079
|
+
* forecast horizon, use <code>SPECIFIC</code>.</p>
|
|
1080
|
+
* <p>Specify time points with the <code>StartDateTime</code> and <code>EndDateTime</code>
|
|
1081
|
+
* parameters within the <a>CreateExplainability</a> operation.</p>
|
|
1082
|
+
*/
|
|
1083
|
+
TimePointGranularity: TimePointGranularity | string | undefined;
|
|
1084
|
+
}
|
|
1085
|
+
export declare namespace ExplainabilityConfig {
|
|
1086
|
+
/**
|
|
1087
|
+
* @internal
|
|
1088
|
+
*/
|
|
1089
|
+
const filterSensitiveLog: (obj: ExplainabilityConfig) => any;
|
|
1090
|
+
}
|
|
1091
|
+
export interface CreateExplainabilityRequest {
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>A unique name for the Explainability.</p>
|
|
1094
|
+
*/
|
|
1095
|
+
ExplainabilityName: string | undefined;
|
|
1096
|
+
/**
|
|
1097
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
1098
|
+
* Explainability.</p>
|
|
1099
|
+
*/
|
|
1100
|
+
ResourceArn: string | undefined;
|
|
1101
|
+
/**
|
|
1102
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
1103
|
+
* for the Explainability.</p>
|
|
1104
|
+
*/
|
|
1105
|
+
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1108
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
1109
|
+
*/
|
|
1110
|
+
DataSource?: DataSource;
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>Defines the fields of a dataset.</p>
|
|
1113
|
+
*/
|
|
1114
|
+
Schema?: Schema;
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>Create an Expainability visualization that is viewable within the AWS console.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
EnableVisualization?: boolean;
|
|
1119
|
+
/**
|
|
1120
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1121
|
+
* point for the Explainability.</p>
|
|
1122
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1123
|
+
*/
|
|
1124
|
+
StartDateTime?: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1127
|
+
* time point for the Explainability.</p>
|
|
1128
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1129
|
+
*/
|
|
1130
|
+
EndDateTime?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1133
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1134
|
+
* are case sensitive.</p>
|
|
1135
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1136
|
+
* <ul>
|
|
1137
|
+
* <li>
|
|
1138
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1139
|
+
* value.</p>
|
|
1140
|
+
* </li>
|
|
1141
|
+
* <li>
|
|
1142
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
1143
|
+
* </li>
|
|
1144
|
+
* <li>
|
|
1145
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1146
|
+
* </li>
|
|
1147
|
+
* <li>
|
|
1148
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1149
|
+
* </li>
|
|
1150
|
+
* <li>
|
|
1151
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1152
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1153
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
1154
|
+
* </li>
|
|
1155
|
+
* <li>
|
|
1156
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1157
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1158
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1159
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1160
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1161
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
1162
|
+
* </li>
|
|
1163
|
+
* </ul>
|
|
1164
|
+
*/
|
|
1165
|
+
Tags?: Tag[];
|
|
1166
|
+
}
|
|
1167
|
+
export declare namespace CreateExplainabilityRequest {
|
|
1168
|
+
/**
|
|
1169
|
+
* @internal
|
|
1170
|
+
*/
|
|
1171
|
+
const filterSensitiveLog: (obj: CreateExplainabilityRequest) => any;
|
|
1172
|
+
}
|
|
1173
|
+
export interface CreateExplainabilityResponse {
|
|
1174
|
+
/**
|
|
1175
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
1176
|
+
*/
|
|
1177
|
+
ExplainabilityArn?: string;
|
|
1178
|
+
}
|
|
1179
|
+
export declare namespace CreateExplainabilityResponse {
|
|
1180
|
+
/**
|
|
1181
|
+
* @internal
|
|
1182
|
+
*/
|
|
1183
|
+
const filterSensitiveLog: (obj: CreateExplainabilityResponse) => any;
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1187
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
1188
|
+
*/
|
|
1189
|
+
export interface DataDestination {
|
|
1190
|
+
/**
|
|
1191
|
+
* <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the
|
|
1192
|
+
* bucket.</p>
|
|
416
1193
|
*/
|
|
417
|
-
|
|
1194
|
+
S3Config: S3Config | undefined;
|
|
1195
|
+
}
|
|
1196
|
+
export declare namespace DataDestination {
|
|
418
1197
|
/**
|
|
419
|
-
*
|
|
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>
|
|
1198
|
+
* @internal
|
|
435
1199
|
*/
|
|
436
|
-
|
|
1200
|
+
const filterSensitiveLog: (obj: DataDestination) => any;
|
|
1201
|
+
}
|
|
1202
|
+
export interface CreateExplainabilityExportRequest {
|
|
437
1203
|
/**
|
|
438
|
-
* <p>A
|
|
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>
|
|
1204
|
+
* <p>A unique name for the Explainability export.</p>
|
|
443
1205
|
*/
|
|
444
|
-
|
|
1206
|
+
ExplainabilityExportName: string | undefined;
|
|
445
1207
|
/**
|
|
446
|
-
* <p>
|
|
447
|
-
* is ideal for datasets that contain timestamps in multiple time zones and those
|
|
448
|
-
* timestamps are expressed in local time.</p>
|
|
1208
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
|
|
449
1209
|
*/
|
|
450
|
-
|
|
1210
|
+
ExplainabilityArn: string | undefined;
|
|
451
1211
|
/**
|
|
452
|
-
* <p>The
|
|
453
|
-
*
|
|
454
|
-
* <ul>
|
|
455
|
-
* <li>
|
|
456
|
-
* <p>
|
|
457
|
-
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
|
|
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>
|
|
1212
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1213
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
464
1214
|
*/
|
|
465
|
-
|
|
1215
|
+
Destination: DataDestination | undefined;
|
|
466
1216
|
/**
|
|
467
|
-
* <p>
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
* </li>
|
|
1217
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1218
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1219
|
+
* are case sensitive.</p>
|
|
1220
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1221
|
+
* <ul>
|
|
473
1222
|
* <li>
|
|
474
|
-
*
|
|
1223
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1224
|
+
* value.</p>
|
|
475
1225
|
* </li>
|
|
476
1226
|
* <li>
|
|
477
|
-
*
|
|
1227
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
478
1228
|
* </li>
|
|
479
1229
|
* <li>
|
|
480
|
-
*
|
|
1230
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
481
1231
|
* </li>
|
|
482
1232
|
* <li>
|
|
483
|
-
*
|
|
1233
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
484
1234
|
* </li>
|
|
485
1235
|
* <li>
|
|
486
|
-
*
|
|
1236
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1237
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1238
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
487
1239
|
* </li>
|
|
488
1240
|
* <li>
|
|
489
|
-
*
|
|
1241
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1242
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1243
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1244
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1245
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1246
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
490
1247
|
* </li>
|
|
491
1248
|
* </ul>
|
|
492
1249
|
*/
|
|
493
1250
|
Tags?: Tag[];
|
|
494
1251
|
}
|
|
495
|
-
export declare namespace
|
|
1252
|
+
export declare namespace CreateExplainabilityExportRequest {
|
|
496
1253
|
/**
|
|
497
1254
|
* @internal
|
|
498
1255
|
*/
|
|
499
|
-
const filterSensitiveLog: (obj:
|
|
1256
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportRequest) => any;
|
|
500
1257
|
}
|
|
501
|
-
export interface
|
|
1258
|
+
export interface CreateExplainabilityExportResponse {
|
|
502
1259
|
/**
|
|
503
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1260
|
+
* <p>The Amazon Resource Name (ARN) of the export.</p>
|
|
504
1261
|
*/
|
|
505
|
-
|
|
1262
|
+
ExplainabilityExportArn?: string;
|
|
506
1263
|
}
|
|
507
|
-
export declare namespace
|
|
1264
|
+
export declare namespace CreateExplainabilityExportResponse {
|
|
508
1265
|
/**
|
|
509
1266
|
* @internal
|
|
510
1267
|
*/
|
|
511
|
-
const filterSensitiveLog: (obj:
|
|
1268
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
|
|
512
1269
|
}
|
|
513
1270
|
export interface CreateForecastRequest {
|
|
514
1271
|
/**
|
|
@@ -528,14 +1285,16 @@ export interface CreateForecastRequest {
|
|
|
528
1285
|
*/
|
|
529
1286
|
ForecastTypes?: string[];
|
|
530
1287
|
/**
|
|
531
|
-
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1288
|
+
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1289
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
532
1290
|
* <p>The following basic restrictions apply to tags:</p>
|
|
533
1291
|
* <ul>
|
|
534
1292
|
* <li>
|
|
535
1293
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
536
1294
|
* </li>
|
|
537
1295
|
* <li>
|
|
538
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1296
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1297
|
+
* value.</p>
|
|
539
1298
|
* </li>
|
|
540
1299
|
* <li>
|
|
541
1300
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -544,13 +1303,21 @@ export interface CreateForecastRequest {
|
|
|
544
1303
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
545
1304
|
* </li>
|
|
546
1305
|
* <li>
|
|
547
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1306
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1307
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1308
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1309
|
+
* - = . _ : / @.</p>
|
|
548
1310
|
* </li>
|
|
549
1311
|
* <li>
|
|
550
1312
|
* <p>Tag keys and values are case sensitive.</p>
|
|
551
1313
|
* </li>
|
|
552
1314
|
* <li>
|
|
553
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1315
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1316
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1317
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1318
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1319
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1320
|
+
* not count against your tags per resource limit.</p>
|
|
554
1321
|
* </li>
|
|
555
1322
|
* </ul>
|
|
556
1323
|
*/
|
|
@@ -574,23 +1341,6 @@ export declare namespace CreateForecastResponse {
|
|
|
574
1341
|
*/
|
|
575
1342
|
const filterSensitiveLog: (obj: CreateForecastResponse) => any;
|
|
576
1343
|
}
|
|
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
1344
|
export interface CreateForecastExportJobRequest {
|
|
595
1345
|
/**
|
|
596
1346
|
* <p>The name for the forecast export job.</p>
|
|
@@ -609,14 +1359,17 @@ export interface CreateForecastExportJobRequest {
|
|
|
609
1359
|
*/
|
|
610
1360
|
Destination: DataDestination | undefined;
|
|
611
1361
|
/**
|
|
612
|
-
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1362
|
+
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1363
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
1364
|
+
* define.</p>
|
|
613
1365
|
* <p>The following basic restrictions apply to tags:</p>
|
|
614
1366
|
* <ul>
|
|
615
1367
|
* <li>
|
|
616
1368
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
617
1369
|
* </li>
|
|
618
1370
|
* <li>
|
|
619
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1371
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1372
|
+
* value.</p>
|
|
620
1373
|
* </li>
|
|
621
1374
|
* <li>
|
|
622
1375
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -625,13 +1378,21 @@ export interface CreateForecastExportJobRequest {
|
|
|
625
1378
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
626
1379
|
* </li>
|
|
627
1380
|
* <li>
|
|
628
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1381
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1382
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1383
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1384
|
+
* - = . _ : / @.</p>
|
|
629
1385
|
* </li>
|
|
630
1386
|
* <li>
|
|
631
1387
|
* <p>Tag keys and values are case sensitive.</p>
|
|
632
1388
|
* </li>
|
|
633
1389
|
* <li>
|
|
634
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1390
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1391
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1392
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1393
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1394
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1395
|
+
* not count against your tags per resource limit.</p>
|
|
635
1396
|
* </li>
|
|
636
1397
|
* </ul>
|
|
637
1398
|
*/
|
|
@@ -656,6 +1417,7 @@ export declare namespace CreateForecastExportJobResponse {
|
|
|
656
1417
|
const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
|
|
657
1418
|
}
|
|
658
1419
|
export declare enum AutoMLOverrideStrategy {
|
|
1420
|
+
AccuracyOptimized = "AccuracyOptimized",
|
|
659
1421
|
LatencyOptimized = "LatencyOptimized"
|
|
660
1422
|
}
|
|
661
1423
|
/**
|
|
@@ -691,10 +1453,10 @@ export declare enum FeaturizationMethodName {
|
|
|
691
1453
|
filling = "filling"
|
|
692
1454
|
}
|
|
693
1455
|
/**
|
|
694
|
-
* <p>Provides information about the method that featurizes (transforms) a dataset field.
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
1456
|
+
* <p>Provides information about the method that featurizes (transforms) a dataset field. The
|
|
1457
|
+
* method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. </p>
|
|
1458
|
+
* <p>The following is an example of how you specify a <code>FeaturizationMethod</code>
|
|
1459
|
+
* object.</p>
|
|
698
1460
|
* <p>
|
|
699
1461
|
* <code>{</code>
|
|
700
1462
|
* </p>
|
|
@@ -702,7 +1464,8 @@ export declare enum FeaturizationMethodName {
|
|
|
702
1464
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
703
1465
|
* </p>
|
|
704
1466
|
* <p>
|
|
705
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1467
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1468
|
+
* "backfill": "zero"}</code>
|
|
706
1469
|
* </p>
|
|
707
1470
|
* <p>
|
|
708
1471
|
* <code>}</code>
|
|
@@ -714,14 +1477,17 @@ export interface FeaturizationMethod {
|
|
|
714
1477
|
*/
|
|
715
1478
|
FeaturizationMethodName: FeaturizationMethodName | string | undefined;
|
|
716
1479
|
/**
|
|
717
|
-
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
718
|
-
* Related Time Series attributes do not accept
|
|
719
|
-
*
|
|
720
|
-
*
|
|
1480
|
+
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
1481
|
+
* these parameters to override the default values. Related Time Series attributes do not accept
|
|
1482
|
+
* aggregation parameters.</p>
|
|
1483
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
1484
|
+
* featurization method for a <b>Target Time Series</b> dataset. Bold
|
|
1485
|
+
* signifies the default value.</p>
|
|
721
1486
|
* <ul>
|
|
722
1487
|
* <li>
|
|
723
1488
|
* <p>
|
|
724
|
-
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1489
|
+
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1490
|
+
* <code>first</code>, <code>min</code>, <code>max</code>
|
|
725
1491
|
* </p>
|
|
726
1492
|
* </li>
|
|
727
1493
|
* <li>
|
|
@@ -731,12 +1497,16 @@ export interface FeaturizationMethod {
|
|
|
731
1497
|
* </li>
|
|
732
1498
|
* <li>
|
|
733
1499
|
* <p>
|
|
734
|
-
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1500
|
+
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1501
|
+
* a number), <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1502
|
+
* <code>max</code>
|
|
735
1503
|
* </p>
|
|
736
1504
|
* </li>
|
|
737
1505
|
* <li>
|
|
738
1506
|
* <p>
|
|
739
|
-
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1507
|
+
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1508
|
+
* <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1509
|
+
* <code>max</code>
|
|
740
1510
|
* </p>
|
|
741
1511
|
* </li>
|
|
742
1512
|
* </ul>
|
|
@@ -745,17 +1515,20 @@ export interface FeaturizationMethod {
|
|
|
745
1515
|
* <ul>
|
|
746
1516
|
* <li>
|
|
747
1517
|
* <p>
|
|
748
|
-
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1518
|
+
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1519
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
749
1520
|
* </p>
|
|
750
1521
|
* </li>
|
|
751
1522
|
* <li>
|
|
752
1523
|
* <p>
|
|
753
|
-
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1524
|
+
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1525
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
754
1526
|
* </p>
|
|
755
1527
|
* </li>
|
|
756
1528
|
* <li>
|
|
757
1529
|
* <p>
|
|
758
|
-
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1530
|
+
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1531
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
759
1532
|
* </p>
|
|
760
1533
|
* </li>
|
|
761
1534
|
* </ul>
|
|
@@ -775,8 +1548,12 @@ export declare namespace FeaturizationMethod {
|
|
|
775
1548
|
const filterSensitiveLog: (obj: FeaturizationMethod) => any;
|
|
776
1549
|
}
|
|
777
1550
|
/**
|
|
778
|
-
* <
|
|
779
|
-
*
|
|
1551
|
+
* <note>
|
|
1552
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1553
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1554
|
+
* </note>
|
|
1555
|
+
* <p>Provides featurization (transformation) information for a dataset field. This object is
|
|
1556
|
+
* part of the <a>FeaturizationConfig</a> object.</p>
|
|
780
1557
|
* <p>For example:</p>
|
|
781
1558
|
* <p>
|
|
782
1559
|
* <code>{</code>
|
|
@@ -792,7 +1569,8 @@ export declare namespace FeaturizationMethod {
|
|
|
792
1569
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
793
1570
|
* </p>
|
|
794
1571
|
* <p>
|
|
795
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1572
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1573
|
+
* "nan"}</code>
|
|
796
1574
|
* </p>
|
|
797
1575
|
* <p>
|
|
798
1576
|
* <code>} ]</code>
|
|
@@ -803,11 +1581,11 @@ export declare namespace FeaturizationMethod {
|
|
|
803
1581
|
*/
|
|
804
1582
|
export interface Featurization {
|
|
805
1583
|
/**
|
|
806
|
-
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
* <code>
|
|
810
|
-
*
|
|
1584
|
+
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1585
|
+
* Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the
|
|
1586
|
+
* <code>RELATED_TIME_SERIES</code> datasets. For example, for the <code>RETAIL</code> domain,
|
|
1587
|
+
* the target is <code>demand</code>, and for the <code>CUSTOM</code> domain, the target is
|
|
1588
|
+
* <code>target_value</code>. For more information, see <a>howitworks-missing-values</a>.</p>
|
|
811
1589
|
*/
|
|
812
1590
|
AttributeName: string | undefined;
|
|
813
1591
|
/**
|
|
@@ -823,25 +1601,29 @@ export declare namespace Featurization {
|
|
|
823
1601
|
const filterSensitiveLog: (obj: Featurization) => any;
|
|
824
1602
|
}
|
|
825
1603
|
/**
|
|
826
|
-
* <
|
|
827
|
-
*
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
* <p>
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
* featurization
|
|
1604
|
+
* <note>
|
|
1605
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1606
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1607
|
+
* </note>
|
|
1608
|
+
* <p>In a <a>CreatePredictor</a> operation, the specified algorithm trains a model
|
|
1609
|
+
* using the specified dataset group. You can optionally tell the operation to modify data fields
|
|
1610
|
+
* prior to training a model. These modifications are referred to as
|
|
1611
|
+
* <i>featurization</i>.</p>
|
|
1612
|
+
* <p>You define featurization using the <code>FeaturizationConfig</code> object. You specify an
|
|
1613
|
+
* array of transformations, one for each field that you want to featurize. You then include the
|
|
1614
|
+
* <code>FeaturizationConfig</code> object in your <code>CreatePredictor</code> request.
|
|
1615
|
+
* Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> and
|
|
1616
|
+
* <code>RELATED_TIME_SERIES</code> datasets before model training.</p>
|
|
1617
|
+
* <p>You can create multiple featurization configurations. For example, you might call the
|
|
1618
|
+
* <code>CreatePredictor</code> operation twice by specifying different featurization
|
|
1619
|
+
* configurations.</p>
|
|
838
1620
|
*/
|
|
839
1621
|
export interface FeaturizationConfig {
|
|
840
1622
|
/**
|
|
841
1623
|
* <p>The frequency of predictions in a forecast.</p>
|
|
842
1624
|
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),
|
|
843
|
-
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
844
|
-
*
|
|
1625
|
+
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
|
|
1626
|
+
* "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
845
1627
|
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
846
1628
|
* frequency.</p>
|
|
847
1629
|
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
@@ -849,14 +1631,16 @@ export interface FeaturizationConfig {
|
|
|
849
1631
|
*/
|
|
850
1632
|
ForecastFrequency: string | undefined;
|
|
851
1633
|
/**
|
|
852
|
-
* <p>An array of dimension (field) names that specify how to group the generated
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
1634
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1635
|
+
* forecast.</p>
|
|
1636
|
+
* <p>For example, suppose that you are generating a forecast for item sales across all of your
|
|
1637
|
+
* stores, and your dataset contains a <code>store_id</code> field. If you want the sales
|
|
1638
|
+
* forecast for each item by store, you would specify <code>store_id</code> as the
|
|
1639
|
+
* dimension.</p>
|
|
856
1640
|
* <p>All forecast dimensions specified in the <code>TARGET_TIME_SERIES</code> dataset don't
|
|
857
|
-
* need to be specified in the <code>CreatePredictor</code> request.
|
|
858
|
-
*
|
|
859
|
-
*
|
|
1641
|
+
* need to be specified in the <code>CreatePredictor</code> request. All forecast dimensions
|
|
1642
|
+
* specified in the <code>RELATED_TIME_SERIES</code> dataset must be specified in the
|
|
1643
|
+
* <code>CreatePredictor</code> request.</p>
|
|
860
1644
|
*/
|
|
861
1645
|
ForecastDimensions?: string[];
|
|
862
1646
|
/**
|
|
@@ -1057,7 +1841,11 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1057
1841
|
const filterSensitiveLog: (obj: HyperParameterTuningJobConfig) => any;
|
|
1058
1842
|
}
|
|
1059
1843
|
/**
|
|
1060
|
-
* <
|
|
1844
|
+
* <note>
|
|
1845
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1846
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AdditionalDataset</a>.</p>
|
|
1847
|
+
* </note>
|
|
1848
|
+
* <p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object. Forecast supports the Weather Index and Holidays built-in
|
|
1061
1849
|
* featurizations.</p>
|
|
1062
1850
|
* <p>
|
|
1063
1851
|
* <b>Weather Index</b>
|
|
@@ -1065,7 +1853,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1065
1853
|
* <p>The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and
|
|
1066
1854
|
* projected weather information into your model. The Weather Index supplements your datasets
|
|
1067
1855
|
* 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
|
|
1856
|
+
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast Weather
|
|
1857
|
+
* Index</a>.</p>
|
|
1069
1858
|
* <p>
|
|
1070
1859
|
* <b>Holidays</b>
|
|
1071
1860
|
* </p>
|
|
@@ -1076,7 +1865,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1076
1865
|
*/
|
|
1077
1866
|
export interface SupplementaryFeature {
|
|
1078
1867
|
/**
|
|
1079
|
-
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1868
|
+
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1869
|
+
* <code>"weather"</code>.</p>
|
|
1080
1870
|
*/
|
|
1081
1871
|
Name: string | undefined;
|
|
1082
1872
|
/**
|
|
@@ -1300,7 +2090,11 @@ export declare namespace SupplementaryFeature {
|
|
|
1300
2090
|
const filterSensitiveLog: (obj: SupplementaryFeature) => any;
|
|
1301
2091
|
}
|
|
1302
2092
|
/**
|
|
1303
|
-
* <
|
|
2093
|
+
* <note>
|
|
2094
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
2095
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>DataConfig</a>.</p>
|
|
2096
|
+
* </note>
|
|
2097
|
+
* <p>The data used to train a predictor. The data includes a dataset group and any
|
|
1304
2098
|
* supplementary features. You specify this object in the <a>CreatePredictor</a>
|
|
1305
2099
|
* request.</p>
|
|
1306
2100
|
*/
|
|
@@ -1321,13 +2115,6 @@ export declare namespace InputDataConfig {
|
|
|
1321
2115
|
*/
|
|
1322
2116
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
1323
2117
|
}
|
|
1324
|
-
export declare enum OptimizationMetric {
|
|
1325
|
-
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
1326
|
-
MAPE = "MAPE",
|
|
1327
|
-
MASE = "MASE",
|
|
1328
|
-
RMSE = "RMSE",
|
|
1329
|
-
WAPE = "WAPE"
|
|
1330
|
-
}
|
|
1331
2118
|
export interface CreatePredictorRequest {
|
|
1332
2119
|
/**
|
|
1333
2120
|
* <p>A name for the predictor.</p>
|
|
@@ -1384,10 +2171,9 @@ export interface CreatePredictorRequest {
|
|
|
1384
2171
|
*/
|
|
1385
2172
|
ForecastHorizon: number | undefined;
|
|
1386
2173
|
/**
|
|
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>
|
|
2174
|
+
* <p>Specifies the forecast types used to train a predictor. You can specify up to five
|
|
2175
|
+
* forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
2176
|
+
* higher. You can also specify the mean forecast with <code>mean</code>. </p>
|
|
1391
2177
|
* <p>The default value is <code>["0.10", "0.50", "0.9"]</code>.</p>
|
|
1392
2178
|
*/
|
|
1393
2179
|
ForecastTypes?: string[];
|
|
@@ -1471,14 +2257,16 @@ export interface CreatePredictorRequest {
|
|
|
1471
2257
|
*/
|
|
1472
2258
|
EncryptionConfig?: EncryptionConfig;
|
|
1473
2259
|
/**
|
|
1474
|
-
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2260
|
+
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2261
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
1475
2262
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1476
2263
|
* <ul>
|
|
1477
2264
|
* <li>
|
|
1478
2265
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1479
2266
|
* </li>
|
|
1480
2267
|
* <li>
|
|
1481
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2268
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2269
|
+
* value.</p>
|
|
1482
2270
|
* </li>
|
|
1483
2271
|
* <li>
|
|
1484
2272
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1487,13 +2275,21 @@ export interface CreatePredictorRequest {
|
|
|
1487
2275
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1488
2276
|
* </li>
|
|
1489
2277
|
* <li>
|
|
1490
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2278
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2279
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
2280
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
2281
|
+
* - = . _ : / @.</p>
|
|
1491
2282
|
* </li>
|
|
1492
2283
|
* <li>
|
|
1493
2284
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1494
2285
|
* </li>
|
|
1495
2286
|
* <li>
|
|
1496
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2287
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2288
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
2289
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
2290
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
2291
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
2292
|
+
* not count against your tags per resource limit.</p>
|
|
1497
2293
|
* </li>
|
|
1498
2294
|
* </ul>
|
|
1499
2295
|
*/
|
|
@@ -1536,9 +2332,9 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
1536
2332
|
*/
|
|
1537
2333
|
Destination: DataDestination | undefined;
|
|
1538
2334
|
/**
|
|
1539
|
-
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
1540
|
-
* of a key and an optional value, both of which you define. Tag keys and values
|
|
1541
|
-
* sensitive.</p>
|
|
2335
|
+
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2336
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
2337
|
+
* are case sensitive.</p>
|
|
1542
2338
|
* <p>The following restrictions apply to tags:</p>
|
|
1543
2339
|
* <ul>
|
|
1544
2340
|
* <li>
|
|
@@ -1555,17 +2351,17 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
1555
2351
|
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1556
2352
|
* </li>
|
|
1557
2353
|
* <li>
|
|
1558
|
-
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1559
|
-
* - = . _ : / @. If your tagging schema is used across other services and
|
|
1560
|
-
* the character restrictions of those services also apply. </p>
|
|
2354
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2355
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
2356
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
1561
2357
|
* </li>
|
|
1562
2358
|
* <li>
|
|
1563
2359
|
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1564
|
-
*
|
|
1565
|
-
* value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1566
|
-
* to be a user tag and will count against the limit of 50 tags. Tags
|
|
1567
|
-
* prefix of <code>aws</code> do not count against your tags per
|
|
1568
|
-
* cannot edit or delete tag keys with this prefix.</p>
|
|
2360
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
2361
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2362
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
2363
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
2364
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
1569
2365
|
* </li>
|
|
1570
2366
|
* </ul>
|
|
1571
2367
|
*/
|
|
@@ -1626,6 +2422,30 @@ export declare namespace DeleteDatasetImportJobRequest {
|
|
|
1626
2422
|
*/
|
|
1627
2423
|
const filterSensitiveLog: (obj: DeleteDatasetImportJobRequest) => any;
|
|
1628
2424
|
}
|
|
2425
|
+
export interface DeleteExplainabilityRequest {
|
|
2426
|
+
/**
|
|
2427
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability resource to delete.</p>
|
|
2428
|
+
*/
|
|
2429
|
+
ExplainabilityArn: string | undefined;
|
|
2430
|
+
}
|
|
2431
|
+
export declare namespace DeleteExplainabilityRequest {
|
|
2432
|
+
/**
|
|
2433
|
+
* @internal
|
|
2434
|
+
*/
|
|
2435
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityRequest) => any;
|
|
2436
|
+
}
|
|
2437
|
+
export interface DeleteExplainabilityExportRequest {
|
|
2438
|
+
/**
|
|
2439
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export to delete. </p>
|
|
2440
|
+
*/
|
|
2441
|
+
ExplainabilityExportArn: string | undefined;
|
|
2442
|
+
}
|
|
2443
|
+
export declare namespace DeleteExplainabilityExportRequest {
|
|
2444
|
+
/**
|
|
2445
|
+
* @internal
|
|
2446
|
+
*/
|
|
2447
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityExportRequest) => any;
|
|
2448
|
+
}
|
|
1629
2449
|
export interface DeleteForecastRequest {
|
|
1630
2450
|
/**
|
|
1631
2451
|
* <p>The Amazon Resource Name (ARN) of the forecast to delete.</p>
|
|
@@ -1648,44 +2468,257 @@ export declare namespace DeleteForecastExportJobRequest {
|
|
|
1648
2468
|
/**
|
|
1649
2469
|
* @internal
|
|
1650
2470
|
*/
|
|
1651
|
-
const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
|
|
1652
|
-
}
|
|
1653
|
-
export interface DeletePredictorRequest {
|
|
2471
|
+
const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
|
|
2472
|
+
}
|
|
2473
|
+
export interface DeletePredictorRequest {
|
|
2474
|
+
/**
|
|
2475
|
+
* <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
|
|
2476
|
+
*/
|
|
2477
|
+
PredictorArn: string | undefined;
|
|
2478
|
+
}
|
|
2479
|
+
export declare namespace DeletePredictorRequest {
|
|
2480
|
+
/**
|
|
2481
|
+
* @internal
|
|
2482
|
+
*/
|
|
2483
|
+
const filterSensitiveLog: (obj: DeletePredictorRequest) => any;
|
|
2484
|
+
}
|
|
2485
|
+
export interface DeletePredictorBacktestExportJobRequest {
|
|
2486
|
+
/**
|
|
2487
|
+
* <p>The Amazon Resource Name (ARN) of the predictor backtest export job to delete.</p>
|
|
2488
|
+
*/
|
|
2489
|
+
PredictorBacktestExportJobArn: string | undefined;
|
|
2490
|
+
}
|
|
2491
|
+
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2492
|
+
/**
|
|
2493
|
+
* @internal
|
|
2494
|
+
*/
|
|
2495
|
+
const filterSensitiveLog: (obj: DeletePredictorBacktestExportJobRequest) => any;
|
|
2496
|
+
}
|
|
2497
|
+
export interface DeleteResourceTreeRequest {
|
|
2498
|
+
/**
|
|
2499
|
+
* <p>The Amazon Resource Name (ARN) of the parent resource to delete. All child resources
|
|
2500
|
+
* of the parent resource will also be deleted.</p>
|
|
2501
|
+
*/
|
|
2502
|
+
ResourceArn: string | undefined;
|
|
2503
|
+
}
|
|
2504
|
+
export declare namespace DeleteResourceTreeRequest {
|
|
2505
|
+
/**
|
|
2506
|
+
* @internal
|
|
2507
|
+
*/
|
|
2508
|
+
const filterSensitiveLog: (obj: DeleteResourceTreeRequest) => any;
|
|
2509
|
+
}
|
|
2510
|
+
export interface DescribeAutoPredictorRequest {
|
|
2511
|
+
/**
|
|
2512
|
+
* <p>The Amazon Resource Name (ARN) of the predictor.</p>
|
|
2513
|
+
*/
|
|
2514
|
+
PredictorArn: string | undefined;
|
|
2515
|
+
}
|
|
2516
|
+
export declare namespace DescribeAutoPredictorRequest {
|
|
2517
|
+
/**
|
|
2518
|
+
* @internal
|
|
2519
|
+
*/
|
|
2520
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
|
|
2521
|
+
}
|
|
2522
|
+
/**
|
|
2523
|
+
* <p>Provides information about the Explainability resource.</p>
|
|
2524
|
+
*/
|
|
2525
|
+
export interface ExplainabilityInfo {
|
|
2526
|
+
/**
|
|
2527
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
2528
|
+
*/
|
|
2529
|
+
ExplainabilityArn?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>The status of the Explainability. States include: </p>
|
|
2532
|
+
* <ul>
|
|
2533
|
+
* <li>
|
|
2534
|
+
* <p>
|
|
2535
|
+
* <code>ACTIVE</code>
|
|
2536
|
+
* </p>
|
|
2537
|
+
* </li>
|
|
2538
|
+
* <li>
|
|
2539
|
+
* <p>
|
|
2540
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2541
|
+
* <code>CREATE_FAILED</code>
|
|
2542
|
+
* </p>
|
|
2543
|
+
* </li>
|
|
2544
|
+
* <li>
|
|
2545
|
+
* <p>
|
|
2546
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2547
|
+
* </p>
|
|
2548
|
+
* </li>
|
|
2549
|
+
* <li>
|
|
2550
|
+
* <p>
|
|
2551
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2552
|
+
* <code>DELETE_FAILED</code>
|
|
2553
|
+
* </p>
|
|
2554
|
+
* </li>
|
|
2555
|
+
* </ul>
|
|
2556
|
+
*/
|
|
2557
|
+
Status?: string;
|
|
2558
|
+
}
|
|
2559
|
+
export declare namespace ExplainabilityInfo {
|
|
2560
|
+
/**
|
|
2561
|
+
* @internal
|
|
2562
|
+
*/
|
|
2563
|
+
const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
|
|
2564
|
+
}
|
|
2565
|
+
export declare enum State {
|
|
2566
|
+
Active = "Active",
|
|
2567
|
+
Deleted = "Deleted"
|
|
2568
|
+
}
|
|
2569
|
+
/**
|
|
2570
|
+
* <p>Provides a summary of the reference predictor used when retraining or upgrading a
|
|
2571
|
+
* predictor.</p>
|
|
2572
|
+
*/
|
|
2573
|
+
export interface ReferencePredictorSummary {
|
|
2574
|
+
/**
|
|
2575
|
+
* <p>The ARN of the reference predictor.</p>
|
|
2576
|
+
*/
|
|
2577
|
+
Arn?: string;
|
|
2578
|
+
/**
|
|
2579
|
+
* <p>Whether the reference predictor is <code>Active</code> or <code>Deleted</code>.</p>
|
|
2580
|
+
*/
|
|
2581
|
+
State?: State | string;
|
|
2582
|
+
}
|
|
2583
|
+
export declare namespace ReferencePredictorSummary {
|
|
2584
|
+
/**
|
|
2585
|
+
* @internal
|
|
2586
|
+
*/
|
|
2587
|
+
const filterSensitiveLog: (obj: ReferencePredictorSummary) => any;
|
|
2588
|
+
}
|
|
2589
|
+
export interface DescribeAutoPredictorResponse {
|
|
2590
|
+
/**
|
|
2591
|
+
* <p>The Amazon Resource Name (ARN) of the predictor</p>
|
|
2592
|
+
*/
|
|
2593
|
+
PredictorArn?: string;
|
|
2594
|
+
/**
|
|
2595
|
+
* <p>The name of the predictor.</p>
|
|
2596
|
+
*/
|
|
2597
|
+
PredictorName?: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
2600
|
+
* the prediction length.</p>
|
|
2601
|
+
*/
|
|
2602
|
+
ForecastHorizon?: number;
|
|
2603
|
+
/**
|
|
2604
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
2605
|
+
* ["0.1","0.5","0.9"].</p>
|
|
2606
|
+
*/
|
|
2607
|
+
ForecastTypes?: string[];
|
|
2608
|
+
/**
|
|
2609
|
+
* <p>The frequency of predictions in a forecast.</p>
|
|
2610
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
2611
|
+
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
2612
|
+
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2613
|
+
*/
|
|
2614
|
+
ForecastFrequency?: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* <p>An array of dimension (field) names that specify the attributes used to group your time series.</p>
|
|
2617
|
+
*/
|
|
2618
|
+
ForecastDimensions?: string[];
|
|
2619
|
+
/**
|
|
2620
|
+
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2621
|
+
* predictor.</p>
|
|
2622
|
+
*/
|
|
2623
|
+
DatasetImportJobArns?: string[];
|
|
2624
|
+
/**
|
|
2625
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
2626
|
+
*/
|
|
2627
|
+
DataConfig?: DataConfig;
|
|
2628
|
+
/**
|
|
2629
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
2630
|
+
* access the key. You can specify this optional object in the
|
|
2631
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
2632
|
+
*/
|
|
2633
|
+
EncryptionConfig?: EncryptionConfig;
|
|
2634
|
+
/**
|
|
2635
|
+
* <p>The ARN and state of the reference predictor. This parameter is only valid for
|
|
2636
|
+
* retrained or upgraded predictors.</p>
|
|
2637
|
+
*/
|
|
2638
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
2639
|
+
/**
|
|
2640
|
+
* <p>The estimated time remaining in minutes for the predictor training job to
|
|
2641
|
+
* complete.</p>
|
|
2642
|
+
*/
|
|
2643
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
2644
|
+
/**
|
|
2645
|
+
* <p>The status of the predictor. States include: </p>
|
|
2646
|
+
* <ul>
|
|
2647
|
+
* <li>
|
|
2648
|
+
* <p>
|
|
2649
|
+
* <code>ACTIVE</code>
|
|
2650
|
+
* </p>
|
|
2651
|
+
* </li>
|
|
2652
|
+
* <li>
|
|
2653
|
+
* <p>
|
|
2654
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2655
|
+
* <code>CREATE_FAILED</code>
|
|
2656
|
+
* </p>
|
|
2657
|
+
* </li>
|
|
2658
|
+
* <li>
|
|
2659
|
+
* <p>
|
|
2660
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2661
|
+
* </p>
|
|
2662
|
+
* </li>
|
|
2663
|
+
* <li>
|
|
2664
|
+
* <p>
|
|
2665
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2666
|
+
* <code>DELETE_FAILED</code>
|
|
2667
|
+
* </p>
|
|
2668
|
+
* </li>
|
|
2669
|
+
* </ul>
|
|
2670
|
+
*/
|
|
2671
|
+
Status?: string;
|
|
1654
2672
|
/**
|
|
1655
|
-
* <p>
|
|
2673
|
+
* <p>In the event of an error, a message detailing the cause of the error.</p>
|
|
1656
2674
|
*/
|
|
1657
|
-
|
|
1658
|
-
}
|
|
1659
|
-
export declare namespace DeletePredictorRequest {
|
|
2675
|
+
Message?: string;
|
|
1660
2676
|
/**
|
|
1661
|
-
*
|
|
2677
|
+
* <p>The timestamp of the CreateAutoPredictor request.</p>
|
|
1662
2678
|
*/
|
|
1663
|
-
|
|
1664
|
-
}
|
|
1665
|
-
export interface DeletePredictorBacktestExportJobRequest {
|
|
2679
|
+
CreationTime?: Date;
|
|
1666
2680
|
/**
|
|
1667
|
-
* <p>The
|
|
2681
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
2682
|
+
* job:</p>
|
|
2683
|
+
* <ul>
|
|
2684
|
+
* <li>
|
|
2685
|
+
* <p>
|
|
2686
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
2687
|
+
* </li>
|
|
2688
|
+
* <li>
|
|
2689
|
+
* <p>
|
|
2690
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
2691
|
+
* </li>
|
|
2692
|
+
* <li>
|
|
2693
|
+
* <p>
|
|
2694
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
2695
|
+
* </li>
|
|
2696
|
+
* <li>
|
|
2697
|
+
* <p>
|
|
2698
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
2699
|
+
* </li>
|
|
2700
|
+
* <li>
|
|
2701
|
+
* <p>
|
|
2702
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
2703
|
+
* failed.</p>
|
|
2704
|
+
* </li>
|
|
2705
|
+
* </ul>
|
|
1668
2706
|
*/
|
|
1669
|
-
|
|
1670
|
-
}
|
|
1671
|
-
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2707
|
+
LastModificationTime?: Date;
|
|
1672
2708
|
/**
|
|
1673
|
-
*
|
|
2709
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
1674
2710
|
*/
|
|
1675
|
-
|
|
1676
|
-
}
|
|
1677
|
-
export interface DeleteResourceTreeRequest {
|
|
2711
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
1678
2712
|
/**
|
|
1679
|
-
* <p>
|
|
1680
|
-
* of the parent resource will also be deleted.</p>
|
|
2713
|
+
* <p>Provides the status and ARN of the Predictor Explainability.</p>
|
|
1681
2714
|
*/
|
|
1682
|
-
|
|
2715
|
+
ExplainabilityInfo?: ExplainabilityInfo;
|
|
1683
2716
|
}
|
|
1684
|
-
export declare namespace
|
|
2717
|
+
export declare namespace DescribeAutoPredictorResponse {
|
|
1685
2718
|
/**
|
|
1686
2719
|
* @internal
|
|
1687
2720
|
*/
|
|
1688
|
-
const filterSensitiveLog: (obj:
|
|
2721
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorResponse) => any;
|
|
1689
2722
|
}
|
|
1690
2723
|
export interface DescribeDatasetRequest {
|
|
1691
2724
|
/**
|
|
@@ -2086,6 +3119,237 @@ export declare namespace DescribeDatasetImportJobResponse {
|
|
|
2086
3119
|
*/
|
|
2087
3120
|
const filterSensitiveLog: (obj: DescribeDatasetImportJobResponse) => any;
|
|
2088
3121
|
}
|
|
3122
|
+
export interface DescribeExplainabilityRequest {
|
|
3123
|
+
/**
|
|
3124
|
+
* <p>The Amazon Resource Name (ARN) of the Explaianability to describe.</p>
|
|
3125
|
+
*/
|
|
3126
|
+
ExplainabilityArn: string | undefined;
|
|
3127
|
+
}
|
|
3128
|
+
export declare namespace DescribeExplainabilityRequest {
|
|
3129
|
+
/**
|
|
3130
|
+
* @internal
|
|
3131
|
+
*/
|
|
3132
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityRequest) => any;
|
|
3133
|
+
}
|
|
3134
|
+
export interface DescribeExplainabilityResponse {
|
|
3135
|
+
/**
|
|
3136
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3137
|
+
*/
|
|
3138
|
+
ExplainabilityArn?: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* <p>The name of the Explainability.</p>
|
|
3141
|
+
*/
|
|
3142
|
+
ExplainabilityName?: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
3145
|
+
* Explainability resource.</p>
|
|
3146
|
+
*/
|
|
3147
|
+
ResourceArn?: string;
|
|
3148
|
+
/**
|
|
3149
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
3150
|
+
* for the Explainability.</p>
|
|
3151
|
+
*/
|
|
3152
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
3153
|
+
/**
|
|
3154
|
+
* <p>Whether the visualization was enabled for the Explainability resource.</p>
|
|
3155
|
+
*/
|
|
3156
|
+
EnableVisualization?: boolean;
|
|
3157
|
+
/**
|
|
3158
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3159
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
3160
|
+
*/
|
|
3161
|
+
DataSource?: DataSource;
|
|
3162
|
+
/**
|
|
3163
|
+
* <p>Defines the fields of a dataset.</p>
|
|
3164
|
+
*/
|
|
3165
|
+
Schema?: Schema;
|
|
3166
|
+
/**
|
|
3167
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time
|
|
3168
|
+
* point in the Explainability.</p>
|
|
3169
|
+
*/
|
|
3170
|
+
StartDateTime?: string;
|
|
3171
|
+
/**
|
|
3172
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time
|
|
3173
|
+
* point in the Explainability.</p>
|
|
3174
|
+
*/
|
|
3175
|
+
EndDateTime?: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* <p>The estimated time remaining in minutes for the <a>CreateExplainability</a>
|
|
3178
|
+
* job to complete.</p>
|
|
3179
|
+
*/
|
|
3180
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
3181
|
+
/**
|
|
3182
|
+
* <p>If an error occurred, a message about the error.</p>
|
|
3183
|
+
*/
|
|
3184
|
+
Message?: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* <p>The status of the Explainability resource. States include: </p>
|
|
3187
|
+
* <ul>
|
|
3188
|
+
* <li>
|
|
3189
|
+
* <p>
|
|
3190
|
+
* <code>ACTIVE</code>
|
|
3191
|
+
* </p>
|
|
3192
|
+
* </li>
|
|
3193
|
+
* <li>
|
|
3194
|
+
* <p>
|
|
3195
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3196
|
+
* <code>CREATE_FAILED</code>
|
|
3197
|
+
* </p>
|
|
3198
|
+
* </li>
|
|
3199
|
+
* <li>
|
|
3200
|
+
* <p>
|
|
3201
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3202
|
+
* </p>
|
|
3203
|
+
* </li>
|
|
3204
|
+
* <li>
|
|
3205
|
+
* <p>
|
|
3206
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3207
|
+
* <code>DELETE_FAILED</code>
|
|
3208
|
+
* </p>
|
|
3209
|
+
* </li>
|
|
3210
|
+
* </ul>
|
|
3211
|
+
*/
|
|
3212
|
+
Status?: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* <p>When the Explainability resource was created.</p>
|
|
3215
|
+
*/
|
|
3216
|
+
CreationTime?: Date;
|
|
3217
|
+
/**
|
|
3218
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3219
|
+
* job:</p>
|
|
3220
|
+
* <ul>
|
|
3221
|
+
* <li>
|
|
3222
|
+
* <p>
|
|
3223
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3224
|
+
* </li>
|
|
3225
|
+
* <li>
|
|
3226
|
+
* <p>
|
|
3227
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3228
|
+
* </li>
|
|
3229
|
+
* <li>
|
|
3230
|
+
* <p>
|
|
3231
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3232
|
+
* </li>
|
|
3233
|
+
* <li>
|
|
3234
|
+
* <p>
|
|
3235
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3236
|
+
* </li>
|
|
3237
|
+
* <li>
|
|
3238
|
+
* <p>
|
|
3239
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3240
|
+
* failed.</p>
|
|
3241
|
+
* </li>
|
|
3242
|
+
* </ul>
|
|
3243
|
+
*/
|
|
3244
|
+
LastModificationTime?: Date;
|
|
3245
|
+
}
|
|
3246
|
+
export declare namespace DescribeExplainabilityResponse {
|
|
3247
|
+
/**
|
|
3248
|
+
* @internal
|
|
3249
|
+
*/
|
|
3250
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityResponse) => any;
|
|
3251
|
+
}
|
|
3252
|
+
export interface DescribeExplainabilityExportRequest {
|
|
3253
|
+
/**
|
|
3254
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3255
|
+
*/
|
|
3256
|
+
ExplainabilityExportArn: string | undefined;
|
|
3257
|
+
}
|
|
3258
|
+
export declare namespace DescribeExplainabilityExportRequest {
|
|
3259
|
+
/**
|
|
3260
|
+
* @internal
|
|
3261
|
+
*/
|
|
3262
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportRequest) => any;
|
|
3263
|
+
}
|
|
3264
|
+
export interface DescribeExplainabilityExportResponse {
|
|
3265
|
+
/**
|
|
3266
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3267
|
+
*/
|
|
3268
|
+
ExplainabilityExportArn?: string;
|
|
3269
|
+
/**
|
|
3270
|
+
* <p>The name of the Explainability export.</p>
|
|
3271
|
+
*/
|
|
3272
|
+
ExplainabilityExportName?: string;
|
|
3273
|
+
/**
|
|
3274
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3275
|
+
*/
|
|
3276
|
+
ExplainabilityArn?: string;
|
|
3277
|
+
/**
|
|
3278
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
3279
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
3280
|
+
*/
|
|
3281
|
+
Destination?: DataDestination;
|
|
3282
|
+
/**
|
|
3283
|
+
* <p>Information about any errors that occurred during the export.</p>
|
|
3284
|
+
*/
|
|
3285
|
+
Message?: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
3288
|
+
* <ul>
|
|
3289
|
+
* <li>
|
|
3290
|
+
* <p>
|
|
3291
|
+
* <code>ACTIVE</code>
|
|
3292
|
+
* </p>
|
|
3293
|
+
* </li>
|
|
3294
|
+
* <li>
|
|
3295
|
+
* <p>
|
|
3296
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3297
|
+
* <code>CREATE_FAILED</code>
|
|
3298
|
+
* </p>
|
|
3299
|
+
* </li>
|
|
3300
|
+
* <li>
|
|
3301
|
+
* <p>
|
|
3302
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3303
|
+
* </p>
|
|
3304
|
+
* </li>
|
|
3305
|
+
* <li>
|
|
3306
|
+
* <p>
|
|
3307
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3308
|
+
* <code>DELETE_FAILED</code>
|
|
3309
|
+
* </p>
|
|
3310
|
+
* </li>
|
|
3311
|
+
* </ul>
|
|
3312
|
+
*/
|
|
3313
|
+
Status?: string;
|
|
3314
|
+
/**
|
|
3315
|
+
* <p>When the Explainability export was created.</p>
|
|
3316
|
+
*/
|
|
3317
|
+
CreationTime?: Date;
|
|
3318
|
+
/**
|
|
3319
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3320
|
+
* job:</p>
|
|
3321
|
+
* <ul>
|
|
3322
|
+
* <li>
|
|
3323
|
+
* <p>
|
|
3324
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3325
|
+
* </li>
|
|
3326
|
+
* <li>
|
|
3327
|
+
* <p>
|
|
3328
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3329
|
+
* </li>
|
|
3330
|
+
* <li>
|
|
3331
|
+
* <p>
|
|
3332
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3333
|
+
* </li>
|
|
3334
|
+
* <li>
|
|
3335
|
+
* <p>
|
|
3336
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3337
|
+
* </li>
|
|
3338
|
+
* <li>
|
|
3339
|
+
* <p>
|
|
3340
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3341
|
+
* failed.</p>
|
|
3342
|
+
* </li>
|
|
3343
|
+
* </ul>
|
|
3344
|
+
*/
|
|
3345
|
+
LastModificationTime?: Date;
|
|
3346
|
+
}
|
|
3347
|
+
export declare namespace DescribeExplainabilityExportResponse {
|
|
3348
|
+
/**
|
|
3349
|
+
* @internal
|
|
3350
|
+
*/
|
|
3351
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportResponse) => any;
|
|
3352
|
+
}
|
|
2089
3353
|
export interface DescribeForecastRequest {
|
|
2090
3354
|
/**
|
|
2091
3355
|
* <p>The Amazon Resource Name (ARN) of the forecast.</p>
|
|
@@ -2410,13 +3674,18 @@ export interface DescribePredictorResponse {
|
|
|
2410
3674
|
* <p>The Amazon Resource Name (ARN) of the algorithm used for model training.</p>
|
|
2411
3675
|
*/
|
|
2412
3676
|
AlgorithmArn?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* <p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>
|
|
3679
|
+
*/
|
|
3680
|
+
AutoMLAlgorithmArns?: string[];
|
|
2413
3681
|
/**
|
|
2414
3682
|
* <p>The number of time-steps of the forecast. The forecast horizon is also called the
|
|
2415
3683
|
* prediction length.</p>
|
|
2416
3684
|
*/
|
|
2417
3685
|
ForecastHorizon?: number;
|
|
2418
3686
|
/**
|
|
2419
|
-
* <p>The forecast types used during predictor training. Default value is
|
|
3687
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
3688
|
+
* <code>["0.1","0.5","0.9"]</code>
|
|
2420
3689
|
* </p>
|
|
2421
3690
|
*/
|
|
2422
3691
|
ForecastTypes?: string[];
|
|
@@ -2480,14 +3749,14 @@ export interface DescribePredictorResponse {
|
|
|
2480
3749
|
*/
|
|
2481
3750
|
EstimatedTimeRemainingInMinutes?: number;
|
|
2482
3751
|
/**
|
|
2483
|
-
* <p>
|
|
2484
|
-
* predictor.</p>
|
|
3752
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
2485
3753
|
*/
|
|
2486
|
-
|
|
3754
|
+
IsAutoPredictor?: boolean;
|
|
2487
3755
|
/**
|
|
2488
|
-
* <p>
|
|
3756
|
+
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
3757
|
+
* predictor.</p>
|
|
2489
3758
|
*/
|
|
2490
|
-
|
|
3759
|
+
DatasetImportJobArns?: string[];
|
|
2491
3760
|
/**
|
|
2492
3761
|
* <p>The status of the predictor. States include:</p>
|
|
2493
3762
|
* <ul>
|
|
@@ -2499,13 +3768,13 @@ export interface DescribePredictorResponse {
|
|
|
2499
3768
|
* <li>
|
|
2500
3769
|
* <p>
|
|
2501
3770
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2502
|
-
*
|
|
3771
|
+
* <code>CREATE_FAILED</code>
|
|
2503
3772
|
* </p>
|
|
2504
3773
|
* </li>
|
|
2505
3774
|
* <li>
|
|
2506
3775
|
* <p>
|
|
2507
3776
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2508
|
-
*
|
|
3777
|
+
* <code>DELETE_FAILED</code>
|
|
2509
3778
|
* </p>
|
|
2510
3779
|
* </li>
|
|
2511
3780
|
* <li>
|
|
@@ -2529,7 +3798,8 @@ export interface DescribePredictorResponse {
|
|
|
2529
3798
|
*/
|
|
2530
3799
|
CreationTime?: Date;
|
|
2531
3800
|
/**
|
|
2532
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3801
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3802
|
+
* job:</p>
|
|
2533
3803
|
* <ul>
|
|
2534
3804
|
* <li>
|
|
2535
3805
|
* <p>
|
|
@@ -2611,7 +3881,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2611
3881
|
* <li>
|
|
2612
3882
|
* <p>
|
|
2613
3883
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2614
|
-
*
|
|
3884
|
+
* <code>CREATE_FAILED</code>
|
|
2615
3885
|
* </p>
|
|
2616
3886
|
* </li>
|
|
2617
3887
|
* <li>
|
|
@@ -2622,7 +3892,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2622
3892
|
* <li>
|
|
2623
3893
|
* <p>
|
|
2624
3894
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2625
|
-
*
|
|
3895
|
+
* <code>DELETE_FAILED</code>
|
|
2626
3896
|
* </p>
|
|
2627
3897
|
* </li>
|
|
2628
3898
|
* </ul>
|
|
@@ -2633,7 +3903,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2633
3903
|
*/
|
|
2634
3904
|
CreationTime?: Date;
|
|
2635
3905
|
/**
|
|
2636
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3906
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3907
|
+
* job:</p>
|
|
2637
3908
|
* <ul>
|
|
2638
3909
|
* <li>
|
|
2639
3910
|
* <p>
|
|
@@ -2839,6 +4110,10 @@ export interface GetAccuracyMetricsResponse {
|
|
|
2839
4110
|
* <p>An array of results from evaluating the predictor.</p>
|
|
2840
4111
|
*/
|
|
2841
4112
|
PredictorEvaluationResults?: EvaluationResult[];
|
|
4113
|
+
/**
|
|
4114
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
4115
|
+
*/
|
|
4116
|
+
IsAutoPredictor?: boolean;
|
|
2842
4117
|
/**
|
|
2843
4118
|
* <note>
|
|
2844
4119
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
@@ -2945,268 +4220,579 @@ export declare enum FilterConditionString {
|
|
|
2945
4220
|
IS = "IS",
|
|
2946
4221
|
IS_NOT = "IS_NOT"
|
|
2947
4222
|
}
|
|
2948
|
-
/**
|
|
2949
|
-
* <p>Describes a filter for choosing a subset of objects. Each filter consists of a
|
|
2950
|
-
* condition and a match statement. The condition is either <code>IS</code> or
|
|
2951
|
-
* <code>IS_NOT</code>, which specifies whether to include or exclude
|
|
2952
|
-
* the objects that match the statement, respectively. The match statement consists of a key and a
|
|
2953
|
-
* value.</p>
|
|
2954
|
-
*/
|
|
2955
|
-
export interface Filter {
|
|
4223
|
+
/**
|
|
4224
|
+
* <p>Describes a filter for choosing a subset of objects. Each filter consists of a
|
|
4225
|
+
* condition and a match statement. The condition is either <code>IS</code> or
|
|
4226
|
+
* <code>IS_NOT</code>, which specifies whether to include or exclude
|
|
4227
|
+
* the objects that match the statement, respectively. The match statement consists of a key and a
|
|
4228
|
+
* value.</p>
|
|
4229
|
+
*/
|
|
4230
|
+
export interface Filter {
|
|
4231
|
+
/**
|
|
4232
|
+
* <p>The name of the parameter to filter on.</p>
|
|
4233
|
+
*/
|
|
4234
|
+
Key: string | undefined;
|
|
4235
|
+
/**
|
|
4236
|
+
* <p>The value to match.</p>
|
|
4237
|
+
*/
|
|
4238
|
+
Value: string | undefined;
|
|
4239
|
+
/**
|
|
4240
|
+
* <p>The condition to apply. To include the objects that match the statement, specify
|
|
4241
|
+
* <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.</p>
|
|
4242
|
+
*/
|
|
4243
|
+
Condition: FilterConditionString | string | undefined;
|
|
4244
|
+
}
|
|
4245
|
+
export declare namespace Filter {
|
|
4246
|
+
/**
|
|
4247
|
+
* @internal
|
|
4248
|
+
*/
|
|
4249
|
+
const filterSensitiveLog: (obj: Filter) => any;
|
|
4250
|
+
}
|
|
4251
|
+
export interface ListDatasetImportJobsRequest {
|
|
4252
|
+
/**
|
|
4253
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4254
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
4255
|
+
* request. Tokens expire after 24 hours.</p>
|
|
4256
|
+
*/
|
|
4257
|
+
NextToken?: string;
|
|
4258
|
+
/**
|
|
4259
|
+
* <p>The number of items to return in the response.</p>
|
|
4260
|
+
*/
|
|
4261
|
+
MaxResults?: number;
|
|
4262
|
+
/**
|
|
4263
|
+
* <p>An array of filters. For each filter, you provide a condition and a match statement. The
|
|
4264
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
|
|
4265
|
+
* or exclude the datasets that match the statement from the list, respectively. The match
|
|
4266
|
+
* statement consists of a key and a value.</p>
|
|
4267
|
+
* <p>
|
|
4268
|
+
* <b>Filter properties</b>
|
|
4269
|
+
* </p>
|
|
4270
|
+
* <ul>
|
|
4271
|
+
* <li>
|
|
4272
|
+
* <p>
|
|
4273
|
+
* <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
|
|
4274
|
+
* <code>IS_NOT</code>. To include the datasets that match the statement, specify
|
|
4275
|
+
* <code>IS</code>. To exclude matching datasets, specify <code>IS_NOT</code>.</p>
|
|
4276
|
+
* </li>
|
|
4277
|
+
* <li>
|
|
4278
|
+
* <p>
|
|
4279
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4280
|
+
* <code>DatasetArn</code> and <code>Status</code>.</p>
|
|
4281
|
+
* </li>
|
|
4282
|
+
* <li>
|
|
4283
|
+
* <p>
|
|
4284
|
+
* <code>Value</code> - The value to match.</p>
|
|
4285
|
+
* </li>
|
|
4286
|
+
* </ul>
|
|
4287
|
+
* <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
|
|
4288
|
+
* following filter:</p>
|
|
4289
|
+
* <p>
|
|
4290
|
+
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
|
|
4291
|
+
* ]</code>
|
|
4292
|
+
* </p>
|
|
4293
|
+
*/
|
|
4294
|
+
Filters?: Filter[];
|
|
4295
|
+
}
|
|
4296
|
+
export declare namespace ListDatasetImportJobsRequest {
|
|
4297
|
+
/**
|
|
4298
|
+
* @internal
|
|
4299
|
+
*/
|
|
4300
|
+
const filterSensitiveLog: (obj: ListDatasetImportJobsRequest) => any;
|
|
4301
|
+
}
|
|
4302
|
+
/**
|
|
4303
|
+
* <p>Provides a summary of the dataset import job properties used in the <a>ListDatasetImportJobs</a> operation. To get the complete set of properties, call the
|
|
4304
|
+
* <a>DescribeDatasetImportJob</a> operation, and provide the
|
|
4305
|
+
* <code>DatasetImportJobArn</code>.</p>
|
|
4306
|
+
*/
|
|
4307
|
+
export interface DatasetImportJobSummary {
|
|
4308
|
+
/**
|
|
4309
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
|
|
4310
|
+
*/
|
|
4311
|
+
DatasetImportJobArn?: string;
|
|
4312
|
+
/**
|
|
4313
|
+
* <p>The name of the dataset import job.</p>
|
|
4314
|
+
*/
|
|
4315
|
+
DatasetImportJobName?: string;
|
|
4316
|
+
/**
|
|
4317
|
+
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
4318
|
+
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
4319
|
+
* <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
|
|
4320
|
+
*/
|
|
4321
|
+
DataSource?: DataSource;
|
|
4322
|
+
/**
|
|
4323
|
+
* <p>The status of the dataset import job. States include:</p>
|
|
4324
|
+
* <ul>
|
|
4325
|
+
* <li>
|
|
4326
|
+
* <p>
|
|
4327
|
+
* <code>ACTIVE</code>
|
|
4328
|
+
* </p>
|
|
4329
|
+
* </li>
|
|
4330
|
+
* <li>
|
|
4331
|
+
* <p>
|
|
4332
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4333
|
+
* <code>CREATE_FAILED</code>
|
|
4334
|
+
* </p>
|
|
4335
|
+
* </li>
|
|
4336
|
+
* <li>
|
|
4337
|
+
* <p>
|
|
4338
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4339
|
+
* <code>DELETE_FAILED</code>
|
|
4340
|
+
* </p>
|
|
4341
|
+
* </li>
|
|
4342
|
+
* <li>
|
|
4343
|
+
* <p>
|
|
4344
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4345
|
+
* </p>
|
|
4346
|
+
* </li>
|
|
4347
|
+
* </ul>
|
|
4348
|
+
*/
|
|
4349
|
+
Status?: string;
|
|
4350
|
+
/**
|
|
4351
|
+
* <p>If an error occurred, an informational message about the error.</p>
|
|
4352
|
+
*/
|
|
4353
|
+
Message?: string;
|
|
4354
|
+
/**
|
|
4355
|
+
* <p>When the dataset import job was created.</p>
|
|
4356
|
+
*/
|
|
4357
|
+
CreationTime?: Date;
|
|
4358
|
+
/**
|
|
4359
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4360
|
+
* job:</p>
|
|
4361
|
+
* <ul>
|
|
4362
|
+
* <li>
|
|
4363
|
+
* <p>
|
|
4364
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4365
|
+
* </li>
|
|
4366
|
+
* <li>
|
|
4367
|
+
* <p>
|
|
4368
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4369
|
+
* </li>
|
|
4370
|
+
* <li>
|
|
4371
|
+
* <p>
|
|
4372
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4373
|
+
* </li>
|
|
4374
|
+
* <li>
|
|
4375
|
+
* <p>
|
|
4376
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4377
|
+
* </li>
|
|
4378
|
+
* <li>
|
|
4379
|
+
* <p>
|
|
4380
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4381
|
+
* failed.</p>
|
|
4382
|
+
* </li>
|
|
4383
|
+
* </ul>
|
|
4384
|
+
*/
|
|
4385
|
+
LastModificationTime?: Date;
|
|
4386
|
+
}
|
|
4387
|
+
export declare namespace DatasetImportJobSummary {
|
|
4388
|
+
/**
|
|
4389
|
+
* @internal
|
|
4390
|
+
*/
|
|
4391
|
+
const filterSensitiveLog: (obj: DatasetImportJobSummary) => any;
|
|
4392
|
+
}
|
|
4393
|
+
export interface ListDatasetImportJobsResponse {
|
|
4394
|
+
/**
|
|
4395
|
+
* <p>An array of objects that summarize each dataset import job's properties.</p>
|
|
4396
|
+
*/
|
|
4397
|
+
DatasetImportJobs?: DatasetImportJobSummary[];
|
|
4398
|
+
/**
|
|
4399
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
4400
|
+
* results, use the token in the next request.</p>
|
|
4401
|
+
*/
|
|
4402
|
+
NextToken?: string;
|
|
4403
|
+
}
|
|
4404
|
+
export declare namespace ListDatasetImportJobsResponse {
|
|
4405
|
+
/**
|
|
4406
|
+
* @internal
|
|
4407
|
+
*/
|
|
4408
|
+
const filterSensitiveLog: (obj: ListDatasetImportJobsResponse) => any;
|
|
4409
|
+
}
|
|
4410
|
+
export interface ListDatasetsRequest {
|
|
4411
|
+
/**
|
|
4412
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4413
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
4414
|
+
* request. Tokens expire after 24 hours.</p>
|
|
4415
|
+
*/
|
|
4416
|
+
NextToken?: string;
|
|
4417
|
+
/**
|
|
4418
|
+
* <p>The number of items to return in the response.</p>
|
|
4419
|
+
*/
|
|
4420
|
+
MaxResults?: number;
|
|
4421
|
+
}
|
|
4422
|
+
export declare namespace ListDatasetsRequest {
|
|
4423
|
+
/**
|
|
4424
|
+
* @internal
|
|
4425
|
+
*/
|
|
4426
|
+
const filterSensitiveLog: (obj: ListDatasetsRequest) => any;
|
|
4427
|
+
}
|
|
4428
|
+
/**
|
|
4429
|
+
* <p>Provides a summary of the dataset properties used in the <a>ListDatasets</a>
|
|
4430
|
+
* operation. To get the complete set of properties, call the <a>DescribeDataset</a>
|
|
4431
|
+
* operation, and provide the <code>DatasetArn</code>.</p>
|
|
4432
|
+
*/
|
|
4433
|
+
export interface DatasetSummary {
|
|
4434
|
+
/**
|
|
4435
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
4436
|
+
*/
|
|
4437
|
+
DatasetArn?: string;
|
|
4438
|
+
/**
|
|
4439
|
+
* <p>The name of the dataset.</p>
|
|
4440
|
+
*/
|
|
4441
|
+
DatasetName?: string;
|
|
4442
|
+
/**
|
|
4443
|
+
* <p>The dataset type.</p>
|
|
4444
|
+
*/
|
|
4445
|
+
DatasetType?: DatasetType | string;
|
|
4446
|
+
/**
|
|
4447
|
+
* <p>The domain associated with the dataset.</p>
|
|
4448
|
+
*/
|
|
4449
|
+
Domain?: Domain | string;
|
|
4450
|
+
/**
|
|
4451
|
+
* <p>When the dataset was created.</p>
|
|
4452
|
+
*/
|
|
4453
|
+
CreationTime?: Date;
|
|
4454
|
+
/**
|
|
4455
|
+
* <p>When you create a dataset, <code>LastModificationTime</code> is the same as
|
|
4456
|
+
* <code>CreationTime</code>. While data is being imported to the dataset,
|
|
4457
|
+
* <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
|
|
4458
|
+
* After a <a>CreateDatasetImportJob</a> operation has finished,
|
|
4459
|
+
* <code>LastModificationTime</code> is when the import job completed or failed.</p>
|
|
4460
|
+
*/
|
|
4461
|
+
LastModificationTime?: Date;
|
|
4462
|
+
}
|
|
4463
|
+
export declare namespace DatasetSummary {
|
|
2956
4464
|
/**
|
|
2957
|
-
*
|
|
4465
|
+
* @internal
|
|
2958
4466
|
*/
|
|
2959
|
-
|
|
4467
|
+
const filterSensitiveLog: (obj: DatasetSummary) => any;
|
|
4468
|
+
}
|
|
4469
|
+
export interface ListDatasetsResponse {
|
|
2960
4470
|
/**
|
|
2961
|
-
* <p>
|
|
4471
|
+
* <p>An array of objects that summarize each dataset's properties.</p>
|
|
2962
4472
|
*/
|
|
2963
|
-
|
|
4473
|
+
Datasets?: DatasetSummary[];
|
|
2964
4474
|
/**
|
|
2965
|
-
* <p>
|
|
2966
|
-
*
|
|
4475
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
4476
|
+
* results, use the token in the next request.</p>
|
|
2967
4477
|
*/
|
|
2968
|
-
|
|
4478
|
+
NextToken?: string;
|
|
2969
4479
|
}
|
|
2970
|
-
export declare namespace
|
|
4480
|
+
export declare namespace ListDatasetsResponse {
|
|
2971
4481
|
/**
|
|
2972
4482
|
* @internal
|
|
2973
4483
|
*/
|
|
2974
|
-
const filterSensitiveLog: (obj:
|
|
4484
|
+
const filterSensitiveLog: (obj: ListDatasetsResponse) => any;
|
|
2975
4485
|
}
|
|
2976
|
-
export interface
|
|
4486
|
+
export interface ListExplainabilitiesRequest {
|
|
2977
4487
|
/**
|
|
2978
4488
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
4489
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4490
|
+
* Tokens expire after 24 hours.</p>
|
|
2981
4491
|
*/
|
|
2982
4492
|
NextToken?: string;
|
|
2983
4493
|
/**
|
|
2984
|
-
* <p>The number of items
|
|
4494
|
+
* <p>The number of items returned in the response.</p>
|
|
2985
4495
|
*/
|
|
2986
4496
|
MaxResults?: number;
|
|
2987
4497
|
/**
|
|
2988
|
-
* <p>An array of filters. For each filter,
|
|
2989
|
-
*
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
4498
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4499
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4500
|
+
* include or exclude the resources that match the statement from the list. The match
|
|
4501
|
+
* statement consists of a key and a value.</p>
|
|
4502
|
+
* <p>
|
|
2993
4503
|
* <b>Filter properties</b>
|
|
2994
|
-
*
|
|
2995
|
-
*
|
|
4504
|
+
* </p>
|
|
4505
|
+
* <ul>
|
|
2996
4506
|
* <li>
|
|
2997
|
-
*
|
|
2998
|
-
* <code>Condition</code> - The condition to apply. Valid values are
|
|
2999
|
-
*
|
|
3000
|
-
* <code>IS</code>. To exclude matching datasets, specify <code>IS_NOT</code>.</p>
|
|
4507
|
+
* <p>
|
|
4508
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4509
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
3001
4510
|
* </li>
|
|
3002
4511
|
* <li>
|
|
3003
|
-
*
|
|
4512
|
+
* <p>
|
|
3004
4513
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
3005
|
-
*
|
|
4514
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
3006
4515
|
* </li>
|
|
3007
4516
|
* <li>
|
|
3008
|
-
*
|
|
4517
|
+
* <p>
|
|
3009
4518
|
* <code>Value</code> - The value to match.</p>
|
|
3010
4519
|
* </li>
|
|
3011
4520
|
* </ul>
|
|
3012
|
-
* <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
|
|
3013
|
-
* following filter:</p>
|
|
3014
|
-
* <p>
|
|
3015
|
-
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
|
|
3016
|
-
* ]</code>
|
|
3017
|
-
* </p>
|
|
3018
4521
|
*/
|
|
3019
4522
|
Filters?: Filter[];
|
|
3020
4523
|
}
|
|
3021
|
-
export declare namespace
|
|
4524
|
+
export declare namespace ListExplainabilitiesRequest {
|
|
3022
4525
|
/**
|
|
3023
4526
|
* @internal
|
|
3024
4527
|
*/
|
|
3025
|
-
const filterSensitiveLog: (obj:
|
|
4528
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesRequest) => any;
|
|
3026
4529
|
}
|
|
3027
4530
|
/**
|
|
3028
|
-
* <p>Provides a summary of the
|
|
3029
|
-
*
|
|
3030
|
-
*
|
|
4531
|
+
* <p>Provides a summary of the Explainability properties used in the <a>ListExplainabilities</a> operation. To get a complete set of properties,
|
|
4532
|
+
* call the <a>DescribeExplainability</a> operation, and provide the listed
|
|
4533
|
+
* <code>ExplainabilityArn</code>.</p>
|
|
3031
4534
|
*/
|
|
3032
|
-
export interface
|
|
4535
|
+
export interface ExplainabilitySummary {
|
|
3033
4536
|
/**
|
|
3034
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4537
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3035
4538
|
*/
|
|
3036
|
-
|
|
4539
|
+
ExplainabilityArn?: string;
|
|
3037
4540
|
/**
|
|
3038
|
-
* <p>The name of the
|
|
4541
|
+
* <p>The name of the Explainability.</p>
|
|
3039
4542
|
*/
|
|
3040
|
-
|
|
4543
|
+
ExplainabilityName?: string;
|
|
3041
4544
|
/**
|
|
3042
|
-
* <p>The
|
|
3043
|
-
*
|
|
3044
|
-
* <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
|
|
4545
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
4546
|
+
* Explainability.</p>
|
|
3045
4547
|
*/
|
|
3046
|
-
|
|
4548
|
+
ResourceArn?: string;
|
|
3047
4549
|
/**
|
|
3048
|
-
* <p>The
|
|
3049
|
-
*
|
|
4550
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
4551
|
+
* for the Explainability.</p>
|
|
4552
|
+
*/
|
|
4553
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
4554
|
+
/**
|
|
4555
|
+
* <p>The status of the Explainability. States include: </p>
|
|
4556
|
+
* <ul>
|
|
3050
4557
|
* <li>
|
|
3051
|
-
*
|
|
4558
|
+
* <p>
|
|
3052
4559
|
* <code>ACTIVE</code>
|
|
3053
4560
|
* </p>
|
|
3054
4561
|
* </li>
|
|
3055
4562
|
* <li>
|
|
3056
|
-
*
|
|
4563
|
+
* <p>
|
|
3057
4564
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3058
|
-
*
|
|
4565
|
+
* <code>CREATE_FAILED</code>
|
|
3059
4566
|
* </p>
|
|
3060
4567
|
* </li>
|
|
3061
4568
|
* <li>
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3065
|
-
* </p>
|
|
4569
|
+
* <p>
|
|
4570
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4571
|
+
* </p>
|
|
3066
4572
|
* </li>
|
|
3067
4573
|
* <li>
|
|
3068
|
-
*
|
|
3069
|
-
* <code>
|
|
4574
|
+
* <p>
|
|
4575
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4576
|
+
* <code>DELETE_FAILED</code>
|
|
3070
4577
|
* </p>
|
|
3071
4578
|
* </li>
|
|
3072
4579
|
* </ul>
|
|
3073
4580
|
*/
|
|
3074
4581
|
Status?: string;
|
|
3075
4582
|
/**
|
|
3076
|
-
* <p>
|
|
4583
|
+
* <p>Information about any errors that may have occurred during the Explainability creation
|
|
4584
|
+
* process.</p>
|
|
3077
4585
|
*/
|
|
3078
4586
|
Message?: string;
|
|
3079
4587
|
/**
|
|
3080
|
-
* <p>When the
|
|
4588
|
+
* <p>When the Explainability was created.</p>
|
|
3081
4589
|
*/
|
|
3082
4590
|
CreationTime?: Date;
|
|
3083
4591
|
/**
|
|
3084
4592
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3085
|
-
*
|
|
3086
|
-
*
|
|
4593
|
+
* job:</p>
|
|
4594
|
+
* <ul>
|
|
3087
4595
|
* <li>
|
|
3088
|
-
*
|
|
4596
|
+
* <p>
|
|
3089
4597
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3090
4598
|
* </li>
|
|
3091
4599
|
* <li>
|
|
3092
|
-
*
|
|
4600
|
+
* <p>
|
|
3093
4601
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3094
4602
|
* </li>
|
|
3095
4603
|
* <li>
|
|
3096
|
-
*
|
|
4604
|
+
* <p>
|
|
3097
4605
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3098
4606
|
* </li>
|
|
3099
4607
|
* <li>
|
|
3100
|
-
*
|
|
4608
|
+
* <p>
|
|
3101
4609
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3102
4610
|
* </li>
|
|
3103
4611
|
* <li>
|
|
3104
|
-
*
|
|
4612
|
+
* <p>
|
|
3105
4613
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3106
|
-
*
|
|
4614
|
+
* failed.</p>
|
|
3107
4615
|
* </li>
|
|
3108
4616
|
* </ul>
|
|
3109
4617
|
*/
|
|
3110
4618
|
LastModificationTime?: Date;
|
|
3111
4619
|
}
|
|
3112
|
-
export declare namespace
|
|
4620
|
+
export declare namespace ExplainabilitySummary {
|
|
3113
4621
|
/**
|
|
3114
4622
|
* @internal
|
|
3115
4623
|
*/
|
|
3116
|
-
const filterSensitiveLog: (obj:
|
|
4624
|
+
const filterSensitiveLog: (obj: ExplainabilitySummary) => any;
|
|
3117
4625
|
}
|
|
3118
|
-
export interface
|
|
4626
|
+
export interface ListExplainabilitiesResponse {
|
|
3119
4627
|
/**
|
|
3120
|
-
* <p>An array of objects that summarize
|
|
4628
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4629
|
+
* resource.</p>
|
|
3121
4630
|
*/
|
|
3122
|
-
|
|
4631
|
+
Explainabilities?: ExplainabilitySummary[];
|
|
3123
4632
|
/**
|
|
3124
|
-
* <p>
|
|
3125
|
-
*
|
|
4633
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4634
|
+
* use the token in the next request.</p>
|
|
3126
4635
|
*/
|
|
3127
4636
|
NextToken?: string;
|
|
3128
4637
|
}
|
|
3129
|
-
export declare namespace
|
|
4638
|
+
export declare namespace ListExplainabilitiesResponse {
|
|
3130
4639
|
/**
|
|
3131
4640
|
* @internal
|
|
3132
4641
|
*/
|
|
3133
|
-
const filterSensitiveLog: (obj:
|
|
4642
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesResponse) => any;
|
|
3134
4643
|
}
|
|
3135
|
-
export interface
|
|
4644
|
+
export interface ListExplainabilityExportsRequest {
|
|
3136
4645
|
/**
|
|
3137
4646
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
4647
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4648
|
+
* Tokens expire after 24 hours.</p>
|
|
3140
4649
|
*/
|
|
3141
4650
|
NextToken?: string;
|
|
3142
4651
|
/**
|
|
3143
4652
|
* <p>The number of items to return in the response.</p>
|
|
3144
4653
|
*/
|
|
3145
4654
|
MaxResults?: number;
|
|
4655
|
+
/**
|
|
4656
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4657
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4658
|
+
* include or exclude resources that match the statement from the list. The match statement
|
|
4659
|
+
* consists of a key and a value.</p>
|
|
4660
|
+
* <p>
|
|
4661
|
+
* <b>Filter properties</b>
|
|
4662
|
+
* </p>
|
|
4663
|
+
* <ul>
|
|
4664
|
+
* <li>
|
|
4665
|
+
* <p>
|
|
4666
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4667
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4668
|
+
* </li>
|
|
4669
|
+
* <li>
|
|
4670
|
+
* <p>
|
|
4671
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4672
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4673
|
+
* </li>
|
|
4674
|
+
* <li>
|
|
4675
|
+
* <p>
|
|
4676
|
+
* <code>Value</code> - The value to match.</p>
|
|
4677
|
+
* </li>
|
|
4678
|
+
* </ul>
|
|
4679
|
+
*/
|
|
4680
|
+
Filters?: Filter[];
|
|
3146
4681
|
}
|
|
3147
|
-
export declare namespace
|
|
4682
|
+
export declare namespace ListExplainabilityExportsRequest {
|
|
3148
4683
|
/**
|
|
3149
4684
|
* @internal
|
|
3150
4685
|
*/
|
|
3151
|
-
const filterSensitiveLog: (obj:
|
|
4686
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsRequest) => any;
|
|
3152
4687
|
}
|
|
3153
4688
|
/**
|
|
3154
|
-
* <p>Provides a summary of the
|
|
3155
|
-
*
|
|
3156
|
-
*
|
|
4689
|
+
* <p>Provides a summary of the Explainability export properties used in the <a>ListExplainabilityExports</a> operation. To get a complete set of
|
|
4690
|
+
* properties, call the <a>DescribeExplainabilityExport</a> operation, and
|
|
4691
|
+
* provide the <code>ExplainabilityExportArn</code>.</p>
|
|
3157
4692
|
*/
|
|
3158
|
-
export interface
|
|
4693
|
+
export interface ExplainabilityExportSummary {
|
|
3159
4694
|
/**
|
|
3160
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4695
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3161
4696
|
*/
|
|
3162
|
-
|
|
4697
|
+
ExplainabilityExportArn?: string;
|
|
3163
4698
|
/**
|
|
3164
|
-
* <p>The name of the
|
|
4699
|
+
* <p>The name of the Explainability export</p>
|
|
3165
4700
|
*/
|
|
3166
|
-
|
|
4701
|
+
ExplainabilityExportName?: string;
|
|
3167
4702
|
/**
|
|
3168
|
-
* <p>The
|
|
4703
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
4704
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
3169
4705
|
*/
|
|
3170
|
-
|
|
4706
|
+
Destination?: DataDestination;
|
|
3171
4707
|
/**
|
|
3172
|
-
* <p>The
|
|
4708
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
4709
|
+
* <ul>
|
|
4710
|
+
* <li>
|
|
4711
|
+
* <p>
|
|
4712
|
+
* <code>ACTIVE</code>
|
|
4713
|
+
* </p>
|
|
4714
|
+
* </li>
|
|
4715
|
+
* <li>
|
|
4716
|
+
* <p>
|
|
4717
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4718
|
+
* <code>CREATE_FAILED</code>
|
|
4719
|
+
* </p>
|
|
4720
|
+
* </li>
|
|
4721
|
+
* <li>
|
|
4722
|
+
* <p>
|
|
4723
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4724
|
+
* </p>
|
|
4725
|
+
* </li>
|
|
4726
|
+
* <li>
|
|
4727
|
+
* <p>
|
|
4728
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4729
|
+
* <code>DELETE_FAILED</code>
|
|
4730
|
+
* </p>
|
|
4731
|
+
* </li>
|
|
4732
|
+
* </ul>
|
|
3173
4733
|
*/
|
|
3174
|
-
|
|
4734
|
+
Status?: string;
|
|
3175
4735
|
/**
|
|
3176
|
-
* <p>
|
|
4736
|
+
* <p>Information about any errors that may have occurred during the Explainability
|
|
4737
|
+
* export.</p>
|
|
4738
|
+
*/
|
|
4739
|
+
Message?: string;
|
|
4740
|
+
/**
|
|
4741
|
+
* <p>When the Explainability was created.</p>
|
|
3177
4742
|
*/
|
|
3178
4743
|
CreationTime?: Date;
|
|
3179
4744
|
/**
|
|
3180
|
-
* <p>
|
|
3181
|
-
*
|
|
3182
|
-
* <
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
4745
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4746
|
+
* job:</p>
|
|
4747
|
+
* <ul>
|
|
4748
|
+
* <li>
|
|
4749
|
+
* <p>
|
|
4750
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4751
|
+
* </li>
|
|
4752
|
+
* <li>
|
|
4753
|
+
* <p>
|
|
4754
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4755
|
+
* </li>
|
|
4756
|
+
* <li>
|
|
4757
|
+
* <p>
|
|
4758
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4759
|
+
* </li>
|
|
4760
|
+
* <li>
|
|
4761
|
+
* <p>
|
|
4762
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4763
|
+
* </li>
|
|
4764
|
+
* <li>
|
|
4765
|
+
* <p>
|
|
4766
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4767
|
+
* failed.</p>
|
|
4768
|
+
* </li>
|
|
4769
|
+
* </ul>
|
|
3185
4770
|
*/
|
|
3186
4771
|
LastModificationTime?: Date;
|
|
3187
4772
|
}
|
|
3188
|
-
export declare namespace
|
|
4773
|
+
export declare namespace ExplainabilityExportSummary {
|
|
3189
4774
|
/**
|
|
3190
4775
|
* @internal
|
|
3191
4776
|
*/
|
|
3192
|
-
const filterSensitiveLog: (obj:
|
|
4777
|
+
const filterSensitiveLog: (obj: ExplainabilityExportSummary) => any;
|
|
3193
4778
|
}
|
|
3194
|
-
export interface
|
|
4779
|
+
export interface ListExplainabilityExportsResponse {
|
|
3195
4780
|
/**
|
|
3196
|
-
* <p>An array of objects that summarize each
|
|
4781
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4782
|
+
* export.</p>
|
|
3197
4783
|
*/
|
|
3198
|
-
|
|
4784
|
+
ExplainabilityExports?: ExplainabilityExportSummary[];
|
|
3199
4785
|
/**
|
|
3200
|
-
* <p>
|
|
3201
|
-
*
|
|
4786
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4787
|
+
* use the token in the next request.</p>
|
|
3202
4788
|
*/
|
|
3203
4789
|
NextToken?: string;
|
|
3204
4790
|
}
|
|
3205
|
-
export declare namespace
|
|
4791
|
+
export declare namespace ListExplainabilityExportsResponse {
|
|
3206
4792
|
/**
|
|
3207
4793
|
* @internal
|
|
3208
4794
|
*/
|
|
3209
|
-
const filterSensitiveLog: (obj:
|
|
4795
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsResponse) => any;
|
|
3210
4796
|
}
|
|
3211
4797
|
export interface ListForecastExportJobsRequest {
|
|
3212
4798
|
/**
|
|
@@ -3437,6 +5023,10 @@ export interface ForecastSummary {
|
|
|
3437
5023
|
* <p>The ARN of the predictor used to generate the forecast.</p>
|
|
3438
5024
|
*/
|
|
3439
5025
|
PredictorArn?: string;
|
|
5026
|
+
/**
|
|
5027
|
+
* <p>Whether the Forecast was created from an AutoPredictor.</p>
|
|
5028
|
+
*/
|
|
5029
|
+
CreatedUsingAutoPredictor?: boolean;
|
|
3440
5030
|
/**
|
|
3441
5031
|
* <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
|
|
3442
5032
|
* the predictor.</p>
|
|
@@ -3535,9 +5125,9 @@ export declare namespace ListForecastsResponse {
|
|
|
3535
5125
|
}
|
|
3536
5126
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
3537
5127
|
/**
|
|
3538
|
-
* <p>If the result of the previous request was truncated, the response includes a
|
|
3539
|
-
* To retrieve the next set of results, use the token in the next request.
|
|
3540
|
-
* 24 hours.</p>
|
|
5128
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5129
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
5130
|
+
* Tokens expire after 24 hours.</p>
|
|
3541
5131
|
*/
|
|
3542
5132
|
NextToken?: string;
|
|
3543
5133
|
/**
|
|
@@ -3546,29 +5136,29 @@ export interface ListPredictorBacktestExportJobsRequest {
|
|
|
3546
5136
|
MaxResults?: number;
|
|
3547
5137
|
/**
|
|
3548
5138
|
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
3549
|
-
*
|
|
3550
|
-
*
|
|
3551
|
-
*
|
|
3552
|
-
*
|
|
3553
|
-
*
|
|
3554
|
-
*
|
|
3555
|
-
*
|
|
5139
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5140
|
+
* include or exclude the predictor backtest export jobs that match the statement from the
|
|
5141
|
+
* list. The match statement consists of a key and a value.</p>
|
|
5142
|
+
* <p>
|
|
5143
|
+
* <b>Filter properties</b>
|
|
5144
|
+
* </p>
|
|
5145
|
+
* <ul>
|
|
3556
5146
|
* <li>
|
|
3557
|
-
*
|
|
5147
|
+
* <p>
|
|
3558
5148
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
3559
5149
|
* <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
|
|
3560
|
-
*
|
|
3561
|
-
*
|
|
3562
|
-
*
|
|
5150
|
+
* export jobs that match the statement, specify <code>IS</code>. To exclude
|
|
5151
|
+
* matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
|
|
5152
|
+
* </li>
|
|
3563
5153
|
* <li>
|
|
3564
|
-
*
|
|
5154
|
+
* <p>
|
|
3565
5155
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
3566
5156
|
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
3567
|
-
*
|
|
5157
|
+
* </li>
|
|
3568
5158
|
* <li>
|
|
3569
|
-
*
|
|
5159
|
+
* <p>
|
|
3570
5160
|
* <code>Value</code> - The value to match.</p>
|
|
3571
|
-
*
|
|
5161
|
+
* </li>
|
|
3572
5162
|
* </ul>
|
|
3573
5163
|
*/
|
|
3574
5164
|
Filters?: Filter[];
|
|
@@ -3580,9 +5170,9 @@ export declare namespace ListPredictorBacktestExportJobsRequest {
|
|
|
3580
5170
|
const filterSensitiveLog: (obj: ListPredictorBacktestExportJobsRequest) => any;
|
|
3581
5171
|
}
|
|
3582
5172
|
/**
|
|
3583
|
-
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
3584
|
-
* the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
3585
|
-
* <code>PredictorBacktestExportJobArn</code>.</p>
|
|
5173
|
+
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
5174
|
+
* properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
5175
|
+
* provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
|
|
3586
5176
|
*/
|
|
3587
5177
|
export interface PredictorBacktestExportJobSummary {
|
|
3588
5178
|
/**
|
|
@@ -3609,7 +5199,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3609
5199
|
* <li>
|
|
3610
5200
|
* <p>
|
|
3611
5201
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3612
|
-
*
|
|
5202
|
+
* <code>CREATE_FAILED</code>
|
|
3613
5203
|
* </p>
|
|
3614
5204
|
* </li>
|
|
3615
5205
|
* <li>
|
|
@@ -3620,7 +5210,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3620
5210
|
* <li>
|
|
3621
5211
|
* <p>
|
|
3622
5212
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3623
|
-
*
|
|
5213
|
+
* <code>DELETE_FAILED</code>
|
|
3624
5214
|
* </p>
|
|
3625
5215
|
* </li>
|
|
3626
5216
|
* </ul>
|
|
@@ -3635,7 +5225,8 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3635
5225
|
*/
|
|
3636
5226
|
CreationTime?: Date;
|
|
3637
5227
|
/**
|
|
3638
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5228
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5229
|
+
* job:</p>
|
|
3639
5230
|
* <ul>
|
|
3640
5231
|
* <li>
|
|
3641
5232
|
* <p>
|
|
@@ -3675,8 +5266,8 @@ export interface ListPredictorBacktestExportJobsResponse {
|
|
|
3675
5266
|
*/
|
|
3676
5267
|
PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
|
|
3677
5268
|
/**
|
|
3678
|
-
* <p>Returns this token if the response is truncated. To retrieve the next
|
|
3679
|
-
*
|
|
5269
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
5270
|
+
* use the token in the next request.</p>
|
|
3680
5271
|
*/
|
|
3681
5272
|
NextToken?: string;
|
|
3682
5273
|
}
|
|
@@ -3754,6 +5345,15 @@ export interface PredictorSummary {
|
|
|
3754
5345
|
* the predictor.</p>
|
|
3755
5346
|
*/
|
|
3756
5347
|
DatasetGroupArn?: string;
|
|
5348
|
+
/**
|
|
5349
|
+
* <p>Whether AutoPredictor was used to create the predictor.</p>
|
|
5350
|
+
*/
|
|
5351
|
+
IsAutoPredictor?: boolean;
|
|
5352
|
+
/**
|
|
5353
|
+
* <p>A summary of the reference predictor used if the predictor was retrained or
|
|
5354
|
+
* upgraded.</p>
|
|
5355
|
+
*/
|
|
5356
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
3757
5357
|
/**
|
|
3758
5358
|
* <p>The status of the predictor. States include:</p>
|
|
3759
5359
|
* <ul>
|
|
@@ -3765,13 +5365,13 @@ export interface PredictorSummary {
|
|
|
3765
5365
|
* <li>
|
|
3766
5366
|
* <p>
|
|
3767
5367
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3768
|
-
*
|
|
5368
|
+
* <code>CREATE_FAILED</code>
|
|
3769
5369
|
* </p>
|
|
3770
5370
|
* </li>
|
|
3771
5371
|
* <li>
|
|
3772
5372
|
* <p>
|
|
3773
5373
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3774
|
-
*
|
|
5374
|
+
* <code>DELETE_FAILED</code>
|
|
3775
5375
|
* </p>
|
|
3776
5376
|
* </li>
|
|
3777
5377
|
* <li>
|
|
@@ -3795,7 +5395,8 @@ export interface PredictorSummary {
|
|
|
3795
5395
|
*/
|
|
3796
5396
|
CreationTime?: Date;
|
|
3797
5397
|
/**
|
|
3798
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5398
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5399
|
+
* job:</p>
|
|
3799
5400
|
* <ul>
|
|
3800
5401
|
* <li>
|
|
3801
5402
|
* <p>
|
|
@@ -3847,7 +5448,8 @@ export declare namespace ListPredictorsResponse {
|
|
|
3847
5448
|
}
|
|
3848
5449
|
export interface ListTagsForResourceRequest {
|
|
3849
5450
|
/**
|
|
3850
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5451
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5452
|
+
* </p>
|
|
3851
5453
|
*/
|
|
3852
5454
|
ResourceArn: string | undefined;
|
|
3853
5455
|
}
|
|
@@ -3873,8 +5475,9 @@ export interface StopResourceRequest {
|
|
|
3873
5475
|
/**
|
|
3874
5476
|
* <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
|
|
3875
5477
|
* are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>,
|
|
3876
|
-
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
3877
|
-
* <code>ForecastExportJobArn</code
|
|
5478
|
+
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5479
|
+
* <code>ForecastExportJobArn</code>, <code>ExplainabilityArn</code>, and
|
|
5480
|
+
* <code>ExplainabilityExportArn</code>. </p>
|
|
3878
5481
|
*/
|
|
3879
5482
|
ResourceArn: string | undefined;
|
|
3880
5483
|
}
|
|
@@ -3886,7 +5489,8 @@ export declare namespace StopResourceRequest {
|
|
|
3886
5489
|
}
|
|
3887
5490
|
export interface TagResourceRequest {
|
|
3888
5491
|
/**
|
|
3889
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5492
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5493
|
+
* </p>
|
|
3890
5494
|
*/
|
|
3891
5495
|
ResourceArn: string | undefined;
|
|
3892
5496
|
/**
|
|
@@ -3897,7 +5501,8 @@ export interface TagResourceRequest {
|
|
|
3897
5501
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
3898
5502
|
* </li>
|
|
3899
5503
|
* <li>
|
|
3900
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5504
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5505
|
+
* value.</p>
|
|
3901
5506
|
* </li>
|
|
3902
5507
|
* <li>
|
|
3903
5508
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -3906,13 +5511,21 @@ export interface TagResourceRequest {
|
|
|
3906
5511
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
3907
5512
|
* </li>
|
|
3908
5513
|
* <li>
|
|
3909
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5514
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5515
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
5516
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
5517
|
+
* - = . _ : / @.</p>
|
|
3910
5518
|
* </li>
|
|
3911
5519
|
* <li>
|
|
3912
5520
|
* <p>Tag keys and values are case sensitive.</p>
|
|
3913
5521
|
* </li>
|
|
3914
5522
|
* <li>
|
|
3915
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5523
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5524
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
5525
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
5526
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
5527
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
5528
|
+
* not count against your tags per resource limit.</p>
|
|
3916
5529
|
* </li>
|
|
3917
5530
|
* </ul>
|
|
3918
5531
|
*/
|
|
@@ -3934,7 +5547,8 @@ export declare namespace TagResourceResponse {
|
|
|
3934
5547
|
}
|
|
3935
5548
|
export interface UntagResourceRequest {
|
|
3936
5549
|
/**
|
|
3937
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5550
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5551
|
+
* </p>
|
|
3938
5552
|
*/
|
|
3939
5553
|
ResourceArn: string | undefined;
|
|
3940
5554
|
/**
|