@aws-sdk/client-forecast 3.296.0 → 3.297.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 (83) hide show
  1. package/dist-types/Forecast.d.ts +64 -0
  2. package/dist-types/ForecastClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateExplainabilityCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateForecastCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateMonitorCommand.d.ts +16 -0
  12. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +16 -0
  13. package/dist-types/commands/CreatePredictorCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteForecastCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteMonitorCommand.d.ts +16 -0
  25. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +16 -0
  26. package/dist-types/commands/DeletePredictorCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeForecastCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeMonitorCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribePredictorCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +16 -0
  45. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +16 -0
  50. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListForecastsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListMonitorsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +16 -0
  56. package/dist-types/commands/ListPredictorsCommand.d.ts +16 -0
  57. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  58. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +16 -0
  59. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +16 -0
  61. package/dist-types/commands/ResumeResourceCommand.d.ts +16 -0
  62. package/dist-types/commands/StopResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +16 -0
  66. package/dist-types/models/ForecastServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +477 -27
  68. package/dist-types/pagination/Interfaces.d.ts +3 -0
  69. package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListForecastExportJobsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListForecastsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListMonitorsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListPredictorBacktestExportJobsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListPredictorsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListWhatIfAnalysesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListWhatIfForecastExportsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListWhatIfForecastsPaginator.d.ts +3 -0
  83. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribePredictorBacktestExportJobRequest, DescribePredictorBacktestExportJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePredictorBacktestExportJobCommand}.
8
10
  */
9
11
  export interface DescribePredictorBacktestExportJobCommandInput extends DescribePredictorBacktestExportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePredictorBacktestExportJobCommand}.
13
17
  */
14
18
  export interface DescribePredictorBacktestExportJobCommandOutput extends DescribePredictorBacktestExportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided by the user in the
19
24
  * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
@@ -49,6 +54,8 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param DescribePredictorBacktestExportJobCommandInput - {@link DescribePredictorBacktestExportJobCommandInput}
58
+ * @returns {@link DescribePredictorBacktestExportJobCommandOutput}
52
59
  * @see {@link DescribePredictorBacktestExportJobCommandInput} for command's `input` shape.
53
60
  * @see {@link DescribePredictorBacktestExportJobCommandOutput} for command's `response` shape.
54
61
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
66
73
  export declare class DescribePredictorBacktestExportJobCommand extends $Command<DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput, ForecastClientResolvedConfig> {
67
74
  readonly input: DescribePredictorBacktestExportJobCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DescribePredictorBacktestExportJobCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribePredictorRequest, DescribePredictorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePredictorCommand}.
8
10
  */
9
11
  export interface DescribePredictorCommandInput extends DescribePredictorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePredictorCommand}.
13
17
  */
14
18
  export interface DescribePredictorCommandOutput extends DescribePredictorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <note>
18
23
  * <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
19
24
  * are not using a legacy predictor, use <a>DescribeAutoPredictor</a>.</p>
@@ -63,6 +68,8 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
63
68
  * const response = await client.send(command);
64
69
  * ```
65
70
  *
71
+ * @param DescribePredictorCommandInput - {@link DescribePredictorCommandInput}
72
+ * @returns {@link DescribePredictorCommandOutput}
66
73
  * @see {@link DescribePredictorCommandInput} for command's `input` shape.
67
74
  * @see {@link DescribePredictorCommandOutput} for command's `response` shape.
68
75
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -80,11 +87,20 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
80
87
  export declare class DescribePredictorCommand extends $Command<DescribePredictorCommandInput, DescribePredictorCommandOutput, ForecastClientResolvedConfig> {
81
88
  readonly input: DescribePredictorCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: DescribePredictorCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePredictorCommandInput, DescribePredictorCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeWhatIfAnalysisRequest, DescribeWhatIfAnalysisResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWhatIfAnalysisCommand}.
8
10
  */
9
11
  export interface DescribeWhatIfAnalysisCommandInput extends DescribeWhatIfAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWhatIfAnalysisCommand}.
13
17
  */
14
18
  export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnalysisResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfAnalysis</code> request, this operation lists the following properties:</p>
19
24
  * <ul>
@@ -47,6 +52,8 @@ export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnaly
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DescribeWhatIfAnalysisCommandInput - {@link DescribeWhatIfAnalysisCommandInput}
56
+ * @returns {@link DescribeWhatIfAnalysisCommandOutput}
50
57
  * @see {@link DescribeWhatIfAnalysisCommandInput} for command's `input` shape.
51
58
  * @see {@link DescribeWhatIfAnalysisCommandOutput} for command's `response` shape.
52
59
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnaly
64
71
  export declare class DescribeWhatIfAnalysisCommand extends $Command<DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
65
72
  readonly input: DescribeWhatIfAnalysisCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DescribeWhatIfAnalysisCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeWhatIfForecastRequest, DescribeWhatIfForecastResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWhatIfForecastCommand}.
8
10
  */
9
11
  export interface DescribeWhatIfForecastCommandInput extends DescribeWhatIfForecastRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWhatIfForecastCommand}.
13
17
  */
14
18
  export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForecastResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the what-if forecast created using the <a>CreateWhatIfForecast</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecast</code> request, this operation lists the following properties:</p>
19
24
  * <ul>
@@ -47,6 +52,8 @@ export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForec
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DescribeWhatIfForecastCommandInput - {@link DescribeWhatIfForecastCommandInput}
56
+ * @returns {@link DescribeWhatIfForecastCommandOutput}
50
57
  * @see {@link DescribeWhatIfForecastCommandInput} for command's `input` shape.
51
58
  * @see {@link DescribeWhatIfForecastCommandOutput} for command's `response` shape.
52
59
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForec
64
71
  export declare class DescribeWhatIfForecastCommand extends $Command<DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
65
72
  readonly input: DescribeWhatIfForecastCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DescribeWhatIfForecastCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeWhatIfForecastExportRequest, DescribeWhatIfForecastExportResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWhatIfForecastExportCommand}.
8
10
  */
9
11
  export interface DescribeWhatIfForecastExportCommandInput extends DescribeWhatIfForecastExportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWhatIfForecastExportCommand}.
13
17
  */
14
18
  export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatIfForecastExportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecastExport</code> request, this operation lists the following properties:</p>
19
24
  * <ul>
@@ -47,6 +52,8 @@ export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatI
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DescribeWhatIfForecastExportCommandInput - {@link DescribeWhatIfForecastExportCommandInput}
56
+ * @returns {@link DescribeWhatIfForecastExportCommandOutput}
50
57
  * @see {@link DescribeWhatIfForecastExportCommandInput} for command's `input` shape.
51
58
  * @see {@link DescribeWhatIfForecastExportCommandOutput} for command's `response` shape.
52
59
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatI
64
71
  export declare class DescribeWhatIfForecastExportCommand extends $Command<DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {
65
72
  readonly input: DescribeWhatIfForecastExportCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DescribeWhatIfForecastExportCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { GetAccuracyMetricsRequest, GetAccuracyMetricsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAccuracyMetricsCommand}.
8
10
  */
9
11
  export interface GetAccuracyMetricsCommandInput extends GetAccuracyMetricsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAccuracyMetricsCommand}.
13
17
  */
14
18
  export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides metrics on the accuracy of the models that were trained by the <a>CreatePredictor</a> operation. Use metrics to see how well the model performed and
18
23
  * to decide whether to use the predictor to generate a forecast. For more information, see
19
24
  * <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
@@ -41,6 +46,8 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param GetAccuracyMetricsCommandInput - {@link GetAccuracyMetricsCommandInput}
50
+ * @returns {@link GetAccuracyMetricsCommandOutput}
44
51
  * @see {@link GetAccuracyMetricsCommandInput} for command's `input` shape.
45
52
  * @see {@link GetAccuracyMetricsCommandOutput} for command's `response` shape.
46
53
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -61,11 +68,20 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
61
68
  export declare class GetAccuracyMetricsCommand extends $Command<GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput, ForecastClientResolvedConfig> {
62
69
  readonly input: GetAccuracyMetricsCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: GetAccuracyMetricsCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListDatasetGroupsRequest, ListDatasetGroupsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetGroupsCommand}.
8
10
  */
9
11
  export interface ListDatasetGroupsCommandInput extends ListDatasetGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetGroupsCommand}.
13
17
  */
14
18
  export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of dataset groups created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation.
18
23
  * For each dataset group, this operation returns a summary of its properties, including its
19
24
  * Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
@@ -29,6 +34,8 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListDatasetGroupsCommandInput - {@link ListDatasetGroupsCommandInput}
38
+ * @returns {@link ListDatasetGroupsCommandOutput}
32
39
  * @see {@link ListDatasetGroupsCommandInput} for command's `input` shape.
33
40
  * @see {@link ListDatasetGroupsCommandOutput} for command's `response` shape.
34
41
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
41
48
  export declare class ListDatasetGroupsCommand extends $Command<ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput, ForecastClientResolvedConfig> {
42
49
  readonly input: ListDatasetGroupsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListDatasetGroupsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListDatasetImportJobsRequest, ListDatasetImportJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetImportJobsCommand}.
8
10
  */
9
11
  export interface ListDatasetImportJobsCommandInput extends ListDatasetImportJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetImportJobsCommand}.
13
17
  */
14
18
  export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of dataset import jobs created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
18
23
  * operation. For each import job, this operation returns a summary of its properties, including
19
24
  * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
@@ -29,6 +34,8 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListDatasetImportJobsCommandInput - {@link ListDatasetImportJobsCommandInput}
38
+ * @returns {@link ListDatasetImportJobsCommandOutput}
32
39
  * @see {@link ListDatasetImportJobsCommandInput} for command's `input` shape.
33
40
  * @see {@link ListDatasetImportJobsCommandOutput} for command's `response` shape.
34
41
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
45
52
  export declare class ListDatasetImportJobsCommand extends $Command<ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput, ForecastClientResolvedConfig> {
46
53
  readonly input: ListDatasetImportJobsCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ListDatasetImportJobsCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListDatasetsRequest, ListDatasetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetsCommand}.
8
10
  */
9
11
  export interface ListDatasetsCommandInput extends ListDatasetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetsCommand}.
13
17
  */
14
18
  export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of datasets created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. For each
18
23
  * dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned.
19
24
  * To retrieve the complete set of properties, use the ARN with the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation.</p>
@@ -27,6 +32,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
36
+ * @returns {@link ListDatasetsCommandOutput}
30
37
  * @see {@link ListDatasetsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListDatasetsCommandOutput} for command's `response` shape.
32
39
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -39,11 +46,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
39
46
  export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, ForecastClientResolvedConfig> {
40
47
  readonly input: ListDatasetsCommandInput;
41
48
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
49
+ /**
50
+ * @public
51
+ */
42
52
  constructor(input: ListDatasetsCommandInput);
43
53
  /**
44
54
  * @internal
45
55
  */
46
56
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetsCommandInput, ListDatasetsCommandOutput>;
57
+ /**
58
+ * @internal
59
+ */
47
60
  private serialize;
61
+ /**
62
+ * @internal
63
+ */
48
64
  private deserialize;
49
65
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListExplainabilitiesRequest, ListExplainabilitiesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListExplainabilitiesCommand}.
8
10
  */
9
11
  export interface ListExplainabilitiesCommandInput extends ListExplainabilitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListExplainabilitiesCommand}.
13
17
  */
14
18
  export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
18
23
  * each Explainability. You can filter the list using an array of <a>Filter</a>
19
24
  * objects.</p>
@@ -29,6 +34,8 @@ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesR
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListExplainabilitiesCommandInput - {@link ListExplainabilitiesCommandInput}
38
+ * @returns {@link ListExplainabilitiesCommandOutput}
32
39
  * @see {@link ListExplainabilitiesCommandInput} for command's `input` shape.
33
40
  * @see {@link ListExplainabilitiesCommandOutput} for command's `response` shape.
34
41
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesR
45
52
  export declare class ListExplainabilitiesCommand extends $Command<ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput, ForecastClientResolvedConfig> {
46
53
  readonly input: ListExplainabilitiesCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ListExplainabilitiesCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListExplainabilityExportsRequest, ListExplainabilityExportsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListExplainabilityExportsCommand}.
8
10
  */
9
11
  export interface ListExplainabilityExportsCommandInput extends ListExplainabilityExportsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListExplainabilityExportsCommand}.
13
17
  */
14
18
  export interface ListExplainabilityExportsCommandOutput extends ListExplainabilityExportsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
18
23
  * for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
19
24
  * <p>To retrieve the complete set of properties for a particular Explainability export, use
@@ -28,6 +33,8 @@ export interface ListExplainabilityExportsCommandOutput extends ListExplainabili
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListExplainabilityExportsCommandInput - {@link ListExplainabilityExportsCommandInput}
37
+ * @returns {@link ListExplainabilityExportsCommandOutput}
31
38
  * @see {@link ListExplainabilityExportsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListExplainabilityExportsCommandOutput} for command's `response` shape.
33
40
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListExplainabilityExportsCommandOutput extends ListExplainabili
44
51
  export declare class ListExplainabilityExportsCommand extends $Command<ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput, ForecastClientResolvedConfig> {
45
52
  readonly input: ListExplainabilityExportsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListExplainabilityExportsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { ListForecastExportJobsRequest, ListForecastExportJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListForecastExportJobsCommand}.
8
10
  */
9
11
  export interface ListForecastExportJobsCommandInput extends ListForecastExportJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListForecastExportJobsCommand}.
13
17
  */
14
18
  export interface ListForecastExportJobsCommandOutput extends ListForecastExportJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, this operation
18
23
  * returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the
19
24
  * complete set of properties, use the ARN with the <a>DescribeForecastExportJob</a>
@@ -28,6 +33,8 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListForecastExportJobsCommandInput - {@link ListForecastExportJobsCommandInput}
37
+ * @returns {@link ListForecastExportJobsCommandOutput}
31
38
  * @see {@link ListForecastExportJobsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListForecastExportJobsCommandOutput} for command's `response` shape.
33
40
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ
44
51
  export declare class ListForecastExportJobsCommand extends $Command<ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput, ForecastClientResolvedConfig> {
45
52
  readonly input: ListForecastExportJobsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListForecastExportJobsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }