Skip to content

AuditCheckDetails

Source code in docs_src/capo_iot/types/audit_check_details.py
class AuditCheckDetails(TypedDict, closed=True):
    check_run_status: NotRequired[
        "capo_iot.types.audit_check_run_status.AuditCheckRunStatus"
    ]
    """<p>The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".</p>"""
    check_compliant: NotRequired["capo_iot.types.check_compliant.CheckCompliant"]
    """<p>True if the check is complete and found all resources compliant.</p>"""
    total_resources_count: NotRequired[
        "capo_iot.types.total_resources_count.TotalResourcesCount"
    ]
    """<p>The number of resources on which the check was performed.</p>"""
    non_compliant_resources_count: NotRequired[
        "capo_iot.types.non_compliant_resources_count.NonCompliantResourcesCount"
    ]
    """<p>The number of resources that were found noncompliant during the check.</p>"""
    suppressed_non_compliant_resources_count: NotRequired[
        "capo_iot.types.suppressed_non_compliant_resources_count.SuppressedNonCompliantResourcesCount"
    ]
    """<p> Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed. </p>"""
    error_code: NotRequired["capo_iot.types.error_code.ErrorCode"]
    """<p>The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".</p>"""
    message: NotRequired["capo_iot.types.error_message.ErrorMessage"]
    """<p>The message associated with any error encountered when this check is performed during this audit.</p>"""

check_compliant instance-attribute

check_compliant: NotRequired[CheckCompliant]

True if the check is complete and found all resources compliant.

check_run_status instance-attribute

check_run_status: NotRequired[AuditCheckRunStatus]

The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

error_code instance-attribute

error_code: NotRequired[ErrorCode]

The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

message instance-attribute

message: NotRequired[ErrorMessage]

The message associated with any error encountered when this check is performed during this audit.

non_compliant_resources_count instance-attribute

non_compliant_resources_count: NotRequired[NonCompliantResourcesCount]

The number of resources that were found noncompliant during the check.

suppressed_non_compliant_resources_count instance-attribute

suppressed_non_compliant_resources_count: NotRequired[
    SuppressedNonCompliantResourcesCount
]

Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

total_resources_count instance-attribute

total_resources_count: NotRequired[TotalResourcesCount]

The number of resources on which the check was performed.