Table of Contents
A low-level client representing Amazon Forecast Query Service
Provides APIs for creating and managing Amazon Forecast resources.
client = session.create_client('forecastquery')
These are the available methods:
Check if an operation can be paginated.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.
To get the full forecast, use the CreateForecastExportJob operation.
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 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.
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.
Exceptions
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
The value is invalid or is too long.
Example
try:
...
except client.exceptions.InvalidInputException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The value is invalid or is too long.
The token is not valid. Tokens expire after 24 hours.
Example
try:
...
except client.exceptions.InvalidNextTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The token is not valid. Tokens expire after 24 hours.
The limit on the number of requests per second has been exceeded.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The limit on the number of requests per second has been exceeded.
The specified resource is in use.
Example
try:
...
except client.exceptions.ResourceInUseException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The specified resource is in use.
We can't find that resource. Check the information that you've provided and try again.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
We can't find that resource. Check the information that you've provided and try again.
The available paginators are: