DESCRIBEEVENTS()`¶

About DescribeEvents¶

Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment.

An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack.

Returns different types of events including:

Progress events - Status updates during stack operation execution.
Validation errors - Failures from CloudFormation Early Validations.
Provisioning errors - Resource creation and update failures.
Hook invocation errors - Failures from CloudFormation Hook during stack operations.

One of ChangeSetName, OperationId or StackName must be specified as input.

Method Signature¶

METHODS /AWS1/IF_FRM~DESCRIBEEVENTS
  IMPORTING
    !IV_STACKNAME TYPE /AWS1/FRMSTACKNAMEORID OPTIONAL
    !IV_CHANGESETNAME TYPE /AWS1/FRMCHANGESETNAMEORID OPTIONAL
    !IV_OPERATIONID TYPE /AWS1/FRMOPERATIONID OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_FRMEVENTFILTER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmdescreventsoutput
  RAISING
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_stackname` `TYPE /AWS1/FRMSTACKNAMEORID` `/AWS1/FRMSTACKNAMEORID`¶

The name or unique stack ID for which you want to retrieve events.

`iv_changesetname` `TYPE /AWS1/FRMCHANGESETNAMEORID` `/AWS1/FRMCHANGESETNAMEORID`¶

The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.

`iv_operationid` `TYPE /AWS1/FRMOPERATIONID` `/AWS1/FRMOPERATIONID`¶

The unique identifier of the operation for which you want to retrieve events.

`io_filters` `TYPE REF TO /AWS1/CL_FRMEVENTFILTER` `/AWS1/CL_FRMEVENTFILTER`¶

Filters to apply when retrieving events.

`iv_nexttoken` `TYPE /AWS1/FRMNEXTTOKEN` `/AWS1/FRMNEXTTOKEN`¶

The token for the next set of items to return. (You received this token from a previous call.)

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_frmdescreventsoutput` `/AWS1/CL_FRMDESCREVENTSOUTPUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describeevents(
  io_filters = new /aws1/cl_frmeventfilter( ABAP_TRUE )
  iv_changesetname = |string|
  iv_nexttoken = |string|
  iv_operationid = |string|
  iv_stackname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_operationevents( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_eventid = lo_row_1->get_eventid( ).
      lv_stackid = lo_row_1->get_stackid( ).
      lv_operationid = lo_row_1->get_operationid( ).
      lv_operationtype = lo_row_1->get_operationtype( ).
      lv_beaconstackoperationsta = lo_row_1->get_operationstatus( ).
      lv_eventtype = lo_row_1->get_eventtype( ).
      lv_logicalresourceid = lo_row_1->get_logicalresourceid( ).
      lv_physicalresourceid = lo_row_1->get_physicalresourceid( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_timestamp = lo_row_1->get_timestamp( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_resourcestatus = lo_row_1->get_resourcestatus( ).
      lv_resourcestatusreason = lo_row_1->get_resourcestatusreason( ).
      lv_resourceproperties = lo_row_1->get_resourceproperties( ).
      lv_clientrequesttoken = lo_row_1->get_clientrequesttoken( ).
      lv_hooktype = lo_row_1->get_hooktype( ).
      lv_hookstatus = lo_row_1->get_hookstatus( ).
      lv_hookstatusreason = lo_row_1->get_hookstatusreason( ).
      lv_hookinvocationpoint = lo_row_1->get_hookinvocationpoint( ).
      lv_hookfailuremode = lo_row_1->get_hookfailuremode( ).
      lv_detailedstatus = lo_row_1->get_detailedstatus( ).
      lv_hookfailuremode = lo_row_1->get_validationfailuremode( ).
      lv_validationname = lo_row_1->get_validationname( ).
      lv_validationstatus = lo_row_1->get_validationstatus( ).
      lv_validationstatusreason = lo_row_1->get_validationstatusreason( ).
      lv_validationpath = lo_row_1->get_validationpath( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_FRM=>DESCRIBEEVENTS()¶