Table of Contents
A low-level client representing Amazon Forecast Query Service:
import boto3
client = boto3.client('forecastquery')
These are the available methods:
Check if an operation can be paginated.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves a forecast filtered by the supplied criteria.
The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.
By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.
Note
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
See also: AWS API Documentation
Request Syntax
response = client.query_forecast(
ForecastArn='string',
StartDate='string',
EndDate='string',
Filters={
'string': 'string'
},
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the forecast to query.
[REQUIRED]
The filtering criteria to apply when retrieving the forecast. For example:
To get the full forecast, use the operation.
dict
Response Syntax
{
'Forecast': {
'Predictions': {
'string': [
{
'Timestamp': 'string',
'Value': 123.0
},
]
}
}
}
Response Structure
(dict) --
Forecast (dict) --
The forecast.
Predictions (dict) --
The forecast.
The string of the string to array map is one of the following values:
(string) --
(list) --
(dict) --
The forecast value for a specific date. Part of the Forecast object.
Timestamp (string) --
The timestamp of the specific forecast.
Value (float) --
The forecast value.
The available paginators are: