Skip to content

/AWS1/IF_MGN=>PUTTEMPLATEACTION()

About PutTemplateAction

Put template post migration custom action.

Method Signature

METHODS /AWS1/IF_MGN~PUTTEMPLATEACTION
  IMPORTING
    !IV_LAUNCHCONFTEMPLATEID TYPE /AWS1/MGNLAUNCHCONFTEMPLATEID OPTIONAL
    !IV_ACTIONNAME TYPE /AWS1/MGNBOUNDEDSTRING OPTIONAL
    !IV_DOCUMENTIDENTIFIER TYPE /AWS1/MGNBOUNDEDSTRING OPTIONAL
    !IV_ORDER TYPE /AWS1/MGNORDERTYPE OPTIONAL
    !IV_ACTIONID TYPE /AWS1/MGNACTIONID OPTIONAL
    !IV_DOCUMENTVERSION TYPE /AWS1/MGNDOCUMENTVERSION OPTIONAL
    !IV_ACTIVE TYPE /AWS1/MGNBOOLEAN OPTIONAL
    !IV_TIMEOUTSECONDS TYPE /AWS1/MGNSTRICTLYPOSINTEGER OPTIONAL
    !IV_MUSTSUCCEEDFORCUTOVER TYPE /AWS1/MGNBOOLEAN OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_MGNSSMPARAMSTOREPARAM=>TT_SSMDOCUMENTPARAMETERS OPTIONAL
    !IV_OPERATINGSYSTEM TYPE /AWS1/MGNOPERATINGSYSTEMSTRING OPTIONAL
    !IT_EXTERNALPARAMETERS TYPE /AWS1/CL_MGNSSMEXTERNALPARAM=>TT_SSMDOCUMENTEXTERNALPARAMS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/MGNACTIONDESCRIPTION OPTIONAL
    !IV_CATEGORY TYPE /AWS1/MGNACTIONCATEGORY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mgntemplateactiondoc
  RAISING
    /AWS1/CX_MGNCONFLICTEXCEPTION
    /AWS1/CX_MGNRESOURCENOTFOUNDEX
    /AWS1/CX_MGNUNINITIALIZEDACEX
    /AWS1/CX_MGNVALIDATIONEX
    /AWS1/CX_MGNCLIENTEXC
    /AWS1/CX_MGNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_launchconftemplateid TYPE /AWS1/MGNLAUNCHCONFTEMPLATEID /AWS1/MGNLAUNCHCONFTEMPLATEID

Launch configuration template ID.

iv_actionname TYPE /AWS1/MGNBOUNDEDSTRING /AWS1/MGNBOUNDEDSTRING

Template post migration custom action name.

iv_documentidentifier TYPE /AWS1/MGNBOUNDEDSTRING /AWS1/MGNBOUNDEDSTRING

Template post migration custom action document identifier.

iv_order TYPE /AWS1/MGNORDERTYPE /AWS1/MGNORDERTYPE

Template post migration custom action order.

iv_actionid TYPE /AWS1/MGNACTIONID /AWS1/MGNACTIONID

Template post migration custom action ID.

Optional arguments:

iv_documentversion TYPE /AWS1/MGNDOCUMENTVERSION /AWS1/MGNDOCUMENTVERSION

Template post migration custom action document version.

iv_active TYPE /AWS1/MGNBOOLEAN /AWS1/MGNBOOLEAN

Template post migration custom action active status.

iv_timeoutseconds TYPE /AWS1/MGNSTRICTLYPOSINTEGER /AWS1/MGNSTRICTLYPOSINTEGER

Template post migration custom action timeout in seconds.

iv_mustsucceedforcutover TYPE /AWS1/MGNBOOLEAN /AWS1/MGNBOOLEAN

Template post migration custom action must succeed for cutover.

it_parameters TYPE /AWS1/CL_MGNSSMPARAMSTOREPARAM=>TT_SSMDOCUMENTPARAMETERS TT_SSMDOCUMENTPARAMETERS

Template post migration custom action parameters.

iv_operatingsystem TYPE /AWS1/MGNOPERATINGSYSTEMSTRING /AWS1/MGNOPERATINGSYSTEMSTRING

Operating system eligible for this template post migration custom action.

it_externalparameters TYPE /AWS1/CL_MGNSSMEXTERNALPARAM=>TT_SSMDOCUMENTEXTERNALPARAMS TT_SSMDOCUMENTEXTERNALPARAMS

Template post migration custom action external parameters.

iv_description TYPE /AWS1/MGNACTIONDESCRIPTION /AWS1/MGNACTIONDESCRIPTION

Template post migration custom action description.

iv_category TYPE /AWS1/MGNACTIONCATEGORY /AWS1/MGNACTIONCATEGORY

Template post migration custom action category.

RETURNING

oo_output TYPE REF TO /aws1/cl_mgntemplateactiondoc /AWS1/CL_MGNTEMPLATEACTIONDOC

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->puttemplateaction(
  it_externalparameters = VALUE /aws1/cl_mgnssmexternalparam=>tt_ssmdocumentexternalparams(
    (
      VALUE /aws1/cl_mgnssmexternalparam=>ts_ssmdocexternalparams_maprow(
        value = new /aws1/cl_mgnssmexternalparam( |string| )
        key = |string|
      )
    )
  )
  it_parameters = VALUE /aws1/cl_mgnssmparamstoreparam=>tt_ssmdocumentparameters(
    (
      VALUE /aws1/cl_mgnssmparamstoreparam=>ts_ssmdocumentparams_maprow(
        key = |string|
        value = VALUE /aws1/cl_mgnssmparamstoreparam=>tt_ssmparameterstoreparameters(
          (
            new /aws1/cl_mgnssmparamstoreparam(
              iv_parametername = |string|
              iv_parametertype = |string|
            )
          )
        )
      )
    )
  )
  iv_actionid = |string|
  iv_actionname = |string|
  iv_active = ABAP_TRUE
  iv_category = |string|
  iv_description = |string|
  iv_documentidentifier = |string|
  iv_documentversion = |string|
  iv_launchconftemplateid = |string|
  iv_mustsucceedforcutover = ABAP_TRUE
  iv_operatingsystem = |string|
  iv_order = 123
  iv_timeoutseconds = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_actionid = lo_result->get_actionid( ).
  lv_boundedstring = lo_result->get_actionname( ).
  lv_boundedstring = lo_result->get_documentidentifier( ).
  lv_ordertype = lo_result->get_order( ).
  lv_documentversion = lo_result->get_documentversion( ).
  lv_boolean = lo_result->get_active( ).
  lv_strictlypositiveinteger = lo_result->get_timeoutseconds( ).
  lv_boolean = lo_result->get_mustsucceedforcutover( ).
  LOOP AT lo_result->get_parameters( ) into ls_row.
    lv_key = ls_row-key.
    LOOP AT ls_row-value into lo_row_1.
      lo_row_2 = lo_row_1.
      IF lo_row_2 IS NOT INITIAL.
        lv_ssmparameterstoreparame = lo_row_2->get_parametertype( ).
        lv_ssmparameterstoreparame_1 = lo_row_2->get_parametername( ).
      ENDIF.
    ENDLOOP.
  ENDLOOP.
  lv_operatingsystemstring = lo_result->get_operatingsystem( ).
  LOOP AT lo_result->get_externalparameters( ) into ls_row_3.
    lv_key = ls_row_3-key.
    lo_value = ls_row_3-value.
    IF lo_value IS NOT INITIAL.
      lv_jmespathstring = lo_value->get_dynamicpath( ).
    ENDIF.
  ENDLOOP.
  lv_actiondescription = lo_result->get_description( ).
  lv_actioncategory = lo_result->get_category( ).
ENDIF.