github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/forecastquery/2018-06-26/docs-2.json

{
  "version": "2.0",
  "service": "<p>Provides APIs for creating and managing Amazon Forecast resources.</p>",
  "operations": {
    "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>"
  },
  "shapes": {
    "Arn": {
      "base": null,
      "refs": {
        "QueryForecastRequest$ForecastArn": "<p>The Amazon Resource Name (ARN) of the forecast to query.</p>"
      }
    },
    "AttributeName": {
      "base": null,
      "refs": {
        "Filters$key": null
      }
    },
    "AttributeValue": {
      "base": null,
      "refs": {
        "Filters$value": null
      }
    },
    "DataPoint": {
      "base": "<p>The forecast value for a specific date. Part of the <a>Forecast</a> object.</p>",
      "refs": {
        "TimeSeries$member": null
      }
    },
    "DateTime": {
      "base": null,
      "refs": {
        "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>",
        "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>"
      }
    },
    "Double": {
      "base": null,
      "refs": {
        "DataPoint$Value": "<p>The forecast value.</p>"
      }
    },
    "ErrorMessage": {
      "base": null,
      "refs": {
        "InvalidInputException$Message": null,
        "InvalidNextTokenException$Message": null,
        "LimitExceededException$Message": null,
        "ResourceInUseException$Message": null,
        "ResourceNotFoundException$Message": null
      }
    },
    "Filters": {
      "base": null,
      "refs": {
        "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>"
      }
    },
    "Forecast": {
      "base": "<p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>",
      "refs": {
        "QueryForecastResponse$Forecast": "<p>The forecast.</p>"
      }
    },
    "InvalidInputException": {
      "base": "<p>The value is invalid or is too long.</p>",
      "refs": {
      }
    },
    "InvalidNextTokenException": {
      "base": "<p>The token is not valid. Tokens expire after 24 hours.</p>",
      "refs": {
      }
    },
    "LimitExceededException": {
      "base": "<p>The limit on the number of requests per second has been exceeded.</p>",
      "refs": {
      }
    },
    "NextToken": {
      "base": null,
      "refs": {
        "QueryForecastRequest$NextToken": "<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>"
      }
    },
    "Predictions": {
      "base": null,
      "refs": {
        "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>"
      }
    },
    "QueryForecastRequest": {
      "base": null,
      "refs": {
      }
    },
    "QueryForecastResponse": {
      "base": null,
      "refs": {
      }
    },
    "ResourceInUseException": {
      "base": "<p>The specified resource is in use.</p>",
      "refs": {
      }
    },
    "ResourceNotFoundException": {
      "base": "<p>We can't find that resource. Check the information that you've provided and try again.</p>",
      "refs": {
      }
    },
    "Statistic": {
      "base": null,
      "refs": {
        "Predictions$key": null
      }
    },
    "TimeSeries": {
      "base": null,
      "refs": {
        "Predictions$value": null
      }
    },
    "Timestamp": {
      "base": null,
      "refs": {
        "DataPoint$Timestamp": "<p>The timestamp of the specific forecast.</p>"
      }
    }
  }
}