@aws-sdk/client-forecast 3.40.0 → 3.45.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 +41 -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 +9 -0
- package/dist-cjs/models/models_0.js +236 -61
- package/dist-cjs/protocols/Aws_json1_1.js +1283 -98
- package/dist-es/Forecast.js +150 -0
- package/dist-es/commands/CreateAutoPredictorCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DescribeAutoPredictorCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/ListExplainabilitiesCommand.js +39 -0
- package/dist-es/commands/ListExplainabilityExportsCommand.js +39 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +160 -40
- package/dist-es/protocols/Aws_json1_1.js +1367 -138
- package/dist-types/Forecast.d.ts +306 -40
- package/dist-types/ForecastClient.d.ts +12 -2
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +83 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +153 -0
- package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +43 -0
- package/dist-types/commands/CreateForecastCommand.d.ts +1 -1
- package/dist-types/commands/CreateForecastExportJobCommand.d.ts +1 -1
- package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +5 -5
- package/dist-types/commands/CreatePredictorCommand.d.ts +20 -19
- package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExplainabilityCommand.d.ts +37 -0
- package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DeleteForecastCommand.d.ts +1 -1
- package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredictorCommand.d.ts +3 -4
- package/dist-types/commands/DeleteResourceTreeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +35 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
- package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DescribeForecastCommand.d.ts +1 -1
- package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +2 -2
- package/dist-types/commands/DescribePredictorCommand.d.ts +6 -2
- package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
- package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
- package/dist-types/commands/ListForecastExportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListForecastsCommand.d.ts +1 -1
- package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +5 -5
- package/dist-types/commands/ListPredictorsCommand.d.ts +6 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/StopResourceCommand.d.ts +10 -4
- package/dist-types/commands/TagResourceCommand.d.ts +5 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +2109 -495
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/Forecast.d.ts +50 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +12 -2
- package/dist-types/ts3.4/commands/CreateAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilityExportsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +492 -83
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +6 -6
package/dist-types/Forecast.d.ts
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
|
+
import { CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput } from "./commands/CreateAutoPredictorCommand";
|
|
2
3
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
3
4
|
import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
|
|
4
5
|
import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
|
|
6
|
+
import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } from "./commands/CreateExplainabilityCommand";
|
|
7
|
+
import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
|
|
5
8
|
import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
|
|
6
9
|
import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
|
|
7
10
|
import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
|
|
@@ -9,14 +12,19 @@ import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./com
|
|
|
9
12
|
import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
|
|
10
13
|
import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
|
|
11
14
|
import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
|
|
15
|
+
import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } from "./commands/DeleteExplainabilityCommand";
|
|
16
|
+
import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
|
|
12
17
|
import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
|
|
13
18
|
import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
|
|
14
19
|
import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
|
|
15
20
|
import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
|
|
16
21
|
import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
|
|
22
|
+
import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
|
|
17
23
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
18
24
|
import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
|
|
19
25
|
import { DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput } from "./commands/DescribeDatasetImportJobCommand";
|
|
26
|
+
import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput } from "./commands/DescribeExplainabilityCommand";
|
|
27
|
+
import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
|
|
20
28
|
import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
|
|
21
29
|
import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
|
|
22
30
|
import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
|
|
@@ -25,6 +33,8 @@ import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from
|
|
|
25
33
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
26
34
|
import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
|
|
27
35
|
import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/ListDatasetsCommand";
|
|
36
|
+
import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } from "./commands/ListExplainabilitiesCommand";
|
|
37
|
+
import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
|
|
28
38
|
import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
|
|
29
39
|
import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
|
|
30
40
|
import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
|
|
@@ -39,6 +49,60 @@ import { ForecastClient } from "./ForecastClient";
|
|
|
39
49
|
* <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
|
|
40
50
|
*/
|
|
41
51
|
export declare class Forecast extends ForecastClient {
|
|
52
|
+
/**
|
|
53
|
+
* <p>Creates an Amazon Forecast predictor.</p>
|
|
54
|
+
* <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
|
|
55
|
+
* optimal combination of algorithms to each time series in your datasets. You can use
|
|
56
|
+
* <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain existing
|
|
57
|
+
* predictors.</p>
|
|
58
|
+
* <p>
|
|
59
|
+
* <b>Creating new predictors</b>
|
|
60
|
+
* </p>
|
|
61
|
+
* <p>The following parameters are required when creating a new predictor:</p>
|
|
62
|
+
* <ul>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>
|
|
65
|
+
* <code>PredictorName</code> - A unique name for the predictor.</p>
|
|
66
|
+
* </li>
|
|
67
|
+
* <li>
|
|
68
|
+
* <p>
|
|
69
|
+
* <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
|
|
70
|
+
* predictor.</p>
|
|
71
|
+
* </li>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
|
|
75
|
+
* daily, weekly, etc).</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>ForecastHorizon</code> - The number of time steps being
|
|
80
|
+
* forecasted.</p>
|
|
81
|
+
* </li>
|
|
82
|
+
* </ul>
|
|
83
|
+
* <p>When creating a new predictor, do not specify a value for
|
|
84
|
+
* <code>ReferencePredictorArn</code>.</p>
|
|
85
|
+
* <p>
|
|
86
|
+
* <b>Upgrading and retraining predictors</b>
|
|
87
|
+
* </p>
|
|
88
|
+
* <p>The following parameters are required when retraining or upgrading a predictor:</p>
|
|
89
|
+
* <ul>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>
|
|
92
|
+
* <code>PredictorName</code> - A unique name for the predictor.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>
|
|
96
|
+
* <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
|
|
97
|
+
* upgrade.</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* </ul>
|
|
100
|
+
* <p>When upgrading or retraining a predictor, only specify values for the
|
|
101
|
+
* <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
|
|
102
|
+
*/
|
|
103
|
+
createAutoPredictor(args: CreateAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<CreateAutoPredictorCommandOutput>;
|
|
104
|
+
createAutoPredictor(args: CreateAutoPredictorCommandInput, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
|
|
105
|
+
createAutoPredictor(args: CreateAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
|
|
42
106
|
/**
|
|
43
107
|
* <p>Creates an Amazon Forecast dataset. The information about the dataset that you provide helps
|
|
44
108
|
* Forecast understand how to consume the data for model training. This includes the
|
|
@@ -126,6 +190,144 @@ export declare class Forecast extends ForecastClient {
|
|
|
126
190
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetImportJobCommandOutput>;
|
|
127
191
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
128
192
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
193
|
+
/**
|
|
194
|
+
* <note>
|
|
195
|
+
* <p>Explainability is only available for Forecasts and Predictors generated from an
|
|
196
|
+
* AutoPredictor (<a>CreateAutoPredictor</a>)</p>
|
|
197
|
+
* </note>
|
|
198
|
+
* <p>Creates an Amazon Forecast Explainability.</p>
|
|
199
|
+
* <p>Explainability helps you better understand how the attributes in your datasets impact
|
|
200
|
+
* forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative
|
|
201
|
+
* impact of each attribute and determine whether they increase or decrease forecast
|
|
202
|
+
* values.</p>
|
|
203
|
+
* <p>To enable Forecast Explainability, your predictor must include at least one of the
|
|
204
|
+
* following: related time series, item metadata, or additional datasets like Holidays and
|
|
205
|
+
* the Weather Index.</p>
|
|
206
|
+
* <p>CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive
|
|
207
|
+
* aggregated Impact scores for all time series and time points in your datasets, provide a
|
|
208
|
+
* Predictor ARN. To receive Impact scores for specific time series and time points,
|
|
209
|
+
* provide a Forecast ARN.</p>
|
|
210
|
+
* <p>
|
|
211
|
+
* <b>CreateExplainability with a Predictor ARN</b>
|
|
212
|
+
* </p>
|
|
213
|
+
* <note>
|
|
214
|
+
* <p>You can only have one Explainability resource per predictor. If you already
|
|
215
|
+
* enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
|
|
216
|
+
* predictor already has an Explainability resource.</p>
|
|
217
|
+
* </note>
|
|
218
|
+
* <p>The following parameters are required when providing a Predictor ARN:</p>
|
|
219
|
+
* <ul>
|
|
220
|
+
* <li>
|
|
221
|
+
* <p>
|
|
222
|
+
* <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
|
|
223
|
+
* </li>
|
|
224
|
+
* <li>
|
|
225
|
+
* <p>
|
|
226
|
+
* <code>ResourceArn</code> - The Arn of the predictor.</p>
|
|
227
|
+
* </li>
|
|
228
|
+
* <li>
|
|
229
|
+
* <p>
|
|
230
|
+
* <code>TimePointGranularity</code> - Must be set to “ALL”.</p>
|
|
231
|
+
* </li>
|
|
232
|
+
* <li>
|
|
233
|
+
* <p>
|
|
234
|
+
* <code>TimeSeriesGranularity</code> - Must be set to “ALL”.</p>
|
|
235
|
+
* </li>
|
|
236
|
+
* </ul>
|
|
237
|
+
* <p>Do not specify a value for the following parameters:</p>
|
|
238
|
+
* <ul>
|
|
239
|
+
* <li>
|
|
240
|
+
* <p>
|
|
241
|
+
* <code>DataSource</code> - Only valid when TimeSeriesGranularity is
|
|
242
|
+
* “SPECIFIC”.</p>
|
|
243
|
+
* </li>
|
|
244
|
+
* <li>
|
|
245
|
+
* <p>
|
|
246
|
+
* <code>Schema</code> - Only valid when TimeSeriesGranularity is
|
|
247
|
+
* “SPECIFIC”.</p>
|
|
248
|
+
* </li>
|
|
249
|
+
* <li>
|
|
250
|
+
* <p>
|
|
251
|
+
* <code>StartDateTime</code> - Only valid when TimePointGranularity is
|
|
252
|
+
* “SPECIFIC”.</p>
|
|
253
|
+
* </li>
|
|
254
|
+
* <li>
|
|
255
|
+
* <p>
|
|
256
|
+
* <code>EndDateTime</code> - Only valid when TimePointGranularity is
|
|
257
|
+
* “SPECIFIC”.</p>
|
|
258
|
+
* </li>
|
|
259
|
+
* </ul>
|
|
260
|
+
* <p>
|
|
261
|
+
* <b>CreateExplainability with a Forecast ARN</b>
|
|
262
|
+
* </p>
|
|
263
|
+
* <note>
|
|
264
|
+
* <p>You can specify a maximum of 50 time series and 500 time points.</p>
|
|
265
|
+
* </note>
|
|
266
|
+
* <p>The following parameters are required when providing a Predictor ARN:</p>
|
|
267
|
+
* <ul>
|
|
268
|
+
* <li>
|
|
269
|
+
* <p>
|
|
270
|
+
* <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
|
|
271
|
+
* </li>
|
|
272
|
+
* <li>
|
|
273
|
+
* <p>
|
|
274
|
+
* <code>ResourceArn</code> - The Arn of the forecast.</p>
|
|
275
|
+
* </li>
|
|
276
|
+
* <li>
|
|
277
|
+
* <p>
|
|
278
|
+
* <code>TimePointGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
|
|
279
|
+
* </li>
|
|
280
|
+
* <li>
|
|
281
|
+
* <p>
|
|
282
|
+
* <code>TimeSeriesGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
|
|
283
|
+
* </li>
|
|
284
|
+
* </ul>
|
|
285
|
+
* <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
|
|
286
|
+
* following:</p>
|
|
287
|
+
* <ul>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>
|
|
290
|
+
* <code>DataSource</code> - The S3 location of the CSV file specifying your time
|
|
291
|
+
* series.</p>
|
|
292
|
+
* </li>
|
|
293
|
+
* <li>
|
|
294
|
+
* <p>
|
|
295
|
+
* <code>Schema</code> - The Schema defines the attributes and attribute types
|
|
296
|
+
* listed in the Data Source.</p>
|
|
297
|
+
* </li>
|
|
298
|
+
* </ul>
|
|
299
|
+
* <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
|
|
300
|
+
* following:</p>
|
|
301
|
+
* <ul>
|
|
302
|
+
* <li>
|
|
303
|
+
* <p>
|
|
304
|
+
* <code>StartDateTime</code> - The first timestamp in the range of time
|
|
305
|
+
* points.</p>
|
|
306
|
+
* </li>
|
|
307
|
+
* <li>
|
|
308
|
+
* <p>
|
|
309
|
+
* <code>EndDateTime</code> - The last timestamp in the range of time
|
|
310
|
+
* points.</p>
|
|
311
|
+
* </li>
|
|
312
|
+
* </ul>
|
|
313
|
+
*/
|
|
314
|
+
createExplainability(args: CreateExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<CreateExplainabilityCommandOutput>;
|
|
315
|
+
createExplainability(args: CreateExplainabilityCommandInput, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
|
|
316
|
+
createExplainability(args: CreateExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
|
|
317
|
+
/**
|
|
318
|
+
* <p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon
|
|
319
|
+
* S3) bucket.</p>
|
|
320
|
+
* <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
|
|
321
|
+
* bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
|
|
322
|
+
* bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
|
|
323
|
+
* <note>
|
|
324
|
+
* <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
|
|
325
|
+
* can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribeExplainabilityExport</a> operation.</p>
|
|
326
|
+
* </note>
|
|
327
|
+
*/
|
|
328
|
+
createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<CreateExplainabilityExportCommandOutput>;
|
|
329
|
+
createExplainabilityExport(args: CreateExplainabilityExportCommandInput, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
|
|
330
|
+
createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
|
|
129
331
|
/**
|
|
130
332
|
* <p>Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was
|
|
131
333
|
* used to train the predictor. This is known as inference. To retrieve the forecast for a single
|
|
@@ -170,35 +372,36 @@ export declare class Forecast extends ForecastClient {
|
|
|
170
372
|
createForecastExportJob(args: CreateForecastExportJobCommandInput, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
|
|
171
373
|
createForecastExportJob(args: CreateForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
|
|
172
374
|
/**
|
|
173
|
-
* <
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
375
|
+
* <note>
|
|
376
|
+
* <p> This operation creates a legacy predictor that does not include all the predictor
|
|
377
|
+
* functionalities provided by Amazon Forecast. To create a predictor that is compatible with all
|
|
378
|
+
* aspects of Forecast, use <a>CreateAutoPredictor</a>.</p>
|
|
379
|
+
* </note>
|
|
380
|
+
* <p>Creates an Amazon Forecast predictor.</p>
|
|
381
|
+
* <p>In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast
|
|
382
|
+
* choose an algorithm for you using AutoML. If you specify an algorithm, you also can override
|
|
383
|
+
* algorithm-specific hyperparameters.</p>
|
|
384
|
+
* <p>Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets
|
|
385
|
+
* in the specified dataset group. You can then generate a forecast using the <a>CreateForecast</a> operation.</p>
|
|
386
|
+
* <p> To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation. </p>
|
|
387
|
+
* <p>You can specify a featurization configuration to fill and aggregate the data fields in the
|
|
388
|
+
* <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more information, see
|
|
389
|
+
* <a>FeaturizationConfig</a>.</p>
|
|
186
390
|
* <p>For RELATED_TIME_SERIES datasets, <code>CreatePredictor</code> verifies that the
|
|
187
391
|
* <code>DataFrequency</code> specified when the dataset was created matches the
|
|
188
392
|
* <code>ForecastFrequency</code>. TARGET_TIME_SERIES datasets don't have this restriction.
|
|
189
393
|
* Amazon Forecast also verifies the delimiter and timestamp format. For more information, see <a>howitworks-datasets-groups</a>.</p>
|
|
190
394
|
* <p>By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9
|
|
191
|
-
* (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor
|
|
192
|
-
*
|
|
193
|
-
* </p>
|
|
395
|
+
* (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by
|
|
396
|
+
* setting the <code>ForecastTypes</code>. </p>
|
|
194
397
|
* <p>
|
|
195
398
|
* <b>AutoML</b>
|
|
196
399
|
* </p>
|
|
197
400
|
* <p>If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
|
|
198
401
|
* <code>objective function</code>, set <code>PerformAutoML</code> to <code>true</code>. The
|
|
199
402
|
* <code>objective function</code> is defined as the mean of the weighted losses over the
|
|
200
|
-
* forecast types. By default, these are the p10, p50, and p90
|
|
201
|
-
*
|
|
403
|
+
* forecast types. By default, these are the p10, p50, and p90 quantile losses. For more
|
|
404
|
+
* information, see <a>EvaluationResult</a>.</p>
|
|
202
405
|
* <p>When AutoML is enabled, the following properties are disallowed:</p>
|
|
203
406
|
* <ul>
|
|
204
407
|
* <li>
|
|
@@ -237,8 +440,8 @@ export declare class Forecast extends ForecastClient {
|
|
|
237
440
|
createPredictor(args: CreatePredictorCommandInput, cb: (err: any, data?: CreatePredictorCommandOutput) => void): void;
|
|
238
441
|
createPredictor(args: CreatePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorCommandOutput) => void): void;
|
|
239
442
|
/**
|
|
240
|
-
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a>
|
|
241
|
-
* to your specified S3 bucket.</p>
|
|
443
|
+
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
|
|
444
|
+
* folders containing CSV files are exported to your specified S3 bucket.</p>
|
|
242
445
|
* <p> The export file names will match the following conventions:</p>
|
|
243
446
|
* <p>
|
|
244
447
|
* <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
|
|
@@ -249,8 +452,8 @@ export declare class Forecast extends ForecastClient {
|
|
|
249
452
|
* bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
|
|
250
453
|
* bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
|
|
251
454
|
* <note>
|
|
252
|
-
* <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before
|
|
253
|
-
*
|
|
455
|
+
* <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
|
|
456
|
+
* can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
|
|
254
457
|
* </note>
|
|
255
458
|
*/
|
|
256
459
|
createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreatePredictorBacktestExportJobCommandOutput>;
|
|
@@ -287,6 +490,20 @@ export declare class Forecast extends ForecastClient {
|
|
|
287
490
|
deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetImportJobCommandOutput>;
|
|
288
491
|
deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
|
|
289
492
|
deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
|
|
493
|
+
/**
|
|
494
|
+
* <p>Deletes an Explainability resource.</p>
|
|
495
|
+
* <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
|
|
496
|
+
* <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeExplainability</a> operation.</p>
|
|
497
|
+
*/
|
|
498
|
+
deleteExplainability(args: DeleteExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityCommandOutput>;
|
|
499
|
+
deleteExplainability(args: DeleteExplainabilityCommandInput, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
|
|
500
|
+
deleteExplainability(args: DeleteExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
|
|
501
|
+
/**
|
|
502
|
+
* <p>Deletes an Explainability export.</p>
|
|
503
|
+
*/
|
|
504
|
+
deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityExportCommandOutput>;
|
|
505
|
+
deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
|
|
506
|
+
deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
|
|
290
507
|
/**
|
|
291
508
|
* <p>Deletes a forecast created using the <a>CreateForecast</a> operation. You can
|
|
292
509
|
* delete only forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
|
|
@@ -306,9 +523,8 @@ export declare class Forecast extends ForecastClient {
|
|
|
306
523
|
deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
|
|
307
524
|
deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
|
|
308
525
|
/**
|
|
309
|
-
* <p>Deletes a predictor created using the <a>CreatePredictor</a>
|
|
310
|
-
*
|
|
311
|
-
* To get the status, use the <a>DescribePredictor</a> operation.</p>
|
|
526
|
+
* <p>Deletes a predictor created using the <a>DescribePredictor</a> or <a>CreatePredictor</a> operations. You can delete only predictor that have a status of
|
|
527
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribePredictor</a> operation.</p>
|
|
312
528
|
*/
|
|
313
529
|
deletePredictor(args: DeletePredictorCommandInput, options?: __HttpHandlerOptions): Promise<DeletePredictorCommandOutput>;
|
|
314
530
|
deletePredictor(args: DeletePredictorCommandInput, cb: (err: any, data?: DeletePredictorCommandOutput) => void): void;
|
|
@@ -356,6 +572,12 @@ export declare class Forecast extends ForecastClient {
|
|
|
356
572
|
deleteResourceTree(args: DeleteResourceTreeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceTreeCommandOutput>;
|
|
357
573
|
deleteResourceTree(args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
|
|
358
574
|
deleteResourceTree(args: DeleteResourceTreeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
|
|
575
|
+
/**
|
|
576
|
+
* <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
|
|
577
|
+
*/
|
|
578
|
+
describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAutoPredictorCommandOutput>;
|
|
579
|
+
describeAutoPredictor(args: DescribeAutoPredictorCommandInput, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
|
|
580
|
+
describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
|
|
359
581
|
/**
|
|
360
582
|
* <p>Describes an Amazon Forecast dataset created using the <a>CreateDataset</a>
|
|
361
583
|
* operation.</p>
|
|
@@ -452,6 +674,18 @@ export declare class Forecast extends ForecastClient {
|
|
|
452
674
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
|
|
453
675
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
454
676
|
describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
|
|
677
|
+
/**
|
|
678
|
+
* <p>Describes an Explainability resource created using the <a>CreateExplainability</a> operation.</p>
|
|
679
|
+
*/
|
|
680
|
+
describeExplainability(args: DescribeExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityCommandOutput>;
|
|
681
|
+
describeExplainability(args: DescribeExplainabilityCommandInput, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
|
|
682
|
+
describeExplainability(args: DescribeExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
|
|
683
|
+
/**
|
|
684
|
+
* <p>Describes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.</p>
|
|
685
|
+
*/
|
|
686
|
+
describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityExportCommandOutput>;
|
|
687
|
+
describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
|
|
688
|
+
describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
|
|
455
689
|
/**
|
|
456
690
|
* <p>Describes a forecast created using the <a>CreateForecast</a> operation.</p>
|
|
457
691
|
* <p>In addition to listing the properties provided in the <code>CreateForecast</code> request,
|
|
@@ -517,7 +751,11 @@ export declare class Forecast extends ForecastClient {
|
|
|
517
751
|
describeForecastExportJob(args: DescribeForecastExportJobCommandInput, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
|
|
518
752
|
describeForecastExportJob(args: DescribeForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
|
|
519
753
|
/**
|
|
520
|
-
* <
|
|
754
|
+
* <note>
|
|
755
|
+
* <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
|
|
756
|
+
* are not using a legacy predictor, use <a>DescribeAutoPredictor</a>.</p>
|
|
757
|
+
* </note>
|
|
758
|
+
* <p>Describes a predictor created using the <a>CreatePredictor</a>
|
|
521
759
|
* operation.</p>
|
|
522
760
|
* <p>In addition to listing the properties provided in the <code>CreatePredictor</code>
|
|
523
761
|
* request, this operation lists the following properties:</p>
|
|
@@ -559,7 +797,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
559
797
|
/**
|
|
560
798
|
* <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
|
|
561
799
|
* <p>In addition to listing the properties provided by the user in the
|
|
562
|
-
*
|
|
800
|
+
* <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
|
|
563
801
|
* following properties:</p>
|
|
564
802
|
* <ul>
|
|
565
803
|
* <li>
|
|
@@ -635,6 +873,25 @@ export declare class Forecast extends ForecastClient {
|
|
|
635
873
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
636
874
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
637
875
|
listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
876
|
+
/**
|
|
877
|
+
* <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
|
|
878
|
+
* each Explainability. You can filter the list using an array of <a>Filter</a>
|
|
879
|
+
* objects.</p>
|
|
880
|
+
* <p>To retrieve the complete set of properties for a particular Explainability resource,
|
|
881
|
+
* use the ARN with the <a>DescribeExplainability</a> operation.</p>
|
|
882
|
+
*/
|
|
883
|
+
listExplainabilities(args: ListExplainabilitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilitiesCommandOutput>;
|
|
884
|
+
listExplainabilities(args: ListExplainabilitiesCommandInput, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
|
|
885
|
+
listExplainabilities(args: ListExplainabilitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
|
|
886
|
+
/**
|
|
887
|
+
* <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
|
|
888
|
+
* for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
889
|
+
* <p>To retrieve the complete set of properties for a particular Explainability export, use
|
|
890
|
+
* the ARN with the <a>DescribeExplainability</a> operation.</p>
|
|
891
|
+
*/
|
|
892
|
+
listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilityExportsCommandOutput>;
|
|
893
|
+
listExplainabilityExports(args: ListExplainabilityExportsCommandInput, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
|
|
894
|
+
listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
|
|
638
895
|
/**
|
|
639
896
|
* <p>Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, this operation
|
|
640
897
|
* returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the
|
|
@@ -655,20 +912,20 @@ export declare class Forecast extends ForecastClient {
|
|
|
655
912
|
listForecasts(args: ListForecastsCommandInput, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
|
|
656
913
|
listForecasts(args: ListForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
|
|
657
914
|
/**
|
|
658
|
-
* <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
|
|
659
|
-
* for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
660
|
-
* <p>To retrieve the complete set of properties for a particular backtest export job, use
|
|
661
|
-
* ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
|
|
915
|
+
* <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
|
|
916
|
+
* summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
917
|
+
* <p>To retrieve the complete set of properties for a particular backtest export job, use
|
|
918
|
+
* the ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
|
|
662
919
|
*/
|
|
663
920
|
listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListPredictorBacktestExportJobsCommandOutput>;
|
|
664
921
|
listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void): void;
|
|
665
922
|
listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void): void;
|
|
666
923
|
/**
|
|
667
|
-
* <p>Returns a list of predictors created using the <a>
|
|
668
|
-
*
|
|
669
|
-
* its Amazon Resource Name (ARN).
|
|
670
|
-
*
|
|
671
|
-
* array of <a>Filter</a> objects.</p>
|
|
924
|
+
* <p>Returns a list of predictors created using the <a>CreateAutoPredictor</a> or
|
|
925
|
+
* <a>CreatePredictor</a> operations. For each predictor, this operation returns a
|
|
926
|
+
* summary of its properties, including its Amazon Resource Name (ARN). </p>
|
|
927
|
+
* <p>You can retrieve the complete set of properties by using the ARN with the <a>DescribeAutoPredictor</a> and <a>DescribePredictor</a> operations. You
|
|
928
|
+
* can filter the list using an array of <a>Filter</a> objects.</p>
|
|
672
929
|
*/
|
|
673
930
|
listPredictors(args: ListPredictorsCommandInput, options?: __HttpHandlerOptions): Promise<ListPredictorsCommandOutput>;
|
|
674
931
|
listPredictors(args: ListPredictorsCommandInput, cb: (err: any, data?: ListPredictorsCommandOutput) => void): void;
|
|
@@ -681,9 +938,9 @@ export declare class Forecast extends ForecastClient {
|
|
|
681
938
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
682
939
|
/**
|
|
683
940
|
* <p>Stops a resource.</p>
|
|
684
|
-
* <p>The resource undergoes the following states:
|
|
685
|
-
*
|
|
686
|
-
*
|
|
941
|
+
* <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and
|
|
942
|
+
* <code>CREATE_STOPPED</code>. You cannot resume a resource once it has been
|
|
943
|
+
* stopped.</p>
|
|
687
944
|
* <p>This operation can be applied to the following resources (and their corresponding child
|
|
688
945
|
* resources):</p>
|
|
689
946
|
* <ul>
|
|
@@ -702,13 +959,22 @@ export declare class Forecast extends ForecastClient {
|
|
|
702
959
|
* <li>
|
|
703
960
|
* <p>Predictor Backtest Export Job</p>
|
|
704
961
|
* </li>
|
|
962
|
+
* <li>
|
|
963
|
+
* <p>Explainability Job</p>
|
|
964
|
+
* </li>
|
|
965
|
+
* <li>
|
|
966
|
+
* <p>Explainability Export Job</p>
|
|
967
|
+
* </li>
|
|
705
968
|
* </ul>
|
|
706
969
|
*/
|
|
707
970
|
stopResource(args: StopResourceCommandInput, options?: __HttpHandlerOptions): Promise<StopResourceCommandOutput>;
|
|
708
971
|
stopResource(args: StopResourceCommandInput, cb: (err: any, data?: StopResourceCommandOutput) => void): void;
|
|
709
972
|
stopResource(args: StopResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopResourceCommandOutput) => void): void;
|
|
710
973
|
/**
|
|
711
|
-
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
|
|
974
|
+
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
|
|
975
|
+
* If existing tags on a resource are not specified in the request parameters, they are not
|
|
976
|
+
* changed. When a resource is deleted, the tags associated with that resource are also
|
|
977
|
+
* deleted.</p>
|
|
712
978
|
*/
|
|
713
979
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
714
980
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
@@ -6,9 +6,12 @@ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middlewa
|
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
|
+
import { CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput } from "./commands/CreateAutoPredictorCommand";
|
|
9
10
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
|
|
10
11
|
import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
|
|
11
12
|
import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
|
|
13
|
+
import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } from "./commands/CreateExplainabilityCommand";
|
|
14
|
+
import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
|
|
12
15
|
import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
|
|
13
16
|
import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
|
|
14
17
|
import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
|
|
@@ -16,14 +19,19 @@ import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./com
|
|
|
16
19
|
import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
|
|
17
20
|
import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
|
|
18
21
|
import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
|
|
22
|
+
import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } from "./commands/DeleteExplainabilityCommand";
|
|
23
|
+
import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
|
|
19
24
|
import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
|
|
20
25
|
import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
|
|
21
26
|
import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
|
|
22
27
|
import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
|
|
23
28
|
import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
|
|
29
|
+
import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
|
|
24
30
|
import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
|
|
25
31
|
import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
|
|
26
32
|
import { DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput } from "./commands/DescribeDatasetImportJobCommand";
|
|
33
|
+
import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput } from "./commands/DescribeExplainabilityCommand";
|
|
34
|
+
import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
|
|
27
35
|
import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
|
|
28
36
|
import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
|
|
29
37
|
import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
|
|
@@ -32,6 +40,8 @@ import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from
|
|
|
32
40
|
import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
|
|
33
41
|
import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
|
|
34
42
|
import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/ListDatasetsCommand";
|
|
43
|
+
import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } from "./commands/ListExplainabilitiesCommand";
|
|
44
|
+
import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
|
|
35
45
|
import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
|
|
36
46
|
import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
|
|
37
47
|
import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
|
|
@@ -41,8 +51,8 @@ import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/
|
|
|
41
51
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
42
52
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
43
53
|
import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
|
|
44
|
-
export declare type ServiceInputTypes = CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
|
|
45
|
-
export declare type ServiceOutputTypes = CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
|
|
54
|
+
export declare type ServiceInputTypes = CreateAutoPredictorCommandInput | CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateExplainabilityCommandInput | CreateExplainabilityExportCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteExplainabilityCommandInput | DeleteExplainabilityExportCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeAutoPredictorCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeExplainabilityCommandInput | DescribeExplainabilityExportCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListExplainabilitiesCommandInput | ListExplainabilityExportsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
|
|
55
|
+
export declare type ServiceOutputTypes = CreateAutoPredictorCommandOutput | CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateExplainabilityCommandOutput | CreateExplainabilityExportCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteExplainabilityCommandOutput | DeleteExplainabilityExportCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeAutoPredictorCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeExplainabilityCommandOutput | DescribeExplainabilityExportCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListExplainabilitiesCommandOutput | ListExplainabilityExportsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
|
|
46
56
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
47
57
|
/**
|
|
48
58
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|