Annotation

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

A URL that you can access for additional remediation guidance.

Link copied to clipboard

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

Link copied to clipboard

The relative risk associated with any violations of this type.

Link copied to clipboard

The status of the Hook invocation from the downstream service.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Annotation.Builder.() -> Unit = {}): Annotation
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String