Skip to content

CloudFormation  >  Structures  >  Annotation

Annotation

Structure Class

Annotation dataclass

Bases: _SerdeShape

The Annotation data type.

A GetHookResult call returns detailed information and remediation guidance from Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.

Attributes

annotation_name class-attribute instance-attribute 
annotation_name: str | None = ...

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.

remediation_link: str | None = ...

A URL that you can access for additional remediation guidance.

remediation_message class-attribute instance-attribute 
remediation_message: str | None = ...

Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

severity_level class-attribute instance-attribute 
severity_level: str | None = ...

The relative risk associated with any violations of this type.

status class-attribute instance-attribute 
status: str | None = ...

The status of the Hook invocation from the downstream service.

status_message class-attribute instance-attribute 
status_message: str | None = ...

The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".