@aws-sdk/client-forecast 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/dist-types/Forecast.d.ts +64 -0
  2. package/dist-types/ForecastClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateExplainabilityCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateForecastCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateMonitorCommand.d.ts +16 -0
  12. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +16 -0
  13. package/dist-types/commands/CreatePredictorCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteForecastCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteMonitorCommand.d.ts +16 -0
  25. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +16 -0
  26. package/dist-types/commands/DeletePredictorCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeForecastCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeMonitorCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribePredictorCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +16 -0
  45. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +16 -0
  50. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListForecastsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListMonitorsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +16 -0
  56. package/dist-types/commands/ListPredictorsCommand.d.ts +16 -0
  57. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  58. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +16 -0
  59. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +16 -0
  61. package/dist-types/commands/ResumeResourceCommand.d.ts +16 -0
  62. package/dist-types/commands/StopResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +16 -0
  66. package/dist-types/models/ForecastServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +477 -27
  68. package/dist-types/pagination/Interfaces.d.ts +3 -0
  69. package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListForecastExportJobsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListForecastsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListMonitorsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListPredictorBacktestExportJobsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListPredictorsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListWhatIfAnalysesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListWhatIfForecastExportsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListWhatIfForecastsPaginator.d.ts +3 -0
  83. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DeleteWhatIfAnalysisRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWhatIfAnalysisCommand}.
8
10
  */
9
11
  export interface DeleteWhatIfAnalysisCommandInput extends DeleteWhatIfAnalysisRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWhatIfAnalysisCommand}.
13
17
  */
14
18
  export interface DeleteWhatIfAnalysisCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a what-if analysis created using the <a>CreateWhatIfAnalysis</a>
18
23
  * operation. You can delete only what-if analyses that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfAnalysis</a> operation. </p>
19
24
  * <p>You can't delete a what-if analysis while any of its forecasts are being exported.</p>
@@ -27,6 +32,8 @@ export interface DeleteWhatIfAnalysisCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteWhatIfAnalysisCommandInput - {@link DeleteWhatIfAnalysisCommandInput}
36
+ * @returns {@link DeleteWhatIfAnalysisCommandOutput}
30
37
  * @see {@link DeleteWhatIfAnalysisCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteWhatIfAnalysisCommandOutput} for command's `response` shape.
32
39
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteWhatIfAnalysisCommandOutput extends __MetadataBearer {
47
54
  export declare class DeleteWhatIfAnalysisCommand extends $Command<DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
48
55
  readonly input: DeleteWhatIfAnalysisCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteWhatIfAnalysisCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DeleteWhatIfForecastRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWhatIfForecastCommand}.
8
10
  */
9
11
  export interface DeleteWhatIfForecastCommandInput extends DeleteWhatIfForecastRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWhatIfForecastCommand}.
13
17
  */
14
18
  export interface DeleteWhatIfForecastCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a what-if forecast created using the <a>CreateWhatIfForecast</a>
18
23
  * operation. You can delete only what-if forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecast</a> operation. </p>
19
24
  * <p>You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.</p>
@@ -27,6 +32,8 @@ export interface DeleteWhatIfForecastCommandOutput extends __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteWhatIfForecastCommandInput - {@link DeleteWhatIfForecastCommandInput}
36
+ * @returns {@link DeleteWhatIfForecastCommandOutput}
30
37
  * @see {@link DeleteWhatIfForecastCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteWhatIfForecastCommandOutput} for command's `response` shape.
32
39
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteWhatIfForecastCommandOutput extends __MetadataBearer {
47
54
  export declare class DeleteWhatIfForecastCommand extends $Command<DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
48
55
  readonly input: DeleteWhatIfForecastCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteWhatIfForecastCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DeleteWhatIfForecastExportRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteWhatIfForecastExportCommand}.
8
10
  */
9
11
  export interface DeleteWhatIfForecastExportCommandInput extends DeleteWhatIfForecastExportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteWhatIfForecastExportCommand}.
13
17
  */
14
18
  export interface DeleteWhatIfForecastExportCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a what-if forecast export created using the <a>CreateWhatIfForecastExport</a>
18
23
  * operation. You can delete only what-if forecast exports that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecastExport</a> operation. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteWhatIfForecastExportCommandOutput extends __MetadataBeare
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteWhatIfForecastExportCommandInput - {@link DeleteWhatIfForecastExportCommandInput}
35
+ * @returns {@link DeleteWhatIfForecastExportCommandOutput}
29
36
  * @see {@link DeleteWhatIfForecastExportCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteWhatIfForecastExportCommandOutput} for command's `response` shape.
31
38
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteWhatIfForecastExportCommandOutput extends __MetadataBeare
46
53
  export declare class DeleteWhatIfForecastExportCommand extends $Command<DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {
47
54
  readonly input: DeleteWhatIfForecastExportCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteWhatIfForecastExportCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeAutoPredictorRequest, DescribeAutoPredictorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAutoPredictorCommand}.
8
10
  */
9
11
  export interface DescribeAutoPredictorCommandInput extends DescribeAutoPredictorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAutoPredictorCommand}.
13
17
  */
14
18
  export interface DescribeAutoPredictorCommandOutput extends DescribeAutoPredictorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAutoPredictorCommandOutput extends DescribeAutoPredicto
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAutoPredictorCommandInput - {@link DescribeAutoPredictorCommandInput}
34
+ * @returns {@link DescribeAutoPredictorCommandOutput}
28
35
  * @see {@link DescribeAutoPredictorCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAutoPredictorCommandOutput} for command's `response` shape.
30
37
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeAutoPredictorCommandOutput extends DescribeAutoPredicto
42
49
  export declare class DescribeAutoPredictorCommand extends $Command<DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput, ForecastClientResolvedConfig> {
43
50
  readonly input: DescribeAutoPredictorCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeAutoPredictorCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeDatasetRequest, DescribeDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatasetCommand}.
8
10
  */
9
11
  export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatasetCommand}.
13
17
  */
14
18
  export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes an Amazon Forecast dataset created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation.</p>
18
23
  * <p>In addition to listing the parameters specified in the <code>CreateDataset</code> request,
19
24
  * this operation includes the following dataset properties:</p>
@@ -44,6 +49,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
53
+ * @returns {@link DescribeDatasetCommandOutput}
47
54
  * @see {@link DescribeDatasetCommandInput} for command's `input` shape.
48
55
  * @see {@link DescribeDatasetCommandOutput} for command's `response` shape.
49
56
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
61
68
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, ForecastClientResolvedConfig> {
62
69
  readonly input: DescribeDatasetCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeDatasetCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetCommandInput, DescribeDatasetCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeDatasetGroupRequest, DescribeDatasetGroupResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatasetGroupCommand}.
8
10
  */
9
11
  export interface DescribeDatasetGroupCommandInput extends DescribeDatasetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatasetGroupCommand}.
13
17
  */
14
18
  export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
18
23
  * operation.</p>
19
24
  * <p>In addition to listing the parameters provided in the <code>CreateDatasetGroup</code>
@@ -49,6 +54,8 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param DescribeDatasetGroupCommandInput - {@link DescribeDatasetGroupCommandInput}
58
+ * @returns {@link DescribeDatasetGroupCommandOutput}
52
59
  * @see {@link DescribeDatasetGroupCommandInput} for command's `input` shape.
53
60
  * @see {@link DescribeDatasetGroupCommandOutput} for command's `response` shape.
54
61
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR
66
73
  export declare class DescribeDatasetGroupCommand extends $Command<DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput, ForecastClientResolvedConfig> {
67
74
  readonly input: DescribeDatasetGroupCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DescribeDatasetGroupCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeDatasetImportJobRequest, DescribeDatasetImportJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatasetImportJobCommand}.
8
10
  */
9
11
  export interface DescribeDatasetImportJobCommandInput extends DescribeDatasetImportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatasetImportJobCommand}.
13
17
  */
14
18
  export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetImportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
18
23
  * operation.</p>
19
24
  * <p>In addition to listing the parameters provided in the <code>CreateDatasetImportJob</code>
@@ -59,6 +64,8 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm
59
64
  * const response = await client.send(command);
60
65
  * ```
61
66
  *
67
+ * @param DescribeDatasetImportJobCommandInput - {@link DescribeDatasetImportJobCommandInput}
68
+ * @returns {@link DescribeDatasetImportJobCommandOutput}
62
69
  * @see {@link DescribeDatasetImportJobCommandInput} for command's `input` shape.
63
70
  * @see {@link DescribeDatasetImportJobCommandOutput} for command's `response` shape.
64
71
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -76,11 +83,20 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm
76
83
  export declare class DescribeDatasetImportJobCommand extends $Command<DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput, ForecastClientResolvedConfig> {
77
84
  readonly input: DescribeDatasetImportJobCommandInput;
78
85
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
86
+ /**
87
+ * @public
88
+ */
79
89
  constructor(input: DescribeDatasetImportJobCommandInput);
80
90
  /**
81
91
  * @internal
82
92
  */
83
93
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput>;
94
+ /**
95
+ * @internal
96
+ */
84
97
  private serialize;
98
+ /**
99
+ * @internal
100
+ */
85
101
  private deserialize;
86
102
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeExplainabilityRequest, DescribeExplainabilityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeExplainabilityCommand}.
8
10
  */
9
11
  export interface DescribeExplainabilityCommandInput extends DescribeExplainabilityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeExplainabilityCommand}.
13
17
  */
14
18
  export interface DescribeExplainabilityCommandOutput extends DescribeExplainabilityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes an Explainability resource created using the <a>CreateExplainability</a> operation.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeExplainabilityCommandOutput extends DescribeExplainabil
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeExplainabilityCommandInput - {@link DescribeExplainabilityCommandInput}
34
+ * @returns {@link DescribeExplainabilityCommandOutput}
28
35
  * @see {@link DescribeExplainabilityCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeExplainabilityCommandOutput} for command's `response` shape.
30
37
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeExplainabilityCommandOutput extends DescribeExplainabil
42
49
  export declare class DescribeExplainabilityCommand extends $Command<DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput, ForecastClientResolvedConfig> {
43
50
  readonly input: DescribeExplainabilityCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeExplainabilityCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeExplainabilityExportRequest, DescribeExplainabilityExportResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeExplainabilityExportCommand}.
8
10
  */
9
11
  export interface DescribeExplainabilityExportCommandInput extends DescribeExplainabilityExportRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeExplainabilityExportCommand}.
13
17
  */
14
18
  export interface DescribeExplainabilityExportCommandOutput extends DescribeExplainabilityExportResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeExplainabilityExportCommandOutput extends DescribeExpla
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeExplainabilityExportCommandInput - {@link DescribeExplainabilityExportCommandInput}
34
+ * @returns {@link DescribeExplainabilityExportCommandOutput}
28
35
  * @see {@link DescribeExplainabilityExportCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeExplainabilityExportCommandOutput} for command's `response` shape.
30
37
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -42,11 +49,20 @@ export interface DescribeExplainabilityExportCommandOutput extends DescribeExpla
42
49
  export declare class DescribeExplainabilityExportCommand extends $Command<DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput, ForecastClientResolvedConfig> {
43
50
  readonly input: DescribeExplainabilityExportCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: DescribeExplainabilityExportCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeForecastRequest, DescribeForecastResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeForecastCommand}.
8
10
  */
9
11
  export interface DescribeForecastCommandInput extends DescribeForecastRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeForecastCommand}.
13
17
  */
14
18
  export interface DescribeForecastCommandOutput extends DescribeForecastResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a forecast created using the <a>CreateForecast</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided in the <code>CreateForecast</code> request,
19
24
  * this operation lists the following properties:</p>
@@ -53,6 +58,8 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse,
53
58
  * const response = await client.send(command);
54
59
  * ```
55
60
  *
61
+ * @param DescribeForecastCommandInput - {@link DescribeForecastCommandInput}
62
+ * @returns {@link DescribeForecastCommandOutput}
56
63
  * @see {@link DescribeForecastCommandInput} for command's `input` shape.
57
64
  * @see {@link DescribeForecastCommandOutput} for command's `response` shape.
58
65
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -70,11 +77,20 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse,
70
77
  export declare class DescribeForecastCommand extends $Command<DescribeForecastCommandInput, DescribeForecastCommandOutput, ForecastClientResolvedConfig> {
71
78
  readonly input: DescribeForecastCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: DescribeForecastCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeForecastCommandInput, DescribeForecastCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeForecastExportJobRequest, DescribeForecastExportJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeForecastExportJobCommand}.
8
10
  */
9
11
  export interface DescribeForecastExportJobCommandInput extends DescribeForecastExportJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeForecastExportJobCommand}.
13
17
  */
14
18
  export interface DescribeForecastExportJobCommandOutput extends DescribeForecastExportJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a forecast export job created using the <a>CreateForecastExportJob</a> operation.</p>
18
23
  * <p>In addition to listing the properties provided by the user in the
19
24
  * <code>CreateForecastExportJob</code> request, this operation lists the following
@@ -49,6 +54,8 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param DescribeForecastExportJobCommandInput - {@link DescribeForecastExportJobCommandInput}
58
+ * @returns {@link DescribeForecastExportJobCommandOutput}
52
59
  * @see {@link DescribeForecastExportJobCommandInput} for command's `input` shape.
53
60
  * @see {@link DescribeForecastExportJobCommandOutput} for command's `response` shape.
54
61
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast
66
73
  export declare class DescribeForecastExportJobCommand extends $Command<DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput, ForecastClientResolvedConfig> {
67
74
  readonly input: DescribeForecastExportJobCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DescribeForecastExportJobCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { DescribeMonitorRequest, DescribeMonitorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeMonitorCommand}.
8
10
  */
9
11
  export interface DescribeMonitorCommandInput extends DescribeMonitorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeMonitorCommand}.
13
17
  */
14
18
  export interface DescribeMonitorCommandOutput extends DescribeMonitorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes a monitor resource. In addition to listing the properties provided in the <a>CreateMonitor</a> request, this operation lists the following properties:</p>
18
23
  * <ul>
19
24
  * <li>
@@ -62,6 +67,8 @@ export interface DescribeMonitorCommandOutput extends DescribeMonitorResponse, _
62
67
  * const response = await client.send(command);
63
68
  * ```
64
69
  *
70
+ * @param DescribeMonitorCommandInput - {@link DescribeMonitorCommandInput}
71
+ * @returns {@link DescribeMonitorCommandOutput}
65
72
  * @see {@link DescribeMonitorCommandInput} for command's `input` shape.
66
73
  * @see {@link DescribeMonitorCommandOutput} for command's `response` shape.
67
74
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -79,11 +86,20 @@ export interface DescribeMonitorCommandOutput extends DescribeMonitorResponse, _
79
86
  export declare class DescribeMonitorCommand extends $Command<DescribeMonitorCommandInput, DescribeMonitorCommandOutput, ForecastClientResolvedConfig> {
80
87
  readonly input: DescribeMonitorCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: DescribeMonitorCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeMonitorCommandInput, DescribeMonitorCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }