@aws-sdk/client-forecast 3.42.0 → 3.43.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.
Files changed (63) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +7 -7
  3. package/dist-cjs/Forecast.js +150 -0
  4. package/dist-cjs/commands/CreateAutoPredictorCommand.js +36 -0
  5. package/dist-cjs/commands/CreateExplainabilityCommand.js +36 -0
  6. package/dist-cjs/commands/CreateExplainabilityExportCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteExplainabilityCommand.js +36 -0
  8. package/dist-cjs/commands/DeleteExplainabilityExportCommand.js +36 -0
  9. package/dist-cjs/commands/DescribeAutoPredictorCommand.js +36 -0
  10. package/dist-cjs/commands/DescribeExplainabilityCommand.js +36 -0
  11. package/dist-cjs/commands/DescribeExplainabilityExportCommand.js +36 -0
  12. package/dist-cjs/commands/ListExplainabilitiesCommand.js +36 -0
  13. package/dist-cjs/commands/ListExplainabilityExportsCommand.js +36 -0
  14. package/dist-cjs/commands/index.js +10 -0
  15. package/dist-cjs/models/models_0.js +236 -61
  16. package/dist-cjs/protocols/Aws_json1_1.js +1280 -98
  17. package/dist-es/Forecast.js +150 -0
  18. package/dist-es/commands/CreateAutoPredictorCommand.js +39 -0
  19. package/dist-es/commands/CreateExplainabilityCommand.js +39 -0
  20. package/dist-es/commands/CreateExplainabilityExportCommand.js +39 -0
  21. package/dist-es/commands/DeleteExplainabilityCommand.js +39 -0
  22. package/dist-es/commands/DeleteExplainabilityExportCommand.js +39 -0
  23. package/dist-es/commands/DescribeAutoPredictorCommand.js +39 -0
  24. package/dist-es/commands/DescribeExplainabilityCommand.js +39 -0
  25. package/dist-es/commands/DescribeExplainabilityExportCommand.js +39 -0
  26. package/dist-es/commands/ListExplainabilitiesCommand.js +39 -0
  27. package/dist-es/commands/ListExplainabilityExportsCommand.js +39 -0
  28. package/dist-es/commands/index.js +10 -0
  29. package/dist-es/models/models_0.js +160 -40
  30. package/dist-es/protocols/Aws_json1_1.js +1364 -138
  31. package/dist-types/Forecast.d.ts +278 -19
  32. package/dist-types/ForecastClient.d.ts +12 -2
  33. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +83 -0
  34. package/dist-types/commands/CreateExplainabilityCommand.d.ts +153 -0
  35. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +43 -0
  36. package/dist-types/commands/CreatePredictorCommand.d.ts +19 -18
  37. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +37 -0
  38. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +35 -0
  39. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +35 -0
  40. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
  41. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +35 -0
  42. package/dist-types/commands/DescribePredictorCommand.d.ts +6 -1
  43. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
  44. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
  45. package/dist-types/commands/index.d.ts +10 -0
  46. package/dist-types/models/models_0.d.ts +1720 -271
  47. package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
  48. package/dist-types/ts3.4/Forecast.d.ts +50 -0
  49. package/dist-types/ts3.4/ForecastClient.d.ts +12 -2
  50. package/dist-types/ts3.4/commands/CreateAutoPredictorCommand.d.ts +17 -0
  51. package/dist-types/ts3.4/commands/CreateExplainabilityCommand.d.ts +17 -0
  52. package/dist-types/ts3.4/commands/CreateExplainabilityExportCommand.d.ts +17 -0
  53. package/dist-types/ts3.4/commands/DeleteExplainabilityCommand.d.ts +17 -0
  54. package/dist-types/ts3.4/commands/DeleteExplainabilityExportCommand.d.ts +17 -0
  55. package/dist-types/ts3.4/commands/DescribeAutoPredictorCommand.d.ts +17 -0
  56. package/dist-types/ts3.4/commands/DescribeExplainabilityCommand.d.ts +17 -0
  57. package/dist-types/ts3.4/commands/DescribeExplainabilityExportCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/ListExplainabilitiesCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/ListExplainabilityExportsCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  61. package/dist-types/ts3.4/models/models_0.d.ts +484 -83
  62. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
  63. package/package.json +2 -2
@@ -0,0 +1,153 @@
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 { CreateExplainabilityRequest, CreateExplainabilityResponse } from "../models/models_0";
5
+ export interface CreateExplainabilityCommandInput extends CreateExplainabilityRequest {
6
+ }
7
+ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <note>
11
+ * <p>Explainability is only available for Forecasts and Predictors generated from an
12
+ * AutoPredictor (<a>CreateAutoPredictor</a>)</p>
13
+ * </note>
14
+ * <p>Creates an Amazon Forecast Explainability.</p>
15
+ * <p>Explainability helps you better understand how the attributes in your datasets impact
16
+ * forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative
17
+ * impact of each attribute and determine whether they increase or decrease forecast
18
+ * values.</p>
19
+ * <p>To enable Forecast Explainability, your predictor must include at least one of the
20
+ * following: related time series, item metadata, or additional datasets like Holidays and
21
+ * the Weather Index.</p>
22
+ * <p>CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive
23
+ * aggregated Impact scores for all time series and time points in your datasets, provide a
24
+ * Predictor ARN. To receive Impact scores for specific time series and time points,
25
+ * provide a Forecast ARN.</p>
26
+ * <p>
27
+ * <b>CreateExplainability with a Predictor ARN</b>
28
+ * </p>
29
+ * <note>
30
+ * <p>You can only have one Explainability resource per predictor. If you already
31
+ * enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
32
+ * predictor already has an Explainability resource.</p>
33
+ * </note>
34
+ * <p>The following parameters are required when providing a Predictor ARN:</p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>
38
+ * <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>
42
+ * <code>ResourceArn</code> - The Arn of the predictor.</p>
43
+ * </li>
44
+ * <li>
45
+ * <p>
46
+ * <code>TimePointGranularity</code> - Must be set to “ALL”.</p>
47
+ * </li>
48
+ * <li>
49
+ * <p>
50
+ * <code>TimeSeriesGranularity</code> - Must be set to “ALL”.</p>
51
+ * </li>
52
+ * </ul>
53
+ * <p>Do not specify a value for the following parameters:</p>
54
+ * <ul>
55
+ * <li>
56
+ * <p>
57
+ * <code>DataSource</code> - Only valid when TimeSeriesGranularity is
58
+ * “SPECIFIC”.</p>
59
+ * </li>
60
+ * <li>
61
+ * <p>
62
+ * <code>Schema</code> - Only valid when TimeSeriesGranularity is
63
+ * “SPECIFIC”.</p>
64
+ * </li>
65
+ * <li>
66
+ * <p>
67
+ * <code>StartDateTime</code> - Only valid when TimePointGranularity is
68
+ * “SPECIFIC”.</p>
69
+ * </li>
70
+ * <li>
71
+ * <p>
72
+ * <code>EndDateTime</code> - Only valid when TimePointGranularity is
73
+ * “SPECIFIC”.</p>
74
+ * </li>
75
+ * </ul>
76
+ * <p>
77
+ * <b>CreateExplainability with a Forecast ARN</b>
78
+ * </p>
79
+ * <note>
80
+ * <p>You can specify a maximum of 50 time series and 1500 time points.</p>
81
+ * </note>
82
+ * <p>The following parameters are required when providing a Predictor ARN:</p>
83
+ * <ul>
84
+ * <li>
85
+ * <p>
86
+ * <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
87
+ * </li>
88
+ * <li>
89
+ * <p>
90
+ * <code>ResourceArn</code> - The Arn of the forecast.</p>
91
+ * </li>
92
+ * <li>
93
+ * <p>
94
+ * <code>TimePointGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
95
+ * </li>
96
+ * <li>
97
+ * <p>
98
+ * <code>TimeSeriesGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
99
+ * </li>
100
+ * </ul>
101
+ * <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
102
+ * following:</p>
103
+ * <ul>
104
+ * <li>
105
+ * <p>
106
+ * <code>DataSource</code> - The S3 location of the CSV file specifying your time
107
+ * series.</p>
108
+ * </li>
109
+ * <li>
110
+ * <p>
111
+ * <code>Schema</code> - The Schema defines the attributes and attribute types
112
+ * listed in the Data Source.</p>
113
+ * </li>
114
+ * </ul>
115
+ * <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
116
+ * following:</p>
117
+ * <ul>
118
+ * <li>
119
+ * <p>
120
+ * <code>StartDateTime</code> - The first timestamp in the range of time
121
+ * points.</p>
122
+ * </li>
123
+ * <li>
124
+ * <p>
125
+ * <code>EndDateTime</code> - The last timestamp in the range of time
126
+ * points.</p>
127
+ * </li>
128
+ * </ul>
129
+ * @example
130
+ * Use a bare-bones client and the command you need to make an API call.
131
+ * ```javascript
132
+ * import { ForecastClient, CreateExplainabilityCommand } from "@aws-sdk/client-forecast"; // ES Modules import
133
+ * // const { ForecastClient, CreateExplainabilityCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
134
+ * const client = new ForecastClient(config);
135
+ * const command = new CreateExplainabilityCommand(input);
136
+ * const response = await client.send(command);
137
+ * ```
138
+ *
139
+ * @see {@link CreateExplainabilityCommandInput} for command's `input` shape.
140
+ * @see {@link CreateExplainabilityCommandOutput} for command's `response` shape.
141
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
142
+ *
143
+ */
144
+ export declare class CreateExplainabilityCommand extends $Command<CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput, ForecastClientResolvedConfig> {
145
+ readonly input: CreateExplainabilityCommandInput;
146
+ constructor(input: CreateExplainabilityCommandInput);
147
+ /**
148
+ * @internal
149
+ */
150
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput>;
151
+ private serialize;
152
+ private deserialize;
153
+ }
@@ -0,0 +1,43 @@
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 { CreateExplainabilityExportRequest, CreateExplainabilityExportResponse } from "../models/models_0";
5
+ export interface CreateExplainabilityExportCommandInput extends CreateExplainabilityExportRequest {
6
+ }
7
+ export interface CreateExplainabilityExportCommandOutput extends CreateExplainabilityExportResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon
11
+ * S3) bucket.</p>
12
+ * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
13
+ * bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
14
+ * bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
15
+ * <note>
16
+ * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
17
+ * can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribeExplainabilityExport</a> operation.</p>
18
+ * </note>
19
+ * @example
20
+ * Use a bare-bones client and the command you need to make an API call.
21
+ * ```javascript
22
+ * import { ForecastClient, CreateExplainabilityExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
23
+ * // const { ForecastClient, CreateExplainabilityExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
24
+ * const client = new ForecastClient(config);
25
+ * const command = new CreateExplainabilityExportCommand(input);
26
+ * const response = await client.send(command);
27
+ * ```
28
+ *
29
+ * @see {@link CreateExplainabilityExportCommandInput} for command's `input` shape.
30
+ * @see {@link CreateExplainabilityExportCommandOutput} for command's `response` shape.
31
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
32
+ *
33
+ */
34
+ export declare class CreateExplainabilityExportCommand extends $Command<CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput, ForecastClientResolvedConfig> {
35
+ readonly input: CreateExplainabilityExportCommandInput;
36
+ constructor(input: CreateExplainabilityExportCommandInput);
37
+ /**
38
+ * @internal
39
+ */
40
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput>;
41
+ private serialize;
42
+ private deserialize;
43
+ }
@@ -7,35 +7,36 @@ export interface CreatePredictorCommandInput extends CreatePredictorRequest {
7
7
  export interface CreatePredictorCommandOutput extends CreatePredictorResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates an Amazon Forecast predictor.</p>
11
- * <p>In the request, provide a dataset group and either specify an algorithm or let
12
- * Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can
13
- * override algorithm-specific hyperparameters.</p>
14
- * <p>Amazon Forecast uses the algorithm to train a predictor using the latest version of the
15
- * datasets in the specified dataset group. You can then generate a
16
- * forecast using the <a>CreateForecast</a> operation.</p>
17
- * <p>
18
- * To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation.
19
- * </p>
20
- * <p>You can specify a featurization configuration to fill and aggregate the data
21
- * fields in the <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more
22
- * information, see <a>FeaturizationConfig</a>.</p>
10
+ * <note>
11
+ * <p> This operation creates a legacy predictor that does not include all the predictor
12
+ * functionalities provided by Amazon Forecast. To create a predictor that is compatible with all
13
+ * aspects of Forecast, use CreateAutoPredictor.</p>
14
+ * </note>
15
+ * <p>Creates an Amazon Forecast predictor.</p>
16
+ * <p>In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast
17
+ * choose an algorithm for you using AutoML. If you specify an algorithm, you also can override
18
+ * algorithm-specific hyperparameters.</p>
19
+ * <p>Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets
20
+ * in the specified dataset group. You can then generate a forecast using the <a>CreateForecast</a> operation.</p>
21
+ * <p> To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation. </p>
22
+ * <p>You can specify a featurization configuration to fill and aggregate the data fields in the
23
+ * <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more information, see
24
+ * <a>FeaturizationConfig</a>.</p>
23
25
  * <p>For RELATED_TIME_SERIES datasets, <code>CreatePredictor</code> verifies that the
24
26
  * <code>DataFrequency</code> specified when the dataset was created matches the
25
27
  * <code>ForecastFrequency</code>. TARGET_TIME_SERIES datasets don't have this restriction.
26
28
  * Amazon Forecast also verifies the delimiter and timestamp format. For more information, see <a>howitworks-datasets-groups</a>.</p>
27
29
  * <p>By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9
28
- * (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor
29
- * by setting the <code>ForecastTypes</code>.
30
- * </p>
30
+ * (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by
31
+ * setting the <code>ForecastTypes</code>. </p>
31
32
  * <p>
32
33
  * <b>AutoML</b>
33
34
  * </p>
34
35
  * <p>If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
35
36
  * <code>objective function</code>, set <code>PerformAutoML</code> to <code>true</code>. The
36
37
  * <code>objective function</code> is defined as the mean of the weighted losses over the
37
- * forecast types. By default, these are the p10, p50, and p90
38
- * quantile losses. For more information, see <a>EvaluationResult</a>.</p>
38
+ * forecast types. By default, these are the p10, p50, and p90 quantile losses. For more
39
+ * information, see <a>EvaluationResult</a>.</p>
39
40
  * <p>When AutoML is enabled, the following properties are disallowed:</p>
40
41
  * <ul>
41
42
  * <li>
@@ -0,0 +1,37 @@
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 { DeleteExplainabilityRequest } from "../models/models_0";
5
+ export interface DeleteExplainabilityCommandInput extends DeleteExplainabilityRequest {
6
+ }
7
+ export interface DeleteExplainabilityCommandOutput extends __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes an Explainability resource.</p>
11
+ * <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
12
+ * <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeExplainability</a> operation.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ForecastClient, DeleteExplainabilityCommand } from "@aws-sdk/client-forecast"; // ES Modules import
17
+ * // const { ForecastClient, DeleteExplainabilityCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
18
+ * const client = new ForecastClient(config);
19
+ * const command = new DeleteExplainabilityCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link DeleteExplainabilityCommandInput} for command's `input` shape.
24
+ * @see {@link DeleteExplainabilityCommandOutput} for command's `response` shape.
25
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class DeleteExplainabilityCommand extends $Command<DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput, ForecastClientResolvedConfig> {
29
+ readonly input: DeleteExplainabilityCommandInput;
30
+ constructor(input: DeleteExplainabilityCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,35 @@
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 { DeleteExplainabilityExportRequest } from "../models/models_0";
5
+ export interface DeleteExplainabilityExportCommandInput extends DeleteExplainabilityExportRequest {
6
+ }
7
+ export interface DeleteExplainabilityExportCommandOutput extends __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes an Explainability export job.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { ForecastClient, DeleteExplainabilityExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
15
+ * // const { ForecastClient, DeleteExplainabilityExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
16
+ * const client = new ForecastClient(config);
17
+ * const command = new DeleteExplainabilityExportCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DeleteExplainabilityExportCommandInput} for command's `input` shape.
22
+ * @see {@link DeleteExplainabilityExportCommandOutput} for command's `response` shape.
23
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DeleteExplainabilityExportCommand extends $Command<DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput, ForecastClientResolvedConfig> {
27
+ readonly input: DeleteExplainabilityExportCommandInput;
28
+ constructor(input: DeleteExplainabilityExportCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
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 { DescribeAutoPredictorRequest, DescribeAutoPredictorResponse } from "../models/models_0";
5
+ export interface DescribeAutoPredictorCommandInput extends DescribeAutoPredictorRequest {
6
+ }
7
+ export interface DescribeAutoPredictorCommandOutput extends DescribeAutoPredictorResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { ForecastClient, DescribeAutoPredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
15
+ * // const { ForecastClient, DescribeAutoPredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
16
+ * const client = new ForecastClient(config);
17
+ * const command = new DescribeAutoPredictorCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DescribeAutoPredictorCommandInput} for command's `input` shape.
22
+ * @see {@link DescribeAutoPredictorCommandOutput} for command's `response` shape.
23
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DescribeAutoPredictorCommand extends $Command<DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput, ForecastClientResolvedConfig> {
27
+ readonly input: DescribeAutoPredictorCommandInput;
28
+ constructor(input: DescribeAutoPredictorCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
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 { DescribeExplainabilityRequest, DescribeExplainabilityResponse } from "../models/models_0";
5
+ export interface DescribeExplainabilityCommandInput extends DescribeExplainabilityRequest {
6
+ }
7
+ export interface DescribeExplainabilityCommandOutput extends DescribeExplainabilityResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Describes an Explainability resource created using the <a>CreateExplainability</a> operation.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { ForecastClient, DescribeExplainabilityCommand } from "@aws-sdk/client-forecast"; // ES Modules import
15
+ * // const { ForecastClient, DescribeExplainabilityCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
16
+ * const client = new ForecastClient(config);
17
+ * const command = new DescribeExplainabilityCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DescribeExplainabilityCommandInput} for command's `input` shape.
22
+ * @see {@link DescribeExplainabilityCommandOutput} for command's `response` shape.
23
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DescribeExplainabilityCommand extends $Command<DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput, ForecastClientResolvedConfig> {
27
+ readonly input: DescribeExplainabilityCommandInput;
28
+ constructor(input: DescribeExplainabilityCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -0,0 +1,35 @@
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 { DescribeExplainabilityExportRequest, DescribeExplainabilityExportResponse } from "../models/models_0";
5
+ export interface DescribeExplainabilityExportCommandInput extends DescribeExplainabilityExportRequest {
6
+ }
7
+ export interface DescribeExplainabilityExportCommandOutput extends DescribeExplainabilityExportResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Describes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.</p>
11
+ * @example
12
+ * Use a bare-bones client and the command you need to make an API call.
13
+ * ```javascript
14
+ * import { ForecastClient, DescribeExplainabilityExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
15
+ * // const { ForecastClient, DescribeExplainabilityExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
16
+ * const client = new ForecastClient(config);
17
+ * const command = new DescribeExplainabilityExportCommand(input);
18
+ * const response = await client.send(command);
19
+ * ```
20
+ *
21
+ * @see {@link DescribeExplainabilityExportCommandInput} for command's `input` shape.
22
+ * @see {@link DescribeExplainabilityExportCommandOutput} for command's `response` shape.
23
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
+ *
25
+ */
26
+ export declare class DescribeExplainabilityExportCommand extends $Command<DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput, ForecastClientResolvedConfig> {
27
+ readonly input: DescribeExplainabilityExportCommandInput;
28
+ constructor(input: DescribeExplainabilityExportCommandInput);
29
+ /**
30
+ * @internal
31
+ */
32
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput>;
33
+ private serialize;
34
+ private deserialize;
35
+ }
@@ -7,7 +7,12 @@ export interface DescribePredictorCommandInput extends DescribePredictorRequest
7
7
  export interface DescribePredictorCommandOutput extends DescribePredictorResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes a predictor created using the <a>CreatePredictor</a>
10
+ * <note>
11
+ * <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
12
+ * are not using a legacy predictor, use DescribeAutoPredictor.</p>
13
+ * <p>To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.</p>
14
+ * </note>
15
+ * <p>Describes a predictor created using the <a>CreatePredictor</a>
11
16
  * operation.</p>
12
17
  * <p>In addition to listing the properties provided in the <code>CreatePredictor</code>
13
18
  * request, this operation lists the following properties:</p>
@@ -0,0 +1,39 @@
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 { ListExplainabilitiesRequest, ListExplainabilitiesResponse } from "../models/models_0";
5
+ export interface ListExplainabilitiesCommandInput extends ListExplainabilitiesRequest {
6
+ }
7
+ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
11
+ * each Explainability. You can filter the list using an array of <a>Filter</a>
12
+ * objects.</p>
13
+ * <p>To retrieve the complete set of properties for a particular Explainability resource,
14
+ * use the ARN with the <a>DescribeExplainability</a> operation.</p>
15
+ * @example
16
+ * Use a bare-bones client and the command you need to make an API call.
17
+ * ```javascript
18
+ * import { ForecastClient, ListExplainabilitiesCommand } from "@aws-sdk/client-forecast"; // ES Modules import
19
+ * // const { ForecastClient, ListExplainabilitiesCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
20
+ * const client = new ForecastClient(config);
21
+ * const command = new ListExplainabilitiesCommand(input);
22
+ * const response = await client.send(command);
23
+ * ```
24
+ *
25
+ * @see {@link ListExplainabilitiesCommandInput} for command's `input` shape.
26
+ * @see {@link ListExplainabilitiesCommandOutput} for command's `response` shape.
27
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
28
+ *
29
+ */
30
+ export declare class ListExplainabilitiesCommand extends $Command<ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput, ForecastClientResolvedConfig> {
31
+ readonly input: ListExplainabilitiesCommandInput;
32
+ constructor(input: ListExplainabilitiesCommandInput);
33
+ /**
34
+ * @internal
35
+ */
36
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput>;
37
+ private serialize;
38
+ private deserialize;
39
+ }
@@ -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
+ }
@@ -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";