Skip to content

QueryForecastRequest

Source code in docs_src/capo_forecastquery/types/query_forecast_request.py 
16
17
18
19
20
21
22
23
24
25
26
class QueryForecastRequest(TypedDict, closed=True):
    forecast_arn: "capo_forecastquery.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the forecast to query.</p>"""
    start_date: NotRequired["capo_forecastquery.types.date_time.DateTime"]
    """<p>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.</p>"""
    end_date: NotRequired["capo_forecastquery.types.date_time.DateTime"]
    """<p>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. </p>"""
    filters: "capo_forecastquery.types.filters.Filters"
    """<p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p> <p> <code>{"item_id" : "client_21"}</code> </p> <p>To get the full forecast, use the <a href="https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html">CreateForecastExportJob</a> operation.</p>"""
    next_token: NotRequired["capo_forecastquery.types.next_token.NextToken"]
    """<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"""

end_date instance-attribute 

end_date: NotRequired[DateTime]

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 instance-attribute 

filters: Filters

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.

forecast_arn instance-attribute 

forecast_arn: Arn

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

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.

start_date instance-attribute 

start_date: NotRequired[DateTime]

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.