Skip to content

ForecastSummary

Source code in docs_src/capo_forecast/types/forecast_summary.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ForecastSummary(TypedDict, closed=True):
    forecast_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The ARN of the forecast.</p>"""
    forecast_name: NotRequired["capo_forecast.types.name.Name"]
    """<p>The name of the forecast.</p>"""
    predictor_arn: NotRequired["capo_forecast.types.string.String"]
    """<p>The ARN of the predictor used to generate the forecast.</p>"""
    created_using_auto_predictor: NotRequired["capo_forecast.types.boolean.Boolean"]
    """<p>Whether the Forecast was created from an AutoPredictor.</p>"""
    dataset_group_arn: NotRequired["capo_forecast.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the forecast. 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>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the 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 forecast creation 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>"""

created_using_auto_predictor instance-attribute 

created_using_auto_predictor: NotRequired[Boolean]

Whether the Forecast was created from an AutoPredictor.

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

When the forecast creation task was created.

dataset_group_arn instance-attribute 

dataset_group_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

forecast_arn instance-attribute 

forecast_arn: NotRequired[Arn]

The ARN of the forecast.

forecast_name instance-attribute 

forecast_name: NotRequired[Name]

The name of the forecast.

last_modification_time instance-attribute 

last_modification_time: NotRequired[Timestamp]

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.

message instance-attribute 

message: NotRequired[ErrorMessage]

If an error occurred, an informational message about the error.

predictor_arn instance-attribute 

predictor_arn: NotRequired[String]

The ARN of the predictor used to generate the forecast.

status instance-attribute 

status: NotRequired[Status]

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

The Status of the forecast must be ACTIVE before you can query or export the forecast.