@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
@@ -50,6 +50,29 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
50
50
  * };
51
51
  * const command = new DescribeDatasetCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // DescribeDatasetResponse
54
+ * // DatasetArn: "STRING_VALUE",
55
+ * // DatasetName: "STRING_VALUE",
56
+ * // Domain: "RETAIL" || "CUSTOM" || "INVENTORY_PLANNING" || "EC2_CAPACITY" || "WORK_FORCE" || "WEB_TRAFFIC" || "METRICS",
57
+ * // DatasetType: "TARGET_TIME_SERIES" || "RELATED_TIME_SERIES" || "ITEM_METADATA",
58
+ * // DataFrequency: "STRING_VALUE",
59
+ * // Schema: { // Schema
60
+ * // Attributes: [ // SchemaAttributes
61
+ * // { // SchemaAttribute
62
+ * // AttributeName: "STRING_VALUE",
63
+ * // AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // EncryptionConfig: { // EncryptionConfig
68
+ * // RoleArn: "STRING_VALUE", // required
69
+ * // KMSKeyArn: "STRING_VALUE", // required
70
+ * // },
71
+ * // Status: "STRING_VALUE",
72
+ * // CreationTime: new Date("TIMESTAMP"),
73
+ * // LastModificationTime: new Date("TIMESTAMP"),
74
+ * // };
75
+ *
53
76
  * ```
54
77
  *
55
78
  * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
@@ -66,6 +89,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
66
89
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
67
90
  * again.</p>
68
91
  *
92
+ * @throws {@link ForecastServiceException}
93
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
69
94
  *
70
95
  */
71
96
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, ForecastClientResolvedConfig> {
@@ -55,6 +55,18 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR
55
55
  * };
56
56
  * const command = new DescribeDatasetGroupCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // DescribeDatasetGroupResponse
59
+ * // DatasetGroupName: "STRING_VALUE",
60
+ * // DatasetGroupArn: "STRING_VALUE",
61
+ * // DatasetArns: [ // ArnList
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // Domain: "RETAIL" || "CUSTOM" || "INVENTORY_PLANNING" || "EC2_CAPACITY" || "WORK_FORCE" || "WEB_TRAFFIC" || "METRICS",
65
+ * // Status: "STRING_VALUE",
66
+ * // CreationTime: new Date("TIMESTAMP"),
67
+ * // LastModificationTime: new Date("TIMESTAMP"),
68
+ * // };
69
+ *
58
70
  * ```
59
71
  *
60
72
  * @param DescribeDatasetGroupCommandInput - {@link DescribeDatasetGroupCommandInput}
@@ -71,6 +83,8 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR
71
83
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
72
84
  * again.</p>
73
85
  *
86
+ * @throws {@link ForecastServiceException}
87
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
74
88
  *
75
89
  */
76
90
  export declare class DescribeDatasetGroupCommand extends $Command<DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
@@ -65,6 +65,47 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm
65
65
  * };
66
66
  * const command = new DescribeDatasetImportJobCommand(input);
67
67
  * const response = await client.send(command);
68
+ * // { // DescribeDatasetImportJobResponse
69
+ * // DatasetImportJobName: "STRING_VALUE",
70
+ * // DatasetImportJobArn: "STRING_VALUE",
71
+ * // DatasetArn: "STRING_VALUE",
72
+ * // TimestampFormat: "STRING_VALUE",
73
+ * // TimeZone: "STRING_VALUE",
74
+ * // UseGeolocationForTimeZone: true || false,
75
+ * // GeolocationFormat: "STRING_VALUE",
76
+ * // DataSource: { // DataSource
77
+ * // S3Config: { // S3Config
78
+ * // Path: "STRING_VALUE", // required
79
+ * // RoleArn: "STRING_VALUE", // required
80
+ * // KMSKeyArn: "STRING_VALUE",
81
+ * // },
82
+ * // },
83
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
84
+ * // FieldStatistics: { // FieldStatistics
85
+ * // "<keys>": { // Statistics
86
+ * // Count: Number("int"),
87
+ * // CountDistinct: Number("int"),
88
+ * // CountNull: Number("int"),
89
+ * // CountNan: Number("int"),
90
+ * // Min: "STRING_VALUE",
91
+ * // Max: "STRING_VALUE",
92
+ * // Avg: Number("double"),
93
+ * // Stddev: Number("double"),
94
+ * // CountLong: Number("long"),
95
+ * // CountDistinctLong: Number("long"),
96
+ * // CountNullLong: Number("long"),
97
+ * // CountNanLong: Number("long"),
98
+ * // },
99
+ * // },
100
+ * // DataSize: Number("double"),
101
+ * // Status: "STRING_VALUE",
102
+ * // Message: "STRING_VALUE",
103
+ * // CreationTime: new Date("TIMESTAMP"),
104
+ * // LastModificationTime: new Date("TIMESTAMP"),
105
+ * // Format: "STRING_VALUE",
106
+ * // ImportMode: "FULL" || "INCREMENTAL",
107
+ * // };
108
+ *
68
109
  * ```
69
110
  *
70
111
  * @param DescribeDatasetImportJobCommandInput - {@link DescribeDatasetImportJobCommandInput}
@@ -81,6 +122,8 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm
81
122
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
82
123
  * again.</p>
83
124
  *
125
+ * @throws {@link ForecastServiceException}
126
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
84
127
  *
85
128
  */
86
129
  export declare class DescribeDatasetImportJobCommand extends $Command<DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -31,6 +31,39 @@ export interface DescribeExplainabilityCommandOutput extends DescribeExplainabil
31
31
  * };
32
32
  * const command = new DescribeExplainabilityCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeExplainabilityResponse
35
+ * // ExplainabilityArn: "STRING_VALUE",
36
+ * // ExplainabilityName: "STRING_VALUE",
37
+ * // ResourceArn: "STRING_VALUE",
38
+ * // ExplainabilityConfig: { // ExplainabilityConfig
39
+ * // TimeSeriesGranularity: "ALL" || "SPECIFIC", // required
40
+ * // TimePointGranularity: "ALL" || "SPECIFIC", // required
41
+ * // },
42
+ * // EnableVisualization: true || false,
43
+ * // DataSource: { // DataSource
44
+ * // S3Config: { // S3Config
45
+ * // Path: "STRING_VALUE", // required
46
+ * // RoleArn: "STRING_VALUE", // required
47
+ * // KMSKeyArn: "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // Schema: { // Schema
51
+ * // Attributes: [ // SchemaAttributes
52
+ * // { // SchemaAttribute
53
+ * // AttributeName: "STRING_VALUE",
54
+ * // AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
55
+ * // },
56
+ * // ],
57
+ * // },
58
+ * // StartDateTime: "STRING_VALUE",
59
+ * // EndDateTime: "STRING_VALUE",
60
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
61
+ * // Message: "STRING_VALUE",
62
+ * // Status: "STRING_VALUE",
63
+ * // CreationTime: new Date("TIMESTAMP"),
64
+ * // LastModificationTime: new Date("TIMESTAMP"),
65
+ * // };
66
+ *
34
67
  * ```
35
68
  *
36
69
  * @param DescribeExplainabilityCommandInput - {@link DescribeExplainabilityCommandInput}
@@ -47,6 +80,8 @@ export interface DescribeExplainabilityCommandOutput extends DescribeExplainabil
47
80
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
48
81
  * again.</p>
49
82
  *
83
+ * @throws {@link ForecastServiceException}
84
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
50
85
  *
51
86
  */
52
87
  export declare class DescribeExplainabilityCommand extends $Command<DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput, ForecastClientResolvedConfig> {
@@ -31,6 +31,24 @@ export interface DescribeExplainabilityExportCommandOutput extends DescribeExpla
31
31
  * };
32
32
  * const command = new DescribeExplainabilityExportCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeExplainabilityExportResponse
35
+ * // ExplainabilityExportArn: "STRING_VALUE",
36
+ * // ExplainabilityExportName: "STRING_VALUE",
37
+ * // ExplainabilityArn: "STRING_VALUE",
38
+ * // Destination: { // DataDestination
39
+ * // S3Config: { // S3Config
40
+ * // Path: "STRING_VALUE", // required
41
+ * // RoleArn: "STRING_VALUE", // required
42
+ * // KMSKeyArn: "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // Message: "STRING_VALUE",
46
+ * // Status: "STRING_VALUE",
47
+ * // CreationTime: new Date("TIMESTAMP"),
48
+ * // LastModificationTime: new Date("TIMESTAMP"),
49
+ * // Format: "STRING_VALUE",
50
+ * // };
51
+ *
34
52
  * ```
35
53
  *
36
54
  * @param DescribeExplainabilityExportCommandInput - {@link DescribeExplainabilityExportCommandInput}
@@ -47,6 +65,8 @@ export interface DescribeExplainabilityExportCommandOutput extends DescribeExpla
47
65
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
48
66
  * again.</p>
49
67
  *
68
+ * @throws {@link ForecastServiceException}
69
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
50
70
  *
51
71
  */
52
72
  export declare class DescribeExplainabilityExportCommand extends $Command<DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput, ForecastClientResolvedConfig> {
@@ -59,6 +59,41 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse,
59
59
  * };
60
60
  * const command = new DescribeForecastCommand(input);
61
61
  * const response = await client.send(command);
62
+ * // { // DescribeForecastResponse
63
+ * // ForecastArn: "STRING_VALUE",
64
+ * // ForecastName: "STRING_VALUE",
65
+ * // ForecastTypes: [ // ForecastTypes
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // PredictorArn: "STRING_VALUE",
69
+ * // DatasetGroupArn: "STRING_VALUE",
70
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
71
+ * // Status: "STRING_VALUE",
72
+ * // Message: "STRING_VALUE",
73
+ * // CreationTime: new Date("TIMESTAMP"),
74
+ * // LastModificationTime: new Date("TIMESTAMP"),
75
+ * // TimeSeriesSelector: { // TimeSeriesSelector
76
+ * // TimeSeriesIdentifiers: { // TimeSeriesIdentifiers
77
+ * // DataSource: { // DataSource
78
+ * // S3Config: { // S3Config
79
+ * // Path: "STRING_VALUE", // required
80
+ * // RoleArn: "STRING_VALUE", // required
81
+ * // KMSKeyArn: "STRING_VALUE",
82
+ * // },
83
+ * // },
84
+ * // Schema: { // Schema
85
+ * // Attributes: [ // SchemaAttributes
86
+ * // { // SchemaAttribute
87
+ * // AttributeName: "STRING_VALUE",
88
+ * // AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
89
+ * // },
90
+ * // ],
91
+ * // },
92
+ * // Format: "STRING_VALUE",
93
+ * // },
94
+ * // },
95
+ * // };
96
+ *
62
97
  * ```
63
98
  *
64
99
  * @param DescribeForecastCommandInput - {@link DescribeForecastCommandInput}
@@ -75,6 +110,8 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse,
75
110
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
76
111
  * again.</p>
77
112
  *
113
+ * @throws {@link ForecastServiceException}
114
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
78
115
  *
79
116
  */
80
117
  export declare class DescribeForecastCommand extends $Command<DescribeForecastCommandInput, DescribeForecastCommandOutput, ForecastClientResolvedConfig> {
@@ -55,6 +55,24 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast
55
55
  * };
56
56
  * const command = new DescribeForecastExportJobCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // DescribeForecastExportJobResponse
59
+ * // ForecastExportJobArn: "STRING_VALUE",
60
+ * // ForecastExportJobName: "STRING_VALUE",
61
+ * // ForecastArn: "STRING_VALUE",
62
+ * // Destination: { // DataDestination
63
+ * // S3Config: { // S3Config
64
+ * // Path: "STRING_VALUE", // required
65
+ * // RoleArn: "STRING_VALUE", // required
66
+ * // KMSKeyArn: "STRING_VALUE",
67
+ * // },
68
+ * // },
69
+ * // Message: "STRING_VALUE",
70
+ * // Status: "STRING_VALUE",
71
+ * // CreationTime: new Date("TIMESTAMP"),
72
+ * // LastModificationTime: new Date("TIMESTAMP"),
73
+ * // Format: "STRING_VALUE",
74
+ * // };
75
+ *
58
76
  * ```
59
77
  *
60
78
  * @param DescribeForecastExportJobCommandInput - {@link DescribeForecastExportJobCommandInput}
@@ -71,6 +89,8 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast
71
89
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
72
90
  * again.</p>
73
91
  *
92
+ * @throws {@link ForecastServiceException}
93
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
74
94
  *
75
95
  */
76
96
  export declare class DescribeForecastExportJobCommand extends $Command<DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -68,6 +68,29 @@ export interface DescribeMonitorCommandOutput extends DescribeMonitorResponse, _
68
68
  * };
69
69
  * const command = new DescribeMonitorCommand(input);
70
70
  * const response = await client.send(command);
71
+ * // { // DescribeMonitorResponse
72
+ * // MonitorName: "STRING_VALUE",
73
+ * // MonitorArn: "STRING_VALUE",
74
+ * // ResourceArn: "STRING_VALUE",
75
+ * // Status: "STRING_VALUE",
76
+ * // LastEvaluationTime: new Date("TIMESTAMP"),
77
+ * // LastEvaluationState: "STRING_VALUE",
78
+ * // Baseline: { // Baseline
79
+ * // PredictorBaseline: { // PredictorBaseline
80
+ * // BaselineMetrics: [ // BaselineMetrics
81
+ * // { // BaselineMetric
82
+ * // Name: "STRING_VALUE",
83
+ * // Value: Number("double"),
84
+ * // },
85
+ * // ],
86
+ * // },
87
+ * // },
88
+ * // Message: "STRING_VALUE",
89
+ * // CreationTime: new Date("TIMESTAMP"),
90
+ * // LastModificationTime: new Date("TIMESTAMP"),
91
+ * // EstimatedEvaluationTimeRemainingInMinutes: Number("long"),
92
+ * // };
93
+ *
71
94
  * ```
72
95
  *
73
96
  * @param DescribeMonitorCommandInput - {@link DescribeMonitorCommandInput}
@@ -84,6 +107,8 @@ export interface DescribeMonitorCommandOutput extends DescribeMonitorResponse, _
84
107
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
85
108
  * again.</p>
86
109
  *
110
+ * @throws {@link ForecastServiceException}
111
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
87
112
  *
88
113
  */
89
114
  export declare class DescribeMonitorCommand extends $Command<DescribeMonitorCommandInput, DescribeMonitorCommandOutput, ForecastClientResolvedConfig> {
@@ -55,6 +55,24 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
55
55
  * };
56
56
  * const command = new DescribePredictorBacktestExportJobCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // DescribePredictorBacktestExportJobResponse
59
+ * // PredictorBacktestExportJobArn: "STRING_VALUE",
60
+ * // PredictorBacktestExportJobName: "STRING_VALUE",
61
+ * // PredictorArn: "STRING_VALUE",
62
+ * // Destination: { // DataDestination
63
+ * // S3Config: { // S3Config
64
+ * // Path: "STRING_VALUE", // required
65
+ * // RoleArn: "STRING_VALUE", // required
66
+ * // KMSKeyArn: "STRING_VALUE",
67
+ * // },
68
+ * // },
69
+ * // Message: "STRING_VALUE",
70
+ * // Status: "STRING_VALUE",
71
+ * // CreationTime: new Date("TIMESTAMP"),
72
+ * // LastModificationTime: new Date("TIMESTAMP"),
73
+ * // Format: "STRING_VALUE",
74
+ * // };
75
+ *
58
76
  * ```
59
77
  *
60
78
  * @param DescribePredictorBacktestExportJobCommandInput - {@link DescribePredictorBacktestExportJobCommandInput}
@@ -71,6 +89,8 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
71
89
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
72
90
  * again.</p>
73
91
  *
92
+ * @throws {@link ForecastServiceException}
93
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
74
94
  *
75
95
  */
76
96
  export declare class DescribePredictorBacktestExportJobCommand extends $Command<DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput, ForecastClientResolvedConfig> {
@@ -69,6 +69,114 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
69
69
  * };
70
70
  * const command = new DescribePredictorCommand(input);
71
71
  * const response = await client.send(command);
72
+ * // { // DescribePredictorResponse
73
+ * // PredictorArn: "STRING_VALUE",
74
+ * // PredictorName: "STRING_VALUE",
75
+ * // AlgorithmArn: "STRING_VALUE",
76
+ * // AutoMLAlgorithmArns: [ // ArnList
77
+ * // "STRING_VALUE",
78
+ * // ],
79
+ * // ForecastHorizon: Number("int"),
80
+ * // ForecastTypes: [ // ForecastTypes
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // PerformAutoML: true || false,
84
+ * // AutoMLOverrideStrategy: "LatencyOptimized" || "AccuracyOptimized",
85
+ * // PerformHPO: true || false,
86
+ * // TrainingParameters: { // TrainingParameters
87
+ * // "<keys>": "STRING_VALUE",
88
+ * // },
89
+ * // EvaluationParameters: { // EvaluationParameters
90
+ * // NumberOfBacktestWindows: Number("int"),
91
+ * // BackTestWindowOffset: Number("int"),
92
+ * // },
93
+ * // HPOConfig: { // HyperParameterTuningJobConfig
94
+ * // ParameterRanges: { // ParameterRanges
95
+ * // CategoricalParameterRanges: [ // CategoricalParameterRanges
96
+ * // { // CategoricalParameterRange
97
+ * // Name: "STRING_VALUE", // required
98
+ * // Values: [ // Values // required
99
+ * // "STRING_VALUE",
100
+ * // ],
101
+ * // },
102
+ * // ],
103
+ * // ContinuousParameterRanges: [ // ContinuousParameterRanges
104
+ * // { // ContinuousParameterRange
105
+ * // Name: "STRING_VALUE", // required
106
+ * // MaxValue: Number("double"), // required
107
+ * // MinValue: Number("double"), // required
108
+ * // ScalingType: "Auto" || "Linear" || "Logarithmic" || "ReverseLogarithmic",
109
+ * // },
110
+ * // ],
111
+ * // IntegerParameterRanges: [ // IntegerParameterRanges
112
+ * // { // IntegerParameterRange
113
+ * // Name: "STRING_VALUE", // required
114
+ * // MaxValue: Number("int"), // required
115
+ * // MinValue: Number("int"), // required
116
+ * // ScalingType: "Auto" || "Linear" || "Logarithmic" || "ReverseLogarithmic",
117
+ * // },
118
+ * // ],
119
+ * // },
120
+ * // },
121
+ * // InputDataConfig: { // InputDataConfig
122
+ * // DatasetGroupArn: "STRING_VALUE", // required
123
+ * // SupplementaryFeatures: [ // SupplementaryFeatures
124
+ * // { // SupplementaryFeature
125
+ * // Name: "STRING_VALUE", // required
126
+ * // Value: "STRING_VALUE", // required
127
+ * // },
128
+ * // ],
129
+ * // },
130
+ * // FeaturizationConfig: { // FeaturizationConfig
131
+ * // ForecastFrequency: "STRING_VALUE", // required
132
+ * // ForecastDimensions: [ // ForecastDimensions
133
+ * // "STRING_VALUE",
134
+ * // ],
135
+ * // Featurizations: [ // Featurizations
136
+ * // { // Featurization
137
+ * // AttributeName: "STRING_VALUE", // required
138
+ * // FeaturizationPipeline: [ // FeaturizationPipeline
139
+ * // { // FeaturizationMethod
140
+ * // FeaturizationMethodName: "filling", // required
141
+ * // FeaturizationMethodParameters: { // FeaturizationMethodParameters
142
+ * // "<keys>": "STRING_VALUE",
143
+ * // },
144
+ * // },
145
+ * // ],
146
+ * // },
147
+ * // ],
148
+ * // },
149
+ * // EncryptionConfig: { // EncryptionConfig
150
+ * // RoleArn: "STRING_VALUE", // required
151
+ * // KMSKeyArn: "STRING_VALUE", // required
152
+ * // },
153
+ * // PredictorExecutionDetails: { // PredictorExecutionDetails
154
+ * // PredictorExecutions: [ // PredictorExecutions
155
+ * // { // PredictorExecution
156
+ * // AlgorithmArn: "STRING_VALUE",
157
+ * // TestWindows: [ // TestWindowDetails
158
+ * // { // TestWindowSummary
159
+ * // TestWindowStart: new Date("TIMESTAMP"),
160
+ * // TestWindowEnd: new Date("TIMESTAMP"),
161
+ * // Status: "STRING_VALUE",
162
+ * // Message: "STRING_VALUE",
163
+ * // },
164
+ * // ],
165
+ * // },
166
+ * // ],
167
+ * // },
168
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
169
+ * // IsAutoPredictor: true || false,
170
+ * // DatasetImportJobArns: [
171
+ * // "STRING_VALUE",
172
+ * // ],
173
+ * // Status: "STRING_VALUE",
174
+ * // Message: "STRING_VALUE",
175
+ * // CreationTime: new Date("TIMESTAMP"),
176
+ * // LastModificationTime: new Date("TIMESTAMP"),
177
+ * // OptimizationMetric: "WAPE" || "RMSE" || "AverageWeightedQuantileLoss" || "MASE" || "MAPE",
178
+ * // };
179
+ *
72
180
  * ```
73
181
  *
74
182
  * @param DescribePredictorCommandInput - {@link DescribePredictorCommandInput}
@@ -85,6 +193,8 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
85
193
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
86
194
  * again.</p>
87
195
  *
196
+ * @throws {@link ForecastServiceException}
197
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
88
198
  *
89
199
  */
90
200
  export declare class DescribePredictorCommand extends $Command<DescribePredictorCommandInput, DescribePredictorCommandOutput, ForecastClientResolvedConfig> {
@@ -53,6 +53,37 @@ export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnaly
53
53
  * };
54
54
  * const command = new DescribeWhatIfAnalysisCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // DescribeWhatIfAnalysisResponse
57
+ * // WhatIfAnalysisName: "STRING_VALUE",
58
+ * // WhatIfAnalysisArn: "STRING_VALUE",
59
+ * // ForecastArn: "STRING_VALUE",
60
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
61
+ * // Status: "STRING_VALUE",
62
+ * // Message: "STRING_VALUE",
63
+ * // CreationTime: new Date("TIMESTAMP"),
64
+ * // LastModificationTime: new Date("TIMESTAMP"),
65
+ * // TimeSeriesSelector: { // TimeSeriesSelector
66
+ * // TimeSeriesIdentifiers: { // TimeSeriesIdentifiers
67
+ * // DataSource: { // DataSource
68
+ * // S3Config: { // S3Config
69
+ * // Path: "STRING_VALUE", // required
70
+ * // RoleArn: "STRING_VALUE", // required
71
+ * // KMSKeyArn: "STRING_VALUE",
72
+ * // },
73
+ * // },
74
+ * // Schema: { // Schema
75
+ * // Attributes: [ // SchemaAttributes
76
+ * // { // SchemaAttribute
77
+ * // AttributeName: "STRING_VALUE",
78
+ * // AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // Format: "STRING_VALUE",
83
+ * // },
84
+ * // },
85
+ * // };
86
+ *
56
87
  * ```
57
88
  *
58
89
  * @param DescribeWhatIfAnalysisCommandInput - {@link DescribeWhatIfAnalysisCommandInput}
@@ -69,6 +100,8 @@ export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnaly
69
100
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
70
101
  * again.</p>
71
102
  *
103
+ * @throws {@link ForecastServiceException}
104
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
72
105
  *
73
106
  */
74
107
  export declare class DescribeWhatIfAnalysisCommand extends $Command<DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
@@ -53,6 +53,53 @@ export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForec
53
53
  * };
54
54
  * const command = new DescribeWhatIfForecastCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // DescribeWhatIfForecastResponse
57
+ * // WhatIfForecastName: "STRING_VALUE",
58
+ * // WhatIfForecastArn: "STRING_VALUE",
59
+ * // WhatIfAnalysisArn: "STRING_VALUE",
60
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
61
+ * // Status: "STRING_VALUE",
62
+ * // Message: "STRING_VALUE",
63
+ * // CreationTime: new Date("TIMESTAMP"),
64
+ * // LastModificationTime: new Date("TIMESTAMP"),
65
+ * // TimeSeriesTransformations: [ // TimeSeriesTransformations
66
+ * // { // TimeSeriesTransformation
67
+ * // Action: { // Action
68
+ * // AttributeName: "STRING_VALUE", // required
69
+ * // Operation: "ADD" || "SUBTRACT" || "MULTIPLY" || "DIVIDE", // required
70
+ * // Value: Number("double"), // required
71
+ * // },
72
+ * // TimeSeriesConditions: [ // TimeSeriesConditions
73
+ * // { // TimeSeriesCondition
74
+ * // AttributeName: "STRING_VALUE", // required
75
+ * // AttributeValue: "STRING_VALUE", // required
76
+ * // Condition: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "GREATER_THAN", // required
77
+ * // },
78
+ * // ],
79
+ * // },
80
+ * // ],
81
+ * // TimeSeriesReplacementsDataSource: { // TimeSeriesReplacementsDataSource
82
+ * // S3Config: { // S3Config
83
+ * // Path: "STRING_VALUE", // required
84
+ * // RoleArn: "STRING_VALUE", // required
85
+ * // KMSKeyArn: "STRING_VALUE",
86
+ * // },
87
+ * // Schema: { // Schema
88
+ * // Attributes: [ // SchemaAttributes
89
+ * // { // SchemaAttribute
90
+ * // AttributeName: "STRING_VALUE",
91
+ * // AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
92
+ * // },
93
+ * // ],
94
+ * // },
95
+ * // Format: "STRING_VALUE",
96
+ * // TimestampFormat: "STRING_VALUE",
97
+ * // },
98
+ * // ForecastTypes: [ // ForecastTypes
99
+ * // "STRING_VALUE",
100
+ * // ],
101
+ * // };
102
+ *
56
103
  * ```
57
104
  *
58
105
  * @param DescribeWhatIfForecastCommandInput - {@link DescribeWhatIfForecastCommandInput}
@@ -69,6 +116,8 @@ export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForec
69
116
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
70
117
  * again.</p>
71
118
  *
119
+ * @throws {@link ForecastServiceException}
120
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
72
121
  *
73
122
  */
74
123
  export declare class DescribeWhatIfForecastCommand extends $Command<DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
@@ -53,6 +53,27 @@ export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatI
53
53
  * };
54
54
  * const command = new DescribeWhatIfForecastExportCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // DescribeWhatIfForecastExportResponse
57
+ * // WhatIfForecastExportArn: "STRING_VALUE",
58
+ * // WhatIfForecastExportName: "STRING_VALUE",
59
+ * // WhatIfForecastArns: [ // LongArnList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // Destination: { // DataDestination
63
+ * // S3Config: { // S3Config
64
+ * // Path: "STRING_VALUE", // required
65
+ * // RoleArn: "STRING_VALUE", // required
66
+ * // KMSKeyArn: "STRING_VALUE",
67
+ * // },
68
+ * // },
69
+ * // Message: "STRING_VALUE",
70
+ * // Status: "STRING_VALUE",
71
+ * // CreationTime: new Date("TIMESTAMP"),
72
+ * // EstimatedTimeRemainingInMinutes: Number("long"),
73
+ * // LastModificationTime: new Date("TIMESTAMP"),
74
+ * // Format: "STRING_VALUE",
75
+ * // };
76
+ *
56
77
  * ```
57
78
  *
58
79
  * @param DescribeWhatIfForecastExportCommandInput - {@link DescribeWhatIfForecastExportCommandInput}
@@ -69,6 +90,8 @@ export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatI
69
90
  * <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
70
91
  * again.</p>
71
92
  *
93
+ * @throws {@link ForecastServiceException}
94
+ * <p>Base exception class for all service exceptions from Forecast service.</p>
72
95
  *
73
96
  */
74
97
  export declare class DescribeWhatIfForecastExportCommand extends $Command<DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {