Class: Aws::ForecastQueryService::Types::QueryForecastRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ForecastQueryService::Types::QueryForecastRequest
- Defined in:
- gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#end_date ⇒ String
The end date for the forecast.
-
#filters ⇒ Hash<String,String>
The filtering criteria to apply when retrieving the forecast.
-
#forecast_arn ⇒ String
The Amazon Resource Name (ARN) of the forecast to query.
-
#next_token ⇒ String
If the result of the previous request was truncated, the response includes a
NextToken
. -
#start_date ⇒ String
The start date for the forecast.
Instance Attribute Details
#end_date ⇒ String
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.
143 144 145 146 147 148 149 150 151 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 143 class QueryForecastRequest < Struct.new( :forecast_arn, :start_date, :end_date, :filters, :next_token) SENSITIVE = [] include Aws::Structure end |
#filters ⇒ Hash<String,String>
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 operation.
143 144 145 146 147 148 149 150 151 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 143 class QueryForecastRequest < Struct.new( :forecast_arn, :start_date, :end_date, :filters, :next_token) SENSITIVE = [] include Aws::Structure end |
#forecast_arn ⇒ String
The Amazon Resource Name (ARN) of the forecast to query.
143 144 145 146 147 148 149 150 151 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 143 class QueryForecastRequest < Struct.new( :forecast_arn, :start_date, :end_date, :filters, :next_token) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
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.
143 144 145 146 147 148 149 150 151 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 143 class QueryForecastRequest < Struct.new( :forecast_arn, :start_date, :end_date, :filters, :next_token) SENSITIVE = [] include Aws::Structure end |
#start_date ⇒ String
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.
143 144 145 146 147 148 149 150 151 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 143 class QueryForecastRequest < Struct.new( :forecast_arn, :start_date, :end_date, :filters, :next_token) SENSITIVE = [] include Aws::Structure end |