Skip to content

/AWS1/IF_FRM=>DESCRIBECHANGESET()

About DescribeChangeSet

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.

Method Signature

METHODS /AWS1/IF_FRM~DESCRIBECHANGESET
  IMPORTING
    !IV_CHANGESETNAME TYPE /AWS1/FRMCHANGESETNAMEORID OPTIONAL
    !IV_STACKNAME TYPE /AWS1/FRMSTACKNAMEORID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN OPTIONAL
    !IV_INCLUDEPROPERTYVALUES TYPE /AWS1/FRMINCLUDEPROPERTYVALUES OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmdescrchangesetout
  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 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_includepropertyvalues TYPE /AWS1/FRMINCLUDEPROPERTYVALUES /AWS1/FRMINCLUDEPROPERTYVALUES

If true, the returned changes include detailed changes in the property values.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmdescrchangesetout /AWS1/CL_FRMDESCRCHANGESETOUT

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->describechangeset(
  iv_changesetname = |string|
  iv_includepropertyvalues = ABAP_TRUE
  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_changesetname = lo_result->get_changesetname( ).
  lv_changesetid = lo_result->get_changesetid( ).
  lv_stackid = lo_result->get_stackid( ).
  lv_stackname = lo_result->get_stackname( ).
  lv_description = lo_result->get_description( ).
  LOOP AT lo_result->get_parameters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_parameterkey = lo_row_1->get_parameterkey( ).
      lv_parametervalue = lo_row_1->get_parametervalue( ).
      lv_usepreviousvalue = lo_row_1->get_usepreviousvalue( ).
      lv_parametervalue = lo_row_1->get_resolvedvalue( ).
    ENDIF.
  ENDLOOP.
  lv_creationtime = lo_result->get_creationtime( ).
  lv_executionstatus = lo_result->get_executionstatus( ).
  lv_changesetstatus = lo_result->get_status( ).
  lv_changesetstatusreason = lo_result->get_statusreason( ).
  LOOP AT lo_result->get_notificationarns( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_notificationarn = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_rollbackconfiguration = lo_result->get_rollbackconfiguration( ).
  IF lo_rollbackconfiguration IS NOT INITIAL.
    LOOP AT lo_rollbackconfiguration->get_rollbacktriggers( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_arn = lo_row_5->get_arn( ).
        lv_type = lo_row_5->get_type( ).
      ENDIF.
    ENDLOOP.
    lv_monitoringtimeinminutes = lo_rollbackconfiguration->get_monitoringtimeinminutes( ).
  ENDIF.
  LOOP AT lo_result->get_capabilities( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_capability = lo_row_7->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_tags( ) into lo_row_8.
    lo_row_9 = lo_row_8.
    IF lo_row_9 IS NOT INITIAL.
      lv_tagkey = lo_row_9->get_key( ).
      lv_tagvalue = lo_row_9->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_changes( ) into lo_row_10.
    lo_row_11 = lo_row_10.
    IF lo_row_11 IS NOT INITIAL.
      lv_changetype = lo_row_11->get_type( ).
      lv_hookinvocationcount = lo_row_11->get_hookinvocationcount( ).
      lo_resourcechange = lo_row_11->get_resourcechange( ).
      IF lo_resourcechange IS NOT INITIAL.
        lv_policyaction = lo_resourcechange->get_policyaction( ).
        lv_changeaction = lo_resourcechange->get_action( ).
        lv_logicalresourceid = lo_resourcechange->get_logicalresourceid( ).
        lv_physicalresourceid = lo_resourcechange->get_physicalresourceid( ).
        lv_resourcetype = lo_resourcechange->get_resourcetype( ).
        lv_replacement = lo_resourcechange->get_replacement( ).
        LOOP AT lo_resourcechange->get_scope( ) into lo_row_12.
          lo_row_13 = lo_row_12.
          IF lo_row_13 IS NOT INITIAL.
            lv_resourceattribute = lo_row_13->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_resourcechange->get_details( ) into lo_row_14.
          lo_row_15 = lo_row_14.
          IF lo_row_15 IS NOT INITIAL.
            lo_resourcetargetdefinitio = lo_row_15->get_target( ).
            IF lo_resourcetargetdefinitio IS NOT INITIAL.
              lv_resourceattribute = lo_resourcetargetdefinitio->get_attribute( ).
              lv_propertyname = lo_resourcetargetdefinitio->get_name( ).
              lv_requiresrecreation = lo_resourcetargetdefinitio->get_requiresrecreation( ).
              lv_resourcepropertypath = lo_resourcetargetdefinitio->get_path( ).
              lv_beforevalue = lo_resourcetargetdefinitio->get_beforevalue( ).
              lv_aftervalue = lo_resourcetargetdefinitio->get_aftervalue( ).
              lv_attributechangetype = lo_resourcetargetdefinitio->get_attributechangetype( ).
            ENDIF.
            lv_evaluationtype = lo_row_15->get_evaluation( ).
            lv_changesource = lo_row_15->get_changesource( ).
            lv_causingentity = lo_row_15->get_causingentity( ).
          ENDIF.
        ENDLOOP.
        lv_changesetid = lo_resourcechange->get_changesetid( ).
        lo_moduleinfo = lo_resourcechange->get_moduleinfo( ).
        IF lo_moduleinfo IS NOT INITIAL.
          lv_typehierarchy = lo_moduleinfo->get_typehierarchy( ).
          lv_logicalidhierarchy = lo_moduleinfo->get_logicalidhierarchy( ).
        ENDIF.
        lv_beforecontext = lo_resourcechange->get_beforecontext( ).
        lv_aftercontext = lo_resourcechange->get_aftercontext( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_includenestedstacks = lo_result->get_includenestedstacks( ).
  lv_changesetid = lo_result->get_parentchangesetid( ).
  lv_changesetid = lo_result->get_rootchangesetid( ).
  lv_onstackfailure = lo_result->get_onstackfailure( ).
  lv_importexistingresources = lo_result->get_importexistingresources( ).
ENDIF.