ForecastService / Client / list_predictor_backtest_export_jobs
list_predictor_backtest_export_jobs#
- ForecastService.Client.list_predictor_backtest_export_jobs(**kwargs)#
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.
To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.
See also: AWS API Documentation
Request Syntax
response = client.list_predictor_backtest_export_jobs( 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, 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.
(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
{ 'PredictorBacktestExportJobs': [ { 'PredictorBacktestExportJobArn': 'string', 'PredictorBacktestExportJobName': 'string', 'Destination': { 'S3Config': { 'Path': 'string', 'RoleArn': 'string', 'KMSKeyArn': 'string' } }, 'Status': 'string', 'Message': 'string', 'CreationTime': datetime(2015, 1, 1), 'LastModificationTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
PredictorBacktestExportJobs (list) –
An array of objects that summarize the properties of each predictor backtest export job.
(dict) –
Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call the DescribePredictorBacktestExportJob operation, and provide the listed
PredictorBacktestExportJobArn
.PredictorBacktestExportJobArn (string) –
The Amazon Resource Name (ARN) of the predictor backtest export job.
PredictorBacktestExportJobName (string) –
The name of the predictor backtest export job.
Destination (dict) –
The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
S3Config (dict) –
The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
Path (string) –
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
RoleArn (string) –
The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the
KMSKeyArn
key, the role must allow access to the key.Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn’t in your account, you get an
InvalidInputException
error.KMSKeyArn (string) –
The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
Status (string) –
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Message (string) –
Information about any errors that may have occurred during the backtest export.
CreationTime (datetime) –
When the predictor backtest export job 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) –
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
Exceptions