@aws-sdk/client-forecast 3.42.0 → 3.47.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 +50 -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 -12
- package/dist-cjs/models/models_0.js +206 -67
- package/dist-cjs/protocols/Aws_json1_1.js +1283 -98
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- 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 -12
- package/dist-es/models/models_0.js +140 -44
- package/dist-es/protocols/Aws_json1_1.js +1367 -138
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/Forecast.d.ts +306 -40
- package/dist-types/ForecastClient.d.ts +17 -3
- 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 +2078 -500
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/Forecast.d.ts +50 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +15 -3
- 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 +479 -94
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +38 -45
|
@@ -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,256 @@ 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
|
+
/**
|
|
583
|
+
* <p>The limit on the number of resources per account has been exceeded.</p>
|
|
584
|
+
*/
|
|
585
|
+
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
586
|
+
name: "LimitExceededException";
|
|
587
|
+
$fault: "client";
|
|
588
|
+
Message?: string;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* <p>There is already a resource with this name. Try again with a different name.</p>
|
|
592
|
+
*/
|
|
593
|
+
export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
|
|
594
|
+
name: "ResourceAlreadyExistsException";
|
|
595
|
+
$fault: "client";
|
|
596
|
+
Message?: string;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* <p>The specified resource is in use.</p>
|
|
600
|
+
*/
|
|
601
|
+
export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
|
|
602
|
+
name: "ResourceInUseException";
|
|
603
|
+
$fault: "client";
|
|
604
|
+
Message?: string;
|
|
605
|
+
}
|
|
606
|
+
/**
|
|
607
|
+
* <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
|
|
608
|
+
* again.</p>
|
|
609
|
+
*/
|
|
610
|
+
export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
|
|
611
|
+
name: "ResourceNotFoundException";
|
|
612
|
+
$fault: "client";
|
|
613
|
+
Message?: string;
|
|
614
|
+
}
|
|
615
|
+
export declare enum DatasetType {
|
|
616
|
+
ITEM_METADATA = "ITEM_METADATA",
|
|
617
|
+
RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
|
|
618
|
+
TARGET_TIME_SERIES = "TARGET_TIME_SERIES"
|
|
619
|
+
}
|
|
620
|
+
export declare enum Domain {
|
|
621
|
+
CUSTOM = "CUSTOM",
|
|
622
|
+
EC2_CAPACITY = "EC2_CAPACITY",
|
|
623
|
+
INVENTORY_PLANNING = "INVENTORY_PLANNING",
|
|
624
|
+
METRICS = "METRICS",
|
|
625
|
+
RETAIL = "RETAIL",
|
|
626
|
+
WEB_TRAFFIC = "WEB_TRAFFIC",
|
|
627
|
+
WORK_FORCE = "WORK_FORCE"
|
|
628
|
+
}
|
|
629
|
+
export declare enum AttributeType {
|
|
630
|
+
FLOAT = "float",
|
|
631
|
+
GEOLOCATION = "geolocation",
|
|
632
|
+
INTEGER = "integer",
|
|
633
|
+
STRING = "string",
|
|
634
|
+
TIMESTAMP = "timestamp"
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* <p>An attribute of a schema, which defines a dataset field. A schema attribute is required
|
|
638
|
+
* for every field in a dataset. The <a>Schema</a> object contains an array of
|
|
639
|
+
* <code>SchemaAttribute</code> objects.</p>
|
|
640
|
+
*/
|
|
641
|
+
export interface SchemaAttribute {
|
|
642
|
+
/**
|
|
643
|
+
* <p>The name of the dataset field.</p>
|
|
644
|
+
*/
|
|
645
|
+
AttributeName?: string;
|
|
646
|
+
/**
|
|
647
|
+
* <p>The data type of the field.</p>
|
|
112
648
|
*/
|
|
113
|
-
|
|
649
|
+
AttributeType?: AttributeType | string;
|
|
650
|
+
}
|
|
651
|
+
export declare namespace SchemaAttribute {
|
|
114
652
|
/**
|
|
115
|
-
*
|
|
653
|
+
* @internal
|
|
116
654
|
*/
|
|
117
|
-
|
|
655
|
+
const filterSensitiveLog: (obj: SchemaAttribute) => any;
|
|
118
656
|
}
|
|
119
|
-
|
|
657
|
+
/**
|
|
658
|
+
* <p>Defines the fields of a dataset.</p>
|
|
659
|
+
*/
|
|
660
|
+
export interface Schema {
|
|
661
|
+
/**
|
|
662
|
+
* <p>An array of attributes specifying the name and type of each field in a dataset.</p>
|
|
663
|
+
*/
|
|
664
|
+
Attributes?: SchemaAttribute[];
|
|
665
|
+
}
|
|
666
|
+
export declare namespace Schema {
|
|
120
667
|
/**
|
|
121
668
|
* @internal
|
|
122
669
|
*/
|
|
123
|
-
const filterSensitiveLog: (obj:
|
|
670
|
+
const filterSensitiveLog: (obj: Schema) => any;
|
|
124
671
|
}
|
|
125
672
|
export interface CreateDatasetRequest {
|
|
126
673
|
/**
|
|
@@ -162,14 +709,16 @@ export interface CreateDatasetRequest {
|
|
|
162
709
|
*/
|
|
163
710
|
EncryptionConfig?: EncryptionConfig;
|
|
164
711
|
/**
|
|
165
|
-
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
712
|
+
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
713
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
166
714
|
* <p>The following basic restrictions apply to tags:</p>
|
|
167
715
|
* <ul>
|
|
168
716
|
* <li>
|
|
169
717
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
170
718
|
* </li>
|
|
171
719
|
* <li>
|
|
172
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
720
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
721
|
+
* value.</p>
|
|
173
722
|
* </li>
|
|
174
723
|
* <li>
|
|
175
724
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -178,13 +727,21 @@ export interface CreateDatasetRequest {
|
|
|
178
727
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
179
728
|
* </li>
|
|
180
729
|
* <li>
|
|
181
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
730
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
731
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
732
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
733
|
+
* - = . _ : / @.</p>
|
|
182
734
|
* </li>
|
|
183
735
|
* <li>
|
|
184
736
|
* <p>Tag keys and values are case sensitive.</p>
|
|
185
737
|
* </li>
|
|
186
738
|
* <li>
|
|
187
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
739
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
740
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
741
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
742
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
743
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
744
|
+
* not count against your tags per resource limit.</p>
|
|
188
745
|
* </li>
|
|
189
746
|
* </ul>
|
|
190
747
|
*/
|
|
@@ -208,49 +765,6 @@ export declare namespace CreateDatasetResponse {
|
|
|
208
765
|
*/
|
|
209
766
|
const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
|
|
210
767
|
}
|
|
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
768
|
export interface CreateDatasetGroupRequest {
|
|
255
769
|
/**
|
|
256
770
|
* <p>A name for the dataset group.</p>
|
|
@@ -273,14 +787,17 @@ export interface CreateDatasetGroupRequest {
|
|
|
273
787
|
*/
|
|
274
788
|
DatasetArns?: string[];
|
|
275
789
|
/**
|
|
276
|
-
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
790
|
+
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
791
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
792
|
+
* define.</p>
|
|
277
793
|
* <p>The following basic restrictions apply to tags:</p>
|
|
278
794
|
* <ul>
|
|
279
795
|
* <li>
|
|
280
796
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
281
797
|
* </li>
|
|
282
798
|
* <li>
|
|
283
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
799
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
800
|
+
* value.</p>
|
|
284
801
|
* </li>
|
|
285
802
|
* <li>
|
|
286
803
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -289,13 +806,21 @@ export interface CreateDatasetGroupRequest {
|
|
|
289
806
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
290
807
|
* </li>
|
|
291
808
|
* <li>
|
|
292
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
809
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
810
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
811
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
812
|
+
* - = . _ : / @.</p>
|
|
293
813
|
* </li>
|
|
294
814
|
* <li>
|
|
295
815
|
* <p>Tag keys and values are case sensitive.</p>
|
|
296
816
|
* </li>
|
|
297
817
|
* <li>
|
|
298
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
818
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
819
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
820
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
821
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
822
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
823
|
+
* not count against your tags per resource limit.</p>
|
|
299
824
|
* </li>
|
|
300
825
|
* </ul>
|
|
301
826
|
*/
|
|
@@ -319,35 +844,6 @@ export declare namespace CreateDatasetGroupResponse {
|
|
|
319
844
|
*/
|
|
320
845
|
const filterSensitiveLog: (obj: CreateDatasetGroupResponse) => any;
|
|
321
846
|
}
|
|
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
847
|
/**
|
|
352
848
|
* <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
849
|
* Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This
|
|
@@ -378,13 +874,12 @@ export declare namespace S3Config {
|
|
|
378
874
|
const filterSensitiveLog: (obj: S3Config) => any;
|
|
379
875
|
}
|
|
380
876
|
/**
|
|
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>
|
|
877
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
878
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
384
879
|
*/
|
|
385
880
|
export interface DataSource {
|
|
386
881
|
/**
|
|
387
|
-
* <p>The path to the
|
|
882
|
+
* <p>The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
|
|
388
883
|
* credentials to access the data.</p>
|
|
389
884
|
*/
|
|
390
885
|
S3Config: S3Config | undefined;
|
|
@@ -408,107 +903,339 @@ export interface CreateDatasetImportJobRequest {
|
|
|
408
903
|
*/
|
|
409
904
|
DatasetArn: string | undefined;
|
|
410
905
|
/**
|
|
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>
|
|
906
|
+
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
907
|
+
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
908
|
+
* <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
|
|
909
|
+
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
910
|
+
* match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a> operation.</p>
|
|
911
|
+
*/
|
|
912
|
+
DataSource: DataSource | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* <p>The format of timestamps in the dataset. The format that you specify depends on the
|
|
915
|
+
* <code>DataFrequency</code> specified when the dataset was created. The following formats are
|
|
916
|
+
* supported</p>
|
|
917
|
+
* <ul>
|
|
918
|
+
* <li>
|
|
919
|
+
* <p>"yyyy-MM-dd"</p>
|
|
920
|
+
* <p>For the following data frequencies: Y, M, W, and D</p>
|
|
921
|
+
* </li>
|
|
922
|
+
* <li>
|
|
923
|
+
* <p>"yyyy-MM-dd HH:mm:ss"</p>
|
|
924
|
+
* <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,
|
|
925
|
+
* M, W, and D</p>
|
|
926
|
+
* </li>
|
|
927
|
+
* </ul>
|
|
928
|
+
* <p>If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd
|
|
929
|
+
* HH:mm:ss".</p>
|
|
930
|
+
*/
|
|
931
|
+
TimestampFormat?: string;
|
|
932
|
+
/**
|
|
933
|
+
* <p>A single time zone for every item in your dataset. This option is ideal for datasets
|
|
934
|
+
* with all timestamps within a single time zone, or if all timestamps are normalized to a
|
|
935
|
+
* single time zone. </p>
|
|
936
|
+
* <p>Refer to the <a href="http://joda-time.sourceforge.net/timezones.html">Joda-Time
|
|
937
|
+
* API</a> for a complete list of valid time zone names.</p>
|
|
938
|
+
*/
|
|
939
|
+
TimeZone?: string;
|
|
940
|
+
/**
|
|
941
|
+
* <p>Automatically derive time zone information from the geolocation attribute. This option
|
|
942
|
+
* is ideal for datasets that contain timestamps in multiple time zones and those
|
|
943
|
+
* timestamps are expressed in local time.</p>
|
|
944
|
+
*/
|
|
945
|
+
UseGeolocationForTimeZone?: boolean;
|
|
946
|
+
/**
|
|
947
|
+
* <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
|
|
948
|
+
* one of two ways:</p>
|
|
949
|
+
* <ul>
|
|
950
|
+
* <li>
|
|
951
|
+
* <p>
|
|
952
|
+
* <code>LAT_LONG</code> - the latitude and longitude in decimal format (Example: 47.61_-122.33).</p>
|
|
953
|
+
* </li>
|
|
954
|
+
* <li>
|
|
955
|
+
* <p>
|
|
956
|
+
* <code>CC_POSTALCODE</code> (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).</p>
|
|
957
|
+
* </li>
|
|
958
|
+
* </ul>
|
|
959
|
+
*/
|
|
960
|
+
GeolocationFormat?: string;
|
|
961
|
+
/**
|
|
962
|
+
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
963
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
964
|
+
* define.</p>
|
|
965
|
+
* <p>The following basic restrictions apply to tags:</p>
|
|
966
|
+
* <ul>
|
|
967
|
+
* <li>
|
|
968
|
+
* <p>Maximum number of tags per resource - 50.</p>
|
|
969
|
+
* </li>
|
|
970
|
+
* <li>
|
|
971
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
972
|
+
* value.</p>
|
|
973
|
+
* </li>
|
|
974
|
+
* <li>
|
|
975
|
+
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
976
|
+
* </li>
|
|
977
|
+
* <li>
|
|
978
|
+
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
979
|
+
* </li>
|
|
980
|
+
* <li>
|
|
981
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
982
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
983
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
984
|
+
* - = . _ : / @.</p>
|
|
985
|
+
* </li>
|
|
986
|
+
* <li>
|
|
987
|
+
* <p>Tag keys and values are case sensitive.</p>
|
|
988
|
+
* </li>
|
|
989
|
+
* <li>
|
|
990
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
991
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
992
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
993
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
994
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
995
|
+
* not count against your tags per resource limit.</p>
|
|
996
|
+
* </li>
|
|
997
|
+
* </ul>
|
|
998
|
+
*/
|
|
999
|
+
Tags?: Tag[];
|
|
1000
|
+
}
|
|
1001
|
+
export declare namespace CreateDatasetImportJobRequest {
|
|
1002
|
+
/**
|
|
1003
|
+
* @internal
|
|
1004
|
+
*/
|
|
1005
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobRequest) => any;
|
|
1006
|
+
}
|
|
1007
|
+
export interface CreateDatasetImportJobResponse {
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
|
|
1010
|
+
*/
|
|
1011
|
+
DatasetImportJobArn?: string;
|
|
1012
|
+
}
|
|
1013
|
+
export declare namespace CreateDatasetImportJobResponse {
|
|
1014
|
+
/**
|
|
1015
|
+
* @internal
|
|
1016
|
+
*/
|
|
1017
|
+
const filterSensitiveLog: (obj: CreateDatasetImportJobResponse) => any;
|
|
1018
|
+
}
|
|
1019
|
+
export declare enum TimePointGranularity {
|
|
1020
|
+
ALL = "ALL",
|
|
1021
|
+
SPECIFIC = "SPECIFIC"
|
|
1022
|
+
}
|
|
1023
|
+
export declare enum TimeSeriesGranularity {
|
|
1024
|
+
ALL = "ALL",
|
|
1025
|
+
SPECIFIC = "SPECIFIC"
|
|
1026
|
+
}
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>The ExplainabilityConfig data type defines the number of time series and time points
|
|
1029
|
+
* included in <a>CreateExplainability</a>.</p>
|
|
1030
|
+
* <p>If you provide a predictor ARN for <code>ResourceArn</code>, you must set both
|
|
1031
|
+
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
|
|
1032
|
+
* When creating Predictor Explainability, Amazon Forecast considers all time series and
|
|
1033
|
+
* time points.</p>
|
|
1034
|
+
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set <code>TimePointGranularity</code> and
|
|
1035
|
+
* <code>TimeSeriesGranularity</code> to either “ALL” or “Specific”.</p>
|
|
1036
|
+
*/
|
|
1037
|
+
export interface ExplainabilityConfig {
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>To create an Explainability for all time series in your datasets, use
|
|
1040
|
+
* <code>ALL</code>. To create an Explainability for specific time series in your datasets,
|
|
1041
|
+
* use <code>SPECIFIC</code>.</p>
|
|
1042
|
+
* <p>Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location
|
|
1043
|
+
* within the <a>DataDestination</a> data type.</p>
|
|
1044
|
+
*/
|
|
1045
|
+
TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>To create an Explainability for all time points in your forecast horizon, use
|
|
1048
|
+
* <code>ALL</code>. To create an Explainability for specific time points in your
|
|
1049
|
+
* forecast horizon, use <code>SPECIFIC</code>.</p>
|
|
1050
|
+
* <p>Specify time points with the <code>StartDateTime</code> and <code>EndDateTime</code>
|
|
1051
|
+
* parameters within the <a>CreateExplainability</a> operation.</p>
|
|
1052
|
+
*/
|
|
1053
|
+
TimePointGranularity: TimePointGranularity | string | undefined;
|
|
1054
|
+
}
|
|
1055
|
+
export declare namespace ExplainabilityConfig {
|
|
1056
|
+
/**
|
|
1057
|
+
* @internal
|
|
1058
|
+
*/
|
|
1059
|
+
const filterSensitiveLog: (obj: ExplainabilityConfig) => any;
|
|
1060
|
+
}
|
|
1061
|
+
export interface CreateExplainabilityRequest {
|
|
1062
|
+
/**
|
|
1063
|
+
* <p>A unique name for the Explainability.</p>
|
|
1064
|
+
*/
|
|
1065
|
+
ExplainabilityName: string | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
1068
|
+
* Explainability.</p>
|
|
1069
|
+
*/
|
|
1070
|
+
ResourceArn: string | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
1073
|
+
* for the Explainability.</p>
|
|
1074
|
+
*/
|
|
1075
|
+
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1078
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
1079
|
+
*/
|
|
1080
|
+
DataSource?: DataSource;
|
|
1081
|
+
/**
|
|
1082
|
+
* <p>Defines the fields of a dataset.</p>
|
|
1083
|
+
*/
|
|
1084
|
+
Schema?: Schema;
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>Create an Expainability visualization that is viewable within the AWS console.</p>
|
|
1087
|
+
*/
|
|
1088
|
+
EnableVisualization?: boolean;
|
|
1089
|
+
/**
|
|
1090
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1091
|
+
* point for the Explainability.</p>
|
|
1092
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1093
|
+
*/
|
|
1094
|
+
StartDateTime?: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1097
|
+
* time point for the Explainability.</p>
|
|
1098
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1099
|
+
*/
|
|
1100
|
+
EndDateTime?: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1103
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1104
|
+
* are case sensitive.</p>
|
|
1105
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1106
|
+
* <ul>
|
|
1107
|
+
* <li>
|
|
1108
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1109
|
+
* value.</p>
|
|
1110
|
+
* </li>
|
|
1111
|
+
* <li>
|
|
1112
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
1113
|
+
* </li>
|
|
1114
|
+
* <li>
|
|
1115
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
1116
|
+
* </li>
|
|
1117
|
+
* <li>
|
|
1118
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1119
|
+
* </li>
|
|
1120
|
+
* <li>
|
|
1121
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1122
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1123
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
1124
|
+
* </li>
|
|
1125
|
+
* <li>
|
|
1126
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1127
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1128
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1129
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1130
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1131
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
1132
|
+
* </li>
|
|
1133
|
+
* </ul>
|
|
1134
|
+
*/
|
|
1135
|
+
Tags?: Tag[];
|
|
1136
|
+
}
|
|
1137
|
+
export declare namespace CreateExplainabilityRequest {
|
|
1138
|
+
/**
|
|
1139
|
+
* @internal
|
|
1140
|
+
*/
|
|
1141
|
+
const filterSensitiveLog: (obj: CreateExplainabilityRequest) => any;
|
|
1142
|
+
}
|
|
1143
|
+
export interface CreateExplainabilityResponse {
|
|
1144
|
+
/**
|
|
1145
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
1146
|
+
*/
|
|
1147
|
+
ExplainabilityArn?: string;
|
|
1148
|
+
}
|
|
1149
|
+
export declare namespace CreateExplainabilityResponse {
|
|
1150
|
+
/**
|
|
1151
|
+
* @internal
|
|
1152
|
+
*/
|
|
1153
|
+
const filterSensitiveLog: (obj: CreateExplainabilityResponse) => any;
|
|
1154
|
+
}
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1157
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
1158
|
+
*/
|
|
1159
|
+
export interface DataDestination {
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the
|
|
1162
|
+
* bucket.</p>
|
|
416
1163
|
*/
|
|
417
|
-
|
|
1164
|
+
S3Config: S3Config | undefined;
|
|
1165
|
+
}
|
|
1166
|
+
export declare namespace DataDestination {
|
|
418
1167
|
/**
|
|
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>
|
|
1168
|
+
* @internal
|
|
435
1169
|
*/
|
|
436
|
-
|
|
1170
|
+
const filterSensitiveLog: (obj: DataDestination) => any;
|
|
1171
|
+
}
|
|
1172
|
+
export interface CreateExplainabilityExportRequest {
|
|
437
1173
|
/**
|
|
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>
|
|
1174
|
+
* <p>A unique name for the Explainability export.</p>
|
|
443
1175
|
*/
|
|
444
|
-
|
|
1176
|
+
ExplainabilityExportName: string | undefined;
|
|
445
1177
|
/**
|
|
446
|
-
* <p>
|
|
447
|
-
* is ideal for datasets that contain timestamps in multiple time zones and those
|
|
448
|
-
* timestamps are expressed in local time.</p>
|
|
1178
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
|
|
449
1179
|
*/
|
|
450
|
-
|
|
1180
|
+
ExplainabilityArn: string | undefined;
|
|
451
1181
|
/**
|
|
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>
|
|
1182
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
1183
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
464
1184
|
*/
|
|
465
|
-
|
|
1185
|
+
Destination: DataDestination | undefined;
|
|
466
1186
|
/**
|
|
467
|
-
* <p>
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
* </li>
|
|
1187
|
+
* <p>Optional metadata to help you categorize and organize your resources. Each tag
|
|
1188
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
1189
|
+
* are case sensitive.</p>
|
|
1190
|
+
* <p>The following restrictions apply to tags:</p>
|
|
1191
|
+
* <ul>
|
|
473
1192
|
* <li>
|
|
474
|
-
*
|
|
1193
|
+
* <p>For each resource, each tag key must be unique and each tag key must have one
|
|
1194
|
+
* value.</p>
|
|
475
1195
|
* </li>
|
|
476
1196
|
* <li>
|
|
477
|
-
*
|
|
1197
|
+
* <p>Maximum number of tags per resource: 50.</p>
|
|
478
1198
|
* </li>
|
|
479
1199
|
* <li>
|
|
480
|
-
*
|
|
1200
|
+
* <p>Maximum key length: 128 Unicode characters in UTF-8.</p>
|
|
481
1201
|
* </li>
|
|
482
1202
|
* <li>
|
|
483
|
-
*
|
|
1203
|
+
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
484
1204
|
* </li>
|
|
485
1205
|
* <li>
|
|
486
|
-
*
|
|
1206
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
1207
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
1208
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
487
1209
|
* </li>
|
|
488
1210
|
* <li>
|
|
489
|
-
*
|
|
1211
|
+
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
1212
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
1213
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
1214
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
1215
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
1216
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
490
1217
|
* </li>
|
|
491
1218
|
* </ul>
|
|
492
1219
|
*/
|
|
493
1220
|
Tags?: Tag[];
|
|
494
1221
|
}
|
|
495
|
-
export declare namespace
|
|
1222
|
+
export declare namespace CreateExplainabilityExportRequest {
|
|
496
1223
|
/**
|
|
497
1224
|
* @internal
|
|
498
1225
|
*/
|
|
499
|
-
const filterSensitiveLog: (obj:
|
|
1226
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportRequest) => any;
|
|
500
1227
|
}
|
|
501
|
-
export interface
|
|
1228
|
+
export interface CreateExplainabilityExportResponse {
|
|
502
1229
|
/**
|
|
503
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1230
|
+
* <p>The Amazon Resource Name (ARN) of the export.</p>
|
|
504
1231
|
*/
|
|
505
|
-
|
|
1232
|
+
ExplainabilityExportArn?: string;
|
|
506
1233
|
}
|
|
507
|
-
export declare namespace
|
|
1234
|
+
export declare namespace CreateExplainabilityExportResponse {
|
|
508
1235
|
/**
|
|
509
1236
|
* @internal
|
|
510
1237
|
*/
|
|
511
|
-
const filterSensitiveLog: (obj:
|
|
1238
|
+
const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
|
|
512
1239
|
}
|
|
513
1240
|
export interface CreateForecastRequest {
|
|
514
1241
|
/**
|
|
@@ -528,14 +1255,16 @@ export interface CreateForecastRequest {
|
|
|
528
1255
|
*/
|
|
529
1256
|
ForecastTypes?: string[];
|
|
530
1257
|
/**
|
|
531
|
-
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1258
|
+
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1259
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
532
1260
|
* <p>The following basic restrictions apply to tags:</p>
|
|
533
1261
|
* <ul>
|
|
534
1262
|
* <li>
|
|
535
1263
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
536
1264
|
* </li>
|
|
537
1265
|
* <li>
|
|
538
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1266
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1267
|
+
* value.</p>
|
|
539
1268
|
* </li>
|
|
540
1269
|
* <li>
|
|
541
1270
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -544,13 +1273,21 @@ export interface CreateForecastRequest {
|
|
|
544
1273
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
545
1274
|
* </li>
|
|
546
1275
|
* <li>
|
|
547
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1276
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1277
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1278
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1279
|
+
* - = . _ : / @.</p>
|
|
548
1280
|
* </li>
|
|
549
1281
|
* <li>
|
|
550
1282
|
* <p>Tag keys and values are case sensitive.</p>
|
|
551
1283
|
* </li>
|
|
552
1284
|
* <li>
|
|
553
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1285
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1286
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1287
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1288
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1289
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1290
|
+
* not count against your tags per resource limit.</p>
|
|
554
1291
|
* </li>
|
|
555
1292
|
* </ul>
|
|
556
1293
|
*/
|
|
@@ -574,23 +1311,6 @@ export declare namespace CreateForecastResponse {
|
|
|
574
1311
|
*/
|
|
575
1312
|
const filterSensitiveLog: (obj: CreateForecastResponse) => any;
|
|
576
1313
|
}
|
|
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
1314
|
export interface CreateForecastExportJobRequest {
|
|
595
1315
|
/**
|
|
596
1316
|
* <p>The name for the forecast export job.</p>
|
|
@@ -609,14 +1329,17 @@ export interface CreateForecastExportJobRequest {
|
|
|
609
1329
|
*/
|
|
610
1330
|
Destination: DataDestination | undefined;
|
|
611
1331
|
/**
|
|
612
|
-
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1332
|
+
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1333
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
1334
|
+
* define.</p>
|
|
613
1335
|
* <p>The following basic restrictions apply to tags:</p>
|
|
614
1336
|
* <ul>
|
|
615
1337
|
* <li>
|
|
616
1338
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
617
1339
|
* </li>
|
|
618
1340
|
* <li>
|
|
619
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1341
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1342
|
+
* value.</p>
|
|
620
1343
|
* </li>
|
|
621
1344
|
* <li>
|
|
622
1345
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -625,13 +1348,21 @@ export interface CreateForecastExportJobRequest {
|
|
|
625
1348
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
626
1349
|
* </li>
|
|
627
1350
|
* <li>
|
|
628
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1351
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1352
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1353
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1354
|
+
* - = . _ : / @.</p>
|
|
629
1355
|
* </li>
|
|
630
1356
|
* <li>
|
|
631
1357
|
* <p>Tag keys and values are case sensitive.</p>
|
|
632
1358
|
* </li>
|
|
633
1359
|
* <li>
|
|
634
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1360
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1361
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1362
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1363
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1364
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1365
|
+
* not count against your tags per resource limit.</p>
|
|
635
1366
|
* </li>
|
|
636
1367
|
* </ul>
|
|
637
1368
|
*/
|
|
@@ -656,6 +1387,7 @@ export declare namespace CreateForecastExportJobResponse {
|
|
|
656
1387
|
const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
|
|
657
1388
|
}
|
|
658
1389
|
export declare enum AutoMLOverrideStrategy {
|
|
1390
|
+
AccuracyOptimized = "AccuracyOptimized",
|
|
659
1391
|
LatencyOptimized = "LatencyOptimized"
|
|
660
1392
|
}
|
|
661
1393
|
/**
|
|
@@ -691,10 +1423,10 @@ export declare enum FeaturizationMethodName {
|
|
|
691
1423
|
filling = "filling"
|
|
692
1424
|
}
|
|
693
1425
|
/**
|
|
694
|
-
* <p>Provides information about the method that featurizes (transforms) a dataset field.
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
1426
|
+
* <p>Provides information about the method that featurizes (transforms) a dataset field. The
|
|
1427
|
+
* method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. </p>
|
|
1428
|
+
* <p>The following is an example of how you specify a <code>FeaturizationMethod</code>
|
|
1429
|
+
* object.</p>
|
|
698
1430
|
* <p>
|
|
699
1431
|
* <code>{</code>
|
|
700
1432
|
* </p>
|
|
@@ -702,7 +1434,8 @@ export declare enum FeaturizationMethodName {
|
|
|
702
1434
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
703
1435
|
* </p>
|
|
704
1436
|
* <p>
|
|
705
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1437
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1438
|
+
* "backfill": "zero"}</code>
|
|
706
1439
|
* </p>
|
|
707
1440
|
* <p>
|
|
708
1441
|
* <code>}</code>
|
|
@@ -714,14 +1447,17 @@ export interface FeaturizationMethod {
|
|
|
714
1447
|
*/
|
|
715
1448
|
FeaturizationMethodName: FeaturizationMethodName | string | undefined;
|
|
716
1449
|
/**
|
|
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
|
-
*
|
|
1450
|
+
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
1451
|
+
* these parameters to override the default values. Related Time Series attributes do not accept
|
|
1452
|
+
* aggregation parameters.</p>
|
|
1453
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
1454
|
+
* featurization method for a <b>Target Time Series</b> dataset. Bold
|
|
1455
|
+
* signifies the default value.</p>
|
|
721
1456
|
* <ul>
|
|
722
1457
|
* <li>
|
|
723
1458
|
* <p>
|
|
724
|
-
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1459
|
+
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1460
|
+
* <code>first</code>, <code>min</code>, <code>max</code>
|
|
725
1461
|
* </p>
|
|
726
1462
|
* </li>
|
|
727
1463
|
* <li>
|
|
@@ -731,12 +1467,16 @@ export interface FeaturizationMethod {
|
|
|
731
1467
|
* </li>
|
|
732
1468
|
* <li>
|
|
733
1469
|
* <p>
|
|
734
|
-
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1470
|
+
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1471
|
+
* a number), <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1472
|
+
* <code>max</code>
|
|
735
1473
|
* </p>
|
|
736
1474
|
* </li>
|
|
737
1475
|
* <li>
|
|
738
1476
|
* <p>
|
|
739
|
-
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1477
|
+
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1478
|
+
* <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1479
|
+
* <code>max</code>
|
|
740
1480
|
* </p>
|
|
741
1481
|
* </li>
|
|
742
1482
|
* </ul>
|
|
@@ -745,17 +1485,20 @@ export interface FeaturizationMethod {
|
|
|
745
1485
|
* <ul>
|
|
746
1486
|
* <li>
|
|
747
1487
|
* <p>
|
|
748
|
-
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1488
|
+
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1489
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
749
1490
|
* </p>
|
|
750
1491
|
* </li>
|
|
751
1492
|
* <li>
|
|
752
1493
|
* <p>
|
|
753
|
-
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1494
|
+
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1495
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
754
1496
|
* </p>
|
|
755
1497
|
* </li>
|
|
756
1498
|
* <li>
|
|
757
1499
|
* <p>
|
|
758
|
-
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1500
|
+
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1501
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
759
1502
|
* </p>
|
|
760
1503
|
* </li>
|
|
761
1504
|
* </ul>
|
|
@@ -775,8 +1518,12 @@ export declare namespace FeaturizationMethod {
|
|
|
775
1518
|
const filterSensitiveLog: (obj: FeaturizationMethod) => any;
|
|
776
1519
|
}
|
|
777
1520
|
/**
|
|
778
|
-
* <
|
|
779
|
-
*
|
|
1521
|
+
* <note>
|
|
1522
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1523
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1524
|
+
* </note>
|
|
1525
|
+
* <p>Provides featurization (transformation) information for a dataset field. This object is
|
|
1526
|
+
* part of the <a>FeaturizationConfig</a> object.</p>
|
|
780
1527
|
* <p>For example:</p>
|
|
781
1528
|
* <p>
|
|
782
1529
|
* <code>{</code>
|
|
@@ -792,7 +1539,8 @@ export declare namespace FeaturizationMethod {
|
|
|
792
1539
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
793
1540
|
* </p>
|
|
794
1541
|
* <p>
|
|
795
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1542
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1543
|
+
* "nan"}</code>
|
|
796
1544
|
* </p>
|
|
797
1545
|
* <p>
|
|
798
1546
|
* <code>} ]</code>
|
|
@@ -803,11 +1551,11 @@ export declare namespace FeaturizationMethod {
|
|
|
803
1551
|
*/
|
|
804
1552
|
export interface Featurization {
|
|
805
1553
|
/**
|
|
806
|
-
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
* <code>
|
|
810
|
-
*
|
|
1554
|
+
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1555
|
+
* Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the
|
|
1556
|
+
* <code>RELATED_TIME_SERIES</code> datasets. For example, for the <code>RETAIL</code> domain,
|
|
1557
|
+
* the target is <code>demand</code>, and for the <code>CUSTOM</code> domain, the target is
|
|
1558
|
+
* <code>target_value</code>. For more information, see <a>howitworks-missing-values</a>.</p>
|
|
811
1559
|
*/
|
|
812
1560
|
AttributeName: string | undefined;
|
|
813
1561
|
/**
|
|
@@ -823,25 +1571,29 @@ export declare namespace Featurization {
|
|
|
823
1571
|
const filterSensitiveLog: (obj: Featurization) => any;
|
|
824
1572
|
}
|
|
825
1573
|
/**
|
|
826
|
-
* <
|
|
827
|
-
*
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
* <p>
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
* featurization
|
|
1574
|
+
* <note>
|
|
1575
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1576
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1577
|
+
* </note>
|
|
1578
|
+
* <p>In a <a>CreatePredictor</a> operation, the specified algorithm trains a model
|
|
1579
|
+
* using the specified dataset group. You can optionally tell the operation to modify data fields
|
|
1580
|
+
* prior to training a model. These modifications are referred to as
|
|
1581
|
+
* <i>featurization</i>.</p>
|
|
1582
|
+
* <p>You define featurization using the <code>FeaturizationConfig</code> object. You specify an
|
|
1583
|
+
* array of transformations, one for each field that you want to featurize. You then include the
|
|
1584
|
+
* <code>FeaturizationConfig</code> object in your <code>CreatePredictor</code> request.
|
|
1585
|
+
* Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> and
|
|
1586
|
+
* <code>RELATED_TIME_SERIES</code> datasets before model training.</p>
|
|
1587
|
+
* <p>You can create multiple featurization configurations. For example, you might call the
|
|
1588
|
+
* <code>CreatePredictor</code> operation twice by specifying different featurization
|
|
1589
|
+
* configurations.</p>
|
|
838
1590
|
*/
|
|
839
1591
|
export interface FeaturizationConfig {
|
|
840
1592
|
/**
|
|
841
1593
|
* <p>The frequency of predictions in a forecast.</p>
|
|
842
1594
|
* <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
|
-
*
|
|
1595
|
+
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
|
|
1596
|
+
* "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
845
1597
|
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
846
1598
|
* frequency.</p>
|
|
847
1599
|
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
@@ -849,14 +1601,16 @@ export interface FeaturizationConfig {
|
|
|
849
1601
|
*/
|
|
850
1602
|
ForecastFrequency: string | undefined;
|
|
851
1603
|
/**
|
|
852
|
-
* <p>An array of dimension (field) names that specify how to group the generated
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
1604
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1605
|
+
* forecast.</p>
|
|
1606
|
+
* <p>For example, suppose that you are generating a forecast for item sales across all of your
|
|
1607
|
+
* stores, and your dataset contains a <code>store_id</code> field. If you want the sales
|
|
1608
|
+
* forecast for each item by store, you would specify <code>store_id</code> as the
|
|
1609
|
+
* dimension.</p>
|
|
856
1610
|
* <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
|
-
*
|
|
1611
|
+
* need to be specified in the <code>CreatePredictor</code> request. All forecast dimensions
|
|
1612
|
+
* specified in the <code>RELATED_TIME_SERIES</code> dataset must be specified in the
|
|
1613
|
+
* <code>CreatePredictor</code> request.</p>
|
|
860
1614
|
*/
|
|
861
1615
|
ForecastDimensions?: string[];
|
|
862
1616
|
/**
|
|
@@ -1057,7 +1811,11 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1057
1811
|
const filterSensitiveLog: (obj: HyperParameterTuningJobConfig) => any;
|
|
1058
1812
|
}
|
|
1059
1813
|
/**
|
|
1060
|
-
* <
|
|
1814
|
+
* <note>
|
|
1815
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1816
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AdditionalDataset</a>.</p>
|
|
1817
|
+
* </note>
|
|
1818
|
+
* <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
1819
|
* featurizations.</p>
|
|
1062
1820
|
* <p>
|
|
1063
1821
|
* <b>Weather Index</b>
|
|
@@ -1065,7 +1823,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1065
1823
|
* <p>The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and
|
|
1066
1824
|
* projected weather information into your model. The Weather Index supplements your datasets
|
|
1067
1825
|
* 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
|
|
1826
|
+
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/weather.html">Amazon Forecast Weather
|
|
1827
|
+
* Index</a>.</p>
|
|
1069
1828
|
* <p>
|
|
1070
1829
|
* <b>Holidays</b>
|
|
1071
1830
|
* </p>
|
|
@@ -1076,7 +1835,8 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1076
1835
|
*/
|
|
1077
1836
|
export interface SupplementaryFeature {
|
|
1078
1837
|
/**
|
|
1079
|
-
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1838
|
+
* <p>The name of the feature. Valid values: <code>"holiday"</code> and
|
|
1839
|
+
* <code>"weather"</code>.</p>
|
|
1080
1840
|
*/
|
|
1081
1841
|
Name: string | undefined;
|
|
1082
1842
|
/**
|
|
@@ -1300,7 +2060,11 @@ export declare namespace SupplementaryFeature {
|
|
|
1300
2060
|
const filterSensitiveLog: (obj: SupplementaryFeature) => any;
|
|
1301
2061
|
}
|
|
1302
2062
|
/**
|
|
1303
|
-
* <
|
|
2063
|
+
* <note>
|
|
2064
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
2065
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>DataConfig</a>.</p>
|
|
2066
|
+
* </note>
|
|
2067
|
+
* <p>The data used to train a predictor. The data includes a dataset group and any
|
|
1304
2068
|
* supplementary features. You specify this object in the <a>CreatePredictor</a>
|
|
1305
2069
|
* request.</p>
|
|
1306
2070
|
*/
|
|
@@ -1321,13 +2085,6 @@ export declare namespace InputDataConfig {
|
|
|
1321
2085
|
*/
|
|
1322
2086
|
const filterSensitiveLog: (obj: InputDataConfig) => any;
|
|
1323
2087
|
}
|
|
1324
|
-
export declare enum OptimizationMetric {
|
|
1325
|
-
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
1326
|
-
MAPE = "MAPE",
|
|
1327
|
-
MASE = "MASE",
|
|
1328
|
-
RMSE = "RMSE",
|
|
1329
|
-
WAPE = "WAPE"
|
|
1330
|
-
}
|
|
1331
2088
|
export interface CreatePredictorRequest {
|
|
1332
2089
|
/**
|
|
1333
2090
|
* <p>A name for the predictor.</p>
|
|
@@ -1384,10 +2141,9 @@ export interface CreatePredictorRequest {
|
|
|
1384
2141
|
*/
|
|
1385
2142
|
ForecastHorizon: number | undefined;
|
|
1386
2143
|
/**
|
|
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>
|
|
2144
|
+
* <p>Specifies the forecast types used to train a predictor. You can specify up to five
|
|
2145
|
+
* forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
|
|
2146
|
+
* higher. You can also specify the mean forecast with <code>mean</code>. </p>
|
|
1391
2147
|
* <p>The default value is <code>["0.10", "0.50", "0.9"]</code>.</p>
|
|
1392
2148
|
*/
|
|
1393
2149
|
ForecastTypes?: string[];
|
|
@@ -1471,14 +2227,16 @@ export interface CreatePredictorRequest {
|
|
|
1471
2227
|
*/
|
|
1472
2228
|
EncryptionConfig?: EncryptionConfig;
|
|
1473
2229
|
/**
|
|
1474
|
-
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2230
|
+
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2231
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
1475
2232
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1476
2233
|
* <ul>
|
|
1477
2234
|
* <li>
|
|
1478
2235
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1479
2236
|
* </li>
|
|
1480
2237
|
* <li>
|
|
1481
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2238
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2239
|
+
* value.</p>
|
|
1482
2240
|
* </li>
|
|
1483
2241
|
* <li>
|
|
1484
2242
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1487,13 +2245,21 @@ export interface CreatePredictorRequest {
|
|
|
1487
2245
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1488
2246
|
* </li>
|
|
1489
2247
|
* <li>
|
|
1490
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2248
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2249
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
2250
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
2251
|
+
* - = . _ : / @.</p>
|
|
1491
2252
|
* </li>
|
|
1492
2253
|
* <li>
|
|
1493
2254
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1494
2255
|
* </li>
|
|
1495
2256
|
* <li>
|
|
1496
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2257
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2258
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
2259
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
2260
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
2261
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
2262
|
+
* not count against your tags per resource limit.</p>
|
|
1497
2263
|
* </li>
|
|
1498
2264
|
* </ul>
|
|
1499
2265
|
*/
|
|
@@ -1536,9 +2302,9 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
1536
2302
|
*/
|
|
1537
2303
|
Destination: DataDestination | undefined;
|
|
1538
2304
|
/**
|
|
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>
|
|
2305
|
+
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2306
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
2307
|
+
* are case sensitive.</p>
|
|
1542
2308
|
* <p>The following restrictions apply to tags:</p>
|
|
1543
2309
|
* <ul>
|
|
1544
2310
|
* <li>
|
|
@@ -1555,17 +2321,17 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
1555
2321
|
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
1556
2322
|
* </li>
|
|
1557
2323
|
* <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>
|
|
2324
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2325
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
2326
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
1561
2327
|
* </li>
|
|
1562
2328
|
* <li>
|
|
1563
2329
|
* <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>
|
|
2330
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
2331
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2332
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
2333
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
2334
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
1569
2335
|
* </li>
|
|
1570
2336
|
* </ul>
|
|
1571
2337
|
*/
|
|
@@ -1626,6 +2392,30 @@ export declare namespace DeleteDatasetImportJobRequest {
|
|
|
1626
2392
|
*/
|
|
1627
2393
|
const filterSensitiveLog: (obj: DeleteDatasetImportJobRequest) => any;
|
|
1628
2394
|
}
|
|
2395
|
+
export interface DeleteExplainabilityRequest {
|
|
2396
|
+
/**
|
|
2397
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability resource to delete.</p>
|
|
2398
|
+
*/
|
|
2399
|
+
ExplainabilityArn: string | undefined;
|
|
2400
|
+
}
|
|
2401
|
+
export declare namespace DeleteExplainabilityRequest {
|
|
2402
|
+
/**
|
|
2403
|
+
* @internal
|
|
2404
|
+
*/
|
|
2405
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityRequest) => any;
|
|
2406
|
+
}
|
|
2407
|
+
export interface DeleteExplainabilityExportRequest {
|
|
2408
|
+
/**
|
|
2409
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export to delete. </p>
|
|
2410
|
+
*/
|
|
2411
|
+
ExplainabilityExportArn: string | undefined;
|
|
2412
|
+
}
|
|
2413
|
+
export declare namespace DeleteExplainabilityExportRequest {
|
|
2414
|
+
/**
|
|
2415
|
+
* @internal
|
|
2416
|
+
*/
|
|
2417
|
+
const filterSensitiveLog: (obj: DeleteExplainabilityExportRequest) => any;
|
|
2418
|
+
}
|
|
1629
2419
|
export interface DeleteForecastRequest {
|
|
1630
2420
|
/**
|
|
1631
2421
|
* <p>The Amazon Resource Name (ARN) of the forecast to delete.</p>
|
|
@@ -1648,44 +2438,257 @@ export declare namespace DeleteForecastExportJobRequest {
|
|
|
1648
2438
|
/**
|
|
1649
2439
|
* @internal
|
|
1650
2440
|
*/
|
|
1651
|
-
const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
|
|
1652
|
-
}
|
|
1653
|
-
export interface DeletePredictorRequest {
|
|
2441
|
+
const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
|
|
2442
|
+
}
|
|
2443
|
+
export interface DeletePredictorRequest {
|
|
2444
|
+
/**
|
|
2445
|
+
* <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
|
|
2446
|
+
*/
|
|
2447
|
+
PredictorArn: string | undefined;
|
|
2448
|
+
}
|
|
2449
|
+
export declare namespace DeletePredictorRequest {
|
|
2450
|
+
/**
|
|
2451
|
+
* @internal
|
|
2452
|
+
*/
|
|
2453
|
+
const filterSensitiveLog: (obj: DeletePredictorRequest) => any;
|
|
2454
|
+
}
|
|
2455
|
+
export interface DeletePredictorBacktestExportJobRequest {
|
|
2456
|
+
/**
|
|
2457
|
+
* <p>The Amazon Resource Name (ARN) of the predictor backtest export job to delete.</p>
|
|
2458
|
+
*/
|
|
2459
|
+
PredictorBacktestExportJobArn: string | undefined;
|
|
2460
|
+
}
|
|
2461
|
+
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2462
|
+
/**
|
|
2463
|
+
* @internal
|
|
2464
|
+
*/
|
|
2465
|
+
const filterSensitiveLog: (obj: DeletePredictorBacktestExportJobRequest) => any;
|
|
2466
|
+
}
|
|
2467
|
+
export interface DeleteResourceTreeRequest {
|
|
2468
|
+
/**
|
|
2469
|
+
* <p>The Amazon Resource Name (ARN) of the parent resource to delete. All child resources
|
|
2470
|
+
* of the parent resource will also be deleted.</p>
|
|
2471
|
+
*/
|
|
2472
|
+
ResourceArn: string | undefined;
|
|
2473
|
+
}
|
|
2474
|
+
export declare namespace DeleteResourceTreeRequest {
|
|
2475
|
+
/**
|
|
2476
|
+
* @internal
|
|
2477
|
+
*/
|
|
2478
|
+
const filterSensitiveLog: (obj: DeleteResourceTreeRequest) => any;
|
|
2479
|
+
}
|
|
2480
|
+
export interface DescribeAutoPredictorRequest {
|
|
2481
|
+
/**
|
|
2482
|
+
* <p>The Amazon Resource Name (ARN) of the predictor.</p>
|
|
2483
|
+
*/
|
|
2484
|
+
PredictorArn: string | undefined;
|
|
2485
|
+
}
|
|
2486
|
+
export declare namespace DescribeAutoPredictorRequest {
|
|
2487
|
+
/**
|
|
2488
|
+
* @internal
|
|
2489
|
+
*/
|
|
2490
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
|
|
2491
|
+
}
|
|
2492
|
+
/**
|
|
2493
|
+
* <p>Provides information about the Explainability resource.</p>
|
|
2494
|
+
*/
|
|
2495
|
+
export interface ExplainabilityInfo {
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
2498
|
+
*/
|
|
2499
|
+
ExplainabilityArn?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>The status of the Explainability. States include: </p>
|
|
2502
|
+
* <ul>
|
|
2503
|
+
* <li>
|
|
2504
|
+
* <p>
|
|
2505
|
+
* <code>ACTIVE</code>
|
|
2506
|
+
* </p>
|
|
2507
|
+
* </li>
|
|
2508
|
+
* <li>
|
|
2509
|
+
* <p>
|
|
2510
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2511
|
+
* <code>CREATE_FAILED</code>
|
|
2512
|
+
* </p>
|
|
2513
|
+
* </li>
|
|
2514
|
+
* <li>
|
|
2515
|
+
* <p>
|
|
2516
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2517
|
+
* </p>
|
|
2518
|
+
* </li>
|
|
2519
|
+
* <li>
|
|
2520
|
+
* <p>
|
|
2521
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2522
|
+
* <code>DELETE_FAILED</code>
|
|
2523
|
+
* </p>
|
|
2524
|
+
* </li>
|
|
2525
|
+
* </ul>
|
|
2526
|
+
*/
|
|
2527
|
+
Status?: string;
|
|
2528
|
+
}
|
|
2529
|
+
export declare namespace ExplainabilityInfo {
|
|
2530
|
+
/**
|
|
2531
|
+
* @internal
|
|
2532
|
+
*/
|
|
2533
|
+
const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
|
|
2534
|
+
}
|
|
2535
|
+
export declare enum State {
|
|
2536
|
+
Active = "Active",
|
|
2537
|
+
Deleted = "Deleted"
|
|
2538
|
+
}
|
|
2539
|
+
/**
|
|
2540
|
+
* <p>Provides a summary of the reference predictor used when retraining or upgrading a
|
|
2541
|
+
* predictor.</p>
|
|
2542
|
+
*/
|
|
2543
|
+
export interface ReferencePredictorSummary {
|
|
2544
|
+
/**
|
|
2545
|
+
* <p>The ARN of the reference predictor.</p>
|
|
2546
|
+
*/
|
|
2547
|
+
Arn?: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* <p>Whether the reference predictor is <code>Active</code> or <code>Deleted</code>.</p>
|
|
2550
|
+
*/
|
|
2551
|
+
State?: State | string;
|
|
2552
|
+
}
|
|
2553
|
+
export declare namespace ReferencePredictorSummary {
|
|
2554
|
+
/**
|
|
2555
|
+
* @internal
|
|
2556
|
+
*/
|
|
2557
|
+
const filterSensitiveLog: (obj: ReferencePredictorSummary) => any;
|
|
2558
|
+
}
|
|
2559
|
+
export interface DescribeAutoPredictorResponse {
|
|
2560
|
+
/**
|
|
2561
|
+
* <p>The Amazon Resource Name (ARN) of the predictor</p>
|
|
2562
|
+
*/
|
|
2563
|
+
PredictorArn?: string;
|
|
2564
|
+
/**
|
|
2565
|
+
* <p>The name of the predictor.</p>
|
|
2566
|
+
*/
|
|
2567
|
+
PredictorName?: string;
|
|
2568
|
+
/**
|
|
2569
|
+
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
2570
|
+
* the prediction length.</p>
|
|
2571
|
+
*/
|
|
2572
|
+
ForecastHorizon?: number;
|
|
2573
|
+
/**
|
|
2574
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
2575
|
+
* ["0.1","0.5","0.9"].</p>
|
|
2576
|
+
*/
|
|
2577
|
+
ForecastTypes?: string[];
|
|
2578
|
+
/**
|
|
2579
|
+
* <p>The frequency of predictions in a forecast.</p>
|
|
2580
|
+
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
|
|
2581
|
+
* minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
2582
|
+
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2583
|
+
*/
|
|
2584
|
+
ForecastFrequency?: string;
|
|
2585
|
+
/**
|
|
2586
|
+
* <p>An array of dimension (field) names that specify the attributes used to group your time series.</p>
|
|
2587
|
+
*/
|
|
2588
|
+
ForecastDimensions?: string[];
|
|
2589
|
+
/**
|
|
2590
|
+
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2591
|
+
* predictor.</p>
|
|
2592
|
+
*/
|
|
2593
|
+
DatasetImportJobArns?: string[];
|
|
2594
|
+
/**
|
|
2595
|
+
* <p>The data configuration for your dataset group and any additional datasets.</p>
|
|
2596
|
+
*/
|
|
2597
|
+
DataConfig?: DataConfig;
|
|
2598
|
+
/**
|
|
2599
|
+
* <p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to
|
|
2600
|
+
* access the key. You can specify this optional object in the
|
|
2601
|
+
* <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
|
|
2602
|
+
*/
|
|
2603
|
+
EncryptionConfig?: EncryptionConfig;
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>The ARN and state of the reference predictor. This parameter is only valid for
|
|
2606
|
+
* retrained or upgraded predictors.</p>
|
|
2607
|
+
*/
|
|
2608
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
2609
|
+
/**
|
|
2610
|
+
* <p>The estimated time remaining in minutes for the predictor training job to
|
|
2611
|
+
* complete.</p>
|
|
2612
|
+
*/
|
|
2613
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
2614
|
+
/**
|
|
2615
|
+
* <p>The status of the predictor. States include: </p>
|
|
2616
|
+
* <ul>
|
|
2617
|
+
* <li>
|
|
2618
|
+
* <p>
|
|
2619
|
+
* <code>ACTIVE</code>
|
|
2620
|
+
* </p>
|
|
2621
|
+
* </li>
|
|
2622
|
+
* <li>
|
|
2623
|
+
* <p>
|
|
2624
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2625
|
+
* <code>CREATE_FAILED</code>
|
|
2626
|
+
* </p>
|
|
2627
|
+
* </li>
|
|
2628
|
+
* <li>
|
|
2629
|
+
* <p>
|
|
2630
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2631
|
+
* </p>
|
|
2632
|
+
* </li>
|
|
2633
|
+
* <li>
|
|
2634
|
+
* <p>
|
|
2635
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2636
|
+
* <code>DELETE_FAILED</code>
|
|
2637
|
+
* </p>
|
|
2638
|
+
* </li>
|
|
2639
|
+
* </ul>
|
|
2640
|
+
*/
|
|
2641
|
+
Status?: string;
|
|
1654
2642
|
/**
|
|
1655
|
-
* <p>
|
|
2643
|
+
* <p>In the event of an error, a message detailing the cause of the error.</p>
|
|
1656
2644
|
*/
|
|
1657
|
-
|
|
1658
|
-
}
|
|
1659
|
-
export declare namespace DeletePredictorRequest {
|
|
2645
|
+
Message?: string;
|
|
1660
2646
|
/**
|
|
1661
|
-
*
|
|
2647
|
+
* <p>The timestamp of the CreateAutoPredictor request.</p>
|
|
1662
2648
|
*/
|
|
1663
|
-
|
|
1664
|
-
}
|
|
1665
|
-
export interface DeletePredictorBacktestExportJobRequest {
|
|
2649
|
+
CreationTime?: Date;
|
|
1666
2650
|
/**
|
|
1667
|
-
* <p>The
|
|
2651
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
2652
|
+
* job:</p>
|
|
2653
|
+
* <ul>
|
|
2654
|
+
* <li>
|
|
2655
|
+
* <p>
|
|
2656
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
2657
|
+
* </li>
|
|
2658
|
+
* <li>
|
|
2659
|
+
* <p>
|
|
2660
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
2661
|
+
* </li>
|
|
2662
|
+
* <li>
|
|
2663
|
+
* <p>
|
|
2664
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
2665
|
+
* </li>
|
|
2666
|
+
* <li>
|
|
2667
|
+
* <p>
|
|
2668
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
2669
|
+
* </li>
|
|
2670
|
+
* <li>
|
|
2671
|
+
* <p>
|
|
2672
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
2673
|
+
* failed.</p>
|
|
2674
|
+
* </li>
|
|
2675
|
+
* </ul>
|
|
1668
2676
|
*/
|
|
1669
|
-
|
|
1670
|
-
}
|
|
1671
|
-
export declare namespace DeletePredictorBacktestExportJobRequest {
|
|
2677
|
+
LastModificationTime?: Date;
|
|
1672
2678
|
/**
|
|
1673
|
-
*
|
|
2679
|
+
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
1674
2680
|
*/
|
|
1675
|
-
|
|
1676
|
-
}
|
|
1677
|
-
export interface DeleteResourceTreeRequest {
|
|
2681
|
+
OptimizationMetric?: OptimizationMetric | string;
|
|
1678
2682
|
/**
|
|
1679
|
-
* <p>
|
|
1680
|
-
* of the parent resource will also be deleted.</p>
|
|
2683
|
+
* <p>Provides the status and ARN of the Predictor Explainability.</p>
|
|
1681
2684
|
*/
|
|
1682
|
-
|
|
2685
|
+
ExplainabilityInfo?: ExplainabilityInfo;
|
|
1683
2686
|
}
|
|
1684
|
-
export declare namespace
|
|
2687
|
+
export declare namespace DescribeAutoPredictorResponse {
|
|
1685
2688
|
/**
|
|
1686
2689
|
* @internal
|
|
1687
2690
|
*/
|
|
1688
|
-
const filterSensitiveLog: (obj:
|
|
2691
|
+
const filterSensitiveLog: (obj: DescribeAutoPredictorResponse) => any;
|
|
1689
2692
|
}
|
|
1690
2693
|
export interface DescribeDatasetRequest {
|
|
1691
2694
|
/**
|
|
@@ -2086,6 +3089,237 @@ export declare namespace DescribeDatasetImportJobResponse {
|
|
|
2086
3089
|
*/
|
|
2087
3090
|
const filterSensitiveLog: (obj: DescribeDatasetImportJobResponse) => any;
|
|
2088
3091
|
}
|
|
3092
|
+
export interface DescribeExplainabilityRequest {
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The Amazon Resource Name (ARN) of the Explaianability to describe.</p>
|
|
3095
|
+
*/
|
|
3096
|
+
ExplainabilityArn: string | undefined;
|
|
3097
|
+
}
|
|
3098
|
+
export declare namespace DescribeExplainabilityRequest {
|
|
3099
|
+
/**
|
|
3100
|
+
* @internal
|
|
3101
|
+
*/
|
|
3102
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityRequest) => any;
|
|
3103
|
+
}
|
|
3104
|
+
export interface DescribeExplainabilityResponse {
|
|
3105
|
+
/**
|
|
3106
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3107
|
+
*/
|
|
3108
|
+
ExplainabilityArn?: string;
|
|
3109
|
+
/**
|
|
3110
|
+
* <p>The name of the Explainability.</p>
|
|
3111
|
+
*/
|
|
3112
|
+
ExplainabilityName?: string;
|
|
3113
|
+
/**
|
|
3114
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
3115
|
+
* Explainability resource.</p>
|
|
3116
|
+
*/
|
|
3117
|
+
ResourceArn?: string;
|
|
3118
|
+
/**
|
|
3119
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
3120
|
+
* for the Explainability.</p>
|
|
3121
|
+
*/
|
|
3122
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
3123
|
+
/**
|
|
3124
|
+
* <p>Whether the visualization was enabled for the Explainability resource.</p>
|
|
3125
|
+
*/
|
|
3126
|
+
EnableVisualization?: boolean;
|
|
3127
|
+
/**
|
|
3128
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3129
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
3130
|
+
*/
|
|
3131
|
+
DataSource?: DataSource;
|
|
3132
|
+
/**
|
|
3133
|
+
* <p>Defines the fields of a dataset.</p>
|
|
3134
|
+
*/
|
|
3135
|
+
Schema?: Schema;
|
|
3136
|
+
/**
|
|
3137
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time
|
|
3138
|
+
* point in the Explainability.</p>
|
|
3139
|
+
*/
|
|
3140
|
+
StartDateTime?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time
|
|
3143
|
+
* point in the Explainability.</p>
|
|
3144
|
+
*/
|
|
3145
|
+
EndDateTime?: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* <p>The estimated time remaining in minutes for the <a>CreateExplainability</a>
|
|
3148
|
+
* job to complete.</p>
|
|
3149
|
+
*/
|
|
3150
|
+
EstimatedTimeRemainingInMinutes?: number;
|
|
3151
|
+
/**
|
|
3152
|
+
* <p>If an error occurred, a message about the error.</p>
|
|
3153
|
+
*/
|
|
3154
|
+
Message?: string;
|
|
3155
|
+
/**
|
|
3156
|
+
* <p>The status of the Explainability resource. States include: </p>
|
|
3157
|
+
* <ul>
|
|
3158
|
+
* <li>
|
|
3159
|
+
* <p>
|
|
3160
|
+
* <code>ACTIVE</code>
|
|
3161
|
+
* </p>
|
|
3162
|
+
* </li>
|
|
3163
|
+
* <li>
|
|
3164
|
+
* <p>
|
|
3165
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3166
|
+
* <code>CREATE_FAILED</code>
|
|
3167
|
+
* </p>
|
|
3168
|
+
* </li>
|
|
3169
|
+
* <li>
|
|
3170
|
+
* <p>
|
|
3171
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3172
|
+
* </p>
|
|
3173
|
+
* </li>
|
|
3174
|
+
* <li>
|
|
3175
|
+
* <p>
|
|
3176
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3177
|
+
* <code>DELETE_FAILED</code>
|
|
3178
|
+
* </p>
|
|
3179
|
+
* </li>
|
|
3180
|
+
* </ul>
|
|
3181
|
+
*/
|
|
3182
|
+
Status?: string;
|
|
3183
|
+
/**
|
|
3184
|
+
* <p>When the Explainability resource was created.</p>
|
|
3185
|
+
*/
|
|
3186
|
+
CreationTime?: Date;
|
|
3187
|
+
/**
|
|
3188
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3189
|
+
* job:</p>
|
|
3190
|
+
* <ul>
|
|
3191
|
+
* <li>
|
|
3192
|
+
* <p>
|
|
3193
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3194
|
+
* </li>
|
|
3195
|
+
* <li>
|
|
3196
|
+
* <p>
|
|
3197
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3198
|
+
* </li>
|
|
3199
|
+
* <li>
|
|
3200
|
+
* <p>
|
|
3201
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3202
|
+
* </li>
|
|
3203
|
+
* <li>
|
|
3204
|
+
* <p>
|
|
3205
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3206
|
+
* </li>
|
|
3207
|
+
* <li>
|
|
3208
|
+
* <p>
|
|
3209
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3210
|
+
* failed.</p>
|
|
3211
|
+
* </li>
|
|
3212
|
+
* </ul>
|
|
3213
|
+
*/
|
|
3214
|
+
LastModificationTime?: Date;
|
|
3215
|
+
}
|
|
3216
|
+
export declare namespace DescribeExplainabilityResponse {
|
|
3217
|
+
/**
|
|
3218
|
+
* @internal
|
|
3219
|
+
*/
|
|
3220
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityResponse) => any;
|
|
3221
|
+
}
|
|
3222
|
+
export interface DescribeExplainabilityExportRequest {
|
|
3223
|
+
/**
|
|
3224
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3225
|
+
*/
|
|
3226
|
+
ExplainabilityExportArn: string | undefined;
|
|
3227
|
+
}
|
|
3228
|
+
export declare namespace DescribeExplainabilityExportRequest {
|
|
3229
|
+
/**
|
|
3230
|
+
* @internal
|
|
3231
|
+
*/
|
|
3232
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportRequest) => any;
|
|
3233
|
+
}
|
|
3234
|
+
export interface DescribeExplainabilityExportResponse {
|
|
3235
|
+
/**
|
|
3236
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3237
|
+
*/
|
|
3238
|
+
ExplainabilityExportArn?: string;
|
|
3239
|
+
/**
|
|
3240
|
+
* <p>The name of the Explainability export.</p>
|
|
3241
|
+
*/
|
|
3242
|
+
ExplainabilityExportName?: string;
|
|
3243
|
+
/**
|
|
3244
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3245
|
+
*/
|
|
3246
|
+
ExplainabilityArn?: string;
|
|
3247
|
+
/**
|
|
3248
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
3249
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
3250
|
+
*/
|
|
3251
|
+
Destination?: DataDestination;
|
|
3252
|
+
/**
|
|
3253
|
+
* <p>Information about any errors that occurred during the export.</p>
|
|
3254
|
+
*/
|
|
3255
|
+
Message?: string;
|
|
3256
|
+
/**
|
|
3257
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
3258
|
+
* <ul>
|
|
3259
|
+
* <li>
|
|
3260
|
+
* <p>
|
|
3261
|
+
* <code>ACTIVE</code>
|
|
3262
|
+
* </p>
|
|
3263
|
+
* </li>
|
|
3264
|
+
* <li>
|
|
3265
|
+
* <p>
|
|
3266
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3267
|
+
* <code>CREATE_FAILED</code>
|
|
3268
|
+
* </p>
|
|
3269
|
+
* </li>
|
|
3270
|
+
* <li>
|
|
3271
|
+
* <p>
|
|
3272
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
3273
|
+
* </p>
|
|
3274
|
+
* </li>
|
|
3275
|
+
* <li>
|
|
3276
|
+
* <p>
|
|
3277
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3278
|
+
* <code>DELETE_FAILED</code>
|
|
3279
|
+
* </p>
|
|
3280
|
+
* </li>
|
|
3281
|
+
* </ul>
|
|
3282
|
+
*/
|
|
3283
|
+
Status?: string;
|
|
3284
|
+
/**
|
|
3285
|
+
* <p>When the Explainability export was created.</p>
|
|
3286
|
+
*/
|
|
3287
|
+
CreationTime?: Date;
|
|
3288
|
+
/**
|
|
3289
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3290
|
+
* job:</p>
|
|
3291
|
+
* <ul>
|
|
3292
|
+
* <li>
|
|
3293
|
+
* <p>
|
|
3294
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3295
|
+
* </li>
|
|
3296
|
+
* <li>
|
|
3297
|
+
* <p>
|
|
3298
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3299
|
+
* </li>
|
|
3300
|
+
* <li>
|
|
3301
|
+
* <p>
|
|
3302
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3303
|
+
* </li>
|
|
3304
|
+
* <li>
|
|
3305
|
+
* <p>
|
|
3306
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3307
|
+
* </li>
|
|
3308
|
+
* <li>
|
|
3309
|
+
* <p>
|
|
3310
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3311
|
+
* failed.</p>
|
|
3312
|
+
* </li>
|
|
3313
|
+
* </ul>
|
|
3314
|
+
*/
|
|
3315
|
+
LastModificationTime?: Date;
|
|
3316
|
+
}
|
|
3317
|
+
export declare namespace DescribeExplainabilityExportResponse {
|
|
3318
|
+
/**
|
|
3319
|
+
* @internal
|
|
3320
|
+
*/
|
|
3321
|
+
const filterSensitiveLog: (obj: DescribeExplainabilityExportResponse) => any;
|
|
3322
|
+
}
|
|
2089
3323
|
export interface DescribeForecastRequest {
|
|
2090
3324
|
/**
|
|
2091
3325
|
* <p>The Amazon Resource Name (ARN) of the forecast.</p>
|
|
@@ -2410,13 +3644,18 @@ export interface DescribePredictorResponse {
|
|
|
2410
3644
|
* <p>The Amazon Resource Name (ARN) of the algorithm used for model training.</p>
|
|
2411
3645
|
*/
|
|
2412
3646
|
AlgorithmArn?: string;
|
|
3647
|
+
/**
|
|
3648
|
+
* <p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>
|
|
3649
|
+
*/
|
|
3650
|
+
AutoMLAlgorithmArns?: string[];
|
|
2413
3651
|
/**
|
|
2414
3652
|
* <p>The number of time-steps of the forecast. The forecast horizon is also called the
|
|
2415
3653
|
* prediction length.</p>
|
|
2416
3654
|
*/
|
|
2417
3655
|
ForecastHorizon?: number;
|
|
2418
3656
|
/**
|
|
2419
|
-
* <p>The forecast types used during predictor training. Default value is
|
|
3657
|
+
* <p>The forecast types used during predictor training. Default value is
|
|
3658
|
+
* <code>["0.1","0.5","0.9"]</code>
|
|
2420
3659
|
* </p>
|
|
2421
3660
|
*/
|
|
2422
3661
|
ForecastTypes?: string[];
|
|
@@ -2479,15 +3718,15 @@ export interface DescribePredictorResponse {
|
|
|
2479
3718
|
* <p>The estimated time remaining in minutes for the predictor training job to complete.</p>
|
|
2480
3719
|
*/
|
|
2481
3720
|
EstimatedTimeRemainingInMinutes?: number;
|
|
3721
|
+
/**
|
|
3722
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
3723
|
+
*/
|
|
3724
|
+
IsAutoPredictor?: boolean;
|
|
2482
3725
|
/**
|
|
2483
3726
|
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2484
3727
|
* predictor.</p>
|
|
2485
3728
|
*/
|
|
2486
3729
|
DatasetImportJobArns?: string[];
|
|
2487
|
-
/**
|
|
2488
|
-
* <p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>
|
|
2489
|
-
*/
|
|
2490
|
-
AutoMLAlgorithmArns?: string[];
|
|
2491
3730
|
/**
|
|
2492
3731
|
* <p>The status of the predictor. States include:</p>
|
|
2493
3732
|
* <ul>
|
|
@@ -2499,13 +3738,13 @@ export interface DescribePredictorResponse {
|
|
|
2499
3738
|
* <li>
|
|
2500
3739
|
* <p>
|
|
2501
3740
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2502
|
-
*
|
|
3741
|
+
* <code>CREATE_FAILED</code>
|
|
2503
3742
|
* </p>
|
|
2504
3743
|
* </li>
|
|
2505
3744
|
* <li>
|
|
2506
3745
|
* <p>
|
|
2507
3746
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2508
|
-
*
|
|
3747
|
+
* <code>DELETE_FAILED</code>
|
|
2509
3748
|
* </p>
|
|
2510
3749
|
* </li>
|
|
2511
3750
|
* <li>
|
|
@@ -2529,7 +3768,8 @@ export interface DescribePredictorResponse {
|
|
|
2529
3768
|
*/
|
|
2530
3769
|
CreationTime?: Date;
|
|
2531
3770
|
/**
|
|
2532
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3771
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3772
|
+
* job:</p>
|
|
2533
3773
|
* <ul>
|
|
2534
3774
|
* <li>
|
|
2535
3775
|
* <p>
|
|
@@ -2611,7 +3851,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2611
3851
|
* <li>
|
|
2612
3852
|
* <p>
|
|
2613
3853
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2614
|
-
*
|
|
3854
|
+
* <code>CREATE_FAILED</code>
|
|
2615
3855
|
* </p>
|
|
2616
3856
|
* </li>
|
|
2617
3857
|
* <li>
|
|
@@ -2622,7 +3862,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2622
3862
|
* <li>
|
|
2623
3863
|
* <p>
|
|
2624
3864
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2625
|
-
*
|
|
3865
|
+
* <code>DELETE_FAILED</code>
|
|
2626
3866
|
* </p>
|
|
2627
3867
|
* </li>
|
|
2628
3868
|
* </ul>
|
|
@@ -2633,7 +3873,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
2633
3873
|
*/
|
|
2634
3874
|
CreationTime?: Date;
|
|
2635
3875
|
/**
|
|
2636
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3876
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3877
|
+
* job:</p>
|
|
2637
3878
|
* <ul>
|
|
2638
3879
|
* <li>
|
|
2639
3880
|
* <p>
|
|
@@ -2839,6 +4080,10 @@ export interface GetAccuracyMetricsResponse {
|
|
|
2839
4080
|
* <p>An array of results from evaluating the predictor.</p>
|
|
2840
4081
|
*/
|
|
2841
4082
|
PredictorEvaluationResults?: EvaluationResult[];
|
|
4083
|
+
/**
|
|
4084
|
+
* <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
|
|
4085
|
+
*/
|
|
4086
|
+
IsAutoPredictor?: boolean;
|
|
2842
4087
|
/**
|
|
2843
4088
|
* <note>
|
|
2844
4089
|
* <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
|
|
@@ -2869,12 +4114,6 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB
|
|
|
2869
4114
|
$fault: "client";
|
|
2870
4115
|
Message?: string;
|
|
2871
4116
|
}
|
|
2872
|
-
export declare namespace InvalidNextTokenException {
|
|
2873
|
-
/**
|
|
2874
|
-
* @internal
|
|
2875
|
-
*/
|
|
2876
|
-
const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
|
|
2877
|
-
}
|
|
2878
4117
|
export interface ListDatasetGroupsRequest {
|
|
2879
4118
|
/**
|
|
2880
4119
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
@@ -2945,268 +4184,579 @@ export declare enum FilterConditionString {
|
|
|
2945
4184
|
IS = "IS",
|
|
2946
4185
|
IS_NOT = "IS_NOT"
|
|
2947
4186
|
}
|
|
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 {
|
|
4187
|
+
/**
|
|
4188
|
+
* <p>Describes a filter for choosing a subset of objects. Each filter consists of a
|
|
4189
|
+
* condition and a match statement. The condition is either <code>IS</code> or
|
|
4190
|
+
* <code>IS_NOT</code>, which specifies whether to include or exclude
|
|
4191
|
+
* the objects that match the statement, respectively. The match statement consists of a key and a
|
|
4192
|
+
* value.</p>
|
|
4193
|
+
*/
|
|
4194
|
+
export interface Filter {
|
|
4195
|
+
/**
|
|
4196
|
+
* <p>The name of the parameter to filter on.</p>
|
|
4197
|
+
*/
|
|
4198
|
+
Key: string | undefined;
|
|
4199
|
+
/**
|
|
4200
|
+
* <p>The value to match.</p>
|
|
4201
|
+
*/
|
|
4202
|
+
Value: string | undefined;
|
|
4203
|
+
/**
|
|
4204
|
+
* <p>The condition to apply. To include the objects that match the statement, specify
|
|
4205
|
+
* <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.</p>
|
|
4206
|
+
*/
|
|
4207
|
+
Condition: FilterConditionString | string | undefined;
|
|
4208
|
+
}
|
|
4209
|
+
export declare namespace Filter {
|
|
4210
|
+
/**
|
|
4211
|
+
* @internal
|
|
4212
|
+
*/
|
|
4213
|
+
const filterSensitiveLog: (obj: Filter) => any;
|
|
4214
|
+
}
|
|
4215
|
+
export interface ListDatasetImportJobsRequest {
|
|
4216
|
+
/**
|
|
4217
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4218
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
4219
|
+
* request. Tokens expire after 24 hours.</p>
|
|
4220
|
+
*/
|
|
4221
|
+
NextToken?: string;
|
|
4222
|
+
/**
|
|
4223
|
+
* <p>The number of items to return in the response.</p>
|
|
4224
|
+
*/
|
|
4225
|
+
MaxResults?: number;
|
|
4226
|
+
/**
|
|
4227
|
+
* <p>An array of filters. For each filter, you provide a condition and a match statement. The
|
|
4228
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
|
|
4229
|
+
* or exclude the datasets that match the statement from the list, respectively. The match
|
|
4230
|
+
* statement consists of a key and a value.</p>
|
|
4231
|
+
* <p>
|
|
4232
|
+
* <b>Filter properties</b>
|
|
4233
|
+
* </p>
|
|
4234
|
+
* <ul>
|
|
4235
|
+
* <li>
|
|
4236
|
+
* <p>
|
|
4237
|
+
* <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
|
|
4238
|
+
* <code>IS_NOT</code>. To include the datasets that match the statement, specify
|
|
4239
|
+
* <code>IS</code>. To exclude matching datasets, specify <code>IS_NOT</code>.</p>
|
|
4240
|
+
* </li>
|
|
4241
|
+
* <li>
|
|
4242
|
+
* <p>
|
|
4243
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4244
|
+
* <code>DatasetArn</code> and <code>Status</code>.</p>
|
|
4245
|
+
* </li>
|
|
4246
|
+
* <li>
|
|
4247
|
+
* <p>
|
|
4248
|
+
* <code>Value</code> - The value to match.</p>
|
|
4249
|
+
* </li>
|
|
4250
|
+
* </ul>
|
|
4251
|
+
* <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
|
|
4252
|
+
* following filter:</p>
|
|
4253
|
+
* <p>
|
|
4254
|
+
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
|
|
4255
|
+
* ]</code>
|
|
4256
|
+
* </p>
|
|
4257
|
+
*/
|
|
4258
|
+
Filters?: Filter[];
|
|
4259
|
+
}
|
|
4260
|
+
export declare namespace ListDatasetImportJobsRequest {
|
|
4261
|
+
/**
|
|
4262
|
+
* @internal
|
|
4263
|
+
*/
|
|
4264
|
+
const filterSensitiveLog: (obj: ListDatasetImportJobsRequest) => any;
|
|
4265
|
+
}
|
|
4266
|
+
/**
|
|
4267
|
+
* <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
|
|
4268
|
+
* <a>DescribeDatasetImportJob</a> operation, and provide the
|
|
4269
|
+
* <code>DatasetImportJobArn</code>.</p>
|
|
4270
|
+
*/
|
|
4271
|
+
export interface DatasetImportJobSummary {
|
|
4272
|
+
/**
|
|
4273
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
|
|
4274
|
+
*/
|
|
4275
|
+
DatasetImportJobArn?: string;
|
|
4276
|
+
/**
|
|
4277
|
+
* <p>The name of the dataset import job.</p>
|
|
4278
|
+
*/
|
|
4279
|
+
DatasetImportJobName?: string;
|
|
4280
|
+
/**
|
|
4281
|
+
* <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
|
|
4282
|
+
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
4283
|
+
* <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
|
|
4284
|
+
*/
|
|
4285
|
+
DataSource?: DataSource;
|
|
4286
|
+
/**
|
|
4287
|
+
* <p>The status of the dataset import job. States include:</p>
|
|
4288
|
+
* <ul>
|
|
4289
|
+
* <li>
|
|
4290
|
+
* <p>
|
|
4291
|
+
* <code>ACTIVE</code>
|
|
4292
|
+
* </p>
|
|
4293
|
+
* </li>
|
|
4294
|
+
* <li>
|
|
4295
|
+
* <p>
|
|
4296
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4297
|
+
* <code>CREATE_FAILED</code>
|
|
4298
|
+
* </p>
|
|
4299
|
+
* </li>
|
|
4300
|
+
* <li>
|
|
4301
|
+
* <p>
|
|
4302
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4303
|
+
* <code>DELETE_FAILED</code>
|
|
4304
|
+
* </p>
|
|
4305
|
+
* </li>
|
|
4306
|
+
* <li>
|
|
4307
|
+
* <p>
|
|
4308
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4309
|
+
* </p>
|
|
4310
|
+
* </li>
|
|
4311
|
+
* </ul>
|
|
4312
|
+
*/
|
|
4313
|
+
Status?: string;
|
|
4314
|
+
/**
|
|
4315
|
+
* <p>If an error occurred, an informational message about the error.</p>
|
|
4316
|
+
*/
|
|
4317
|
+
Message?: string;
|
|
4318
|
+
/**
|
|
4319
|
+
* <p>When the dataset import job was created.</p>
|
|
4320
|
+
*/
|
|
4321
|
+
CreationTime?: Date;
|
|
4322
|
+
/**
|
|
4323
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4324
|
+
* job:</p>
|
|
4325
|
+
* <ul>
|
|
4326
|
+
* <li>
|
|
4327
|
+
* <p>
|
|
4328
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4329
|
+
* </li>
|
|
4330
|
+
* <li>
|
|
4331
|
+
* <p>
|
|
4332
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4333
|
+
* </li>
|
|
4334
|
+
* <li>
|
|
4335
|
+
* <p>
|
|
4336
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4337
|
+
* </li>
|
|
4338
|
+
* <li>
|
|
4339
|
+
* <p>
|
|
4340
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4341
|
+
* </li>
|
|
4342
|
+
* <li>
|
|
4343
|
+
* <p>
|
|
4344
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4345
|
+
* failed.</p>
|
|
4346
|
+
* </li>
|
|
4347
|
+
* </ul>
|
|
4348
|
+
*/
|
|
4349
|
+
LastModificationTime?: Date;
|
|
4350
|
+
}
|
|
4351
|
+
export declare namespace DatasetImportJobSummary {
|
|
4352
|
+
/**
|
|
4353
|
+
* @internal
|
|
4354
|
+
*/
|
|
4355
|
+
const filterSensitiveLog: (obj: DatasetImportJobSummary) => any;
|
|
4356
|
+
}
|
|
4357
|
+
export interface ListDatasetImportJobsResponse {
|
|
4358
|
+
/**
|
|
4359
|
+
* <p>An array of objects that summarize each dataset import job's properties.</p>
|
|
4360
|
+
*/
|
|
4361
|
+
DatasetImportJobs?: DatasetImportJobSummary[];
|
|
4362
|
+
/**
|
|
4363
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
4364
|
+
* results, use the token in the next request.</p>
|
|
4365
|
+
*/
|
|
4366
|
+
NextToken?: string;
|
|
4367
|
+
}
|
|
4368
|
+
export declare namespace ListDatasetImportJobsResponse {
|
|
4369
|
+
/**
|
|
4370
|
+
* @internal
|
|
4371
|
+
*/
|
|
4372
|
+
const filterSensitiveLog: (obj: ListDatasetImportJobsResponse) => any;
|
|
4373
|
+
}
|
|
4374
|
+
export interface ListDatasetsRequest {
|
|
4375
|
+
/**
|
|
4376
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
4377
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
4378
|
+
* request. Tokens expire after 24 hours.</p>
|
|
4379
|
+
*/
|
|
4380
|
+
NextToken?: string;
|
|
4381
|
+
/**
|
|
4382
|
+
* <p>The number of items to return in the response.</p>
|
|
4383
|
+
*/
|
|
4384
|
+
MaxResults?: number;
|
|
4385
|
+
}
|
|
4386
|
+
export declare namespace ListDatasetsRequest {
|
|
4387
|
+
/**
|
|
4388
|
+
* @internal
|
|
4389
|
+
*/
|
|
4390
|
+
const filterSensitiveLog: (obj: ListDatasetsRequest) => any;
|
|
4391
|
+
}
|
|
4392
|
+
/**
|
|
4393
|
+
* <p>Provides a summary of the dataset properties used in the <a>ListDatasets</a>
|
|
4394
|
+
* operation. To get the complete set of properties, call the <a>DescribeDataset</a>
|
|
4395
|
+
* operation, and provide the <code>DatasetArn</code>.</p>
|
|
4396
|
+
*/
|
|
4397
|
+
export interface DatasetSummary {
|
|
4398
|
+
/**
|
|
4399
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
4400
|
+
*/
|
|
4401
|
+
DatasetArn?: string;
|
|
4402
|
+
/**
|
|
4403
|
+
* <p>The name of the dataset.</p>
|
|
4404
|
+
*/
|
|
4405
|
+
DatasetName?: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* <p>The dataset type.</p>
|
|
4408
|
+
*/
|
|
4409
|
+
DatasetType?: DatasetType | string;
|
|
4410
|
+
/**
|
|
4411
|
+
* <p>The domain associated with the dataset.</p>
|
|
4412
|
+
*/
|
|
4413
|
+
Domain?: Domain | string;
|
|
4414
|
+
/**
|
|
4415
|
+
* <p>When the dataset was created.</p>
|
|
4416
|
+
*/
|
|
4417
|
+
CreationTime?: Date;
|
|
4418
|
+
/**
|
|
4419
|
+
* <p>When you create a dataset, <code>LastModificationTime</code> is the same as
|
|
4420
|
+
* <code>CreationTime</code>. While data is being imported to the dataset,
|
|
4421
|
+
* <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
|
|
4422
|
+
* After a <a>CreateDatasetImportJob</a> operation has finished,
|
|
4423
|
+
* <code>LastModificationTime</code> is when the import job completed or failed.</p>
|
|
4424
|
+
*/
|
|
4425
|
+
LastModificationTime?: Date;
|
|
4426
|
+
}
|
|
4427
|
+
export declare namespace DatasetSummary {
|
|
2956
4428
|
/**
|
|
2957
|
-
*
|
|
4429
|
+
* @internal
|
|
2958
4430
|
*/
|
|
2959
|
-
|
|
4431
|
+
const filterSensitiveLog: (obj: DatasetSummary) => any;
|
|
4432
|
+
}
|
|
4433
|
+
export interface ListDatasetsResponse {
|
|
2960
4434
|
/**
|
|
2961
|
-
* <p>
|
|
4435
|
+
* <p>An array of objects that summarize each dataset's properties.</p>
|
|
2962
4436
|
*/
|
|
2963
|
-
|
|
4437
|
+
Datasets?: DatasetSummary[];
|
|
2964
4438
|
/**
|
|
2965
|
-
* <p>
|
|
2966
|
-
*
|
|
4439
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
4440
|
+
* results, use the token in the next request.</p>
|
|
2967
4441
|
*/
|
|
2968
|
-
|
|
4442
|
+
NextToken?: string;
|
|
2969
4443
|
}
|
|
2970
|
-
export declare namespace
|
|
4444
|
+
export declare namespace ListDatasetsResponse {
|
|
2971
4445
|
/**
|
|
2972
4446
|
* @internal
|
|
2973
4447
|
*/
|
|
2974
|
-
const filterSensitiveLog: (obj:
|
|
4448
|
+
const filterSensitiveLog: (obj: ListDatasetsResponse) => any;
|
|
2975
4449
|
}
|
|
2976
|
-
export interface
|
|
4450
|
+
export interface ListExplainabilitiesRequest {
|
|
2977
4451
|
/**
|
|
2978
4452
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
4453
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4454
|
+
* Tokens expire after 24 hours.</p>
|
|
2981
4455
|
*/
|
|
2982
4456
|
NextToken?: string;
|
|
2983
4457
|
/**
|
|
2984
|
-
* <p>The number of items
|
|
4458
|
+
* <p>The number of items returned in the response.</p>
|
|
2985
4459
|
*/
|
|
2986
4460
|
MaxResults?: number;
|
|
2987
4461
|
/**
|
|
2988
|
-
* <p>An array of filters. For each filter,
|
|
2989
|
-
*
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
4462
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4463
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4464
|
+
* include or exclude the resources that match the statement from the list. The match
|
|
4465
|
+
* statement consists of a key and a value.</p>
|
|
4466
|
+
* <p>
|
|
2993
4467
|
* <b>Filter properties</b>
|
|
2994
|
-
*
|
|
2995
|
-
*
|
|
4468
|
+
* </p>
|
|
4469
|
+
* <ul>
|
|
2996
4470
|
* <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>
|
|
4471
|
+
* <p>
|
|
4472
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4473
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
3001
4474
|
* </li>
|
|
3002
4475
|
* <li>
|
|
3003
|
-
*
|
|
4476
|
+
* <p>
|
|
3004
4477
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
3005
|
-
*
|
|
4478
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
3006
4479
|
* </li>
|
|
3007
4480
|
* <li>
|
|
3008
|
-
*
|
|
4481
|
+
* <p>
|
|
3009
4482
|
* <code>Value</code> - The value to match.</p>
|
|
3010
4483
|
* </li>
|
|
3011
4484
|
* </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
4485
|
*/
|
|
3019
4486
|
Filters?: Filter[];
|
|
3020
4487
|
}
|
|
3021
|
-
export declare namespace
|
|
4488
|
+
export declare namespace ListExplainabilitiesRequest {
|
|
3022
4489
|
/**
|
|
3023
4490
|
* @internal
|
|
3024
4491
|
*/
|
|
3025
|
-
const filterSensitiveLog: (obj:
|
|
4492
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesRequest) => any;
|
|
3026
4493
|
}
|
|
3027
4494
|
/**
|
|
3028
|
-
* <p>Provides a summary of the
|
|
3029
|
-
*
|
|
3030
|
-
*
|
|
4495
|
+
* <p>Provides a summary of the Explainability properties used in the <a>ListExplainabilities</a> operation. To get a complete set of properties,
|
|
4496
|
+
* call the <a>DescribeExplainability</a> operation, and provide the listed
|
|
4497
|
+
* <code>ExplainabilityArn</code>.</p>
|
|
3031
4498
|
*/
|
|
3032
|
-
export interface
|
|
4499
|
+
export interface ExplainabilitySummary {
|
|
3033
4500
|
/**
|
|
3034
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4501
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3035
4502
|
*/
|
|
3036
|
-
|
|
4503
|
+
ExplainabilityArn?: string;
|
|
3037
4504
|
/**
|
|
3038
|
-
* <p>The name of the
|
|
4505
|
+
* <p>The name of the Explainability.</p>
|
|
3039
4506
|
*/
|
|
3040
|
-
|
|
4507
|
+
ExplainabilityName?: string;
|
|
3041
4508
|
/**
|
|
3042
|
-
* <p>The
|
|
3043
|
-
*
|
|
3044
|
-
* <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
|
|
4509
|
+
* <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
|
|
4510
|
+
* Explainability.</p>
|
|
3045
4511
|
*/
|
|
3046
|
-
|
|
4512
|
+
ResourceArn?: string;
|
|
3047
4513
|
/**
|
|
3048
|
-
* <p>The
|
|
3049
|
-
*
|
|
4514
|
+
* <p>The configuration settings that define the granularity of time series and time points
|
|
4515
|
+
* for the Explainability.</p>
|
|
4516
|
+
*/
|
|
4517
|
+
ExplainabilityConfig?: ExplainabilityConfig;
|
|
4518
|
+
/**
|
|
4519
|
+
* <p>The status of the Explainability. States include: </p>
|
|
4520
|
+
* <ul>
|
|
3050
4521
|
* <li>
|
|
3051
|
-
*
|
|
4522
|
+
* <p>
|
|
3052
4523
|
* <code>ACTIVE</code>
|
|
3053
4524
|
* </p>
|
|
3054
4525
|
* </li>
|
|
3055
4526
|
* <li>
|
|
3056
|
-
*
|
|
4527
|
+
* <p>
|
|
3057
4528
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3058
|
-
*
|
|
4529
|
+
* <code>CREATE_FAILED</code>
|
|
3059
4530
|
* </p>
|
|
3060
4531
|
* </li>
|
|
3061
4532
|
* <li>
|
|
3062
|
-
*
|
|
3063
|
-
*
|
|
3064
|
-
*
|
|
3065
|
-
* </p>
|
|
4533
|
+
* <p>
|
|
4534
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4535
|
+
* </p>
|
|
3066
4536
|
* </li>
|
|
3067
4537
|
* <li>
|
|
3068
|
-
*
|
|
3069
|
-
* <code>
|
|
4538
|
+
* <p>
|
|
4539
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4540
|
+
* <code>DELETE_FAILED</code>
|
|
3070
4541
|
* </p>
|
|
3071
4542
|
* </li>
|
|
3072
4543
|
* </ul>
|
|
3073
4544
|
*/
|
|
3074
4545
|
Status?: string;
|
|
3075
4546
|
/**
|
|
3076
|
-
* <p>
|
|
4547
|
+
* <p>Information about any errors that may have occurred during the Explainability creation
|
|
4548
|
+
* process.</p>
|
|
3077
4549
|
*/
|
|
3078
4550
|
Message?: string;
|
|
3079
4551
|
/**
|
|
3080
|
-
* <p>When the
|
|
4552
|
+
* <p>When the Explainability was created.</p>
|
|
3081
4553
|
*/
|
|
3082
4554
|
CreationTime?: Date;
|
|
3083
4555
|
/**
|
|
3084
4556
|
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3085
|
-
*
|
|
3086
|
-
*
|
|
4557
|
+
* job:</p>
|
|
4558
|
+
* <ul>
|
|
3087
4559
|
* <li>
|
|
3088
|
-
*
|
|
4560
|
+
* <p>
|
|
3089
4561
|
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
3090
4562
|
* </li>
|
|
3091
4563
|
* <li>
|
|
3092
|
-
*
|
|
4564
|
+
* <p>
|
|
3093
4565
|
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
3094
4566
|
* </li>
|
|
3095
4567
|
* <li>
|
|
3096
|
-
*
|
|
4568
|
+
* <p>
|
|
3097
4569
|
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
3098
4570
|
* </li>
|
|
3099
4571
|
* <li>
|
|
3100
|
-
*
|
|
4572
|
+
* <p>
|
|
3101
4573
|
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
3102
4574
|
* </li>
|
|
3103
4575
|
* <li>
|
|
3104
|
-
*
|
|
4576
|
+
* <p>
|
|
3105
4577
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
3106
|
-
*
|
|
4578
|
+
* failed.</p>
|
|
3107
4579
|
* </li>
|
|
3108
4580
|
* </ul>
|
|
3109
4581
|
*/
|
|
3110
4582
|
LastModificationTime?: Date;
|
|
3111
4583
|
}
|
|
3112
|
-
export declare namespace
|
|
4584
|
+
export declare namespace ExplainabilitySummary {
|
|
3113
4585
|
/**
|
|
3114
4586
|
* @internal
|
|
3115
4587
|
*/
|
|
3116
|
-
const filterSensitiveLog: (obj:
|
|
4588
|
+
const filterSensitiveLog: (obj: ExplainabilitySummary) => any;
|
|
3117
4589
|
}
|
|
3118
|
-
export interface
|
|
4590
|
+
export interface ListExplainabilitiesResponse {
|
|
3119
4591
|
/**
|
|
3120
|
-
* <p>An array of objects that summarize
|
|
4592
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4593
|
+
* resource.</p>
|
|
3121
4594
|
*/
|
|
3122
|
-
|
|
4595
|
+
Explainabilities?: ExplainabilitySummary[];
|
|
3123
4596
|
/**
|
|
3124
|
-
* <p>
|
|
3125
|
-
*
|
|
4597
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4598
|
+
* use the token in the next request.</p>
|
|
3126
4599
|
*/
|
|
3127
4600
|
NextToken?: string;
|
|
3128
4601
|
}
|
|
3129
|
-
export declare namespace
|
|
4602
|
+
export declare namespace ListExplainabilitiesResponse {
|
|
3130
4603
|
/**
|
|
3131
4604
|
* @internal
|
|
3132
4605
|
*/
|
|
3133
|
-
const filterSensitiveLog: (obj:
|
|
4606
|
+
const filterSensitiveLog: (obj: ListExplainabilitiesResponse) => any;
|
|
3134
4607
|
}
|
|
3135
|
-
export interface
|
|
4608
|
+
export interface ListExplainabilityExportsRequest {
|
|
3136
4609
|
/**
|
|
3137
4610
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
4611
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
4612
|
+
* Tokens expire after 24 hours.</p>
|
|
3140
4613
|
*/
|
|
3141
4614
|
NextToken?: string;
|
|
3142
4615
|
/**
|
|
3143
4616
|
* <p>The number of items to return in the response.</p>
|
|
3144
4617
|
*/
|
|
3145
4618
|
MaxResults?: number;
|
|
4619
|
+
/**
|
|
4620
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4621
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
4622
|
+
* include or exclude resources that match the statement from the list. The match statement
|
|
4623
|
+
* consists of a key and a value.</p>
|
|
4624
|
+
* <p>
|
|
4625
|
+
* <b>Filter properties</b>
|
|
4626
|
+
* </p>
|
|
4627
|
+
* <ul>
|
|
4628
|
+
* <li>
|
|
4629
|
+
* <p>
|
|
4630
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4631
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
4632
|
+
* </li>
|
|
4633
|
+
* <li>
|
|
4634
|
+
* <p>
|
|
4635
|
+
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4636
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4637
|
+
* </li>
|
|
4638
|
+
* <li>
|
|
4639
|
+
* <p>
|
|
4640
|
+
* <code>Value</code> - The value to match.</p>
|
|
4641
|
+
* </li>
|
|
4642
|
+
* </ul>
|
|
4643
|
+
*/
|
|
4644
|
+
Filters?: Filter[];
|
|
3146
4645
|
}
|
|
3147
|
-
export declare namespace
|
|
4646
|
+
export declare namespace ListExplainabilityExportsRequest {
|
|
3148
4647
|
/**
|
|
3149
4648
|
* @internal
|
|
3150
4649
|
*/
|
|
3151
|
-
const filterSensitiveLog: (obj:
|
|
4650
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsRequest) => any;
|
|
3152
4651
|
}
|
|
3153
4652
|
/**
|
|
3154
|
-
* <p>Provides a summary of the
|
|
3155
|
-
*
|
|
3156
|
-
*
|
|
4653
|
+
* <p>Provides a summary of the Explainability export properties used in the <a>ListExplainabilityExports</a> operation. To get a complete set of
|
|
4654
|
+
* properties, call the <a>DescribeExplainabilityExport</a> operation, and
|
|
4655
|
+
* provide the <code>ExplainabilityExportArn</code>.</p>
|
|
3157
4656
|
*/
|
|
3158
|
-
export interface
|
|
4657
|
+
export interface ExplainabilityExportSummary {
|
|
3159
4658
|
/**
|
|
3160
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
4659
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3161
4660
|
*/
|
|
3162
|
-
|
|
4661
|
+
ExplainabilityExportArn?: string;
|
|
3163
4662
|
/**
|
|
3164
|
-
* <p>The name of the
|
|
4663
|
+
* <p>The name of the Explainability export</p>
|
|
3165
4664
|
*/
|
|
3166
|
-
|
|
4665
|
+
ExplainabilityExportName?: string;
|
|
3167
4666
|
/**
|
|
3168
|
-
* <p>The
|
|
4667
|
+
* <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
|
|
4668
|
+
* to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
|
|
3169
4669
|
*/
|
|
3170
|
-
|
|
4670
|
+
Destination?: DataDestination;
|
|
3171
4671
|
/**
|
|
3172
|
-
* <p>The
|
|
4672
|
+
* <p>The status of the Explainability export. States include: </p>
|
|
4673
|
+
* <ul>
|
|
4674
|
+
* <li>
|
|
4675
|
+
* <p>
|
|
4676
|
+
* <code>ACTIVE</code>
|
|
4677
|
+
* </p>
|
|
4678
|
+
* </li>
|
|
4679
|
+
* <li>
|
|
4680
|
+
* <p>
|
|
4681
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
4682
|
+
* <code>CREATE_FAILED</code>
|
|
4683
|
+
* </p>
|
|
4684
|
+
* </li>
|
|
4685
|
+
* <li>
|
|
4686
|
+
* <p>
|
|
4687
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
4688
|
+
* </p>
|
|
4689
|
+
* </li>
|
|
4690
|
+
* <li>
|
|
4691
|
+
* <p>
|
|
4692
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
4693
|
+
* <code>DELETE_FAILED</code>
|
|
4694
|
+
* </p>
|
|
4695
|
+
* </li>
|
|
4696
|
+
* </ul>
|
|
3173
4697
|
*/
|
|
3174
|
-
|
|
4698
|
+
Status?: string;
|
|
3175
4699
|
/**
|
|
3176
|
-
* <p>
|
|
4700
|
+
* <p>Information about any errors that may have occurred during the Explainability
|
|
4701
|
+
* export.</p>
|
|
4702
|
+
*/
|
|
4703
|
+
Message?: string;
|
|
4704
|
+
/**
|
|
4705
|
+
* <p>When the Explainability was created.</p>
|
|
3177
4706
|
*/
|
|
3178
4707
|
CreationTime?: Date;
|
|
3179
4708
|
/**
|
|
3180
|
-
* <p>
|
|
3181
|
-
*
|
|
3182
|
-
* <
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
4709
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
4710
|
+
* job:</p>
|
|
4711
|
+
* <ul>
|
|
4712
|
+
* <li>
|
|
4713
|
+
* <p>
|
|
4714
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
4715
|
+
* </li>
|
|
4716
|
+
* <li>
|
|
4717
|
+
* <p>
|
|
4718
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
4719
|
+
* </li>
|
|
4720
|
+
* <li>
|
|
4721
|
+
* <p>
|
|
4722
|
+
* <code>CREATE_STOPPING</code> - The current timestamp.</p>
|
|
4723
|
+
* </li>
|
|
4724
|
+
* <li>
|
|
4725
|
+
* <p>
|
|
4726
|
+
* <code>CREATE_STOPPED</code> - When the job stopped.</p>
|
|
4727
|
+
* </li>
|
|
4728
|
+
* <li>
|
|
4729
|
+
* <p>
|
|
4730
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
|
|
4731
|
+
* failed.</p>
|
|
4732
|
+
* </li>
|
|
4733
|
+
* </ul>
|
|
3185
4734
|
*/
|
|
3186
4735
|
LastModificationTime?: Date;
|
|
3187
4736
|
}
|
|
3188
|
-
export declare namespace
|
|
4737
|
+
export declare namespace ExplainabilityExportSummary {
|
|
3189
4738
|
/**
|
|
3190
4739
|
* @internal
|
|
3191
4740
|
*/
|
|
3192
|
-
const filterSensitiveLog: (obj:
|
|
4741
|
+
const filterSensitiveLog: (obj: ExplainabilityExportSummary) => any;
|
|
3193
4742
|
}
|
|
3194
|
-
export interface
|
|
4743
|
+
export interface ListExplainabilityExportsResponse {
|
|
3195
4744
|
/**
|
|
3196
|
-
* <p>An array of objects that summarize each
|
|
4745
|
+
* <p>An array of objects that summarize the properties of each Explainability
|
|
4746
|
+
* export.</p>
|
|
3197
4747
|
*/
|
|
3198
|
-
|
|
4748
|
+
ExplainabilityExports?: ExplainabilityExportSummary[];
|
|
3199
4749
|
/**
|
|
3200
|
-
* <p>
|
|
3201
|
-
*
|
|
4750
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
4751
|
+
* use the token in the next request.</p>
|
|
3202
4752
|
*/
|
|
3203
4753
|
NextToken?: string;
|
|
3204
4754
|
}
|
|
3205
|
-
export declare namespace
|
|
4755
|
+
export declare namespace ListExplainabilityExportsResponse {
|
|
3206
4756
|
/**
|
|
3207
4757
|
* @internal
|
|
3208
4758
|
*/
|
|
3209
|
-
const filterSensitiveLog: (obj:
|
|
4759
|
+
const filterSensitiveLog: (obj: ListExplainabilityExportsResponse) => any;
|
|
3210
4760
|
}
|
|
3211
4761
|
export interface ListForecastExportJobsRequest {
|
|
3212
4762
|
/**
|
|
@@ -3437,6 +4987,10 @@ export interface ForecastSummary {
|
|
|
3437
4987
|
* <p>The ARN of the predictor used to generate the forecast.</p>
|
|
3438
4988
|
*/
|
|
3439
4989
|
PredictorArn?: string;
|
|
4990
|
+
/**
|
|
4991
|
+
* <p>Whether the Forecast was created from an AutoPredictor.</p>
|
|
4992
|
+
*/
|
|
4993
|
+
CreatedUsingAutoPredictor?: boolean;
|
|
3440
4994
|
/**
|
|
3441
4995
|
* <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
|
|
3442
4996
|
* the predictor.</p>
|
|
@@ -3535,9 +5089,9 @@ export declare namespace ListForecastsResponse {
|
|
|
3535
5089
|
}
|
|
3536
5090
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
3537
5091
|
/**
|
|
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>
|
|
5092
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5093
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
5094
|
+
* Tokens expire after 24 hours.</p>
|
|
3541
5095
|
*/
|
|
3542
5096
|
NextToken?: string;
|
|
3543
5097
|
/**
|
|
@@ -3546,29 +5100,29 @@ export interface ListPredictorBacktestExportJobsRequest {
|
|
|
3546
5100
|
MaxResults?: number;
|
|
3547
5101
|
/**
|
|
3548
5102
|
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
3549
|
-
*
|
|
3550
|
-
*
|
|
3551
|
-
*
|
|
3552
|
-
*
|
|
3553
|
-
*
|
|
3554
|
-
*
|
|
3555
|
-
*
|
|
5103
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5104
|
+
* include or exclude the predictor backtest export jobs that match the statement from the
|
|
5105
|
+
* list. The match statement consists of a key and a value.</p>
|
|
5106
|
+
* <p>
|
|
5107
|
+
* <b>Filter properties</b>
|
|
5108
|
+
* </p>
|
|
5109
|
+
* <ul>
|
|
3556
5110
|
* <li>
|
|
3557
|
-
*
|
|
5111
|
+
* <p>
|
|
3558
5112
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
3559
5113
|
* <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
|
|
3560
|
-
*
|
|
3561
|
-
*
|
|
3562
|
-
*
|
|
5114
|
+
* export jobs that match the statement, specify <code>IS</code>. To exclude
|
|
5115
|
+
* matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
|
|
5116
|
+
* </li>
|
|
3563
5117
|
* <li>
|
|
3564
|
-
*
|
|
5118
|
+
* <p>
|
|
3565
5119
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
3566
5120
|
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
3567
|
-
*
|
|
5121
|
+
* </li>
|
|
3568
5122
|
* <li>
|
|
3569
|
-
*
|
|
5123
|
+
* <p>
|
|
3570
5124
|
* <code>Value</code> - The value to match.</p>
|
|
3571
|
-
*
|
|
5125
|
+
* </li>
|
|
3572
5126
|
* </ul>
|
|
3573
5127
|
*/
|
|
3574
5128
|
Filters?: Filter[];
|
|
@@ -3580,9 +5134,9 @@ export declare namespace ListPredictorBacktestExportJobsRequest {
|
|
|
3580
5134
|
const filterSensitiveLog: (obj: ListPredictorBacktestExportJobsRequest) => any;
|
|
3581
5135
|
}
|
|
3582
5136
|
/**
|
|
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>
|
|
5137
|
+
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
5138
|
+
* properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
5139
|
+
* provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
|
|
3586
5140
|
*/
|
|
3587
5141
|
export interface PredictorBacktestExportJobSummary {
|
|
3588
5142
|
/**
|
|
@@ -3609,7 +5163,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3609
5163
|
* <li>
|
|
3610
5164
|
* <p>
|
|
3611
5165
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3612
|
-
*
|
|
5166
|
+
* <code>CREATE_FAILED</code>
|
|
3613
5167
|
* </p>
|
|
3614
5168
|
* </li>
|
|
3615
5169
|
* <li>
|
|
@@ -3620,7 +5174,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3620
5174
|
* <li>
|
|
3621
5175
|
* <p>
|
|
3622
5176
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3623
|
-
*
|
|
5177
|
+
* <code>DELETE_FAILED</code>
|
|
3624
5178
|
* </p>
|
|
3625
5179
|
* </li>
|
|
3626
5180
|
* </ul>
|
|
@@ -3635,7 +5189,8 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
3635
5189
|
*/
|
|
3636
5190
|
CreationTime?: Date;
|
|
3637
5191
|
/**
|
|
3638
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5192
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5193
|
+
* job:</p>
|
|
3639
5194
|
* <ul>
|
|
3640
5195
|
* <li>
|
|
3641
5196
|
* <p>
|
|
@@ -3675,8 +5230,8 @@ export interface ListPredictorBacktestExportJobsResponse {
|
|
|
3675
5230
|
*/
|
|
3676
5231
|
PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
|
|
3677
5232
|
/**
|
|
3678
|
-
* <p>Returns this token if the response is truncated. To retrieve the next
|
|
3679
|
-
*
|
|
5233
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
5234
|
+
* use the token in the next request.</p>
|
|
3680
5235
|
*/
|
|
3681
5236
|
NextToken?: string;
|
|
3682
5237
|
}
|
|
@@ -3754,6 +5309,15 @@ export interface PredictorSummary {
|
|
|
3754
5309
|
* the predictor.</p>
|
|
3755
5310
|
*/
|
|
3756
5311
|
DatasetGroupArn?: string;
|
|
5312
|
+
/**
|
|
5313
|
+
* <p>Whether AutoPredictor was used to create the predictor.</p>
|
|
5314
|
+
*/
|
|
5315
|
+
IsAutoPredictor?: boolean;
|
|
5316
|
+
/**
|
|
5317
|
+
* <p>A summary of the reference predictor used if the predictor was retrained or
|
|
5318
|
+
* upgraded.</p>
|
|
5319
|
+
*/
|
|
5320
|
+
ReferencePredictorSummary?: ReferencePredictorSummary;
|
|
3757
5321
|
/**
|
|
3758
5322
|
* <p>The status of the predictor. States include:</p>
|
|
3759
5323
|
* <ul>
|
|
@@ -3765,13 +5329,13 @@ export interface PredictorSummary {
|
|
|
3765
5329
|
* <li>
|
|
3766
5330
|
* <p>
|
|
3767
5331
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3768
|
-
*
|
|
5332
|
+
* <code>CREATE_FAILED</code>
|
|
3769
5333
|
* </p>
|
|
3770
5334
|
* </li>
|
|
3771
5335
|
* <li>
|
|
3772
5336
|
* <p>
|
|
3773
5337
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3774
|
-
*
|
|
5338
|
+
* <code>DELETE_FAILED</code>
|
|
3775
5339
|
* </p>
|
|
3776
5340
|
* </li>
|
|
3777
5341
|
* <li>
|
|
@@ -3795,7 +5359,8 @@ export interface PredictorSummary {
|
|
|
3795
5359
|
*/
|
|
3796
5360
|
CreationTime?: Date;
|
|
3797
5361
|
/**
|
|
3798
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5362
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5363
|
+
* job:</p>
|
|
3799
5364
|
* <ul>
|
|
3800
5365
|
* <li>
|
|
3801
5366
|
* <p>
|
|
@@ -3847,7 +5412,8 @@ export declare namespace ListPredictorsResponse {
|
|
|
3847
5412
|
}
|
|
3848
5413
|
export interface ListTagsForResourceRequest {
|
|
3849
5414
|
/**
|
|
3850
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5415
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5416
|
+
* </p>
|
|
3851
5417
|
*/
|
|
3852
5418
|
ResourceArn: string | undefined;
|
|
3853
5419
|
}
|
|
@@ -3873,8 +5439,9 @@ export interface StopResourceRequest {
|
|
|
3873
5439
|
/**
|
|
3874
5440
|
* <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
|
|
3875
5441
|
* are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>,
|
|
3876
|
-
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
3877
|
-
* <code>ForecastExportJobArn</code
|
|
5442
|
+
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5443
|
+
* <code>ForecastExportJobArn</code>, <code>ExplainabilityArn</code>, and
|
|
5444
|
+
* <code>ExplainabilityExportArn</code>. </p>
|
|
3878
5445
|
*/
|
|
3879
5446
|
ResourceArn: string | undefined;
|
|
3880
5447
|
}
|
|
@@ -3886,7 +5453,8 @@ export declare namespace StopResourceRequest {
|
|
|
3886
5453
|
}
|
|
3887
5454
|
export interface TagResourceRequest {
|
|
3888
5455
|
/**
|
|
3889
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5456
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5457
|
+
* </p>
|
|
3890
5458
|
*/
|
|
3891
5459
|
ResourceArn: string | undefined;
|
|
3892
5460
|
/**
|
|
@@ -3897,7 +5465,8 @@ export interface TagResourceRequest {
|
|
|
3897
5465
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
3898
5466
|
* </li>
|
|
3899
5467
|
* <li>
|
|
3900
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5468
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5469
|
+
* value.</p>
|
|
3901
5470
|
* </li>
|
|
3902
5471
|
* <li>
|
|
3903
5472
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -3906,13 +5475,21 @@ export interface TagResourceRequest {
|
|
|
3906
5475
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
3907
5476
|
* </li>
|
|
3908
5477
|
* <li>
|
|
3909
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5478
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5479
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
5480
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
5481
|
+
* - = . _ : / @.</p>
|
|
3910
5482
|
* </li>
|
|
3911
5483
|
* <li>
|
|
3912
5484
|
* <p>Tag keys and values are case sensitive.</p>
|
|
3913
5485
|
* </li>
|
|
3914
5486
|
* <li>
|
|
3915
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5487
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5488
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
5489
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
5490
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
5491
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
5492
|
+
* not count against your tags per resource limit.</p>
|
|
3916
5493
|
* </li>
|
|
3917
5494
|
* </ul>
|
|
3918
5495
|
*/
|
|
@@ -3934,7 +5511,8 @@ export declare namespace TagResourceResponse {
|
|
|
3934
5511
|
}
|
|
3935
5512
|
export interface UntagResourceRequest {
|
|
3936
5513
|
/**
|
|
3937
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5514
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5515
|
+
* </p>
|
|
3938
5516
|
*/
|
|
3939
5517
|
ResourceArn: string | undefined;
|
|
3940
5518
|
/**
|