@aws-sdk/client-forecast 3.95.0 → 3.97.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/dist-cjs/Forecast.js +90 -0
- package/dist-cjs/commands/CreateMonitorCommand.js +36 -0
- package/dist-cjs/commands/DeleteMonitorCommand.js +36 -0
- package/dist-cjs/commands/DescribeMonitorCommand.js +36 -0
- package/dist-cjs/commands/ListMonitorEvaluationsCommand.js +36 -0
- package/dist-cjs/commands/ListMonitorsCommand.js +36 -0
- package/dist-cjs/commands/ResumeResourceCommand.js +36 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/models/models_0.js +125 -3
- package/dist-cjs/pagination/ListExplainabilitiesPaginator.js +36 -0
- package/dist-cjs/pagination/ListExplainabilityExportsPaginator.js +36 -0
- package/dist-cjs/pagination/ListMonitorEvaluationsPaginator.js +36 -0
- package/dist-cjs/pagination/ListMonitorsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +539 -2
- package/dist-es/Forecast.js +90 -0
- package/dist-es/commands/CreateMonitorCommand.js +39 -0
- package/dist-es/commands/DeleteMonitorCommand.js +39 -0
- package/dist-es/commands/DescribeMonitorCommand.js +39 -0
- package/dist-es/commands/ListMonitorEvaluationsCommand.js +39 -0
- package/dist-es/commands/ListMonitorsCommand.js +39 -0
- package/dist-es/commands/ResumeResourceCommand.js +39 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +80 -0
- package/dist-es/pagination/ListExplainabilitiesPaginator.js +75 -0
- package/dist-es/pagination/ListExplainabilityExportsPaginator.js +75 -0
- package/dist-es/pagination/ListMonitorEvaluationsPaginator.js +75 -0
- package/dist-es/pagination/ListMonitorsPaginator.js +75 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +624 -1
- package/dist-types/Forecast.d.ts +133 -45
- package/dist-types/ForecastClient.d.ts +8 -2
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +7 -5
- package/dist-types/commands/CreateDatasetCommand.d.ts +4 -4
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +4 -4
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +5 -4
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +2 -2
- package/dist-types/commands/CreateMonitorCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +5 -6
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +3 -2
- package/dist-types/commands/DeleteMonitorCommand.d.ts +35 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMonitorCommand.d.ts +72 -0
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +5 -4
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +5 -4
- package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
- package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +37 -0
- package/dist-types/commands/ListMonitorsCommand.d.ts +36 -0
- package/dist-types/commands/ResumeResourceCommand.d.ts +35 -0
- package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +660 -62
- package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListMonitorsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/Forecast.d.ts +30 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/CreateMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListMonitorEvaluationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListMonitorsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ResumeResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +252 -0
- package/dist-types/ts3.4/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListMonitorsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +18 -0
- package/package.json +1 -1
package/dist-types/Forecast.d.ts
CHANGED
|
@@ -7,6 +7,7 @@ import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } f
|
|
|
7
7
|
import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
|
|
8
8
|
import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
|
|
9
9
|
import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
|
|
10
|
+
import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "./commands/CreateMonitorCommand";
|
|
10
11
|
import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
|
|
11
12
|
import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./commands/CreatePredictorCommand";
|
|
12
13
|
import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
|
|
@@ -16,6 +17,7 @@ import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } f
|
|
|
16
17
|
import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
|
|
17
18
|
import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
|
|
18
19
|
import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
|
|
20
|
+
import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "./commands/DeleteMonitorCommand";
|
|
19
21
|
import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
|
|
20
22
|
import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
|
|
21
23
|
import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
|
|
@@ -27,6 +29,7 @@ import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput
|
|
|
27
29
|
import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
|
|
28
30
|
import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
|
|
29
31
|
import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
|
|
32
|
+
import { DescribeMonitorCommandInput, DescribeMonitorCommandOutput } from "./commands/DescribeMonitorCommand";
|
|
30
33
|
import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
|
|
31
34
|
import { DescribePredictorCommandInput, DescribePredictorCommandOutput } from "./commands/DescribePredictorCommand";
|
|
32
35
|
import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from "./commands/GetAccuracyMetricsCommand";
|
|
@@ -37,9 +40,12 @@ import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } f
|
|
|
37
40
|
import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
|
|
38
41
|
import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
|
|
39
42
|
import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
|
|
43
|
+
import { ListMonitorEvaluationsCommandInput, ListMonitorEvaluationsCommandOutput } from "./commands/ListMonitorEvaluationsCommand";
|
|
44
|
+
import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "./commands/ListMonitorsCommand";
|
|
40
45
|
import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
|
|
41
46
|
import { ListPredictorsCommandInput, ListPredictorsCommandOutput } from "./commands/ListPredictorsCommand";
|
|
42
47
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
48
|
+
import { ResumeResourceCommandInput, ResumeResourceCommandOutput } from "./commands/ResumeResourceCommand";
|
|
43
49
|
import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/StopResourceCommand";
|
|
44
50
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
45
51
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
@@ -53,11 +59,13 @@ export declare class Forecast extends ForecastClient {
|
|
|
53
59
|
* <p>Creates an Amazon Forecast predictor.</p>
|
|
54
60
|
* <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
|
|
55
61
|
* optimal combination of algorithms to each time series in your datasets. You can use
|
|
56
|
-
*
|
|
57
|
-
* predictors.</p>
|
|
62
|
+
* <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain
|
|
63
|
+
* existing predictors.</p>
|
|
64
|
+
*
|
|
58
65
|
* <p>
|
|
59
66
|
* <b>Creating new predictors</b>
|
|
60
67
|
* </p>
|
|
68
|
+
*
|
|
61
69
|
* <p>The following parameters are required when creating a new predictor:</p>
|
|
62
70
|
* <ul>
|
|
63
71
|
* <li>
|
|
@@ -76,15 +84,15 @@ export declare class Forecast extends ForecastClient {
|
|
|
76
84
|
* </li>
|
|
77
85
|
* <li>
|
|
78
86
|
* <p>
|
|
79
|
-
* <code>ForecastHorizon</code> - The number of time
|
|
80
|
-
*
|
|
87
|
+
* <code>ForecastHorizon</code> - The number of time-steps that the model
|
|
88
|
+
* predicts. The forecast horizon is also called the prediction length.</p>
|
|
81
89
|
* </li>
|
|
82
90
|
* </ul>
|
|
83
91
|
* <p>When creating a new predictor, do not specify a value for
|
|
84
92
|
* <code>ReferencePredictorArn</code>.</p>
|
|
85
93
|
* <p>
|
|
86
94
|
* <b>Upgrading and retraining predictors</b>
|
|
87
|
-
*
|
|
95
|
+
* </p>
|
|
88
96
|
* <p>The following parameters are required when retraining or upgrading a predictor:</p>
|
|
89
97
|
* <ul>
|
|
90
98
|
* <li>
|
|
@@ -137,14 +145,14 @@ export declare class Forecast extends ForecastClient {
|
|
|
137
145
|
* </ul>
|
|
138
146
|
* <p>After creating a dataset, you import your training data into it and add the dataset to a
|
|
139
147
|
* dataset group. You use the dataset group to create a predictor. For more information, see
|
|
140
|
-
* <a
|
|
141
|
-
* <p>To get a list of all your datasets, use the <a>ListDatasets</a>
|
|
142
|
-
* operation.</p>
|
|
148
|
+
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Importing datasets</a>.</p>
|
|
149
|
+
* <p>To get a list of all your datasets, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html">ListDatasets</a> operation.</p>
|
|
143
150
|
* <p>For example Forecast datasets, see the <a href="https://github.com/aws-samples/amazon-forecast-samples">Amazon Forecast Sample GitHub
|
|
144
151
|
* repository</a>.</p>
|
|
145
152
|
* <note>
|
|
146
153
|
* <p>The <code>Status</code> of a dataset must be <code>ACTIVE</code> before you can import
|
|
147
|
-
* training data. Use the <a>DescribeDataset</a> operation to get
|
|
154
|
+
* training data. Use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation to get
|
|
155
|
+
* the status.</p>
|
|
148
156
|
* </note>
|
|
149
157
|
*/
|
|
150
158
|
createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
|
|
@@ -152,14 +160,14 @@ export declare class Forecast extends ForecastClient {
|
|
|
152
160
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
153
161
|
/**
|
|
154
162
|
* <p>Creates a dataset group, which holds a collection of related datasets. You can add
|
|
155
|
-
* datasets to the dataset group when you create the dataset group, or later by using the <a>UpdateDatasetGroup</a> operation.</p>
|
|
163
|
+
* datasets to the dataset group when you create the dataset group, or later by using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation.</p>
|
|
156
164
|
* <p>After creating a dataset group and adding datasets, you use the dataset group when you
|
|
157
|
-
* create a predictor. For more information, see <a
|
|
158
|
-
* <p>To get a list of all your datasets groups, use the <a>ListDatasetGroups</a>
|
|
165
|
+
* create a predictor. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Dataset groups</a>.</p>
|
|
166
|
+
* <p>To get a list of all your datasets groups, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a>
|
|
159
167
|
* operation.</p>
|
|
160
168
|
* <note>
|
|
161
169
|
* <p>The <code>Status</code> of a dataset group must be <code>ACTIVE</code> before you can
|
|
162
|
-
* use the dataset group to create a predictor. To get the status, use the <a>DescribeDatasetGroup</a> operation.</p>
|
|
170
|
+
* use the dataset group to create a predictor. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a> operation.</p>
|
|
163
171
|
* </note>
|
|
164
172
|
*/
|
|
165
173
|
createDatasetGroup(args: CreateDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetGroupCommandOutput>;
|
|
@@ -169,9 +177,10 @@ export declare class Forecast extends ForecastClient {
|
|
|
169
177
|
* <p>Imports your training data to an Amazon Forecast dataset. You provide the location of your
|
|
170
178
|
* training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
|
|
171
179
|
* that you want to import the data to.</p>
|
|
172
|
-
* <p>You must specify a <a>DataSource</a> object that includes an
|
|
173
|
-
* role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
|
|
174
|
-
* processes it in an internal AWS system. For more information, see <a
|
|
180
|
+
* <p>You must specify a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html">DataSource</a> object that includes an
|
|
181
|
+
* AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
|
|
182
|
+
* of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
|
|
183
|
+
* permissions</a>.</p>
|
|
175
184
|
* <p>The training data must be in CSV format. The delimiter must be a comma (,).</p>
|
|
176
185
|
* <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3
|
|
177
186
|
* bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000
|
|
@@ -185,7 +194,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
185
194
|
*
|
|
186
195
|
*
|
|
187
196
|
* <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the
|
|
188
|
-
* <a>ListDatasetImportJobs</a> operation.</p>
|
|
197
|
+
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation.</p>
|
|
189
198
|
*/
|
|
190
199
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetImportJobCommandOutput>;
|
|
191
200
|
createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
|
|
@@ -209,7 +218,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
209
218
|
* provide a Forecast ARN.</p>
|
|
210
219
|
* <p>
|
|
211
220
|
* <b>CreateExplainability with a Predictor ARN</b>
|
|
212
|
-
*
|
|
221
|
+
* </p>
|
|
213
222
|
* <note>
|
|
214
223
|
* <p>You can only have one Explainability resource per predictor. If you already
|
|
215
224
|
* enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
|
|
@@ -259,7 +268,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
259
268
|
* </ul>
|
|
260
269
|
* <p>
|
|
261
270
|
* <b>CreateExplainability with a Forecast ARN</b>
|
|
262
|
-
*
|
|
271
|
+
* </p>
|
|
263
272
|
* <note>
|
|
264
273
|
* <p>You can specify a maximum of 50 time series and 500 time points.</p>
|
|
265
274
|
* </note>
|
|
@@ -371,6 +380,14 @@ export declare class Forecast extends ForecastClient {
|
|
|
371
380
|
createForecastExportJob(args: CreateForecastExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateForecastExportJobCommandOutput>;
|
|
372
381
|
createForecastExportJob(args: CreateForecastExportJobCommandInput, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
|
|
373
382
|
createForecastExportJob(args: CreateForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
|
|
383
|
+
/**
|
|
384
|
+
* <p>Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time.
|
|
385
|
+
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.
|
|
386
|
+
* </p>
|
|
387
|
+
*/
|
|
388
|
+
createMonitor(args: CreateMonitorCommandInput, options?: __HttpHandlerOptions): Promise<CreateMonitorCommandOutput>;
|
|
389
|
+
createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
|
|
390
|
+
createMonitor(args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
|
|
374
391
|
/**
|
|
375
392
|
* <note>
|
|
376
393
|
* <p> This operation creates a legacy predictor that does not include all the predictor
|
|
@@ -460,32 +477,32 @@ export declare class Forecast extends ForecastClient {
|
|
|
460
477
|
createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
|
|
461
478
|
createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
|
|
462
479
|
/**
|
|
463
|
-
* <p>Deletes an Amazon Forecast dataset that was created using the <a>CreateDataset</a>
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
* operation.</p>
|
|
480
|
+
* <p>Deletes an Amazon Forecast dataset that was created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. You can
|
|
481
|
+
* only delete datasets that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
|
|
482
|
+
* To get the status use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation.</p>
|
|
467
483
|
* <note>
|
|
468
484
|
* <p>Forecast does not automatically update any dataset groups that contain the deleted dataset.
|
|
469
|
-
* In order to update the dataset group, use the
|
|
470
|
-
*
|
|
485
|
+
* In order to update the dataset group, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation,
|
|
486
|
+
* omitting the deleted dataset's ARN.</p>
|
|
471
487
|
* </note>
|
|
472
488
|
*/
|
|
473
489
|
deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
|
|
474
490
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
475
491
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
476
492
|
/**
|
|
477
|
-
* <p>Deletes a dataset group created using the <a>CreateDatasetGroup</a> operation.
|
|
493
|
+
* <p>Deletes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation.
|
|
478
494
|
* You can only delete dataset groups that have a status of <code>ACTIVE</code>,
|
|
479
|
-
* <code>CREATE_FAILED</code>, or <code>UPDATE_FAILED</code>. To get the status, use the <a>DescribeDatasetGroup</a> operation.</p>
|
|
495
|
+
* <code>CREATE_FAILED</code>, or <code>UPDATE_FAILED</code>. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a> operation.</p>
|
|
480
496
|
* <p>This operation deletes only the dataset group, not the datasets in the group.</p>
|
|
481
497
|
*/
|
|
482
498
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetGroupCommandOutput>;
|
|
483
499
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
484
500
|
deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
|
|
485
501
|
/**
|
|
486
|
-
* <p>Deletes a dataset import job created using the <a>CreateDatasetImportJob</a>
|
|
502
|
+
* <p>Deletes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
|
|
487
503
|
* operation. You can delete only dataset import jobs that have a status of <code>ACTIVE</code>
|
|
488
|
-
* or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeDatasetImportJob</a>
|
|
504
|
+
* or <code>CREATE_FAILED</code>. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
|
|
505
|
+
* operation.</p>
|
|
489
506
|
*/
|
|
490
507
|
deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetImportJobCommandOutput>;
|
|
491
508
|
deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
|
|
@@ -522,6 +539,12 @@ export declare class Forecast extends ForecastClient {
|
|
|
522
539
|
deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteForecastExportJobCommandOutput>;
|
|
523
540
|
deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
|
|
524
541
|
deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
|
|
542
|
+
/**
|
|
543
|
+
* <p>Deletes a monitor resource. You can only delete a monitor resource with a status of <code>ACTIVE</code>, <code>ACTIVE_STOPPED</code>, <code>CREATE_FAILED</code>, or <code>CREATE_STOPPED</code>.</p>
|
|
544
|
+
*/
|
|
545
|
+
deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMonitorCommandOutput>;
|
|
546
|
+
deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
|
|
547
|
+
deleteMonitor(args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
|
|
525
548
|
/**
|
|
526
549
|
* <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
550
|
* <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribePredictor</a> operation.</p>
|
|
@@ -579,8 +602,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
579
602
|
describeAutoPredictor(args: DescribeAutoPredictorCommandInput, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
|
|
580
603
|
describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
|
|
581
604
|
/**
|
|
582
|
-
* <p>Describes an Amazon Forecast dataset created using the <a>CreateDataset</a>
|
|
583
|
-
* operation.</p>
|
|
605
|
+
* <p>Describes an Amazon Forecast dataset created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation.</p>
|
|
584
606
|
* <p>In addition to listing the parameters specified in the <code>CreateDataset</code> request,
|
|
585
607
|
* this operation includes the following dataset properties:</p>
|
|
586
608
|
* <ul>
|
|
@@ -605,7 +627,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
605
627
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
606
628
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
607
629
|
/**
|
|
608
|
-
* <p>Describes a dataset group created using the <a>CreateDatasetGroup</a>
|
|
630
|
+
* <p>Describes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
|
|
609
631
|
* operation.</p>
|
|
610
632
|
* <p>In addition to listing the parameters provided in the <code>CreateDatasetGroup</code>
|
|
611
633
|
* request, this operation includes the following properties:</p>
|
|
@@ -635,7 +657,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
635
657
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
636
658
|
describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
|
|
637
659
|
/**
|
|
638
|
-
* <p>Describes a dataset import job created using the <a>CreateDatasetImportJob</a>
|
|
660
|
+
* <p>Describes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
|
|
639
661
|
* operation.</p>
|
|
640
662
|
* <p>In addition to listing the parameters provided in the <code>CreateDatasetImportJob</code>
|
|
641
663
|
* request, this operation includes the following properties:</p>
|
|
@@ -750,6 +772,49 @@ export declare class Forecast extends ForecastClient {
|
|
|
750
772
|
describeForecastExportJob(args: DescribeForecastExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeForecastExportJobCommandOutput>;
|
|
751
773
|
describeForecastExportJob(args: DescribeForecastExportJobCommandInput, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
|
|
752
774
|
describeForecastExportJob(args: DescribeForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
|
|
775
|
+
/**
|
|
776
|
+
* <p>Describes a monitor resource. In addition to listing the properties provided in the <a>CreateMonitor</a> request, this operation lists the following properties:</p>
|
|
777
|
+
* <ul>
|
|
778
|
+
* <li>
|
|
779
|
+
* <p>
|
|
780
|
+
* <code>Baseline</code>
|
|
781
|
+
* </p>
|
|
782
|
+
* </li>
|
|
783
|
+
* <li>
|
|
784
|
+
* <p>
|
|
785
|
+
* <code>CreationTime</code>
|
|
786
|
+
* </p>
|
|
787
|
+
* </li>
|
|
788
|
+
* <li>
|
|
789
|
+
* <p>
|
|
790
|
+
* <code>LastEvaluationTime</code>
|
|
791
|
+
* </p>
|
|
792
|
+
* </li>
|
|
793
|
+
* <li>
|
|
794
|
+
* <p>
|
|
795
|
+
* <code>LastEvaluationState</code>
|
|
796
|
+
* </p>
|
|
797
|
+
* </li>
|
|
798
|
+
* <li>
|
|
799
|
+
* <p>
|
|
800
|
+
* <code>LastModificationTime</code>
|
|
801
|
+
* </p>
|
|
802
|
+
* </li>
|
|
803
|
+
* <li>
|
|
804
|
+
* <p>
|
|
805
|
+
* <code>Message</code>
|
|
806
|
+
* </p>
|
|
807
|
+
* </li>
|
|
808
|
+
* <li>
|
|
809
|
+
* <p>
|
|
810
|
+
* <code>Status</code>
|
|
811
|
+
* </p>
|
|
812
|
+
* </li>
|
|
813
|
+
* </ul>
|
|
814
|
+
*/
|
|
815
|
+
describeMonitor(args: DescribeMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMonitorCommandOutput>;
|
|
816
|
+
describeMonitor(args: DescribeMonitorCommandInput, cb: (err: any, data?: DescribeMonitorCommandOutput) => void): void;
|
|
817
|
+
describeMonitor(args: DescribeMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMonitorCommandOutput) => void): void;
|
|
753
818
|
/**
|
|
754
819
|
* <note>
|
|
755
820
|
* <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
|
|
@@ -848,27 +913,29 @@ export declare class Forecast extends ForecastClient {
|
|
|
848
913
|
getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void): void;
|
|
849
914
|
getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void): void;
|
|
850
915
|
/**
|
|
851
|
-
* <p>Returns a list of dataset groups created using the <a>CreateDatasetGroup</a>
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
916
|
+
* <p>Returns a list of dataset groups created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation.
|
|
917
|
+
* For each dataset group, this operation returns a summary of its properties, including its
|
|
918
|
+
* Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
|
|
919
|
+
* dataset group ARN with the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
920
|
+
* operation.</p>
|
|
855
921
|
*/
|
|
856
922
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetGroupsCommandOutput>;
|
|
857
923
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
858
924
|
listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
|
|
859
925
|
/**
|
|
860
|
-
* <p>Returns a list of dataset import jobs created using the <a>CreateDatasetImportJob</a>
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
926
|
+
* <p>Returns a list of dataset import jobs created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
|
|
927
|
+
* operation. For each import job, this operation returns a summary of its properties, including
|
|
928
|
+
* its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
|
|
929
|
+
* ARN with the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
|
|
930
|
+
* operation. You can filter the list by providing an array of <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html">Filter</a> objects.</p>
|
|
864
931
|
*/
|
|
865
932
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetImportJobsCommandOutput>;
|
|
866
933
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
867
934
|
listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
|
|
868
935
|
/**
|
|
869
|
-
* <p>Returns a list of datasets created using the <a>CreateDataset</a> operation.
|
|
870
|
-
*
|
|
871
|
-
*
|
|
936
|
+
* <p>Returns a list of datasets created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. For each
|
|
937
|
+
* dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned.
|
|
938
|
+
* To retrieve the complete set of properties, use the ARN with the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation.</p>
|
|
872
939
|
*/
|
|
873
940
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
874
941
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
@@ -911,6 +978,21 @@ export declare class Forecast extends ForecastClient {
|
|
|
911
978
|
listForecasts(args: ListForecastsCommandInput, options?: __HttpHandlerOptions): Promise<ListForecastsCommandOutput>;
|
|
912
979
|
listForecasts(args: ListForecastsCommandInput, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
|
|
913
980
|
listForecasts(args: ListForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
|
|
981
|
+
/**
|
|
982
|
+
* <p>Returns a list of the monitoring evaluation results and predictor events collected by
|
|
983
|
+
* the monitor resource during different windows of time.</p>
|
|
984
|
+
* <p>For information about monitoring see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>. For more information about retrieving monitoring results see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>.</p>
|
|
985
|
+
*/
|
|
986
|
+
listMonitorEvaluations(args: ListMonitorEvaluationsCommandInput, options?: __HttpHandlerOptions): Promise<ListMonitorEvaluationsCommandOutput>;
|
|
987
|
+
listMonitorEvaluations(args: ListMonitorEvaluationsCommandInput, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void): void;
|
|
988
|
+
listMonitorEvaluations(args: ListMonitorEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void): void;
|
|
989
|
+
/**
|
|
990
|
+
* <p>Returns a list of monitors created with the <a>CreateMonitor</a> operation and <a>CreateAutoPredictor</a> operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You
|
|
991
|
+
* can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the <a>DescribeMonitor</a> operation.</p>
|
|
992
|
+
*/
|
|
993
|
+
listMonitors(args: ListMonitorsCommandInput, options?: __HttpHandlerOptions): Promise<ListMonitorsCommandOutput>;
|
|
994
|
+
listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
|
|
995
|
+
listMonitors(args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
|
|
914
996
|
/**
|
|
915
997
|
* <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
|
|
916
998
|
* summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
@@ -936,6 +1018,12 @@ export declare class Forecast extends ForecastClient {
|
|
|
936
1018
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
937
1019
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
938
1020
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1021
|
+
/**
|
|
1022
|
+
* <p>Resumes a stopped monitor resource.</p>
|
|
1023
|
+
*/
|
|
1024
|
+
resumeResource(args: ResumeResourceCommandInput, options?: __HttpHandlerOptions): Promise<ResumeResourceCommandOutput>;
|
|
1025
|
+
resumeResource(args: ResumeResourceCommandInput, cb: (err: any, data?: ResumeResourceCommandOutput) => void): void;
|
|
1026
|
+
resumeResource(args: ResumeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeResourceCommandOutput) => void): void;
|
|
939
1027
|
/**
|
|
940
1028
|
* <p>Stops a resource.</p>
|
|
941
1029
|
* <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and
|
|
@@ -989,7 +1077,7 @@ export declare class Forecast extends ForecastClient {
|
|
|
989
1077
|
* <p>Replaces the datasets in a dataset group with the specified datasets.</p>
|
|
990
1078
|
* <note>
|
|
991
1079
|
* <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before you can
|
|
992
|
-
* use the dataset group to create a predictor. Use the <a>DescribeDatasetGroup</a>
|
|
1080
|
+
* use the dataset group to create a predictor. Use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
993
1081
|
* operation to get the status.</p>
|
|
994
1082
|
* </note>
|
|
995
1083
|
*/
|
|
@@ -14,6 +14,7 @@ import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } f
|
|
|
14
14
|
import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
|
|
15
15
|
import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
|
|
16
16
|
import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
|
|
17
|
+
import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "./commands/CreateMonitorCommand";
|
|
17
18
|
import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
|
|
18
19
|
import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./commands/CreatePredictorCommand";
|
|
19
20
|
import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
|
|
@@ -23,6 +24,7 @@ import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } f
|
|
|
23
24
|
import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
|
|
24
25
|
import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
|
|
25
26
|
import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
|
|
27
|
+
import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "./commands/DeleteMonitorCommand";
|
|
26
28
|
import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
|
|
27
29
|
import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
|
|
28
30
|
import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
|
|
@@ -34,6 +36,7 @@ import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput
|
|
|
34
36
|
import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
|
|
35
37
|
import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
|
|
36
38
|
import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
|
|
39
|
+
import { DescribeMonitorCommandInput, DescribeMonitorCommandOutput } from "./commands/DescribeMonitorCommand";
|
|
37
40
|
import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
|
|
38
41
|
import { DescribePredictorCommandInput, DescribePredictorCommandOutput } from "./commands/DescribePredictorCommand";
|
|
39
42
|
import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from "./commands/GetAccuracyMetricsCommand";
|
|
@@ -44,15 +47,18 @@ import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } f
|
|
|
44
47
|
import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
|
|
45
48
|
import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
|
|
46
49
|
import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
|
|
50
|
+
import { ListMonitorEvaluationsCommandInput, ListMonitorEvaluationsCommandOutput } from "./commands/ListMonitorEvaluationsCommand";
|
|
51
|
+
import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "./commands/ListMonitorsCommand";
|
|
47
52
|
import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
|
|
48
53
|
import { ListPredictorsCommandInput, ListPredictorsCommandOutput } from "./commands/ListPredictorsCommand";
|
|
49
54
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
55
|
+
import { ResumeResourceCommandInput, ResumeResourceCommandOutput } from "./commands/ResumeResourceCommand";
|
|
50
56
|
import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/StopResourceCommand";
|
|
51
57
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
52
58
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
53
59
|
import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
|
|
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;
|
|
60
|
+
export declare type ServiceInputTypes = CreateAutoPredictorCommandInput | CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateExplainabilityCommandInput | CreateExplainabilityExportCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreateMonitorCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteExplainabilityCommandInput | DeleteExplainabilityExportCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeleteMonitorCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeAutoPredictorCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeExplainabilityCommandInput | DescribeExplainabilityExportCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribeMonitorCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListExplainabilitiesCommandInput | ListExplainabilityExportsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListMonitorEvaluationsCommandInput | ListMonitorsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | ResumeResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
|
|
61
|
+
export declare type ServiceOutputTypes = CreateAutoPredictorCommandOutput | CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateExplainabilityCommandOutput | CreateExplainabilityExportCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreateMonitorCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteExplainabilityCommandOutput | DeleteExplainabilityExportCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeleteMonitorCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeAutoPredictorCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeExplainabilityCommandOutput | DescribeExplainabilityExportCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribeMonitorCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListExplainabilitiesCommandOutput | ListExplainabilityExportsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListMonitorEvaluationsCommandOutput | ListMonitorsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | ResumeResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
|
|
56
62
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
57
63
|
/**
|
|
58
64
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -10,11 +10,13 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
|
|
|
10
10
|
* <p>Creates an Amazon Forecast predictor.</p>
|
|
11
11
|
* <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
|
|
12
12
|
* optimal combination of algorithms to each time series in your datasets. You can use
|
|
13
|
-
*
|
|
14
|
-
* predictors.</p>
|
|
13
|
+
* <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain
|
|
14
|
+
* existing predictors.</p>
|
|
15
|
+
*
|
|
15
16
|
* <p>
|
|
16
17
|
* <b>Creating new predictors</b>
|
|
17
18
|
* </p>
|
|
19
|
+
*
|
|
18
20
|
* <p>The following parameters are required when creating a new predictor:</p>
|
|
19
21
|
* <ul>
|
|
20
22
|
* <li>
|
|
@@ -33,15 +35,15 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
|
|
|
33
35
|
* </li>
|
|
34
36
|
* <li>
|
|
35
37
|
* <p>
|
|
36
|
-
* <code>ForecastHorizon</code> - The number of time
|
|
37
|
-
*
|
|
38
|
+
* <code>ForecastHorizon</code> - The number of time-steps that the model
|
|
39
|
+
* predicts. The forecast horizon is also called the prediction length.</p>
|
|
38
40
|
* </li>
|
|
39
41
|
* </ul>
|
|
40
42
|
* <p>When creating a new predictor, do not specify a value for
|
|
41
43
|
* <code>ReferencePredictorArn</code>.</p>
|
|
42
44
|
* <p>
|
|
43
45
|
* <b>Upgrading and retraining predictors</b>
|
|
44
|
-
*
|
|
46
|
+
* </p>
|
|
45
47
|
* <p>The following parameters are required when retraining or upgrading a predictor:</p>
|
|
46
48
|
* <ul>
|
|
47
49
|
* <li>
|
|
@@ -40,14 +40,14 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
|
|
|
40
40
|
* </ul>
|
|
41
41
|
* <p>After creating a dataset, you import your training data into it and add the dataset to a
|
|
42
42
|
* dataset group. You use the dataset group to create a predictor. For more information, see
|
|
43
|
-
* <a
|
|
44
|
-
* <p>To get a list of all your datasets, use the <a>ListDatasets</a>
|
|
45
|
-
* operation.</p>
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Importing datasets</a>.</p>
|
|
44
|
+
* <p>To get a list of all your datasets, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html">ListDatasets</a> operation.</p>
|
|
46
45
|
* <p>For example Forecast datasets, see the <a href="https://github.com/aws-samples/amazon-forecast-samples">Amazon Forecast Sample GitHub
|
|
47
46
|
* repository</a>.</p>
|
|
48
47
|
* <note>
|
|
49
48
|
* <p>The <code>Status</code> of a dataset must be <code>ACTIVE</code> before you can import
|
|
50
|
-
* training data. Use the <a>DescribeDataset</a> operation to get
|
|
49
|
+
* training data. Use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation to get
|
|
50
|
+
* the status.</p>
|
|
51
51
|
* </note>
|
|
52
52
|
* @example
|
|
53
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,14 +8,14 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a dataset group, which holds a collection of related datasets. You can add
|
|
11
|
-
* datasets to the dataset group when you create the dataset group, or later by using the <a>UpdateDatasetGroup</a> operation.</p>
|
|
11
|
+
* datasets to the dataset group when you create the dataset group, or later by using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation.</p>
|
|
12
12
|
* <p>After creating a dataset group and adding datasets, you use the dataset group when you
|
|
13
|
-
* create a predictor. For more information, see <a
|
|
14
|
-
* <p>To get a list of all your datasets groups, use the <a>ListDatasetGroups</a>
|
|
13
|
+
* create a predictor. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Dataset groups</a>.</p>
|
|
14
|
+
* <p>To get a list of all your datasets groups, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a>
|
|
15
15
|
* operation.</p>
|
|
16
16
|
* <note>
|
|
17
17
|
* <p>The <code>Status</code> of a dataset group must be <code>ACTIVE</code> before you can
|
|
18
|
-
* use the dataset group to create a predictor. To get the status, use the <a>DescribeDatasetGroup</a> operation.</p>
|
|
18
|
+
* use the dataset group to create a predictor. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a> operation.</p>
|
|
19
19
|
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,9 +10,10 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
10
10
|
* <p>Imports your training data to an Amazon Forecast dataset. You provide the location of your
|
|
11
11
|
* training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
|
|
12
12
|
* that you want to import the data to.</p>
|
|
13
|
-
* <p>You must specify a <a>DataSource</a> object that includes an
|
|
14
|
-
* role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
|
|
15
|
-
* processes it in an internal AWS system. For more information, see <a
|
|
13
|
+
* <p>You must specify a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html">DataSource</a> object that includes an
|
|
14
|
+
* AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
|
|
15
|
+
* of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
|
|
16
|
+
* permissions</a>.</p>
|
|
16
17
|
* <p>The training data must be in CSV format. The delimiter must be a comma (,).</p>
|
|
17
18
|
* <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3
|
|
18
19
|
* bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000
|
|
@@ -26,7 +27,7 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
26
27
|
*
|
|
27
28
|
*
|
|
28
29
|
* <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the
|
|
29
|
-
* <a>ListDatasetImportJobs</a> operation.</p>
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -25,7 +25,7 @@ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityR
|
|
|
25
25
|
* provide a Forecast ARN.</p>
|
|
26
26
|
* <p>
|
|
27
27
|
* <b>CreateExplainability with a Predictor ARN</b>
|
|
28
|
-
*
|
|
28
|
+
* </p>
|
|
29
29
|
* <note>
|
|
30
30
|
* <p>You can only have one Explainability resource per predictor. If you already
|
|
31
31
|
* enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
|
|
@@ -75,7 +75,7 @@ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityR
|
|
|
75
75
|
* </ul>
|
|
76
76
|
* <p>
|
|
77
77
|
* <b>CreateExplainability with a Forecast ARN</b>
|
|
78
|
-
*
|
|
78
|
+
* </p>
|
|
79
79
|
* <note>
|
|
80
80
|
* <p>You can specify a maximum of 50 time series and 500 time points.</p>
|
|
81
81
|
* </note>
|