@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,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
+ }
@@ -40,7 +40,7 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
40
40
  *
41
41
  * @see {@link DescribeDatasetCommandInput} for command's `input` shape.
42
42
  * @see {@link DescribeDatasetCommandOutput} for command's `response` shape.
43
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
43
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
44
44
  *
45
45
  */
46
46
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, ForecastClientResolvedConfig> {
@@ -44,7 +44,7 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR
44
44
  *
45
45
  * @see {@link DescribeDatasetGroupCommandInput} for command's `input` shape.
46
46
  * @see {@link DescribeDatasetGroupCommandOutput} for command's `response` shape.
47
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
47
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
48
48
  *
49
49
  */
50
50
  export declare class DescribeDatasetGroupCommand extends $Command<DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
@@ -54,7 +54,7 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm
54
54
  *
55
55
  * @see {@link DescribeDatasetImportJobCommandInput} for command's `input` shape.
56
56
  * @see {@link DescribeDatasetImportJobCommandOutput} for command's `response` shape.
57
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
57
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
58
58
  *
59
59
  */
60
60
  export declare class DescribeDatasetImportJobCommand extends $Command<DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -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
+ }
@@ -48,7 +48,7 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse,
48
48
  *
49
49
  * @see {@link DescribeForecastCommandInput} for command's `input` shape.
50
50
  * @see {@link DescribeForecastCommandOutput} for command's `response` shape.
51
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
51
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
52
52
  *
53
53
  */
54
54
  export declare class DescribeForecastCommand extends $Command<DescribeForecastCommandInput, DescribeForecastCommandOutput, ForecastClientResolvedConfig> {
@@ -44,7 +44,7 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast
44
44
  *
45
45
  * @see {@link DescribeForecastExportJobCommandInput} for command's `input` shape.
46
46
  * @see {@link DescribeForecastExportJobCommandOutput} for command's `response` shape.
47
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
47
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
48
48
  *
49
49
  */
50
50
  export declare class DescribeForecastExportJobCommand extends $Command<DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -9,7 +9,7 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
9
9
  /**
10
10
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
11
11
  * <p>In addition to listing the properties provided by the user in the
12
- * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
12
+ * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
13
13
  * following properties:</p>
14
14
  * <ul>
15
15
  * <li>
@@ -44,7 +44,7 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
44
44
  *
45
45
  * @see {@link DescribePredictorBacktestExportJobCommandInput} for command's `input` shape.
46
46
  * @see {@link DescribePredictorBacktestExportJobCommandOutput} for command's `response` shape.
47
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
47
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
48
48
  *
49
49
  */
50
50
  export declare class DescribePredictorBacktestExportJobCommand extends $Command<DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -7,7 +7,11 @@ 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 <a>DescribeAutoPredictor</a>.</p>
13
+ * </note>
14
+ * <p>Describes a predictor created using the <a>CreatePredictor</a>
11
15
  * operation.</p>
12
16
  * <p>In addition to listing the properties provided in the <code>CreatePredictor</code>
13
17
  * request, this operation lists the following properties:</p>
@@ -54,7 +58,7 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
54
58
  *
55
59
  * @see {@link DescribePredictorCommandInput} for command's `input` shape.
56
60
  * @see {@link DescribePredictorCommandOutput} for command's `response` shape.
57
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
61
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
58
62
  *
59
63
  */
60
64
  export declare class DescribePredictorCommand extends $Command<DescribePredictorCommandInput, DescribePredictorCommandOutput, ForecastClientResolvedConfig> {
@@ -37,7 +37,7 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
37
37
  *
38
38
  * @see {@link GetAccuracyMetricsCommandInput} for command's `input` shape.
39
39
  * @see {@link GetAccuracyMetricsCommandOutput} for command's `response` shape.
40
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
40
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
41
41
  *
42
42
  */
43
43
  export declare class GetAccuracyMetricsCommand extends $Command<GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput, ForecastClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
23
23
  *
24
24
  * @see {@link ListDatasetGroupsCommandInput} for command's `input` shape.
25
25
  * @see {@link ListDatasetGroupsCommandOutput} 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 ListDatasetGroupsCommand extends $Command<ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput, ForecastClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
23
23
  *
24
24
  * @see {@link ListDatasetImportJobsCommandInput} for command's `input` shape.
25
25
  * @see {@link ListDatasetImportJobsCommandOutput} 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 ListDatasetImportJobsCommand extends $Command<ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
22
22
  *
23
23
  * @see {@link ListDatasetsCommandInput} for command's `input` shape.
24
24
  * @see {@link ListDatasetsCommandOutput} 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 ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, ForecastClientResolvedConfig> {
@@ -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
+ }
@@ -23,7 +23,7 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ
23
23
  *
24
24
  * @see {@link ListForecastExportJobsCommandInput} for command's `input` shape.
25
25
  * @see {@link ListForecastExportJobsCommandOutput} 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 ListForecastExportJobsCommand extends $Command<ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface ListForecastsCommandOutput extends ListForecastsResponse, __Met
24
24
  *
25
25
  * @see {@link ListForecastsCommandInput} for command's `input` shape.
26
26
  * @see {@link ListForecastsCommandOutput} 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 ListForecastsCommand extends $Command<ListForecastsCommandInput, ListForecastsCommandOutput, ForecastClientResolvedConfig> {
@@ -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 summary
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 the
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
@@ -23,7 +23,7 @@ export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredic
23
23
  *
24
24
  * @see {@link ListPredictorBacktestExportJobsCommandInput} for command's `input` shape.
25
25
  * @see {@link ListPredictorBacktestExportJobsCommandOutput} 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 ListPredictorBacktestExportJobsCommand extends $Command<ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -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>CreatePredictor</a>
11
- * operation. For each predictor, this operation returns a summary of its properties, including
12
- * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
13
- * ARN with the <a>DescribePredictor</a> operation. You can filter the list using an
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
@@ -24,7 +24,7 @@ export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __M
24
24
  *
25
25
  * @see {@link ListPredictorsCommandInput} for command's `input` shape.
26
26
  * @see {@link ListPredictorsCommandOutput} 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 ListPredictorsCommand extends $Command<ListPredictorsCommandInput, ListPredictorsCommandOutput, ForecastClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
20
20
  *
21
21
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
22
22
  * @see {@link ListTagsForResourceCommandOutput} 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 ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -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
- * <code>CREATE_STOPPING</code> and <code>CREATE_STOPPED</code>. You cannot resume
13
- * a resource once it has been stopped.</p>
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.
@@ -42,7 +48,7 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
42
48
  *
43
49
  * @see {@link StopResourceCommandInput} for command's `input` shape.
44
50
  * @see {@link StopResourceCommandOutput} for command's `response` shape.
45
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
51
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
46
52
  *
47
53
  */
48
54
  export declare class StopResourceCommand extends $Command<StopResourceCommandInput, StopResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -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>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.</p>
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
@@ -20,7 +23,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
20
23
  *
21
24
  * @see {@link TagResourceCommandInput} for command's `input` shape.
22
25
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
23
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
24
27
  *
25
28
  */
26
29
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
20
20
  *
21
21
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
22
22
  * @see {@link UntagResourceCommandOutput} 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 UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -25,7 +25,7 @@ export interface UpdateDatasetGroupCommandOutput extends UpdateDatasetGroupRespo
25
25
  *
26
26
  * @see {@link UpdateDatasetGroupCommandInput} for command's `input` shape.
27
27
  * @see {@link UpdateDatasetGroupCommandOutput} for command's `response` shape.
28
- * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape.
28
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
29
29
  *
30
30
  */
31
31
  export declare class UpdateDatasetGroupCommand extends $Command<UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
@@ -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";