@aws-sdk/client-forecast 3.40.0 → 3.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/CHANGELOG.md +41 -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/endpoints.js +9 -0
  16. package/dist-cjs/models/models_0.js +236 -61
  17. package/dist-cjs/protocols/Aws_json1_1.js +1283 -98
  18. package/dist-es/Forecast.js +150 -0
  19. package/dist-es/commands/CreateAutoPredictorCommand.js +39 -0
  20. package/dist-es/commands/CreateExplainabilityCommand.js +39 -0
  21. package/dist-es/commands/CreateExplainabilityExportCommand.js +39 -0
  22. package/dist-es/commands/DeleteExplainabilityCommand.js +39 -0
  23. package/dist-es/commands/DeleteExplainabilityExportCommand.js +39 -0
  24. package/dist-es/commands/DescribeAutoPredictorCommand.js +39 -0
  25. package/dist-es/commands/DescribeExplainabilityCommand.js +39 -0
  26. package/dist-es/commands/DescribeExplainabilityExportCommand.js +39 -0
  27. package/dist-es/commands/ListExplainabilitiesCommand.js +39 -0
  28. package/dist-es/commands/ListExplainabilityExportsCommand.js +39 -0
  29. package/dist-es/commands/index.js +10 -0
  30. package/dist-es/endpoints.js +9 -0
  31. package/dist-es/models/models_0.js +160 -40
  32. package/dist-es/protocols/Aws_json1_1.js +1367 -138
  33. package/dist-types/Forecast.d.ts +306 -40
  34. package/dist-types/ForecastClient.d.ts +12 -2
  35. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +83 -0
  36. package/dist-types/commands/CreateDatasetCommand.d.ts +1 -1
  37. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +1 -1
  38. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +1 -1
  39. package/dist-types/commands/CreateExplainabilityCommand.d.ts +153 -0
  40. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +43 -0
  41. package/dist-types/commands/CreateForecastCommand.d.ts +1 -1
  42. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +1 -1
  43. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +5 -5
  44. package/dist-types/commands/CreatePredictorCommand.d.ts +20 -19
  45. package/dist-types/commands/DeleteDatasetCommand.d.ts +1 -1
  46. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +1 -1
  47. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +1 -1
  48. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +37 -0
  49. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +35 -0
  50. package/dist-types/commands/DeleteForecastCommand.d.ts +1 -1
  51. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +1 -1
  52. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +1 -1
  53. package/dist-types/commands/DeletePredictorCommand.d.ts +3 -4
  54. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +1 -1
  55. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +35 -0
  56. package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
  57. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
  58. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
  59. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
  60. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +35 -0
  61. package/dist-types/commands/DescribeForecastCommand.d.ts +1 -1
  62. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +1 -1
  63. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +2 -2
  64. package/dist-types/commands/DescribePredictorCommand.d.ts +6 -2
  65. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +1 -1
  66. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +1 -1
  67. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +1 -1
  68. package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
  69. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +39 -0
  70. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +38 -0
  71. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +1 -1
  72. package/dist-types/commands/ListForecastsCommand.d.ts +1 -1
  73. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +5 -5
  74. package/dist-types/commands/ListPredictorsCommand.d.ts +6 -6
  75. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  76. package/dist-types/commands/StopResourceCommand.d.ts +10 -4
  77. package/dist-types/commands/TagResourceCommand.d.ts +5 -2
  78. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  79. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +1 -1
  80. package/dist-types/commands/index.d.ts +10 -0
  81. package/dist-types/models/models_0.d.ts +2109 -495
  82. package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
  83. package/dist-types/ts3.4/Forecast.d.ts +50 -0
  84. package/dist-types/ts3.4/ForecastClient.d.ts +12 -2
  85. package/dist-types/ts3.4/commands/CreateAutoPredictorCommand.d.ts +17 -0
  86. package/dist-types/ts3.4/commands/CreateExplainabilityCommand.d.ts +17 -0
  87. package/dist-types/ts3.4/commands/CreateExplainabilityExportCommand.d.ts +17 -0
  88. package/dist-types/ts3.4/commands/DeleteExplainabilityCommand.d.ts +17 -0
  89. package/dist-types/ts3.4/commands/DeleteExplainabilityExportCommand.d.ts +17 -0
  90. package/dist-types/ts3.4/commands/DescribeAutoPredictorCommand.d.ts +17 -0
  91. package/dist-types/ts3.4/commands/DescribeExplainabilityCommand.d.ts +17 -0
  92. package/dist-types/ts3.4/commands/DescribeExplainabilityExportCommand.d.ts +17 -0
  93. package/dist-types/ts3.4/commands/ListExplainabilitiesCommand.d.ts +17 -0
  94. package/dist-types/ts3.4/commands/ListExplainabilityExportsCommand.d.ts +17 -0
  95. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  96. package/dist-types/ts3.4/models/models_0.d.ts +492 -83
  97. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
  98. package/package.json +6 -6
@@ -0,0 +1,83 @@
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 { CreateAutoPredictorRequest, CreateAutoPredictorResponse } from "../models/models_0";
5
+ export interface CreateAutoPredictorCommandInput extends CreateAutoPredictorRequest {
6
+ }
7
+ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Creates an Amazon Forecast predictor.</p>
11
+ * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
12
+ * optimal combination of algorithms to each time series in your datasets. You can use
13
+ * <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain existing
14
+ * predictors.</p>
15
+ * <p>
16
+ * <b>Creating new predictors</b>
17
+ * </p>
18
+ * <p>The following parameters are required when creating a new predictor:</p>
19
+ * <ul>
20
+ * <li>
21
+ * <p>
22
+ * <code>PredictorName</code> - A unique name for the predictor.</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>
26
+ * <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
27
+ * predictor.</p>
28
+ * </li>
29
+ * <li>
30
+ * <p>
31
+ * <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
32
+ * daily, weekly, etc).</p>
33
+ * </li>
34
+ * <li>
35
+ * <p>
36
+ * <code>ForecastHorizon</code> - The number of time steps being
37
+ * forecasted.</p>
38
+ * </li>
39
+ * </ul>
40
+ * <p>When creating a new predictor, do not specify a value for
41
+ * <code>ReferencePredictorArn</code>.</p>
42
+ * <p>
43
+ * <b>Upgrading and retraining predictors</b>
44
+ * </p>
45
+ * <p>The following parameters are required when retraining or upgrading a predictor:</p>
46
+ * <ul>
47
+ * <li>
48
+ * <p>
49
+ * <code>PredictorName</code> - A unique name for the predictor.</p>
50
+ * </li>
51
+ * <li>
52
+ * <p>
53
+ * <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
54
+ * upgrade.</p>
55
+ * </li>
56
+ * </ul>
57
+ * <p>When upgrading or retraining a predictor, only specify values for the
58
+ * <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
59
+ * @example
60
+ * Use a bare-bones client and the command you need to make an API call.
61
+ * ```javascript
62
+ * import { ForecastClient, CreateAutoPredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
63
+ * // const { ForecastClient, CreateAutoPredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
64
+ * const client = new ForecastClient(config);
65
+ * const command = new CreateAutoPredictorCommand(input);
66
+ * const response = await client.send(command);
67
+ * ```
68
+ *
69
+ * @see {@link CreateAutoPredictorCommandInput} for command's `input` shape.
70
+ * @see {@link CreateAutoPredictorCommandOutput} for command's `response` shape.
71
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
72
+ *
73
+ */
74
+ export declare class CreateAutoPredictorCommand extends $Command<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput, ForecastClientResolvedConfig> {
75
+ readonly input: CreateAutoPredictorCommandInput;
76
+ constructor(input: CreateAutoPredictorCommandInput);
77
+ /**
78
+ * @internal
79
+ */
80
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput>;
81
+ private serialize;
82
+ private deserialize;
83
+ }
@@ -61,7 +61,7 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
61
61
  *
62
62
  * @see {@link CreateDatasetCommandInput} for command's `input` shape.
63
63
  * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
64
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
64
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
65
65
  *
66
66
  */
67
67
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, ForecastClientResolvedConfig> {
@@ -29,7 +29,7 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
29
29
  *
30
30
  * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape.
31
31
  * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape.
32
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
32
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
33
33
  *
34
34
  */
35
35
  export declare class CreateDatasetGroupCommand extends $Command<CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
@@ -39,7 +39,7 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
39
39
  *
40
40
  * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape.
41
41
  * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape.
42
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
42
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
43
43
  *
44
44
  */
45
45
  export declare class CreateDatasetImportJobCommand extends $Command<CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -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 500 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
+ }
@@ -38,7 +38,7 @@ export interface CreateForecastCommandOutput extends CreateForecastResponse, __M
38
38
  *
39
39
  * @see {@link CreateForecastCommandInput} for command's `input` shape.
40
40
  * @see {@link CreateForecastCommandOutput} for command's `response` shape.
41
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
41
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
42
42
  *
43
43
  */
44
44
  export declare class CreateForecastCommand extends $Command<CreateForecastCommandInput, CreateForecastCommandOutput, ForecastClientResolvedConfig> {
@@ -33,7 +33,7 @@ export interface CreateForecastExportJobCommandOutput extends CreateForecastExpo
33
33
  *
34
34
  * @see {@link CreateForecastExportJobCommandInput} for command's `input` shape.
35
35
  * @see {@link CreateForecastExportJobCommandOutput} for command's `response` shape.
36
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
36
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
37
37
  *
38
38
  */
39
39
  export declare class CreateForecastExportJobCommand extends $Command<CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -7,8 +7,8 @@ export interface CreatePredictorBacktestExportJobCommandInput extends CreatePred
7
7
  export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePredictorBacktestExportJobResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two folders containing CSV files are exported
11
- * to your specified S3 bucket.</p>
10
+ * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
11
+ * folders containing CSV files are exported to your specified S3 bucket.</p>
12
12
  * <p> The export file names will match the following conventions:</p>
13
13
  * <p>
14
14
  * <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
@@ -19,8 +19,8 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
19
19
  * bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
20
20
  * bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
21
21
  * <note>
22
- * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before
23
- * you can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
22
+ * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
23
+ * can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
24
24
  * </note>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
@@ -34,7 +34,7 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
34
34
  *
35
35
  * @see {@link CreatePredictorBacktestExportJobCommandInput} for command's `input` shape.
36
36
  * @see {@link CreatePredictorBacktestExportJobCommandOutput} for command's `response` shape.
37
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
37
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
38
38
  *
39
39
  */
40
40
  export declare class CreatePredictorBacktestExportJobCommand extends $Command<CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -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 <a>CreateAutoPredictor</a>.</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>
@@ -81,7 +82,7 @@ export interface CreatePredictorCommandOutput extends CreatePredictorResponse, _
81
82
  *
82
83
  * @see {@link CreatePredictorCommandInput} for command's `input` shape.
83
84
  * @see {@link CreatePredictorCommandOutput} for command's `response` shape.
84
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
85
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
85
86
  *
86
87
  */
87
88
  export declare class CreatePredictorCommand extends $Command<CreatePredictorCommandInput, CreatePredictorCommandOutput, ForecastClientResolvedConfig> {
@@ -28,7 +28,7 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
28
28
  *
29
29
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
30
30
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
31
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
31
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
32
32
  *
33
33
  */
34
34
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, ForecastClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
23
23
  *
24
24
  * @see {@link DeleteDatasetGroupCommandInput} for command's `input` shape.
25
25
  * @see {@link DeleteDatasetGroupCommandOutput} for command's `response` shape.
26
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class DeleteDatasetGroupCommand extends $Command<DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface DeleteDatasetImportJobCommandOutput extends __MetadataBearer {
22
22
  *
23
23
  * @see {@link DeleteDatasetImportJobCommandInput} for command's `input` shape.
24
24
  * @see {@link DeleteDatasetImportJobCommandOutput} for command's `response` shape.
25
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class DeleteDatasetImportJobCommand extends $Command<DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -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.</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
+ }
@@ -24,7 +24,7 @@ export interface DeleteForecastCommandOutput extends __MetadataBearer {
24
24
  *
25
25
  * @see {@link DeleteForecastCommandInput} for command's `input` shape.
26
26
  * @see {@link DeleteForecastCommandOutput} for command's `response` shape.
27
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class DeleteForecastCommand extends $Command<DeleteForecastCommandInput, DeleteForecastCommandOutput, ForecastClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface DeleteForecastExportJobCommandOutput extends __MetadataBearer {
22
22
  *
23
23
  * @see {@link DeleteForecastExportJobCommandInput} for command's `input` shape.
24
24
  * @see {@link DeleteForecastExportJobCommandOutput} for command's `response` shape.
25
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class DeleteForecastExportJobCommand extends $Command<DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DeletePredictorBacktestExportJobCommandOutput extends __Metadat
20
20
  *
21
21
  * @see {@link DeletePredictorBacktestExportJobCommandInput} for command's `input` shape.
22
22
  * @see {@link DeletePredictorBacktestExportJobCommandOutput} for command's `response` shape.
23
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DeletePredictorBacktestExportJobCommand extends $Command<DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -7,9 +7,8 @@ export interface DeletePredictorCommandInput extends DeletePredictorRequest {
7
7
  export interface DeletePredictorCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes a predictor created using the <a>CreatePredictor</a> operation. You can
11
- * delete only predictor that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
12
- * To get the status, use the <a>DescribePredictor</a> operation.</p>
10
+ * <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
11
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribePredictor</a> operation.</p>
13
12
  * @example
14
13
  * Use a bare-bones client and the command you need to make an API call.
15
14
  * ```javascript
@@ -22,7 +21,7 @@ export interface DeletePredictorCommandOutput extends __MetadataBearer {
22
21
  *
23
22
  * @see {@link DeletePredictorCommandInput} for command's `input` shape.
24
23
  * @see {@link DeletePredictorCommandOutput} for command's `response` shape.
25
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
25
  *
27
26
  */
28
27
  export declare class DeletePredictorCommand extends $Command<DeletePredictorCommandInput, DeletePredictorCommandOutput, ForecastClientResolvedConfig> {
@@ -51,7 +51,7 @@ export interface DeleteResourceTreeCommandOutput extends __MetadataBearer {
51
51
  *
52
52
  * @see {@link DeleteResourceTreeCommandInput} for command's `input` shape.
53
53
  * @see {@link DeleteResourceTreeCommandOutput} for command's `response` shape.
54
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
54
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
55
55
  *
56
56
  */
57
57
  export declare class DeleteResourceTreeCommand extends $Command<DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput, ForecastClientResolvedConfig> {