ForecastService / Client / list_forecasts
list_forecasts#
- ForecastService.Client.list_forecasts(**kwargs)#
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
See also: AWS API Documentation
Request Syntax
response = client.list_forecasts( NextToken='string', MaxResults=123, Filters=[ { 'Key': 'string', 'Value': 'string', 'Condition': 'IS'|'IS_NOT' }, ] )
- Parameters:
NextToken (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.MaxResults (integer) – The number of items to return in the response.
Filters (list) –
An array of filters. For each filter, you provide a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
(dict) –
Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.Key (string) – [REQUIRED]
The name of the parameter to filter on.
Value (string) – [REQUIRED]
The value to match.
Condition (string) – [REQUIRED]
The condition to apply. To include the objects that match the statement, specify
IS
. To exclude matching objects, specifyIS_NOT
.
- Return type:
dict
- Returns:
Response Syntax
{ 'Forecasts': [ { 'ForecastArn': 'string', 'ForecastName': 'string', 'PredictorArn': 'string', 'CreatedUsingAutoPredictor': True|False, 'DatasetGroupArn': 'string', 'Status': 'string', 'Message': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModificationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
Forecasts (list) –
An array of objects that summarize each forecast’s properties.
(dict) –
Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the
ForecastArn
that is listed in the summary.ForecastArn (string) –
The ARN of the forecast.
ForecastName (string) –
The name of the forecast.
PredictorArn (string) –
The ARN of the predictor used to generate the forecast.
CreatedUsingAutoPredictor (boolean) –
Whether the Forecast was created from an AutoPredictor.
DatasetGroupArn (string) –
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
Status (string) –
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Note
The
Status
of the forecast must beACTIVE
before you can query or export the forecast.Message (string) –
If an error occurred, an informational message about the error.
CreationTime (datetime) –
When the forecast creation task was created.
LastModificationTime (datetime) –
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
NextToken (string) –
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
Exceptions
ForecastService.Client.exceptions.InvalidNextTokenException
ForecastService.Client.exceptions.InvalidInputException