Skip to content

DetectMitigationActionExecution

Source code in docs_src/capo_iot/types/detect_mitigation_action_execution.py
class DetectMitigationActionExecution(TypedDict, closed=True):
    task_id: NotRequired[
        "capo_iot.types.mitigation_actions_task_id.MitigationActionsTaskId"
    ]
    """<p> The unique identifier of the task. </p>"""
    violation_id: NotRequired["capo_iot.types.violation_id.ViolationId"]
    """<p> The unique identifier of the violation. </p>"""
    action_name: NotRequired[
        "capo_iot.types.mitigation_action_name.MitigationActionName"
    ]
    """<p> The friendly name that uniquely identifies the mitigation action. </p>"""
    thing_name: NotRequired[
        "capo_iot.types.device_defender_thing_name.DeviceDefenderThingName"
    ]
    """<p> The name of the thing. </p>"""
    execution_start_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The date a mitigation action was started. </p>"""
    execution_end_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The date a mitigation action ended. </p>"""
    status: NotRequired[
        "capo_iot.types.detect_mitigation_action_execution_status.DetectMitigationActionExecutionStatus"
    ]
    """<p> The status of a mitigation action. </p>"""
    error_code: NotRequired[
        "capo_iot.types.detect_mitigation_action_execution_error_code.DetectMitigationActionExecutionErrorCode"
    ]
    """<p> The error code of a mitigation action. </p>"""
    message: NotRequired["capo_iot.types.error_message.ErrorMessage"]
    """<p> The message of a mitigation action. </p>"""

action_name instance-attribute

action_name: NotRequired[MitigationActionName]

The friendly name that uniquely identifies the mitigation action.

error_code instance-attribute

The error code of a mitigation action.

execution_end_date instance-attribute

execution_end_date: NotRequired[Timestamp]

The date a mitigation action ended.

execution_start_date instance-attribute

execution_start_date: NotRequired[Timestamp]

The date a mitigation action was started.

message instance-attribute

message: NotRequired[ErrorMessage]

The message of a mitigation action.

status instance-attribute

The status of a mitigation action.

task_id instance-attribute

task_id: NotRequired[MitigationActionsTaskId]

The unique identifier of the task.

thing_name instance-attribute

thing_name: NotRequired[DeviceDefenderThingName]

The name of the thing.

violation_id instance-attribute

violation_id: NotRequired[ViolationId]

The unique identifier of the violation.