Table of Contents
ForecastQueryService.Client¶A low-level client representing Amazon Forecast Query Service
Provides APIs for creating and managing Amazon Forecast resources.
import boto3
client = boto3.client('forecastquery')
These are the available methods:
can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
query_forecast(**kwargs)¶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.
NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.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:
The default setting is ["0.1", "0.5", "0.9"] . Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.
(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
ForecastQueryService.Client.exceptions.ResourceNotFoundExceptionForecastQueryService.Client.exceptions.ResourceInUseExceptionForecastQueryService.Client.exceptions.InvalidInputExceptionForecastQueryService.Client.exceptions.LimitExceededExceptionForecastQueryService.Client.exceptions.InvalidNextTokenExceptionquery_what_if_forecast(**kwargs)¶Retrieves a what-if forecast.
See also: AWS API Documentation
Request Syntax
response = client.query_what_if_forecast(
WhatIfForecastArn='string',
StartDate='string',
EndDate='string',
Filters={
'string': 'string'
},
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the what-if 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 what-if forecast, use the CreateForecastExportJob operation.
NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.dict
Response Syntax
{
'Forecast': {
'Predictions': {
'string': [
{
'Timestamp': 'string',
'Value': 123.0
},
]
}
}
}
Response Structure
(dict) --
Forecast (dict) --
Provides information about a forecast. Returned as part of the QueryForecast response.
Predictions (dict) --
The forecast.
The string of the string-to-array map is one of the following values:
The default setting is ["0.1", "0.5", "0.9"] . Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.
(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
ForecastQueryService.Client.exceptions.ResourceNotFoundExceptionForecastQueryService.Client.exceptions.ResourceInUseExceptionForecastQueryService.Client.exceptions.InvalidInputExceptionForecastQueryService.Client.exceptions.LimitExceededExceptionForecastQueryService.Client.exceptions.InvalidNextTokenExceptionThe available paginators are: