Class: Aws::ForecastQueryService::Types::QueryWhatIfForecastRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-forecastqueryservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_date ⇒ String

The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd’T’HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

Returns:

  • (String) 


204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-forecastqueryservice/types.rb', line 204

class QueryWhatIfForecastRequest < Struct.new(
  :what_if_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:

‘: “client_21”`

To get the full what-if forecast, use the

CreateForecastExportJob][1

operation.

[1]: docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html

Returns:

  • (Hash<String,String>) 


204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-forecastqueryservice/types.rb', line 204

class QueryWhatIfForecastRequest < Struct.new(
  :what_if_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.

Returns:

  • (String) 


204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-forecastqueryservice/types.rb', line 204

class QueryWhatIfForecastRequest < Struct.new(
  :what_if_forecast_arn,
  :start_date,
  :end_date,
  :filters,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ String

The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd’T’HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

Returns:

  • (String) 


204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-forecastqueryservice/types.rb', line 204

class QueryWhatIfForecastRequest < Struct.new(
  :what_if_forecast_arn,
  :start_date,
  :end_date,
  :filters,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#what_if_forecast_arn ⇒ String

The Amazon Resource Name (ARN) of the what-if forecast to query.

Returns:

  • (String) 


204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-forecastqueryservice/types.rb', line 204

class QueryWhatIfForecastRequest < Struct.new(
  :what_if_forecast_arn,
  :start_date,
  :end_date,
  :filters,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end