Class: Aws::ForecastQueryService::Types::QueryForecastRequest

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

Overview

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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateString

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.

Returns:

  • (String)


147
148
149
150
151
152
153
154
155
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 147

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

#filtersHash<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.

Returns:

  • (Hash<String,String>)


147
148
149
150
151
152
153
154
155
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 147

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

#forecast_arnString

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

Returns:

  • (String)


147
148
149
150
151
152
153
154
155
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 147

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

#next_tokenString

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)


147
148
149
150
151
152
153
154
155
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 147

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

#start_dateString

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.

Returns:

  • (String)


147
148
149
150
151
152
153
154
155
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/types.rb', line 147

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