Skip to content

Compliance

Source code in docs_src/capo_securityhub/types/compliance.py
class Compliance(TypedDict, closed=True):
    status: NotRequired["capo_securityhub.types.compliance_status.ComplianceStatus"]
    """<p>Typically summarizes the result of a control check.</p> <p>For Security Hub CSPM controls, valid values for <code>Status</code> are as follows.</p> <ul> <li> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported for your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was <code>NOT_APPLICABLE</code>. If the Config evaluation result was <code>NOT_APPLICABLE</code> for a Security Hub CSPM control, Security Hub CSPM automatically archives the finding after 3 days.</p> </li> </ul> </li> </ul>"""
    related_requirements: NotRequired[
        "capo_securityhub.types.related_requirements_list.RelatedRequirementsList"
    ]
    """<p>Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.</p> <p>Array Members: Maximum number of 32 items.</p>"""
    status_reasons: NotRequired[
        "capo_securityhub.types.status_reasons_list.StatusReasonsList"
    ]
    """<p>Typically used to provide a list of reasons for the value of <code>Status</code>.</p>"""
    security_control_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p> Typically provides the unique identifier of a control across standards. For Security Hub CSPM controls, this field consists of an Amazon Web Services service and a unique number, such as <code>APIGateway.5</code>. </p>"""
    associated_standards: NotRequired[
        "capo_securityhub.types.associated_standards_list.AssociatedStandardsList"
    ]
    """<p>Typically provides an array of enabled security standards in which a security control is currently enabled. </p>"""
    security_control_parameters: NotRequired[
        "capo_securityhub.types.security_control_parameters_list.SecurityControlParametersList"
    ]
    """<p> Typically an object that includes security control parameter names and values. </p>"""

associated_standards instance-attribute

associated_standards: NotRequired[AssociatedStandardsList]

Typically provides an array of enabled security standards in which a security control is currently enabled.

related_requirements instance-attribute

related_requirements: NotRequired[RelatedRequirementsList]

Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.

Array Members: Maximum number of 32 items.

security_control_id instance-attribute

security_control_id: NotRequired[NonEmptyString]

Typically provides the unique identifier of a control across standards. For Security Hub CSPM controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

security_control_parameters instance-attribute

security_control_parameters: NotRequired[SecurityControlParametersList]

Typically an object that includes security control parameter names and values.

status instance-attribute

status: NotRequired[ComplianceStatus]

Typically summarizes the result of a control check.

For Security Hub CSPM controls, valid values for Status are as follows.

    • PASSED - Standards check passed for all evaluated resources.

    • WARNING - Some information is missing or this check is not supported for your configuration.

    • FAILED - Standards check failed for at least one evaluated resource.

    • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE for a Security Hub CSPM control, Security Hub CSPM automatically archives the finding after 3 days.

status_reasons instance-attribute

status_reasons: NotRequired[StatusReasonsList]

Typically used to provide a list of reasons for the value of Status.