/AWS1/CL_FRMANNOTATION

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_annotationname TYPE /AWS1/FRMANNOTATIONNAME /AWS1/FRMANNOTATIONNAME

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.

iv_status TYPE /AWS1/FRMANNOTATIONSTATUS /AWS1/FRMANNOTATIONSTATUS

The status of the Hook invocation from the downstream service.

iv_statusmessage TYPE /AWS1/FRMREMEDIATIONMSGSTATMSG /AWS1/FRMREMEDIATIONMSGSTATMSG

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

iv_remediationmessage TYPE /AWS1/FRMREMEDIATIONMSGREMED00 /AWS1/FRMREMEDIATIONMSGREMED00

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

iv_remediationlink TYPE /AWS1/FRMANNOTATIONREMEDIATI00 /AWS1/FRMANNOTATIONREMEDIATI00

A URL that you can access for additional remediation guidance.

iv_severitylevel TYPE /AWS1/FRMANNOTATIONSEVERITYL00 /AWS1/FRMANNOTATIONSEVERITYL00

The relative risk associated with any violations of this type.

---

Queryable Attributes

AnnotationName

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.

Accessible with the following methods

Method	Description
GET_ANNOTATIONNAME()	Getter for ANNOTATIONNAME, with configurable default
ASK_ANNOTATIONNAME()	Getter for ANNOTATIONNAME w/ exceptions if field has no valu
HAS_ANNOTATIONNAME()	Determine if ANNOTATIONNAME has a value

Status

The status of the Hook invocation from the downstream service.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

StatusMessage

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

Accessible with the following methods

Method	Description
GET_STATUSMESSAGE()	Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE()	Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE()	Determine if STATUSMESSAGE has a value

RemediationMessage

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

Accessible with the following methods

Method	Description
GET_REMEDIATIONMESSAGE()	Getter for REMEDIATIONMESSAGE, with configurable default
ASK_REMEDIATIONMESSAGE()	Getter for REMEDIATIONMESSAGE w/ exceptions if field has no
HAS_REMEDIATIONMESSAGE()	Determine if REMEDIATIONMESSAGE has a value

RemediationLink

A URL that you can access for additional remediation guidance.

Accessible with the following methods

Method	Description
GET_REMEDIATIONLINK()	Getter for REMEDIATIONLINK, with configurable default
ASK_REMEDIATIONLINK()	Getter for REMEDIATIONLINK w/ exceptions if field has no val
HAS_REMEDIATIONLINK()	Determine if REMEDIATIONLINK has a value

SeverityLevel

The relative risk associated with any violations of this type.

Accessible with the following methods

Method	Description
GET_SEVERITYLEVEL()	Getter for SEVERITYLEVEL, with configurable default
ASK_SEVERITYLEVEL()	Getter for SEVERITYLEVEL w/ exceptions if field has no value
HAS_SEVERITYLEVEL()	Determine if SEVERITYLEVEL has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ANNOTATIONLIST

TYPES TT_ANNOTATIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_FRMANNOTATION WITH DEFAULT KEY
.