Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryForecastRequest

Hierarchy

Index

Properties

Optional EndDate

EndDate: undefined | 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.

Filters

Filters: Record<string, string> | undefined

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.

ForecastArn

ForecastArn: string | undefined

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

Optional NextToken

NextToken: undefined | 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.

Optional StartDate

StartDate: undefined | 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.