Skip to content

AuditFinding

Source code in docs_src/capo_iot/types/audit_finding.py
class AuditFinding(TypedDict, closed=True):
    finding_id: NotRequired["capo_iot.types.finding_id.FindingId"]
    """<p>A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.</p>"""
    task_id: NotRequired["capo_iot.types.audit_task_id.AuditTaskId"]
    """<p>The ID of the audit that generated this result (finding).</p>"""
    check_name: NotRequired["capo_iot.types.audit_check_name.AuditCheckName"]
    """<p>The audit check that generated this result.</p>"""
    task_start_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the audit started.</p>"""
    finding_time: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the result (finding) was discovered.</p>"""
    severity: NotRequired["capo_iot.types.audit_finding_severity.AuditFindingSeverity"]
    """<p>The severity of the result (finding).</p>"""
    non_compliant_resource: NotRequired[
        "capo_iot.types.non_compliant_resource.NonCompliantResource"
    ]
    """<p>The resource that was found to be noncompliant with the audit check.</p>"""
    related_resources: NotRequired["capo_iot.types.related_resources.RelatedResources"]
    """<p>The list of related resources.</p>"""
    reason_for_non_compliance: NotRequired[
        "capo_iot.types.reason_for_non_compliance.ReasonForNonCompliance"
    ]
    """<p>The reason the resource was noncompliant.</p>"""
    reason_for_non_compliance_code: NotRequired[
        "capo_iot.types.reason_for_non_compliance_code.ReasonForNonComplianceCode"
    ]
    """<p>A code that indicates the reason that the resource was noncompliant.</p>"""
    is_suppressed: NotRequired["capo_iot.types.is_suppressed.IsSuppressed"]
    """<p> Indicates whether the audit finding was suppressed or not during reporting. </p>"""

check_name instance-attribute

check_name: NotRequired[AuditCheckName]

The audit check that generated this result.

finding_id instance-attribute

finding_id: NotRequired[FindingId]

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

finding_time instance-attribute

finding_time: NotRequired[Timestamp]

The time the result (finding) was discovered.

is_suppressed instance-attribute

is_suppressed: NotRequired[IsSuppressed]

Indicates whether the audit finding was suppressed or not during reporting.

non_compliant_resource instance-attribute

non_compliant_resource: NotRequired[NonCompliantResource]

The resource that was found to be noncompliant with the audit check.

reason_for_non_compliance instance-attribute

reason_for_non_compliance: NotRequired[ReasonForNonCompliance]

The reason the resource was noncompliant.

reason_for_non_compliance_code instance-attribute

reason_for_non_compliance_code: NotRequired[ReasonForNonComplianceCode]

A code that indicates the reason that the resource was noncompliant.

related_resources instance-attribute

related_resources: NotRequired[RelatedResources]

The list of related resources.

severity instance-attribute

severity: NotRequired[AuditFindingSeverity]

The severity of the result (finding).

task_id instance-attribute

task_id: NotRequired[AuditTaskId]

The ID of the audit that generated this result (finding).

task_start_time instance-attribute

task_start_time: NotRequired[Timestamp]

The time the audit started.