|
2 | 2 | "version": "2.0", |
3 | 3 | "service": "<p>Provides APIs for creating and managing Amazon Forecast resources.</p>", |
4 | 4 | "operations": { |
5 | | - "QueryForecast": "<p>Retrieves a forecast filtered by the supplied criteria.</p> <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p> <p>By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note>" |
| 5 | + "QueryForecast": "<p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p> <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p> <p>By default, <code>QueryForecast</code> returns the complete date range for the filtered forecast. You can request a specific date range.</p> <p>To get the full forecast, use the <a href=\"https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html\">CreateForecastExportJob</a> operation.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note>" |
6 | 6 | }, |
7 | 7 | "shapes": { |
8 | 8 | "Arn": { |
|
32 | 32 | "DateTime": { |
33 | 33 | "base": null, |
34 | 34 | "refs": { |
35 | | - "QueryForecastRequest$StartDate": "<p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example, \"1970-01-01T00:00:00Z.\"</p>", |
36 | | - "QueryForecastRequest$EndDate": "<p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example, \"1970-01-01T00:00:00Z.\" </p>" |
| 35 | + "QueryForecastRequest$StartDate": "<p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>", |
| 36 | + "QueryForecastRequest$EndDate": "<p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. </p>" |
37 | 37 | } |
38 | 38 | }, |
39 | 39 | "Double": { |
|
55 | 55 | "Filters": { |
56 | 56 | "base": null, |
57 | 57 | "refs": { |
58 | | - "QueryForecastRequest$Filters": "<p>The filtering criteria to apply when retrieving the forecast. For example:</p> <ul> <li> <p>To get a forecast for a specific item specify the following:</p> <p> <code>{\"item_id\" : \"client_1\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for a specific item sold in a specific location, specify the following:</p> <p> <code>{\"item_id\" : \"client_1\", \"location\" : \"ny\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for all blue items sold in a specific location, specify the following:</p> <p> <code>{ \"location\" : \"ny\", \"color\":\"blue\"}</code> </p> </li> </ul> <p>To get the full forecast, use the operation.</p>" |
| 58 | + "QueryForecastRequest$Filters": "<p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p> <p> <code>{\"item_id\" : \"client_21\"}</code> </p> <p>To get the full forecast, use the <a href=\"https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html\">CreateForecastExportJob</a> operation.</p>" |
59 | 59 | } |
60 | 60 | }, |
61 | 61 | "Forecast": { |
|
65 | 65 | } |
66 | 66 | }, |
67 | 67 | "InvalidInputException": { |
68 | | - "base": "<p>The value that you provided was invalid or too long.</p>", |
| 68 | + "base": "<p>The value is invalid or is too long.</p>", |
69 | 69 | "refs": { |
70 | 70 | } |
71 | 71 | }, |
|
88 | 88 | "Predictions": { |
89 | 89 | "base": null, |
90 | 90 | "refs": { |
91 | | - "Forecast$Predictions": "<p>The forecast.</p> <p>The <i>string</i> of the string to array map is one of the following values:</p> <ul> <li> <p>mean</p> </li> <li> <p>p10</p> </li> <li> <p>p50</p> </li> <li> <p>p90</p> </li> </ul>" |
| 91 | + "Forecast$Predictions": "<p>The forecast.</p> <p>The <i>string</i> of the string-to-array map is one of the following values:</p> <ul> <li> <p>p10</p> </li> <li> <p>p50</p> </li> <li> <p>p90</p> </li> </ul>" |
92 | 92 | } |
93 | 93 | }, |
94 | 94 | "QueryForecastRequest": { |
|
0 commit comments