@aws-sdk/client-forecast 3.41.0 → 3.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +47 -0
- package/README.md +7 -7
- package/dist-cjs/Forecast.js +150 -0
- package/dist-cjs/commands/CreateAutoPredictorCommand.js +36 -0
- package/dist-cjs/commands/CreateExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/CreateExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/DeleteExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/DeleteExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/DescribeAutoPredictorCommand.js +36 -0
- package/dist-cjs/commands/DescribeExplainabilityCommand.js +36 -0
- package/dist-cjs/commands/DescribeExplainabilityExportCommand.js +36 -0
- package/dist-cjs/commands/ListExplainabilitiesCommand.js +36 -0
- package/dist-cjs/commands/ListExplainabilityExportsCommand.js +36 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +236 -61
- package/dist-cjs/protocols/Aws_json1_1.js +1283 -98
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/Forecast.js +150 -0
- package/dist-es/commands/CreateAutoPredictorCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityCommand.js +39 -0
- package/dist-es/commands/CreateExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityCommand.js +39 -0
- package/dist-es/commands/DeleteExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/DescribeAutoPredictorCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityCommand.js +39 -0
- package/dist-es/commands/DescribeExplainabilityExportCommand.js +39 -0
- package/dist-es/commands/ListExplainabilitiesCommand.js +39 -0
- package/dist-es/commands/ListExplainabilityExportsCommand.js +39 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +160 -40
- package/dist-es/protocols/Aws_json1_1.js +1367 -138
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/Forecast.d.ts +306 -40
- package/dist-types/ForecastClient.d.ts +12 -2
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +83 -0
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +153 -0
- package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +43 -0
- package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +4 -4
- package/dist-types/commands/CreatePredictorCommand.d.ts +19 -18
- package/dist-types/commands/DeleteExplainabilityCommand.d.ts +37 -0
- package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DeletePredictorCommand.d.ts +2 -3
- package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +35 -0
- package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
- package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +35 -0
- package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribePredictorCommand.d.ts +5 -1
- package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
- package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
- package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +4 -4
- package/dist-types/commands/ListPredictorsCommand.d.ts +5 -5
- package/dist-types/commands/StopResourceCommand.d.ts +9 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +2109 -495
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/Forecast.d.ts +50 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +12 -2
- package/dist-types/ts3.4/commands/CreateAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAutoPredictorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeExplainabilityExportCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilitiesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListExplainabilityExportsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +492 -83
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +36 -43
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
|
|
4
|
+
import { ListExplainabilityExportsRequest, ListExplainabilityExportsResponse } from "../models/models_0";
|
|
5
|
+
export interface ListExplainabilityExportsCommandInput extends ListExplainabilityExportsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListExplainabilityExportsCommandOutput extends ListExplainabilityExportsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
|
|
11
|
+
* for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
12
|
+
* <p>To retrieve the complete set of properties for a particular Explainability export, use
|
|
13
|
+
* the ARN with the <a>DescribeExplainability</a> operation.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { ForecastClient, ListExplainabilityExportsCommand } from "@aws-sdk/client-forecast"; // ES Modules import
|
|
18
|
+
* // const { ForecastClient, ListExplainabilityExportsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
|
|
19
|
+
* const client = new ForecastClient(config);
|
|
20
|
+
* const command = new ListExplainabilityExportsCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link ListExplainabilityExportsCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link ListExplainabilityExportsCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class ListExplainabilityExportsCommand extends $Command<ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput, ForecastClientResolvedConfig> {
|
|
30
|
+
readonly input: ListExplainabilityExportsCommandInput;
|
|
31
|
+
constructor(input: ListExplainabilityExportsCommandInput);
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|
|
@@ -7,10 +7,10 @@ export interface ListPredictorBacktestExportJobsCommandInput extends ListPredict
|
|
|
7
7
|
export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredictorBacktestExportJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
|
|
11
|
-
* for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
12
|
-
* <p>To retrieve the complete set of properties for a particular backtest export job, use
|
|
13
|
-
* ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
|
|
10
|
+
* <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
|
|
11
|
+
* summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
|
|
12
|
+
* <p>To retrieve the complete set of properties for a particular backtest export job, use
|
|
13
|
+
* the ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -7,11 +7,11 @@ export interface ListPredictorsCommandInput extends ListPredictorsRequest {
|
|
|
7
7
|
export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of predictors created using the <a>
|
|
11
|
-
*
|
|
12
|
-
* its Amazon Resource Name (ARN).
|
|
13
|
-
*
|
|
14
|
-
* array of <a>Filter</a> objects.</p>
|
|
10
|
+
* <p>Returns a list of predictors created using the <a>CreateAutoPredictor</a> or
|
|
11
|
+
* <a>CreatePredictor</a> operations. For each predictor, this operation returns a
|
|
12
|
+
* summary of its properties, including its Amazon Resource Name (ARN). </p>
|
|
13
|
+
* <p>You can retrieve the complete set of properties by using the ARN with the <a>DescribeAutoPredictor</a> and <a>DescribePredictor</a> operations. You
|
|
14
|
+
* can filter the list using an array of <a>Filter</a> objects.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -8,9 +8,9 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Stops a resource.</p>
|
|
11
|
-
* <p>The resource undergoes the following states:
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and
|
|
12
|
+
* <code>CREATE_STOPPED</code>. You cannot resume a resource once it has been
|
|
13
|
+
* stopped.</p>
|
|
14
14
|
* <p>This operation can be applied to the following resources (and their corresponding child
|
|
15
15
|
* resources):</p>
|
|
16
16
|
* <ul>
|
|
@@ -29,6 +29,12 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>Predictor Backtest Export Job</p>
|
|
31
31
|
* </li>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>Explainability Job</p>
|
|
34
|
+
* </li>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>Explainability Export Job</p>
|
|
37
|
+
* </li>
|
|
32
38
|
* </ul>
|
|
33
39
|
* @example
|
|
34
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,10 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
|
|
10
|
+
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
|
|
11
|
+
* If existing tags on a resource are not specified in the request parameters, they are not
|
|
12
|
+
* changed. When a resource is deleted, the tags associated with that resource are also
|
|
13
|
+
* deleted.</p>
|
|
11
14
|
* @example
|
|
12
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
16
|
* ```javascript
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
+
export * from "./CreateAutoPredictorCommand";
|
|
1
2
|
export * from "./CreateDatasetCommand";
|
|
2
3
|
export * from "./CreateDatasetGroupCommand";
|
|
3
4
|
export * from "./CreateDatasetImportJobCommand";
|
|
5
|
+
export * from "./CreateExplainabilityCommand";
|
|
6
|
+
export * from "./CreateExplainabilityExportCommand";
|
|
4
7
|
export * from "./CreateForecastCommand";
|
|
5
8
|
export * from "./CreateForecastExportJobCommand";
|
|
6
9
|
export * from "./CreatePredictorBacktestExportJobCommand";
|
|
@@ -8,14 +11,19 @@ export * from "./CreatePredictorCommand";
|
|
|
8
11
|
export * from "./DeleteDatasetCommand";
|
|
9
12
|
export * from "./DeleteDatasetGroupCommand";
|
|
10
13
|
export * from "./DeleteDatasetImportJobCommand";
|
|
14
|
+
export * from "./DeleteExplainabilityCommand";
|
|
15
|
+
export * from "./DeleteExplainabilityExportCommand";
|
|
11
16
|
export * from "./DeleteForecastCommand";
|
|
12
17
|
export * from "./DeleteForecastExportJobCommand";
|
|
13
18
|
export * from "./DeletePredictorBacktestExportJobCommand";
|
|
14
19
|
export * from "./DeletePredictorCommand";
|
|
15
20
|
export * from "./DeleteResourceTreeCommand";
|
|
21
|
+
export * from "./DescribeAutoPredictorCommand";
|
|
16
22
|
export * from "./DescribeDatasetCommand";
|
|
17
23
|
export * from "./DescribeDatasetGroupCommand";
|
|
18
24
|
export * from "./DescribeDatasetImportJobCommand";
|
|
25
|
+
export * from "./DescribeExplainabilityCommand";
|
|
26
|
+
export * from "./DescribeExplainabilityExportCommand";
|
|
19
27
|
export * from "./DescribeForecastCommand";
|
|
20
28
|
export * from "./DescribeForecastExportJobCommand";
|
|
21
29
|
export * from "./DescribePredictorBacktestExportJobCommand";
|
|
@@ -24,6 +32,8 @@ export * from "./GetAccuracyMetricsCommand";
|
|
|
24
32
|
export * from "./ListDatasetGroupsCommand";
|
|
25
33
|
export * from "./ListDatasetImportJobsCommand";
|
|
26
34
|
export * from "./ListDatasetsCommand";
|
|
35
|
+
export * from "./ListExplainabilitiesCommand";
|
|
36
|
+
export * from "./ListExplainabilityExportsCommand";
|
|
27
37
|
export * from "./ListForecastExportJobsCommand";
|
|
28
38
|
export * from "./ListForecastsCommand";
|
|
29
39
|
export * from "./ListPredictorBacktestExportJobsCommand";
|