Skip to content

AlarmModelVersionSummary

Source code in docs_src/capo_iot_events/types/alarm_model_version_summary.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class AlarmModelVersionSummary(TypedDict, closed=True):
    alarm_model_name: NotRequired[
        "capo_iot_events.types.alarm_model_name.AlarmModelName"
    ]
    """<p>The name of the alarm model.</p>"""
    alarm_model_arn: NotRequired["capo_iot_events.types.alarm_model_arn.AlarmModelArn"]
    """<p>The ARN of the alarm model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"""
    alarm_model_version: NotRequired[
        "capo_iot_events.types.alarm_model_version.AlarmModelVersion"
    ]
    """<p>The version of the alarm model.</p>"""
    role_arn: NotRequired[
        "capo_iot_events.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"""
    creation_time: NotRequired["capo_iot_events.types.timestamp.Timestamp"]
    """<p>The time the alarm model was created, in the Unix epoch format.</p>"""
    last_update_time: NotRequired["capo_iot_events.types.timestamp.Timestamp"]
    """<p>The time the alarm model was last updated, in the Unix epoch format.</p>"""
    status: NotRequired[
        "capo_iot_events.types.alarm_model_version_status.AlarmModelVersionStatus"
    ]
    """<p>The status of the alarm model. The status can be one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The alarm model is active and it's ready to evaluate data.</p> </li> <li> <p> <code>ACTIVATING</code> - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.</p> </li> <li> <p> <code>INACTIVE</code> - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.</p> </li> <li> <p> <code>FAILED</code> - You couldn't create or update the alarm model. Check your alarm model information and try again.</p> </li> </ul>"""
    status_message: NotRequired["capo_iot_events.types.status_message.StatusMessage"]
    """<p> Contains information about the status of the alarm model version. </p>"""

alarm_model_arn instance-attribute 

alarm_model_arn: NotRequired[AlarmModelArn]

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

alarm_model_name instance-attribute 

alarm_model_name: NotRequired[AlarmModelName]

The name of the alarm model.

alarm_model_version instance-attribute 

alarm_model_version: NotRequired[AlarmModelVersion]

The version of the alarm model.

creation_time instance-attribute 

creation_time: NotRequired[Timestamp]

The time the alarm model was created, in the Unix epoch format.

last_update_time instance-attribute 

last_update_time: NotRequired[Timestamp]

The time the alarm model was last updated, in the Unix epoch format.

role_arn instance-attribute 

role_arn: NotRequired[AmazonResourceName]

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

status instance-attribute 

status: NotRequired[AlarmModelVersionStatus]

The status of the alarm model. The status can be one of the following values:

  • ACTIVE - The alarm model is active and it's ready to evaluate data.

  • ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

  • INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

  • FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

status_message instance-attribute 

status_message: NotRequired[StatusMessage]

Contains information about the status of the alarm model version.