Annotation ¶

class Annotation(TypedDict, closed=True):
    annotation_name: NotRequired[
        "capo_cloudformation.types.annotation_name.AnnotationName"
    ]
    """<p>An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.</p>"""
    status: NotRequired["capo_cloudformation.types.annotation_status.AnnotationStatus"]
    """<p>The status of the Hook invocation from the downstream service.</p>"""
    status_message: NotRequired[
        "capo_cloudformation.types.remediation_message_status_message.RemediationMessageStatusMessage"
    ]
    """<p>The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".</p>"""
    remediation_message: NotRequired[
        "capo_cloudformation.types.remediation_message_remediation_message.RemediationMessageRemediationMessage"
    ]
    """<p>Suggests what to change if your Hook returns a <code>FAILED</code> status. For example, "Block public access to the bucket".</p>"""
    remediation_link: NotRequired[
        "capo_cloudformation.types.annotation_remediation_link.AnnotationRemediationLink"
    ]
    """<p>A URL that you can access for additional remediation guidance.</p>"""
    severity_level: NotRequired[
        "capo_cloudformation.types.annotation_severity_level.AnnotationSeverityLevel"
    ]
    """<p>The relative risk associated with any violations of this type.</p>"""