|
| 1 | +{ |
| 2 | + "version":"2.0", |
| 3 | + "metadata":{ |
| 4 | + "apiVersion":"2018-06-26", |
| 5 | + "endpointPrefix":"forecastquery", |
| 6 | + "jsonVersion":"1.1", |
| 7 | + "protocol":"json", |
| 8 | + "serviceFullName":"Amazon Forecast Query Service", |
| 9 | + "serviceId":"forecastquery", |
| 10 | + "signatureVersion":"v4", |
| 11 | + "signingName":"forecast", |
| 12 | + "targetPrefix":"AmazonForecastRuntime", |
| 13 | + "uid":"forecastquery-2018-06-26" |
| 14 | + }, |
| 15 | + "operations":{ |
| 16 | + "QueryForecast":{ |
| 17 | + "name":"QueryForecast", |
| 18 | + "http":{ |
| 19 | + "method":"POST", |
| 20 | + "requestUri":"/" |
| 21 | + }, |
| 22 | + "input":{"shape":"QueryForecastRequest"}, |
| 23 | + "output":{"shape":"QueryForecastResponse"}, |
| 24 | + "errors":[ |
| 25 | + {"shape":"ResourceNotFoundException"}, |
| 26 | + {"shape":"ResourceInUseException"}, |
| 27 | + {"shape":"InvalidInputException"}, |
| 28 | + {"shape":"LimitExceededException"}, |
| 29 | + {"shape":"InvalidNextTokenException"} |
| 30 | + ], |
| 31 | + "documentation":"<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>" |
| 32 | + } |
| 33 | + }, |
| 34 | + "shapes":{ |
| 35 | + "Arn":{ |
| 36 | + "type":"string", |
| 37 | + "max":256, |
| 38 | + "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" |
| 39 | + }, |
| 40 | + "AttributeName":{ |
| 41 | + "type":"string", |
| 42 | + "max":256, |
| 43 | + "pattern":"^[a-zA-Z0-9\\_\\-]+$" |
| 44 | + }, |
| 45 | + "AttributeValue":{ |
| 46 | + "type":"string", |
| 47 | + "max":256 |
| 48 | + }, |
| 49 | + "DataPoint":{ |
| 50 | + "type":"structure", |
| 51 | + "members":{ |
| 52 | + "Timestamp":{ |
| 53 | + "shape":"Timestamp", |
| 54 | + "documentation":"<p>The timestamp of the specific forecast.</p>" |
| 55 | + }, |
| 56 | + "Value":{ |
| 57 | + "shape":"Double", |
| 58 | + "documentation":"<p>The forecast value.</p>" |
| 59 | + } |
| 60 | + }, |
| 61 | + "documentation":"<p>The forecast value for a specific date. Part of the <a>Forecast</a> object.</p>" |
| 62 | + }, |
| 63 | + "DateTime":{ |
| 64 | + "type":"string", |
| 65 | + "max":20, |
| 66 | + "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" |
| 67 | + }, |
| 68 | + "Double":{"type":"double"}, |
| 69 | + "ErrorMessage":{"type":"string"}, |
| 70 | + "Filters":{ |
| 71 | + "type":"map", |
| 72 | + "key":{"shape":"AttributeName"}, |
| 73 | + "value":{"shape":"AttributeValue"}, |
| 74 | + "max":50, |
| 75 | + "min":1 |
| 76 | + }, |
| 77 | + "Forecast":{ |
| 78 | + "type":"structure", |
| 79 | + "members":{ |
| 80 | + "Predictions":{ |
| 81 | + "shape":"Predictions", |
| 82 | + "documentation":"<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>" |
| 83 | + } |
| 84 | + }, |
| 85 | + "documentation":"<p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>" |
| 86 | + }, |
| 87 | + "InvalidInputException":{ |
| 88 | + "type":"structure", |
| 89 | + "members":{ |
| 90 | + "Message":{"shape":"ErrorMessage"} |
| 91 | + }, |
| 92 | + "documentation":"<p>The value that you provided was invalid or too long.</p>", |
| 93 | + "exception":true |
| 94 | + }, |
| 95 | + "InvalidNextTokenException":{ |
| 96 | + "type":"structure", |
| 97 | + "members":{ |
| 98 | + "Message":{"shape":"ErrorMessage"} |
| 99 | + }, |
| 100 | + "documentation":"<p>The token is not valid. Tokens expire after 24 hours.</p>", |
| 101 | + "exception":true |
| 102 | + }, |
| 103 | + "LimitExceededException":{ |
| 104 | + "type":"structure", |
| 105 | + "members":{ |
| 106 | + "Message":{"shape":"ErrorMessage"} |
| 107 | + }, |
| 108 | + "documentation":"<p>The limit on the number of requests per second has been exceeded.</p>", |
| 109 | + "exception":true |
| 110 | + }, |
| 111 | + "NextToken":{ |
| 112 | + "type":"string", |
| 113 | + "max":3000, |
| 114 | + "min":1 |
| 115 | + }, |
| 116 | + "Predictions":{ |
| 117 | + "type":"map", |
| 118 | + "key":{"shape":"Statistic"}, |
| 119 | + "value":{"shape":"TimeSeries"} |
| 120 | + }, |
| 121 | + "QueryForecastRequest":{ |
| 122 | + "type":"structure", |
| 123 | + "required":[ |
| 124 | + "ForecastArn", |
| 125 | + "Filters" |
| 126 | + ], |
| 127 | + "members":{ |
| 128 | + "ForecastArn":{ |
| 129 | + "shape":"Arn", |
| 130 | + "documentation":"<p>The Amazon Resource Name (ARN) of the forecast to query.</p>" |
| 131 | + }, |
| 132 | + "StartDate":{ |
| 133 | + "shape":"DateTime", |
| 134 | + "documentation":"<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>" |
| 135 | + }, |
| 136 | + "EndDate":{ |
| 137 | + "shape":"DateTime", |
| 138 | + "documentation":"<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>" |
| 139 | + }, |
| 140 | + "Filters":{ |
| 141 | + "shape":"Filters", |
| 142 | + "documentation":"<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>" |
| 143 | + }, |
| 144 | + "NextToken":{ |
| 145 | + "shape":"NextToken", |
| 146 | + "documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>" |
| 147 | + } |
| 148 | + } |
| 149 | + }, |
| 150 | + "QueryForecastResponse":{ |
| 151 | + "type":"structure", |
| 152 | + "members":{ |
| 153 | + "Forecast":{ |
| 154 | + "shape":"Forecast", |
| 155 | + "documentation":"<p>The forecast.</p>" |
| 156 | + } |
| 157 | + } |
| 158 | + }, |
| 159 | + "ResourceInUseException":{ |
| 160 | + "type":"structure", |
| 161 | + "members":{ |
| 162 | + "Message":{"shape":"ErrorMessage"} |
| 163 | + }, |
| 164 | + "documentation":"<p>The specified resource is in use.</p>", |
| 165 | + "exception":true |
| 166 | + }, |
| 167 | + "ResourceNotFoundException":{ |
| 168 | + "type":"structure", |
| 169 | + "members":{ |
| 170 | + "Message":{"shape":"ErrorMessage"} |
| 171 | + }, |
| 172 | + "documentation":"<p>We can't find that resource. Check the information that you've provided and try again.</p>", |
| 173 | + "exception":true |
| 174 | + }, |
| 175 | + "Statistic":{ |
| 176 | + "type":"string", |
| 177 | + "max":4 |
| 178 | + }, |
| 179 | + "TimeSeries":{ |
| 180 | + "type":"list", |
| 181 | + "member":{"shape":"DataPoint"} |
| 182 | + }, |
| 183 | + "Timestamp":{ |
| 184 | + "type":"string", |
| 185 | + "max":20, |
| 186 | + "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" |
| 187 | + } |
| 188 | + }, |
| 189 | + "documentation":"<p>Provides APIs for creating and managing Amazon Forecast resources.</p>" |
| 190 | +} |
0 commit comments