@aws-sdk/client-forecast 3.298.0 → 3.300.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 +54 -0
  2. package/dist-types/commands/CreateDatasetCommand.d.ts +24 -0
  3. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +13 -0
  4. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +23 -0
  5. package/dist-types/commands/CreateExplainabilityCommand.d.ts +32 -0
  6. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +18 -0
  7. package/dist-types/commands/CreateForecastCommand.d.ts +33 -0
  8. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +18 -0
  9. package/dist-types/commands/CreateMonitorCommand.d.ts +10 -0
  10. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +18 -0
  11. package/dist-types/commands/CreatePredictorCommand.d.ts +85 -0
  12. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +30 -0
  13. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +43 -0
  14. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +20 -0
  15. package/dist-types/commands/DeleteDatasetCommand.d.ts +3 -0
  16. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +3 -0
  17. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +3 -0
  18. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +3 -0
  19. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +3 -0
  20. package/dist-types/commands/DeleteForecastCommand.d.ts +3 -0
  21. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +3 -0
  22. package/dist-types/commands/DeleteMonitorCommand.d.ts +3 -0
  23. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +3 -0
  24. package/dist-types/commands/DeletePredictorCommand.d.ts +3 -0
  25. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +3 -0
  26. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +3 -0
  27. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +3 -0
  28. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +3 -0
  29. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +3 -0
  30. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +3 -0
  32. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +3 -0
  33. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +3 -0
  34. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +3 -0
  35. package/dist-types/commands/DescribeForecastCommand.d.ts +3 -0
  36. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +3 -0
  37. package/dist-types/commands/DescribeMonitorCommand.d.ts +3 -0
  38. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +3 -0
  39. package/dist-types/commands/DescribePredictorCommand.d.ts +3 -0
  40. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +3 -0
  41. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +3 -0
  42. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +3 -0
  43. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +3 -0
  44. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +4 -0
  45. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +11 -0
  46. package/dist-types/commands/ListDatasetsCommand.d.ts +4 -0
  47. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +11 -0
  48. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +11 -0
  49. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +11 -0
  50. package/dist-types/commands/ListForecastsCommand.d.ts +11 -0
  51. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +12 -0
  52. package/dist-types/commands/ListMonitorsCommand.d.ts +11 -0
  53. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +11 -0
  54. package/dist-types/commands/ListPredictorsCommand.d.ts +11 -0
  55. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  56. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +11 -0
  57. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +11 -0
  58. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +11 -0
  59. package/dist-types/commands/ResumeResourceCommand.d.ts +3 -0
  60. package/dist-types/commands/StopResourceCommand.d.ts +3 -0
  61. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  62. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  63. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +6 -0
  64. package/package.json +12 -12
@@ -74,6 +74,60 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
74
74
  * import { ForecastClient, CreateAutoPredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
75
75
  * // const { ForecastClient, CreateAutoPredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
76
76
  * const client = new ForecastClient(config);
77
+ * const input = {
78
+ * PredictorName: "STRING_VALUE", // required
79
+ * ForecastHorizon: Number("int"),
80
+ * ForecastTypes: [
81
+ * "STRING_VALUE",
82
+ * ],
83
+ * ForecastDimensions: [
84
+ * "STRING_VALUE",
85
+ * ],
86
+ * ForecastFrequency: "STRING_VALUE",
87
+ * DataConfig: {
88
+ * DatasetGroupArn: "STRING_VALUE", // required
89
+ * AttributeConfigs: [
90
+ * {
91
+ * AttributeName: "STRING_VALUE", // required
92
+ * Transformations: { // required
93
+ * "<keys>": "STRING_VALUE",
94
+ * },
95
+ * },
96
+ * ],
97
+ * AdditionalDatasets: [
98
+ * {
99
+ * Name: "STRING_VALUE", // required
100
+ * Configuration: {
101
+ * "<keys>": [
102
+ * "STRING_VALUE",
103
+ * ],
104
+ * },
105
+ * },
106
+ * ],
107
+ * },
108
+ * EncryptionConfig: {
109
+ * RoleArn: "STRING_VALUE", // required
110
+ * KMSKeyArn: "STRING_VALUE", // required
111
+ * },
112
+ * ReferencePredictorArn: "STRING_VALUE",
113
+ * OptimizationMetric: "WAPE" || "RMSE" || "AverageWeightedQuantileLoss" || "MASE" || "MAPE",
114
+ * ExplainPredictor: true || false,
115
+ * Tags: [
116
+ * {
117
+ * Key: "STRING_VALUE", // required
118
+ * Value: "STRING_VALUE", // required
119
+ * },
120
+ * ],
121
+ * MonitorConfig: {
122
+ * MonitorName: "STRING_VALUE", // required
123
+ * },
124
+ * TimeAlignmentBoundary: {
125
+ * Month: "JANUARY" || "FEBRUARY" || "MARCH" || "APRIL" || "MAY" || "JUNE" || "JULY" || "AUGUST" || "SEPTEMBER" || "OCTOBER" || "NOVEMBER" || "DECEMBER",
126
+ * DayOfMonth: Number("int"),
127
+ * DayOfWeek: "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY",
128
+ * Hour: Number("int"),
129
+ * },
130
+ * };
77
131
  * const command = new CreateAutoPredictorCommand(input);
78
132
  * const response = await client.send(command);
79
133
  * ```
@@ -67,6 +67,30 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
67
67
  * import { ForecastClient, CreateDatasetCommand } from "@aws-sdk/client-forecast"; // ES Modules import
68
68
  * // const { ForecastClient, CreateDatasetCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
69
69
  * const client = new ForecastClient(config);
70
+ * const input = {
71
+ * DatasetName: "STRING_VALUE", // required
72
+ * Domain: "RETAIL" || "CUSTOM" || "INVENTORY_PLANNING" || "EC2_CAPACITY" || "WORK_FORCE" || "WEB_TRAFFIC" || "METRICS", // required
73
+ * DatasetType: "TARGET_TIME_SERIES" || "RELATED_TIME_SERIES" || "ITEM_METADATA", // required
74
+ * DataFrequency: "STRING_VALUE",
75
+ * Schema: {
76
+ * Attributes: [
77
+ * {
78
+ * AttributeName: "STRING_VALUE",
79
+ * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
80
+ * },
81
+ * ],
82
+ * },
83
+ * EncryptionConfig: {
84
+ * RoleArn: "STRING_VALUE", // required
85
+ * KMSKeyArn: "STRING_VALUE", // required
86
+ * },
87
+ * Tags: [
88
+ * {
89
+ * Key: "STRING_VALUE", // required
90
+ * Value: "STRING_VALUE", // required
91
+ * },
92
+ * ],
93
+ * };
70
94
  * const command = new CreateDatasetCommand(input);
71
95
  * const response = await client.send(command);
72
96
  * ```
@@ -35,6 +35,19 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo
35
35
  * import { ForecastClient, CreateDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import
36
36
  * // const { ForecastClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
37
37
  * const client = new ForecastClient(config);
38
+ * const input = {
39
+ * DatasetGroupName: "STRING_VALUE", // required
40
+ * Domain: "RETAIL" || "CUSTOM" || "INVENTORY_PLANNING" || "EC2_CAPACITY" || "WORK_FORCE" || "WEB_TRAFFIC" || "METRICS", // required
41
+ * DatasetArns: [
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * Tags: [
45
+ * {
46
+ * Key: "STRING_VALUE", // required
47
+ * Value: "STRING_VALUE", // required
48
+ * },
49
+ * ],
50
+ * };
38
51
  * const command = new CreateDatasetGroupCommand(input);
39
52
  * const response = await client.send(command);
40
53
  * ```
@@ -42,6 +42,29 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
42
42
  * import { ForecastClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
43
43
  * // const { ForecastClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
44
44
  * const client = new ForecastClient(config);
45
+ * const input = {
46
+ * DatasetImportJobName: "STRING_VALUE", // required
47
+ * DatasetArn: "STRING_VALUE", // required
48
+ * DataSource: {
49
+ * S3Config: {
50
+ * Path: "STRING_VALUE", // required
51
+ * RoleArn: "STRING_VALUE", // required
52
+ * KMSKeyArn: "STRING_VALUE",
53
+ * },
54
+ * },
55
+ * TimestampFormat: "STRING_VALUE",
56
+ * TimeZone: "STRING_VALUE",
57
+ * UseGeolocationForTimeZone: true || false,
58
+ * GeolocationFormat: "STRING_VALUE",
59
+ * Tags: [
60
+ * {
61
+ * Key: "STRING_VALUE", // required
62
+ * Value: "STRING_VALUE", // required
63
+ * },
64
+ * ],
65
+ * Format: "STRING_VALUE",
66
+ * ImportMode: "FULL" || "INCREMENTAL",
67
+ * };
45
68
  * const command = new CreateDatasetImportJobCommand(input);
46
69
  * const response = await client.send(command);
47
70
  * ```
@@ -144,6 +144,38 @@ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityR
144
144
  * import { ForecastClient, CreateExplainabilityCommand } from "@aws-sdk/client-forecast"; // ES Modules import
145
145
  * // const { ForecastClient, CreateExplainabilityCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
146
146
  * const client = new ForecastClient(config);
147
+ * const input = {
148
+ * ExplainabilityName: "STRING_VALUE", // required
149
+ * ResourceArn: "STRING_VALUE", // required
150
+ * ExplainabilityConfig: {
151
+ * TimeSeriesGranularity: "ALL" || "SPECIFIC", // required
152
+ * TimePointGranularity: "ALL" || "SPECIFIC", // required
153
+ * },
154
+ * DataSource: {
155
+ * S3Config: {
156
+ * Path: "STRING_VALUE", // required
157
+ * RoleArn: "STRING_VALUE", // required
158
+ * KMSKeyArn: "STRING_VALUE",
159
+ * },
160
+ * },
161
+ * Schema: {
162
+ * Attributes: [
163
+ * {
164
+ * AttributeName: "STRING_VALUE",
165
+ * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
166
+ * },
167
+ * ],
168
+ * },
169
+ * EnableVisualization: true || false,
170
+ * StartDateTime: "STRING_VALUE",
171
+ * EndDateTime: "STRING_VALUE",
172
+ * Tags: [
173
+ * {
174
+ * Key: "STRING_VALUE", // required
175
+ * Value: "STRING_VALUE", // required
176
+ * },
177
+ * ],
178
+ * };
147
179
  * const command = new CreateExplainabilityCommand(input);
148
180
  * const response = await client.send(command);
149
181
  * ```
@@ -34,6 +34,24 @@ export interface CreateExplainabilityExportCommandOutput extends CreateExplainab
34
34
  * import { ForecastClient, CreateExplainabilityExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
35
35
  * // const { ForecastClient, CreateExplainabilityExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
36
36
  * const client = new ForecastClient(config);
37
+ * const input = {
38
+ * ExplainabilityExportName: "STRING_VALUE", // required
39
+ * ExplainabilityArn: "STRING_VALUE", // required
40
+ * Destination: {
41
+ * S3Config: {
42
+ * Path: "STRING_VALUE", // required
43
+ * RoleArn: "STRING_VALUE", // required
44
+ * KMSKeyArn: "STRING_VALUE",
45
+ * },
46
+ * },
47
+ * Tags: [
48
+ * {
49
+ * Key: "STRING_VALUE", // required
50
+ * Value: "STRING_VALUE", // required
51
+ * },
52
+ * ],
53
+ * Format: "STRING_VALUE",
54
+ * };
37
55
  * const command = new CreateExplainabilityExportCommand(input);
38
56
  * const response = await client.send(command);
39
57
  * ```
@@ -46,6 +46,39 @@ export interface CreateForecastCommandOutput extends CreateForecastResponse, __M
46
46
  * import { ForecastClient, CreateForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
47
47
  * // const { ForecastClient, CreateForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
48
48
  * const client = new ForecastClient(config);
49
+ * const input = {
50
+ * ForecastName: "STRING_VALUE", // required
51
+ * PredictorArn: "STRING_VALUE", // required
52
+ * ForecastTypes: [
53
+ * "STRING_VALUE",
54
+ * ],
55
+ * Tags: [
56
+ * {
57
+ * Key: "STRING_VALUE", // required
58
+ * Value: "STRING_VALUE", // required
59
+ * },
60
+ * ],
61
+ * TimeSeriesSelector: {
62
+ * TimeSeriesIdentifiers: {
63
+ * DataSource: {
64
+ * S3Config: {
65
+ * Path: "STRING_VALUE", // required
66
+ * RoleArn: "STRING_VALUE", // required
67
+ * KMSKeyArn: "STRING_VALUE",
68
+ * },
69
+ * },
70
+ * Schema: {
71
+ * Attributes: [
72
+ * {
73
+ * AttributeName: "STRING_VALUE",
74
+ * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
75
+ * },
76
+ * ],
77
+ * },
78
+ * Format: "STRING_VALUE",
79
+ * },
80
+ * },
81
+ * };
49
82
  * const command = new CreateForecastCommand(input);
50
83
  * const response = await client.send(command);
51
84
  * ```
@@ -39,6 +39,24 @@ export interface CreateForecastExportJobCommandOutput extends CreateForecastExpo
39
39
  * import { ForecastClient, CreateForecastExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
40
40
  * // const { ForecastClient, CreateForecastExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
41
41
  * const client = new ForecastClient(config);
42
+ * const input = {
43
+ * ForecastExportJobName: "STRING_VALUE", // required
44
+ * ForecastArn: "STRING_VALUE", // required
45
+ * Destination: {
46
+ * S3Config: {
47
+ * Path: "STRING_VALUE", // required
48
+ * RoleArn: "STRING_VALUE", // required
49
+ * KMSKeyArn: "STRING_VALUE",
50
+ * },
51
+ * },
52
+ * Tags: [
53
+ * {
54
+ * Key: "STRING_VALUE", // required
55
+ * Value: "STRING_VALUE", // required
56
+ * },
57
+ * ],
58
+ * Format: "STRING_VALUE",
59
+ * };
42
60
  * const command = new CreateForecastExportJobCommand(input);
43
61
  * const response = await client.send(command);
44
62
  * ```
@@ -28,6 +28,16 @@ export interface CreateMonitorCommandOutput extends CreateMonitorResponse, __Met
28
28
  * import { ForecastClient, CreateMonitorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
29
29
  * // const { ForecastClient, CreateMonitorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
30
30
  * const client = new ForecastClient(config);
31
+ * const input = {
32
+ * MonitorName: "STRING_VALUE", // required
33
+ * ResourceArn: "STRING_VALUE", // required
34
+ * Tags: [
35
+ * {
36
+ * Key: "STRING_VALUE", // required
37
+ * Value: "STRING_VALUE", // required
38
+ * },
39
+ * ],
40
+ * };
31
41
  * const command = new CreateMonitorCommand(input);
32
42
  * const response = await client.send(command);
33
43
  * ```
@@ -40,6 +40,24 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
40
40
  * import { ForecastClient, CreatePredictorBacktestExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
41
41
  * // const { ForecastClient, CreatePredictorBacktestExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
42
42
  * const client = new ForecastClient(config);
43
+ * const input = {
44
+ * PredictorBacktestExportJobName: "STRING_VALUE", // required
45
+ * PredictorArn: "STRING_VALUE", // required
46
+ * Destination: {
47
+ * S3Config: {
48
+ * Path: "STRING_VALUE", // required
49
+ * RoleArn: "STRING_VALUE", // required
50
+ * KMSKeyArn: "STRING_VALUE",
51
+ * },
52
+ * },
53
+ * Tags: [
54
+ * {
55
+ * Key: "STRING_VALUE", // required
56
+ * Value: "STRING_VALUE", // required
57
+ * },
58
+ * ],
59
+ * Format: "STRING_VALUE",
60
+ * };
43
61
  * const command = new CreatePredictorBacktestExportJobCommand(input);
44
62
  * const response = await client.send(command);
45
63
  * ```
@@ -85,6 +85,91 @@ export interface CreatePredictorCommandOutput extends CreatePredictorResponse, _
85
85
  * import { ForecastClient, CreatePredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
86
86
  * // const { ForecastClient, CreatePredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
87
87
  * const client = new ForecastClient(config);
88
+ * const input = {
89
+ * PredictorName: "STRING_VALUE", // required
90
+ * AlgorithmArn: "STRING_VALUE",
91
+ * ForecastHorizon: Number("int"), // required
92
+ * ForecastTypes: [
93
+ * "STRING_VALUE",
94
+ * ],
95
+ * PerformAutoML: true || false,
96
+ * AutoMLOverrideStrategy: "LatencyOptimized" || "AccuracyOptimized",
97
+ * PerformHPO: true || false,
98
+ * TrainingParameters: {
99
+ * "<keys>": "STRING_VALUE",
100
+ * },
101
+ * EvaluationParameters: {
102
+ * NumberOfBacktestWindows: Number("int"),
103
+ * BackTestWindowOffset: Number("int"),
104
+ * },
105
+ * HPOConfig: {
106
+ * ParameterRanges: {
107
+ * CategoricalParameterRanges: [
108
+ * {
109
+ * Name: "STRING_VALUE", // required
110
+ * Values: [ // required
111
+ * "STRING_VALUE",
112
+ * ],
113
+ * },
114
+ * ],
115
+ * ContinuousParameterRanges: [
116
+ * {
117
+ * Name: "STRING_VALUE", // required
118
+ * MaxValue: Number("double"), // required
119
+ * MinValue: Number("double"), // required
120
+ * ScalingType: "Auto" || "Linear" || "Logarithmic" || "ReverseLogarithmic",
121
+ * },
122
+ * ],
123
+ * IntegerParameterRanges: [
124
+ * {
125
+ * Name: "STRING_VALUE", // required
126
+ * MaxValue: Number("int"), // required
127
+ * MinValue: Number("int"), // required
128
+ * ScalingType: "Auto" || "Linear" || "Logarithmic" || "ReverseLogarithmic",
129
+ * },
130
+ * ],
131
+ * },
132
+ * },
133
+ * InputDataConfig: {
134
+ * DatasetGroupArn: "STRING_VALUE", // required
135
+ * SupplementaryFeatures: [
136
+ * {
137
+ * Name: "STRING_VALUE", // required
138
+ * Value: "STRING_VALUE", // required
139
+ * },
140
+ * ],
141
+ * },
142
+ * FeaturizationConfig: {
143
+ * ForecastFrequency: "STRING_VALUE", // required
144
+ * ForecastDimensions: [
145
+ * "STRING_VALUE",
146
+ * ],
147
+ * Featurizations: [
148
+ * {
149
+ * AttributeName: "STRING_VALUE", // required
150
+ * FeaturizationPipeline: [
151
+ * {
152
+ * FeaturizationMethodName: "filling", // required
153
+ * FeaturizationMethodParameters: {
154
+ * "<keys>": "STRING_VALUE",
155
+ * },
156
+ * },
157
+ * ],
158
+ * },
159
+ * ],
160
+ * },
161
+ * EncryptionConfig: {
162
+ * RoleArn: "STRING_VALUE", // required
163
+ * KMSKeyArn: "STRING_VALUE", // required
164
+ * },
165
+ * Tags: [
166
+ * {
167
+ * Key: "STRING_VALUE", // required
168
+ * Value: "STRING_VALUE", // required
169
+ * },
170
+ * ],
171
+ * OptimizationMetric: "WAPE" || "RMSE" || "AverageWeightedQuantileLoss" || "MASE" || "MAPE",
172
+ * };
88
173
  * const command = new CreatePredictorCommand(input);
89
174
  * const response = await client.send(command);
90
175
  * ```
@@ -38,6 +38,36 @@ export interface CreateWhatIfAnalysisCommandOutput extends CreateWhatIfAnalysisR
38
38
  * import { ForecastClient, CreateWhatIfAnalysisCommand } from "@aws-sdk/client-forecast"; // ES Modules import
39
39
  * // const { ForecastClient, CreateWhatIfAnalysisCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
40
40
  * const client = new ForecastClient(config);
41
+ * const input = {
42
+ * WhatIfAnalysisName: "STRING_VALUE", // required
43
+ * ForecastArn: "STRING_VALUE", // required
44
+ * TimeSeriesSelector: {
45
+ * TimeSeriesIdentifiers: {
46
+ * DataSource: {
47
+ * S3Config: {
48
+ * Path: "STRING_VALUE", // required
49
+ * RoleArn: "STRING_VALUE", // required
50
+ * KMSKeyArn: "STRING_VALUE",
51
+ * },
52
+ * },
53
+ * Schema: {
54
+ * Attributes: [
55
+ * {
56
+ * AttributeName: "STRING_VALUE",
57
+ * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
58
+ * },
59
+ * ],
60
+ * },
61
+ * Format: "STRING_VALUE",
62
+ * },
63
+ * },
64
+ * Tags: [
65
+ * {
66
+ * Key: "STRING_VALUE", // required
67
+ * Value: "STRING_VALUE", // required
68
+ * },
69
+ * ],
70
+ * };
41
71
  * const command = new CreateWhatIfAnalysisCommand(input);
42
72
  * const response = await client.send(command);
43
73
  * ```
@@ -27,6 +27,49 @@ export interface CreateWhatIfForecastCommandOutput extends CreateWhatIfForecastR
27
27
  * import { ForecastClient, CreateWhatIfForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
28
28
  * // const { ForecastClient, CreateWhatIfForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
29
29
  * const client = new ForecastClient(config);
30
+ * const input = {
31
+ * WhatIfForecastName: "STRING_VALUE", // required
32
+ * WhatIfAnalysisArn: "STRING_VALUE", // required
33
+ * TimeSeriesTransformations: [
34
+ * {
35
+ * Action: {
36
+ * AttributeName: "STRING_VALUE", // required
37
+ * Operation: "ADD" || "SUBTRACT" || "MULTIPLY" || "DIVIDE", // required
38
+ * Value: Number("double"), // required
39
+ * },
40
+ * TimeSeriesConditions: [
41
+ * {
42
+ * AttributeName: "STRING_VALUE", // required
43
+ * AttributeValue: "STRING_VALUE", // required
44
+ * Condition: "EQUALS" || "NOT_EQUALS" || "LESS_THAN" || "GREATER_THAN", // required
45
+ * },
46
+ * ],
47
+ * },
48
+ * ],
49
+ * TimeSeriesReplacementsDataSource: {
50
+ * S3Config: {
51
+ * Path: "STRING_VALUE", // required
52
+ * RoleArn: "STRING_VALUE", // required
53
+ * KMSKeyArn: "STRING_VALUE",
54
+ * },
55
+ * Schema: {
56
+ * Attributes: [
57
+ * {
58
+ * AttributeName: "STRING_VALUE",
59
+ * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
60
+ * },
61
+ * ],
62
+ * },
63
+ * Format: "STRING_VALUE",
64
+ * TimestampFormat: "STRING_VALUE",
65
+ * },
66
+ * Tags: [
67
+ * {
68
+ * Key: "STRING_VALUE", // required
69
+ * Value: "STRING_VALUE", // required
70
+ * },
71
+ * ],
72
+ * };
30
73
  * const command = new CreateWhatIfForecastCommand(input);
31
74
  * const response = await client.send(command);
32
75
  * ```
@@ -42,6 +42,26 @@ export interface CreateWhatIfForecastExportCommandOutput extends CreateWhatIfFor
42
42
  * import { ForecastClient, CreateWhatIfForecastExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
43
43
  * // const { ForecastClient, CreateWhatIfForecastExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
44
44
  * const client = new ForecastClient(config);
45
+ * const input = {
46
+ * WhatIfForecastExportName: "STRING_VALUE", // required
47
+ * WhatIfForecastArns: [ // required
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * Destination: {
51
+ * S3Config: {
52
+ * Path: "STRING_VALUE", // required
53
+ * RoleArn: "STRING_VALUE", // required
54
+ * KMSKeyArn: "STRING_VALUE",
55
+ * },
56
+ * },
57
+ * Tags: [
58
+ * {
59
+ * Key: "STRING_VALUE", // required
60
+ * Value: "STRING_VALUE", // required
61
+ * },
62
+ * ],
63
+ * Format: "STRING_VALUE",
64
+ * };
45
65
  * const command = new CreateWhatIfForecastExportCommand(input);
46
66
  * const response = await client.send(command);
47
67
  * ```
@@ -33,6 +33,9 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {
33
33
  * import { ForecastClient, DeleteDatasetCommand } from "@aws-sdk/client-forecast"; // ES Modules import
34
34
  * // const { ForecastClient, DeleteDatasetCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
35
35
  * const client = new ForecastClient(config);
36
+ * const input = {
37
+ * DatasetArn: "STRING_VALUE", // required
38
+ * };
36
39
  * const command = new DeleteDatasetCommand(input);
37
40
  * const response = await client.send(command);
38
41
  * ```
@@ -29,6 +29,9 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {
29
29
  * import { ForecastClient, DeleteDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import
30
30
  * // const { ForecastClient, DeleteDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
31
31
  * const client = new ForecastClient(config);
32
+ * const input = {
33
+ * DatasetGroupArn: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new DeleteDatasetGroupCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```
@@ -29,6 +29,9 @@ export interface DeleteDatasetImportJobCommandOutput extends __MetadataBearer {
29
29
  * import { ForecastClient, DeleteDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
30
30
  * // const { ForecastClient, DeleteDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
31
31
  * const client = new ForecastClient(config);
32
+ * const input = {
33
+ * DatasetImportJobArn: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new DeleteDatasetImportJobCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```
@@ -28,6 +28,9 @@ export interface DeleteExplainabilityCommandOutput extends __MetadataBearer {
28
28
  * import { ForecastClient, DeleteExplainabilityCommand } from "@aws-sdk/client-forecast"; // ES Modules import
29
29
  * // const { ForecastClient, DeleteExplainabilityCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
30
30
  * const client = new ForecastClient(config);
31
+ * const input = {
32
+ * ExplainabilityArn: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new DeleteExplainabilityCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -26,6 +26,9 @@ export interface DeleteExplainabilityExportCommandOutput extends __MetadataBeare
26
26
  * import { ForecastClient, DeleteExplainabilityExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
27
27
  * // const { ForecastClient, DeleteExplainabilityExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
28
28
  * const client = new ForecastClient(config);
29
+ * const input = {
30
+ * ExplainabilityExportArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteExplainabilityExportCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -30,6 +30,9 @@ export interface DeleteForecastCommandOutput extends __MetadataBearer {
30
30
  * import { ForecastClient, DeleteForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
31
31
  * // const { ForecastClient, DeleteForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
32
32
  * const client = new ForecastClient(config);
33
+ * const input = {
34
+ * ForecastArn: "STRING_VALUE", // required
35
+ * };
33
36
  * const command = new DeleteForecastCommand(input);
34
37
  * const response = await client.send(command);
35
38
  * ```
@@ -28,6 +28,9 @@ export interface DeleteForecastExportJobCommandOutput extends __MetadataBearer {
28
28
  * import { ForecastClient, DeleteForecastExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
29
29
  * // const { ForecastClient, DeleteForecastExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
30
30
  * const client = new ForecastClient(config);
31
+ * const input = {
32
+ * ForecastExportJobArn: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new DeleteForecastExportJobCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -26,6 +26,9 @@ export interface DeleteMonitorCommandOutput extends __MetadataBearer {
26
26
  * import { ForecastClient, DeleteMonitorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
27
27
  * // const { ForecastClient, DeleteMonitorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
28
28
  * const client = new ForecastClient(config);
29
+ * const input = {
30
+ * MonitorArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteMonitorCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,9 @@ export interface DeletePredictorBacktestExportJobCommandOutput extends __Metadat
26
26
  * import { ForecastClient, DeletePredictorBacktestExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
27
27
  * // const { ForecastClient, DeletePredictorBacktestExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
28
28
  * const client = new ForecastClient(config);
29
+ * const input = {
30
+ * PredictorBacktestExportJobArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeletePredictorBacktestExportJobCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,9 @@ export interface DeletePredictorCommandOutput extends __MetadataBearer {
27
27
  * import { ForecastClient, DeletePredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
28
28
  * // const { ForecastClient, DeletePredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
29
29
  * const client = new ForecastClient(config);
30
+ * const input = {
31
+ * PredictorArn: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DeletePredictorCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -56,6 +56,9 @@ export interface DeleteResourceTreeCommandOutput extends __MetadataBearer {
56
56
  * import { ForecastClient, DeleteResourceTreeCommand } from "@aws-sdk/client-forecast"; // ES Modules import
57
57
  * // const { ForecastClient, DeleteResourceTreeCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
58
58
  * const client = new ForecastClient(config);
59
+ * const input = {
60
+ * ResourceArn: "STRING_VALUE", // required
61
+ * };
59
62
  * const command = new DeleteResourceTreeCommand(input);
60
63
  * const response = await client.send(command);
61
64
  * ```