Skip to content

MonitorSummary

Source code in docs_src/capo_forecast/types/monitor_summary.py
class MonitorSummary(TypedDict, closed=True):
    monitor_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the monitor resource.</p>"""
    monitor_name: NotRequired["capo_forecast.types.name.Name"]
    """<p>The name of the monitor resource.</p>"""
    resource_arn: NotRequired["capo_forecast.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>"""
    status: NotRequired["capo_forecast.types.status.Status"]
    """<p>The status of the monitor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</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> </ul>"""
    creation_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>When the monitor resource was created.</p>"""
    last_modification_time: NotRequired["capo_forecast.types.timestamp.Timestamp"]
    """<p>The last time the monitor 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>STOPPED</code> - When the resource stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the monitor creation finished or failed.</p> </li> </ul>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

When the monitor resource was created.

last_modification_time instance-attribute

last_modification_time: NotRequired[Timestamp]

The last time the monitor resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • STOPPED - When the resource stopped.

  • ACTIVE or CREATE_FAILED - When the monitor creation finished or failed.

monitor_arn instance-attribute

monitor_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the monitor resource.

monitor_name instance-attribute

monitor_name: NotRequired[Name]

The name of the monitor resource.

resource_arn instance-attribute

resource_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the predictor being monitored.

status instance-attribute

status: NotRequired[Status]

The status of the monitor. States include:

  • ACTIVE

  • ACTIVE_STOPPING, ACTIVE_STOPPED

  • UPDATE_IN_PROGRESS

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED