class Aws::ForecastQueryService::Types::QueryForecastRequest
@note When making an API call, you may pass QueryForecastRequest
data as a hash: { forecast_arn: "Arn", # required start_date: "DateTime", end_date: "DateTime", filters: { # required "AttributeName" => "AttributeValue", }, next_token: "NextToken", }
@!attribute [rw] forecast_arn
The Amazon Resource Name (ARN) of the forecast to query. @return [String]
@!attribute [rw] start_date
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. @return [String]
@!attribute [rw] end_date
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. @return [String]
@!attribute [rw] filters
The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for `client_21` in the electricity usage dataset, specify the following: `\{"item_id" : "client_21"\}` To get the full forecast, use the [CreateForecastExportJob][1] operation. [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html @return [Hash<String,String>]
@!attribute [rw] next_token
If the result of the previous request was truncated, the response includes a `NextToken`. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryForecastRequest AWS API Documentation
Constants
- SENSITIVE