/AWS1/CL_FRMHOOKRESULTSUMMARY¶
A ListHookResults call returns a summary of a Hook invocation.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_hookresultid TYPE /AWS1/FRMHOOKINVOCATIONID /AWS1/FRMHOOKINVOCATIONID¶
The unique identifier for this Hook invocation 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_typeversionid TYPE /AWS1/FRMHOOKTYPEVERSIONID /AWS1/FRMHOOKTYPEVERSIONID¶
The version of the Hook that was invoked.
iv_typeconfversionid TYPE /AWS1/FRMHOOKTYPECONFVERSIONID /AWS1/FRMHOOKTYPECONFVERSIONID¶
The version of the Hook configuration.
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 description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.
iv_invokedat TYPE /AWS1/FRMTIMESTAMP /AWS1/FRMTIMESTAMP¶
The timestamp when the Hook was invoked.
Only shown in responses when the request does not specify
TargetTypeandTargetIdfilters.
iv_targettype TYPE /AWS1/FRMLISTHOOKRSLTSTGTTYPE /AWS1/FRMLISTHOOKRSLTSTGTTYPE¶
The target type that the Hook was invoked against.
iv_targetid TYPE /AWS1/FRMHOOKRESULTID /AWS1/FRMHOOKRESULTID¶
The unique identifier of the Hook invocation target.
iv_typearn TYPE /AWS1/FRMHOOKTYPEARN /AWS1/FRMHOOKTYPEARN¶
The ARN of the Hook that was invoked.
iv_hookexecutiontarget TYPE /AWS1/FRMHOOKRESULTID /AWS1/FRMHOOKRESULTID¶
The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.
Only shown in responses when the request does not specify
TargetTypeandTargetIdfilters.
Queryable Attributes¶
HookResultId¶
The unique identifier for this Hook invocation 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 |
TypeVersionId¶
The version 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 of the Hook configuration.
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 |
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 description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.
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.
Only shown in responses when the request does not specify
TargetTypeandTargetIdfilters.
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 |
TargetType¶
The target type that the Hook was invoked against.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETTYPE() |
Getter for TARGETTYPE, with configurable default |
ASK_TARGETTYPE() |
Getter for TARGETTYPE w/ exceptions if field has no value |
HAS_TARGETTYPE() |
Determine if TARGETTYPE has a value |
TargetId¶
The unique identifier of the Hook invocation target.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TARGETID() |
Getter for TARGETID, with configurable default |
ASK_TARGETID() |
Getter for TARGETID w/ exceptions if field has no value |
HAS_TARGETID() |
Determine if TARGETID has a value |
TypeArn¶
The ARN of the Hook that was invoked.
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 |
HookExecutionTarget¶
The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.
Only shown in responses when the request does not specify
TargetTypeandTargetIdfilters.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HOOKEXECUTIONTARGET() |
Getter for HOOKEXECUTIONTARGET, with configurable default |
ASK_HOOKEXECUTIONTARGET() |
Getter for HOOKEXECUTIONTARGET w/ exceptions if field has no |
HAS_HOOKEXECUTIONTARGET() |
Determine if HOOKEXECUTIONTARGET 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_HOOKRESULTSUMMARIES¶
TYPES TT_HOOKRESULTSUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_FRMHOOKRESULTSUMMARY WITH DEFAULT KEY
.