@aws-sdk/client-forecast 3.321.1 → 3.326.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 (64) hide show
  1. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateExplainabilityCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateForecastCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +6 -0
  9. package/dist-types/commands/CreateMonitorCommand.d.ts +6 -0
  10. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +6 -0
  11. package/dist-types/commands/CreatePredictorCommand.d.ts +6 -0
  12. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +6 -0
  13. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +6 -0
  14. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +6 -0
  15. package/dist-types/commands/DeleteDatasetCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteForecastCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteMonitorCommand.d.ts +4 -0
  23. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +4 -0
  24. package/dist-types/commands/DeletePredictorCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +4 -0
  28. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +4 -0
  29. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +67 -0
  30. package/dist-types/commands/DescribeDatasetCommand.d.ts +25 -0
  31. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +14 -0
  32. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +43 -0
  33. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +35 -0
  34. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +20 -0
  35. package/dist-types/commands/DescribeForecastCommand.d.ts +37 -0
  36. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +20 -0
  37. package/dist-types/commands/DescribeMonitorCommand.d.ts +25 -0
  38. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +20 -0
  39. package/dist-types/commands/DescribePredictorCommand.d.ts +110 -0
  40. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +33 -0
  41. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +49 -0
  42. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +23 -0
  43. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +40 -0
  44. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +14 -0
  45. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +24 -0
  46. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +21 -0
  48. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +23 -0
  49. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +23 -0
  50. package/dist-types/commands/ListForecastsCommand.d.ts +19 -0
  51. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +33 -0
  52. package/dist-types/commands/ListMonitorsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +23 -0
  54. package/dist-types/commands/ListPredictorsCommand.d.ts +22 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  56. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +17 -0
  57. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +26 -0
  58. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +17 -0
  59. package/dist-types/commands/ResumeResourceCommand.d.ts +4 -0
  60. package/dist-types/commands/StopResourceCommand.d.ts +4 -0
  61. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  62. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +4 -0
  64. package/package.json +16 -16
@@ -47,6 +47,44 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
47
47
  * };
48
48
  * const command = new GetAccuracyMetricsCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // GetAccuracyMetricsResponse
51
+ * // PredictorEvaluationResults: [ // PredictorEvaluationResults
52
+ * // { // EvaluationResult
53
+ * // AlgorithmArn: "STRING_VALUE",
54
+ * // TestWindows: [ // TestWindows
55
+ * // { // WindowSummary
56
+ * // TestWindowStart: new Date("TIMESTAMP"),
57
+ * // TestWindowEnd: new Date("TIMESTAMP"),
58
+ * // ItemCount: Number("int"),
59
+ * // EvaluationType: "SUMMARY" || "COMPUTED",
60
+ * // Metrics: { // Metrics
61
+ * // RMSE: Number("double"),
62
+ * // WeightedQuantileLosses: [ // WeightedQuantileLosses
63
+ * // { // WeightedQuantileLoss
64
+ * // Quantile: Number("double"),
65
+ * // LossValue: Number("double"),
66
+ * // },
67
+ * // ],
68
+ * // ErrorMetrics: [ // ErrorMetrics
69
+ * // { // ErrorMetric
70
+ * // ForecastType: "STRING_VALUE",
71
+ * // WAPE: Number("double"),
72
+ * // RMSE: Number("double"),
73
+ * // MASE: Number("double"),
74
+ * // MAPE: Number("double"),
75
+ * // },
76
+ * // ],
77
+ * // AverageWeightedQuantileLoss: Number("double"),
78
+ * // },
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // ],
83
+ * // IsAutoPredictor: true || false,
84
+ * // AutoMLOverrideStrategy: "LatencyOptimized" || "AccuracyOptimized",
85
+ * // OptimizationMetric: "WAPE" || "RMSE" || "AverageWeightedQuantileLoss" || "MASE" || "MAPE",
86
+ * // };
87
+ *
50
88
  * ```
51
89
  *
52
90
  * @param GetAccuracyMetricsCommandInput - {@link GetAccuracyMetricsCommandInput}
@@ -66,6 +104,8 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
66
104
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
67
105
  * again.</p>
68
106
  *
107
+ * @throws {@link ForecastServiceException}
108
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
69
109
  *
70
110
  */
71
111
  export declare class GetAccuracyMetricsCommand extends $Command<GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput, ForecastClientResolvedConfig> {
@@ -36,6 +36,18 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
36
36
  * };
37
37
  * const command = new ListDatasetGroupsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListDatasetGroupsResponse
40
+ * // DatasetGroups: [ // DatasetGroups
41
+ * // { // DatasetGroupSummary
42
+ * // DatasetGroupArn: "STRING_VALUE",
43
+ * // DatasetGroupName: "STRING_VALUE",
44
+ * // CreationTime: new Date("TIMESTAMP"),
45
+ * // LastModificationTime: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
39
51
  * ```
40
52
  *
41
53
  * @param ListDatasetGroupsCommandInput - {@link ListDatasetGroupsCommandInput}
@@ -47,6 +59,8 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons
47
59
  * @throws {@link InvalidNextTokenException} (client fault)
48
60
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
49
61
  *
62
+ * @throws {@link ForecastServiceException}
63
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
50
64
  *
51
65
  */
52
66
  export declare class ListDatasetGroupsCommand extends $Command<ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput, ForecastClientResolvedConfig> {
@@ -43,6 +43,28 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
43
43
  * };
44
44
  * const command = new ListDatasetImportJobsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListDatasetImportJobsResponse
47
+ * // DatasetImportJobs: [ // DatasetImportJobs
48
+ * // { // DatasetImportJobSummary
49
+ * // DatasetImportJobArn: "STRING_VALUE",
50
+ * // DatasetImportJobName: "STRING_VALUE",
51
+ * // DataSource: { // DataSource
52
+ * // S3Config: { // S3Config
53
+ * // Path: "STRING_VALUE", // required
54
+ * // RoleArn: "STRING_VALUE", // required
55
+ * // KMSKeyArn: "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // Status: "STRING_VALUE",
59
+ * // Message: "STRING_VALUE",
60
+ * // CreationTime: new Date("TIMESTAMP"),
61
+ * // LastModificationTime: new Date("TIMESTAMP"),
62
+ * // ImportMode: "FULL" || "INCREMENTAL",
63
+ * // },
64
+ * // ],
65
+ * // NextToken: "STRING_VALUE",
66
+ * // };
67
+ *
46
68
  * ```
47
69
  *
48
70
  * @param ListDatasetImportJobsCommandInput - {@link ListDatasetImportJobsCommandInput}
@@ -58,6 +80,8 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob
58
80
  * @throws {@link InvalidNextTokenException} (client fault)
59
81
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
60
82
  *
83
+ * @throws {@link ForecastServiceException}
84
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
61
85
  *
62
86
  */
63
87
  export declare class ListDatasetImportJobsCommand extends $Command<ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -34,6 +34,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
34
34
  * };
35
35
  * const command = new ListDatasetsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListDatasetsResponse
38
+ * // Datasets: [ // Datasets
39
+ * // { // DatasetSummary
40
+ * // DatasetArn: "STRING_VALUE",
41
+ * // DatasetName: "STRING_VALUE",
42
+ * // DatasetType: "TARGET_TIME_SERIES" || "RELATED_TIME_SERIES" || "ITEM_METADATA",
43
+ * // Domain: "RETAIL" || "CUSTOM" || "INVENTORY_PLANNING" || "EC2_CAPACITY" || "WORK_FORCE" || "WEB_TRAFFIC" || "METRICS",
44
+ * // CreationTime: new Date("TIMESTAMP"),
45
+ * // LastModificationTime: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // NextToken: "STRING_VALUE",
49
+ * // };
50
+ *
37
51
  * ```
38
52
  *
39
53
  * @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
@@ -45,6 +59,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
45
59
  * @throws {@link InvalidNextTokenException} (client fault)
46
60
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
47
61
  *
62
+ * @throws {@link ForecastServiceException}
63
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
48
64
  *
49
65
  */
50
66
  export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, ForecastClientResolvedConfig> {
@@ -43,6 +43,25 @@ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesR
43
43
  * };
44
44
  * const command = new ListExplainabilitiesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListExplainabilitiesResponse
47
+ * // Explainabilities: [ // Explainabilities
48
+ * // { // ExplainabilitySummary
49
+ * // ExplainabilityArn: "STRING_VALUE",
50
+ * // ExplainabilityName: "STRING_VALUE",
51
+ * // ResourceArn: "STRING_VALUE",
52
+ * // ExplainabilityConfig: { // ExplainabilityConfig
53
+ * // TimeSeriesGranularity: "ALL" || "SPECIFIC", // required
54
+ * // TimePointGranularity: "ALL" || "SPECIFIC", // required
55
+ * // },
56
+ * // Status: "STRING_VALUE",
57
+ * // Message: "STRING_VALUE",
58
+ * // CreationTime: new Date("TIMESTAMP"),
59
+ * // LastModificationTime: new Date("TIMESTAMP"),
60
+ * // },
61
+ * // ],
62
+ * // NextToken: "STRING_VALUE",
63
+ * // };
64
+ *
46
65
  * ```
47
66
  *
48
67
  * @param ListExplainabilitiesCommandInput - {@link ListExplainabilitiesCommandInput}
@@ -58,6 +77,8 @@ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesR
58
77
  * @throws {@link InvalidNextTokenException} (client fault)
59
78
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
60
79
  *
80
+ * @throws {@link ForecastServiceException}
81
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
61
82
  *
62
83
  */
63
84
  export declare class ListExplainabilitiesCommand extends $Command<ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput, ForecastClientResolvedConfig> {
@@ -42,6 +42,27 @@ export interface ListExplainabilityExportsCommandOutput extends ListExplainabili
42
42
  * };
43
43
  * const command = new ListExplainabilityExportsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListExplainabilityExportsResponse
46
+ * // ExplainabilityExports: [ // ExplainabilityExports
47
+ * // { // ExplainabilityExportSummary
48
+ * // ExplainabilityExportArn: "STRING_VALUE",
49
+ * // ExplainabilityExportName: "STRING_VALUE",
50
+ * // Destination: { // DataDestination
51
+ * // S3Config: { // S3Config
52
+ * // Path: "STRING_VALUE", // required
53
+ * // RoleArn: "STRING_VALUE", // required
54
+ * // KMSKeyArn: "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // Status: "STRING_VALUE",
58
+ * // Message: "STRING_VALUE",
59
+ * // CreationTime: new Date("TIMESTAMP"),
60
+ * // LastModificationTime: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
45
66
  * ```
46
67
  *
47
68
  * @param ListExplainabilityExportsCommandInput - {@link ListExplainabilityExportsCommandInput}
@@ -57,6 +78,8 @@ export interface ListExplainabilityExportsCommandOutput extends ListExplainabili
57
78
  * @throws {@link InvalidNextTokenException} (client fault)
58
79
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
59
80
  *
81
+ * @throws {@link ForecastServiceException}
82
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
60
83
  *
61
84
  */
62
85
  export declare class ListExplainabilityExportsCommand extends $Command<ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput, ForecastClientResolvedConfig> {
@@ -42,6 +42,27 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ
42
42
  * };
43
43
  * const command = new ListForecastExportJobsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListForecastExportJobsResponse
46
+ * // ForecastExportJobs: [ // ForecastExportJobs
47
+ * // { // ForecastExportJobSummary
48
+ * // ForecastExportJobArn: "STRING_VALUE",
49
+ * // ForecastExportJobName: "STRING_VALUE",
50
+ * // Destination: { // DataDestination
51
+ * // S3Config: { // S3Config
52
+ * // Path: "STRING_VALUE", // required
53
+ * // RoleArn: "STRING_VALUE", // required
54
+ * // KMSKeyArn: "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // Status: "STRING_VALUE",
58
+ * // Message: "STRING_VALUE",
59
+ * // CreationTime: new Date("TIMESTAMP"),
60
+ * // LastModificationTime: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
45
66
  * ```
46
67
  *
47
68
  * @param ListForecastExportJobsCommandInput - {@link ListForecastExportJobsCommandInput}
@@ -57,6 +78,8 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ
57
78
  * @throws {@link InvalidNextTokenException} (client fault)
58
79
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
59
80
  *
81
+ * @throws {@link ForecastServiceException}
82
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
60
83
  *
61
84
  */
62
85
  export declare class ListForecastExportJobsCommand extends $Command<ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -43,6 +43,23 @@ export interface ListForecastsCommandOutput extends ListForecastsResponse, __Met
43
43
  * };
44
44
  * const command = new ListForecastsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListForecastsResponse
47
+ * // Forecasts: [ // Forecasts
48
+ * // { // ForecastSummary
49
+ * // ForecastArn: "STRING_VALUE",
50
+ * // ForecastName: "STRING_VALUE",
51
+ * // PredictorArn: "STRING_VALUE",
52
+ * // CreatedUsingAutoPredictor: true || false,
53
+ * // DatasetGroupArn: "STRING_VALUE",
54
+ * // Status: "STRING_VALUE",
55
+ * // Message: "STRING_VALUE",
56
+ * // CreationTime: new Date("TIMESTAMP"),
57
+ * // LastModificationTime: new Date("TIMESTAMP"),
58
+ * // },
59
+ * // ],
60
+ * // NextToken: "STRING_VALUE",
61
+ * // };
62
+ *
46
63
  * ```
47
64
  *
48
65
  * @param ListForecastsCommandInput - {@link ListForecastsCommandInput}
@@ -58,6 +75,8 @@ export interface ListForecastsCommandOutput extends ListForecastsResponse, __Met
58
75
  * @throws {@link InvalidNextTokenException} (client fault)
59
76
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
60
77
  *
78
+ * @throws {@link ForecastServiceException}
79
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
61
80
  *
62
81
  */
63
82
  export declare class ListForecastsCommand extends $Command<ListForecastsCommandInput, ListForecastsCommandOutput, ForecastClientResolvedConfig> {
@@ -43,6 +43,37 @@ export interface ListMonitorEvaluationsCommandOutput extends ListMonitorEvaluati
43
43
  * };
44
44
  * const command = new ListMonitorEvaluationsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListMonitorEvaluationsResponse
47
+ * // NextToken: "STRING_VALUE",
48
+ * // PredictorMonitorEvaluations: [ // PredictorMonitorEvaluations
49
+ * // { // PredictorMonitorEvaluation
50
+ * // ResourceArn: "STRING_VALUE",
51
+ * // MonitorArn: "STRING_VALUE",
52
+ * // EvaluationTime: new Date("TIMESTAMP"),
53
+ * // EvaluationState: "STRING_VALUE",
54
+ * // WindowStartDatetime: new Date("TIMESTAMP"),
55
+ * // WindowEndDatetime: new Date("TIMESTAMP"),
56
+ * // PredictorEvent: { // PredictorEvent
57
+ * // Detail: "STRING_VALUE",
58
+ * // Datetime: new Date("TIMESTAMP"),
59
+ * // },
60
+ * // MonitorDataSource: { // MonitorDataSource
61
+ * // DatasetImportJobArn: "STRING_VALUE",
62
+ * // ForecastArn: "STRING_VALUE",
63
+ * // PredictorArn: "STRING_VALUE",
64
+ * // },
65
+ * // MetricResults: [ // MetricResults
66
+ * // { // MetricResult
67
+ * // MetricName: "STRING_VALUE",
68
+ * // MetricValue: Number("double"),
69
+ * // },
70
+ * // ],
71
+ * // NumItemsEvaluated: Number("long"),
72
+ * // Message: "STRING_VALUE",
73
+ * // },
74
+ * // ],
75
+ * // };
76
+ *
46
77
  * ```
47
78
  *
48
79
  * @param ListMonitorEvaluationsCommandInput - {@link ListMonitorEvaluationsCommandInput}
@@ -62,6 +93,8 @@ export interface ListMonitorEvaluationsCommandOutput extends ListMonitorEvaluati
62
93
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
63
94
  * again.</p>
64
95
  *
96
+ * @throws {@link ForecastServiceException}
97
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
65
98
  *
66
99
  */
67
100
  export declare class ListMonitorEvaluationsCommand extends $Command<ListMonitorEvaluationsCommandInput, ListMonitorEvaluationsCommandOutput, ForecastClientResolvedConfig> {
@@ -40,6 +40,20 @@ export interface ListMonitorsCommandOutput extends ListMonitorsResponse, __Metad
40
40
  * };
41
41
  * const command = new ListMonitorsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // ListMonitorsResponse
44
+ * // Monitors: [ // Monitors
45
+ * // { // MonitorSummary
46
+ * // MonitorArn: "STRING_VALUE",
47
+ * // MonitorName: "STRING_VALUE",
48
+ * // ResourceArn: "STRING_VALUE",
49
+ * // Status: "STRING_VALUE",
50
+ * // CreationTime: new Date("TIMESTAMP"),
51
+ * // LastModificationTime: new Date("TIMESTAMP"),
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
43
57
  * ```
44
58
  *
45
59
  * @param ListMonitorsCommandInput - {@link ListMonitorsCommandInput}
@@ -55,6 +69,8 @@ export interface ListMonitorsCommandOutput extends ListMonitorsResponse, __Metad
55
69
  * @throws {@link InvalidNextTokenException} (client fault)
56
70
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
57
71
  *
72
+ * @throws {@link ForecastServiceException}
73
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
58
74
  *
59
75
  */
60
76
  export declare class ListMonitorsCommand extends $Command<ListMonitorsCommandInput, ListMonitorsCommandOutput, ForecastClientResolvedConfig> {
@@ -42,6 +42,27 @@ export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredic
42
42
  * };
43
43
  * const command = new ListPredictorBacktestExportJobsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // ListPredictorBacktestExportJobsResponse
46
+ * // PredictorBacktestExportJobs: [ // PredictorBacktestExportJobs
47
+ * // { // PredictorBacktestExportJobSummary
48
+ * // PredictorBacktestExportJobArn: "STRING_VALUE",
49
+ * // PredictorBacktestExportJobName: "STRING_VALUE",
50
+ * // Destination: { // DataDestination
51
+ * // S3Config: { // S3Config
52
+ * // Path: "STRING_VALUE", // required
53
+ * // RoleArn: "STRING_VALUE", // required
54
+ * // KMSKeyArn: "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // Status: "STRING_VALUE",
58
+ * // Message: "STRING_VALUE",
59
+ * // CreationTime: new Date("TIMESTAMP"),
60
+ * // LastModificationTime: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
45
66
  * ```
46
67
  *
47
68
  * @param ListPredictorBacktestExportJobsCommandInput - {@link ListPredictorBacktestExportJobsCommandInput}
@@ -57,6 +78,8 @@ export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredic
57
78
  * @throws {@link InvalidNextTokenException} (client fault)
58
79
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
59
80
  *
81
+ * @throws {@link ForecastServiceException}
82
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
60
83
  *
61
84
  */
62
85
  export declare class ListPredictorBacktestExportJobsCommand extends $Command<ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput, ForecastClientResolvedConfig> {
@@ -43,6 +43,26 @@ export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __M
43
43
  * };
44
44
  * const command = new ListPredictorsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListPredictorsResponse
47
+ * // Predictors: [ // Predictors
48
+ * // { // PredictorSummary
49
+ * // PredictorArn: "STRING_VALUE",
50
+ * // PredictorName: "STRING_VALUE",
51
+ * // DatasetGroupArn: "STRING_VALUE",
52
+ * // IsAutoPredictor: true || false,
53
+ * // ReferencePredictorSummary: { // ReferencePredictorSummary
54
+ * // Arn: "STRING_VALUE",
55
+ * // State: "Active" || "Deleted",
56
+ * // },
57
+ * // Status: "STRING_VALUE",
58
+ * // Message: "STRING_VALUE",
59
+ * // CreationTime: new Date("TIMESTAMP"),
60
+ * // LastModificationTime: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
46
66
  * ```
47
67
  *
48
68
  * @param ListPredictorsCommandInput - {@link ListPredictorsCommandInput}
@@ -58,6 +78,8 @@ export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __M
58
78
  * @throws {@link InvalidNextTokenException} (client fault)
59
79
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
60
80
  *
81
+ * @throws {@link ForecastServiceException}
82
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
61
83
  *
62
84
  */
63
85
  export declare class ListPredictorsCommand extends $Command<ListPredictorsCommandInput, ListPredictorsCommandOutput, ForecastClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // Tags: [ // Tags
36
+ * // { // Tag
37
+ * // Key: "STRING_VALUE", // required
38
+ * // Value: "STRING_VALUE", // required
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -47,6 +56,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
47
56
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
48
57
  * again.</p>
49
58
  *
59
+ * @throws {@link ForecastServiceException}
60
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
50
61
  *
51
62
  */
52
63
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -39,6 +39,21 @@ export interface ListWhatIfAnalysesCommandOutput extends ListWhatIfAnalysesRespo
39
39
  * };
40
40
  * const command = new ListWhatIfAnalysesCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListWhatIfAnalysesResponse
43
+ * // WhatIfAnalyses: [ // WhatIfAnalyses
44
+ * // { // WhatIfAnalysisSummary
45
+ * // WhatIfAnalysisArn: "STRING_VALUE",
46
+ * // WhatIfAnalysisName: "STRING_VALUE",
47
+ * // ForecastArn: "STRING_VALUE",
48
+ * // Status: "STRING_VALUE",
49
+ * // Message: "STRING_VALUE",
50
+ * // CreationTime: new Date("TIMESTAMP"),
51
+ * // LastModificationTime: new Date("TIMESTAMP"),
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
42
57
  * ```
43
58
  *
44
59
  * @param ListWhatIfAnalysesCommandInput - {@link ListWhatIfAnalysesCommandInput}
@@ -54,6 +69,8 @@ export interface ListWhatIfAnalysesCommandOutput extends ListWhatIfAnalysesRespo
54
69
  * @throws {@link InvalidNextTokenException} (client fault)
55
70
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
56
71
  *
72
+ * @throws {@link ForecastServiceException}
73
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
57
74
  *
58
75
  */
59
76
  export declare class ListWhatIfAnalysesCommand extends $Command<ListWhatIfAnalysesCommandInput, ListWhatIfAnalysesCommandOutput, ForecastClientResolvedConfig> {
@@ -39,6 +39,30 @@ export interface ListWhatIfForecastExportsCommandOutput extends ListWhatIfForeca
39
39
  * };
40
40
  * const command = new ListWhatIfForecastExportsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListWhatIfForecastExportsResponse
43
+ * // WhatIfForecastExports: [ // WhatIfForecastExports
44
+ * // { // WhatIfForecastExportSummary
45
+ * // WhatIfForecastExportArn: "STRING_VALUE",
46
+ * // WhatIfForecastArns: [ // WhatIfForecastArnListForExport
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // WhatIfForecastExportName: "STRING_VALUE",
50
+ * // Destination: { // DataDestination
51
+ * // S3Config: { // S3Config
52
+ * // Path: "STRING_VALUE", // required
53
+ * // RoleArn: "STRING_VALUE", // required
54
+ * // KMSKeyArn: "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // Status: "STRING_VALUE",
58
+ * // Message: "STRING_VALUE",
59
+ * // CreationTime: new Date("TIMESTAMP"),
60
+ * // LastModificationTime: new Date("TIMESTAMP"),
61
+ * // },
62
+ * // ],
63
+ * // NextToken: "STRING_VALUE",
64
+ * // };
65
+ *
42
66
  * ```
43
67
  *
44
68
  * @param ListWhatIfForecastExportsCommandInput - {@link ListWhatIfForecastExportsCommandInput}
@@ -54,6 +78,8 @@ export interface ListWhatIfForecastExportsCommandOutput extends ListWhatIfForeca
54
78
  * @throws {@link InvalidNextTokenException} (client fault)
55
79
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
56
80
  *
81
+ * @throws {@link ForecastServiceException}
82
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
57
83
  *
58
84
  */
59
85
  export declare class ListWhatIfForecastExportsCommand extends $Command<ListWhatIfForecastExportsCommandInput, ListWhatIfForecastExportsCommandOutput, ForecastClientResolvedConfig> {
@@ -39,6 +39,21 @@ export interface ListWhatIfForecastsCommandOutput extends ListWhatIfForecastsRes
39
39
  * };
40
40
  * const command = new ListWhatIfForecastsCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ListWhatIfForecastsResponse
43
+ * // WhatIfForecasts: [ // WhatIfForecasts
44
+ * // { // WhatIfForecastSummary
45
+ * // WhatIfForecastArn: "STRING_VALUE",
46
+ * // WhatIfForecastName: "STRING_VALUE",
47
+ * // WhatIfAnalysisArn: "STRING_VALUE",
48
+ * // Status: "STRING_VALUE",
49
+ * // Message: "STRING_VALUE",
50
+ * // CreationTime: new Date("TIMESTAMP"),
51
+ * // LastModificationTime: new Date("TIMESTAMP"),
52
+ * // },
53
+ * // ],
54
+ * // NextToken: "STRING_VALUE",
55
+ * // };
56
+ *
42
57
  * ```
43
58
  *
44
59
  * @param ListWhatIfForecastsCommandInput - {@link ListWhatIfForecastsCommandInput}
@@ -54,6 +69,8 @@ export interface ListWhatIfForecastsCommandOutput extends ListWhatIfForecastsRes
54
69
  * @throws {@link InvalidNextTokenException} (client fault)
55
70
  * <p>The token is not valid. Tokens expire after 24 hours.</p>
56
71
  *
72
+ * @throws {@link ForecastServiceException}
73
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
57
74
  *
58
75
  */
59
76
  export declare class ListWhatIfForecastsCommand extends $Command<ListWhatIfForecastsCommandInput, ListWhatIfForecastsCommandOutput, ForecastClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface ResumeResourceCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new ResumeResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param ResumeResourceCommandInput - {@link ResumeResourceCommandInput}
@@ -53,6 +55,8 @@ export interface ResumeResourceCommandOutput extends __MetadataBearer {
53
55
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
54
56
  * again.</p>
55
57
  *
58
+ * @throws {@link ForecastServiceException}
59
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
56
60
  *
57
61
  */
58
62
  export declare class ResumeResourceCommand extends $Command<ResumeResourceCommandInput, ResumeResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -59,6 +59,8 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
59
59
  * };
60
60
  * const command = new StopResourceCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // {};
63
+ *
62
64
  * ```
63
65
  *
64
66
  * @param StopResourceCommandInput - {@link StopResourceCommandInput}
@@ -78,6 +80,8 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
78
80
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
79
81
  * again.</p>
80
82
  *
83
+ * @throws {@link ForecastServiceException}
84
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
81
85
  *
82
86
  */
83
87
  export declare class StopResourceCommand extends $Command<StopResourceCommandInput, StopResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -40,6 +40,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
40
40
  * };
41
41
  * const command = new TagResourceCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -59,6 +61,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
59
61
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
60
62
  * again.</p>
61
63
  *
64
+ * @throws {@link ForecastServiceException}
65
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
62
66
  *
63
67
  */
64
68
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ForecastClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -50,6 +52,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
50
52
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
51
53
  * again.</p>
52
54
  *
55
+ * @throws {@link ForecastServiceException}
56
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
53
57
  *
54
58
  */
55
59
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ForecastClientResolvedConfig> {