DESCRIBECHANGESETHOOKS()`¶

About DescribeChangeSetHooks¶

Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Method Signature¶

METHODS /AWS1/IF_FRM~DESCRIBECHANGESETHOOKS
  IMPORTING
    !IV_CHANGESETNAME TYPE /AWS1/FRMCHANGESETNAMEORID OPTIONAL
    !IV_STACKNAME TYPE /AWS1/FRMSTACKNAMEORID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN OPTIONAL
    !IV_LOGICALRESOURCEID TYPE /AWS1/FRMLOGICALRESOURCEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmdscchangesethook01
  RAISING
    /AWS1/CX_FRMCHANGESETNOTFNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

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

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

Optional arguments:¶

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

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

`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.)

`iv_logicalresourceid` `TYPE /AWS1/FRMLOGICALRESOURCEID` `/AWS1/FRMLOGICALRESOURCEID`¶

If specified, lists only the Hooks related to the specified LogicalResourceId.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_frmdscchangesethook01` `/AWS1/CL_FRMDSCCHANGESETHOOK01`¶

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->describechangesethooks(
  iv_changesetname = |string|
  iv_logicalresourceid = |string|
  iv_nexttoken = |string|
  iv_stackname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_changesetid = lo_result->get_changesetid( ).
  lv_changesetname = lo_result->get_changesetname( ).
  LOOP AT lo_result->get_hooks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_hookinvocationpoint = lo_row_1->get_invocationpoint( ).
      lv_hookfailuremode = lo_row_1->get_failuremode( ).
      lv_hooktypename = lo_row_1->get_typename( ).
      lv_hooktypeversionid = lo_row_1->get_typeversionid( ).
      lv_hooktypeconfigurationve = lo_row_1->get_typeconfversionid( ).
      lo_changesethooktargetdeta = lo_row_1->get_targetdetails( ).
      IF lo_changesethooktargetdeta IS NOT INITIAL.
        lv_hooktargettype = lo_changesethooktargetdeta->get_targettype( ).
        lo_changesethookresourceta = lo_changesethooktargetdeta->get_resourcetargetdetails( ).
        IF lo_changesethookresourceta IS NOT INITIAL.
          lv_logicalresourceid = lo_changesethookresourceta->get_logicalresourceid( ).
          lv_hooktargettypename = lo_changesethookresourceta->get_resourcetype( ).
          lv_changeaction = lo_changesethookresourceta->get_resourceaction( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_changesethooksstatus = lo_result->get_status( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_stackid = lo_result->get_stackid( ).
  lv_stackname = lo_result->get_stackname( ).
ENDIF.

/AWS1/IF_FRM=>DESCRIBECHANGESETHOOKS()¶