Skip to content

DetectMitigationActionsTaskSummary

Source code in docs_src/capo_iot/types/detect_mitigation_actions_task_summary.py
class DetectMitigationActionsTaskSummary(TypedDict, closed=True):
    task_id: NotRequired[
        "capo_iot.types.mitigation_actions_task_id.MitigationActionsTaskId"
    ]
    """<p> The unique identifier of the task. </p>"""
    task_status: NotRequired[
        "capo_iot.types.detect_mitigation_actions_task_status.DetectMitigationActionsTaskStatus"
    ]
    """<p> The status of the task. </p>"""
    task_start_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The date the task started. </p>"""
    task_end_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p> The date the task ended. </p>"""
    target: NotRequired[
        "capo_iot.types.detect_mitigation_actions_task_target.DetectMitigationActionsTaskTarget"
    ]
    """<p> Specifies the ML Detect findings to which the mitigation actions are applied. </p>"""
    violation_event_occurrence_range: NotRequired[
        "capo_iot.types.violation_event_occurrence_range.ViolationEventOccurrenceRange"
    ]
    """<p> Specifies the time period of which violation events occurred between. </p>"""
    only_active_violations_included: "capo_iot.types.primitive_boolean.PrimitiveBoolean"
    """<p> Includes only active violations. </p>"""
    suppressed_alerts_included: "capo_iot.types.primitive_boolean.PrimitiveBoolean"
    """<p> Includes suppressed alerts. </p>"""
    actions_definition: NotRequired[
        "capo_iot.types.mitigation_action_list.MitigationActionList"
    ]
    """<p> The definition of the actions. </p>"""
    task_statistics: NotRequired[
        "capo_iot.types.detect_mitigation_actions_task_statistics.DetectMitigationActionsTaskStatistics"
    ]
    """<p> The statistics of a mitigation action task. </p>"""

actions_definition instance-attribute

actions_definition: NotRequired[MitigationActionList]

The definition of the actions.

only_active_violations_included instance-attribute

only_active_violations_included: PrimitiveBoolean

Includes only active violations.

suppressed_alerts_included instance-attribute

suppressed_alerts_included: PrimitiveBoolean

Includes suppressed alerts.

target instance-attribute

target: NotRequired[DetectMitigationActionsTaskTarget]

Specifies the ML Detect findings to which the mitigation actions are applied.

task_end_time instance-attribute

task_end_time: NotRequired[Timestamp]

The date the task ended.

task_id instance-attribute

task_id: NotRequired[MitigationActionsTaskId]

The unique identifier of the task.

task_start_time instance-attribute

task_start_time: NotRequired[Timestamp]

The date the task started.

task_statistics instance-attribute

task_statistics: NotRequired[DetectMitigationActionsTaskStatistics]

The statistics of a mitigation action task.

task_status instance-attribute

task_status: NotRequired[DetectMitigationActionsTaskStatus]

The status of the task.

violation_event_occurrence_range instance-attribute

violation_event_occurrence_range: NotRequired[ViolationEventOccurrenceRange]

Specifies the time period of which violation events occurred between.