Skip to content

AuditMitigationActionExecutionMetadata

Source code in docs_src/capo_iot/types/audit_mitigation_action_execution_metadata.py
class AuditMitigationActionExecutionMetadata(TypedDict, closed=True):
    task_id: NotRequired[
        "capo_iot.types.mitigation_actions_task_id.MitigationActionsTaskId"
    ]
    """<p>The unique identifier for the task that applies the mitigation action.</p>"""
    finding_id: NotRequired["capo_iot.types.finding_id.FindingId"]
    """<p>The unique identifier for the findings to which the task and associated mitigation action are applied.</p>"""
    action_name: NotRequired[
        "capo_iot.types.mitigation_action_name.MitigationActionName"
    ]
    """<p>The friendly name of the mitigation action being applied by the task.</p>"""
    action_id: NotRequired["capo_iot.types.mitigation_action_id.MitigationActionId"]
    """<p>The unique identifier for the mitigation action being applied by the task.</p>"""
    status: NotRequired[
        "capo_iot.types.audit_mitigation_actions_execution_status.AuditMitigationActionsExecutionStatus"
    ]
    """<p>The current status of the task being executed.</p>"""
    start_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The date and time when the task was started.</p>"""
    end_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The date and time when the task was completed or canceled. Blank if the task is still running.</p>"""
    error_code: NotRequired["capo_iot.types.error_code.ErrorCode"]
    """<p>If an error occurred, the code that indicates which type of error occurred.</p>"""
    message: NotRequired["capo_iot.types.error_message.ErrorMessage"]
    """<p>If an error occurred, a message that describes the error.</p>"""

action_id instance-attribute

action_id: NotRequired[MitigationActionId]

The unique identifier for the mitigation action being applied by the task.

action_name instance-attribute

action_name: NotRequired[MitigationActionName]

The friendly name of the mitigation action being applied by the task.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The date and time when the task was completed or canceled. Blank if the task is still running.

error_code instance-attribute

error_code: NotRequired[ErrorCode]

If an error occurred, the code that indicates which type of error occurred.

finding_id instance-attribute

finding_id: NotRequired[FindingId]

The unique identifier for the findings to which the task and associated mitigation action are applied.

message instance-attribute

message: NotRequired[ErrorMessage]

If an error occurred, a message that describes the error.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The date and time when the task was started.

status instance-attribute

The current status of the task being executed.

task_id instance-attribute

task_id: NotRequired[MitigationActionsTaskId]

The unique identifier for the task that applies the mitigation action.