ForecastService / Client / describe_predictor_backtest_export_job

describe_predictor_backtest_export_job#

ForecastService.Client.describe_predictor_backtest_export_job(**kwargs)#

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

CreationTime
LastModificationTime
Status
Message (if an error occurred)

Request Syntax

response = client.describe_predictor_backtest_export_job(
    PredictorBacktestExportJobArn='string'
)

Parameters:

PredictorBacktestExportJobArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the predictor backtest export job.

Return type:

dict

Returns:

Response Syntax

{
    'PredictorBacktestExportJobArn': 'string',
    'PredictorBacktestExportJobName': 'string',
    'PredictorArn': 'string',
    'Destination': {
        'S3Config': {
            'Path': 'string',
            'RoleArn': 'string',
            'KMSKeyArn': 'string'
        }
    },
    'Message': 'string',
    'Status': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'Format': 'string'
}

Response Structure

(dict) –
- PredictorBacktestExportJobArn (string) –
  
  The Amazon Resource Name (ARN) of the predictor backtest export job.
- PredictorBacktestExportJobName (string) –
  
  The name of the predictor backtest export job.
- PredictorArn (string) –
  
  The Amazon Resource Name (ARN) of the predictor.
- 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.
- Message (string) –
  
  Information about any errors that may have occurred during the backtest export.
- 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
- 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 - The CreationTime.
  - CREATE_IN_PROGRESS - The current timestamp.
  - CREATE_STOPPING - The current timestamp.
  - CREATE_STOPPED - When the job stopped.
  - ACTIVE or CREATE_FAILED - When the job finished or failed.
- Format (string) –
  
  The format of the exported data, CSV or PARQUET.

Exceptions

ForecastService.Client.exceptions.InvalidInputException
ForecastService.Client.exceptions.ResourceNotFoundException