You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing QueryForecastRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  forecast_arn: "Arn", # required
  start_date: "DateTime",
  end_date: "DateTime",
  filters: { # required
    "AttributeName" => "AttributeValue",
  },
  next_token: "NextToken",
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (String) —

    The end date for the forecast.

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

Returns:

  • (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.

Returns:

  • (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. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Returns:

  • (String) —

    If the result of the previous request was truncated, the response includes a NextToken.

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

Returns:

  • (String) —

    The start date for the forecast.