Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
ListPredictorBacktestExportJobs
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.
Important
Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.
Request Syntax
{
"Filters": [
{
"Condition": "string
",
"Key": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- Filters
-
An array of filters. For each filter, provide a condition and a match statement. The condition is either
IS
orIS_NOT
, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. 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 predictor backtest export jobs that match the statement, specifyIS
. To exclude matching predictor backtest export jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values arePredictorArn
andStatus
. -
Value
- The value to match.
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The number of items to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
Required: No
Response Syntax
{
"NextToken": "string",
"PredictorBacktestExportJobs": [
{
"CreationTime": number,
"Destination": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"LastModificationTime": number,
"Message": "string",
"PredictorBacktestExportJobArn": "string",
"PredictorBacktestExportJobName": "string",
"Status": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 3000.
Pattern:
.+
- PredictorBacktestExportJobs
-
An array of objects that summarize the properties of each predictor backtest export job.
Type: Array of PredictorBacktestExportJobSummary objects
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The token is not valid. Tokens expire after 24 hours.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: