/AWS1/CL_FRMGETHOOKRSLTOUTPUT¶
GetHookResultOutput
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_hookresultid TYPE /AWS1/FRMHOOKINVOCATIONID /AWS1/FRMHOOKINVOCATIONID¶
The unique identifier of the Hook result.
iv_invocationpoint TYPE /AWS1/FRMHOOKINVOCATIONPOINT /AWS1/FRMHOOKINVOCATIONPOINT¶
The specific point in the provisioning process where the Hook is invoked.
iv_failuremode TYPE /AWS1/FRMHOOKFAILUREMODE /AWS1/FRMHOOKFAILUREMODE¶
The failure mode of the invocation.
iv_typename TYPE /AWS1/FRMHOOKTYPENAME /AWS1/FRMHOOKTYPENAME¶
The name of the Hook that was invoked.
iv_originaltypename TYPE /AWS1/FRMHOOKTYPENAME /AWS1/FRMHOOKTYPENAME¶
The original public type name of the Hook when an alias is used.
For example, if you activate
AWS::Hooks::GuardHookwith aliasMyCompany::Custom::GuardHook, thenTypeNamewill beMyCompany::Custom::GuardHookandOriginalTypeNamewill beAWS::Hooks::GuardHook.
iv_typeversionid TYPE /AWS1/FRMHOOKTYPEVERSIONID /AWS1/FRMHOOKTYPEVERSIONID¶
The version identifier of the Hook that was invoked.
iv_typeconfversionid TYPE /AWS1/FRMHOOKTYPECONFVERSIONID /AWS1/FRMHOOKTYPECONFVERSIONID¶
The version identifier of the Hook configuration data that was used during invocation.
iv_typearn TYPE /AWS1/FRMHOOKTYPEARN /AWS1/FRMHOOKTYPEARN¶
The Amazon Resource Name (ARN) of the Hook.
iv_status TYPE /AWS1/FRMHOOKSTATUS /AWS1/FRMHOOKSTATUS¶
The status of the Hook invocation. The following statuses are possible:
HOOK_IN_PROGRESS: The Hook is currently running.
HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
HOOK_FAILED: The Hook encountered an error during execution.
iv_hookstatusreason TYPE /AWS1/FRMHOOKSTATUSREASON /AWS1/FRMHOOKSTATUSREASON¶
A message that provides additional details about the Hook invocation status.
iv_invokedat TYPE /AWS1/FRMTIMESTAMP /AWS1/FRMTIMESTAMP¶
The timestamp when the Hook was invoked.
io_target TYPE REF TO /AWS1/CL_FRMHOOKTARGET /AWS1/CL_FRMHOOKTARGET¶
Information about the target of the Hook invocation.
it_annotations TYPE /AWS1/CL_FRMANNOTATION=>TT_ANNOTATIONLIST TT_ANNOTATIONLIST¶
A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.
Queryable Attributes¶
HookResultId¶
The unique identifier of the Hook result.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HOOKRESULTID() |
Getter for HOOKRESULTID, with configurable default |
ASK_HOOKRESULTID() |
Getter for HOOKRESULTID w/ exceptions if field has no value |
HAS_HOOKRESULTID() |
Determine if HOOKRESULTID has a value |
InvocationPoint¶
The specific point in the provisioning process where the Hook is invoked.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INVOCATIONPOINT() |
Getter for INVOCATIONPOINT, with configurable default |
ASK_INVOCATIONPOINT() |
Getter for INVOCATIONPOINT w/ exceptions if field has no val |
HAS_INVOCATIONPOINT() |
Determine if INVOCATIONPOINT has a value |
FailureMode¶
The failure mode of the invocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREMODE() |
Getter for FAILUREMODE, with configurable default |
ASK_FAILUREMODE() |
Getter for FAILUREMODE w/ exceptions if field has no value |
HAS_FAILUREMODE() |
Determine if FAILUREMODE has a value |
TypeName¶
The name of the Hook that was invoked.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPENAME() |
Getter for TYPENAME, with configurable default |
ASK_TYPENAME() |
Getter for TYPENAME w/ exceptions if field has no value |
HAS_TYPENAME() |
Determine if TYPENAME has a value |
OriginalTypeName¶
The original public type name of the Hook when an alias is used.
For example, if you activate
AWS::Hooks::GuardHookwith aliasMyCompany::Custom::GuardHook, thenTypeNamewill beMyCompany::Custom::GuardHookandOriginalTypeNamewill beAWS::Hooks::GuardHook.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORIGINALTYPENAME() |
Getter for ORIGINALTYPENAME, with configurable default |
ASK_ORIGINALTYPENAME() |
Getter for ORIGINALTYPENAME w/ exceptions if field has no va |
HAS_ORIGINALTYPENAME() |
Determine if ORIGINALTYPENAME has a value |
TypeVersionId¶
The version identifier of the Hook that was invoked.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPEVERSIONID() |
Getter for TYPEVERSIONID, with configurable default |
ASK_TYPEVERSIONID() |
Getter for TYPEVERSIONID w/ exceptions if field has no value |
HAS_TYPEVERSIONID() |
Determine if TYPEVERSIONID has a value |
TypeConfigurationVersionId¶
The version identifier of the Hook configuration data that was used during invocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPECONFVERSIONID() |
Getter for TYPECONFIGURATIONVERSIONID, with configurable def |
ASK_TYPECONFVERSIONID() |
Getter for TYPECONFIGURATIONVERSIONID w/ exceptions if field |
HAS_TYPECONFVERSIONID() |
Determine if TYPECONFIGURATIONVERSIONID has a value |
TypeArn¶
The Amazon Resource Name (ARN) of the Hook.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPEARN() |
Getter for TYPEARN, with configurable default |
ASK_TYPEARN() |
Getter for TYPEARN w/ exceptions if field has no value |
HAS_TYPEARN() |
Determine if TYPEARN has a value |
Status¶
The status of the Hook invocation. The following statuses are possible:
HOOK_IN_PROGRESS: The Hook is currently running.
HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.
HOOK_COMPLETE_FAILED: The Hook completed but failed validation.
HOOK_FAILED: The Hook encountered an error during execution.
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 |
HookStatusReason¶
A message that provides additional details about the Hook invocation status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HOOKSTATUSREASON() |
Getter for HOOKSTATUSREASON, with configurable default |
ASK_HOOKSTATUSREASON() |
Getter for HOOKSTATUSREASON w/ exceptions if field has no va |
HAS_HOOKSTATUSREASON() |
Determine if HOOKSTATUSREASON has a value |
InvokedAt¶
The timestamp when the Hook was invoked.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INVOKEDAT() |
Getter for INVOKEDAT, with configurable default |
ASK_INVOKEDAT() |
Getter for INVOKEDAT w/ exceptions if field has no value |
HAS_INVOKEDAT() |
Determine if INVOKEDAT has a value |
Target¶
Information about the target of the Hook invocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGET() |
Getter for TARGET |
Annotations¶
A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ANNOTATIONS() |
Getter for ANNOTATIONS, with configurable default |
ASK_ANNOTATIONS() |
Getter for ANNOTATIONS w/ exceptions if field has no value |
HAS_ANNOTATIONS() |
Determine if ANNOTATIONS has a value |