PredictorSummary ¶

class PredictorSummary(TypedDict, closed=True):
    predictor_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The ARN of the predictor.</p>"""
    predictor_name: NotRequired["capo_forecast.types.name.Name"]
    """<p>The name of the predictor.</p>"""
    dataset_group_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.</p>"""
    is_auto_predictor: NotRequired["capo_forecast.types.boolean.Boolean"]
    """<p>Whether AutoPredictor was used to create the predictor.</p>"""
    reference_predictor_summary: NotRequired[
        "capo_forecast.types.reference_predictor_summary.ReferencePredictorSummary"
    ]
    """<p>A summary of the reference predictor used if the predictor was retrained or upgraded.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>"""
    message: NotRequired["capo_forecast.types.error_message.ErrorMessage"]
    """<p>If an error occurred, an informational message about the error.</p>"""
    creation_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the model training task was created.</p>"""
    last_modification_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"""