/AWS1/IF_IOT=>DESCRIBEMANAGEDJOBTEMPLATE()

About DescribeManagedJobTemplate

View details of a managed job template.

Method Signature

METHODS /AWS1/IF_IOT~DESCRIBEMANAGEDJOBTEMPLATE
  IMPORTING
    !IV_TEMPLATENAME TYPE /AWS1/IOTMANAGEDJOBTMPLNAME OPTIONAL
    !IV_TEMPLATEVERSION TYPE /AWS1/IOTMANAGEDTMPLVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotdscmanagedjobtmp01
  RAISING
    /AWS1/CX_IOTINTERNALSERVEREX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_templatename TYPE /AWS1/IOTMANAGEDJOBTMPLNAME /AWS1/IOTMANAGEDJOBTMPLNAME

The unique name of a managed job template, which is required.

Optional arguments:

iv_templateversion TYPE /AWS1/IOTMANAGEDTMPLVERSION /AWS1/IOTMANAGEDTMPLVERSION

An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotdscmanagedjobtmp01 /AWS1/CL_IOTDSCMANAGEDJOBTMP01

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->describemanagedjobtemplate(
  iv_templatename = |string|
  iv_templateversion = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_managedjobtemplatename = lo_result->get_templatename( ).
  lv_jobtemplatearn = lo_result->get_templatearn( ).
  lv_jobdescription = lo_result->get_description( ).
  lv_managedtemplateversion = lo_result->get_templateversion( ).
  LOOP AT lo_result->get_environments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_environment = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_documentparameters( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_parameterkey = lo_row_3->get_key( ).
      lv_jobdescription = lo_row_3->get_description( ).
      lv_regex = lo_row_3->get_regex( ).
      lv_example = lo_row_3->get_example( ).
      lv_optional = lo_row_3->get_optional( ).
    ENDIF.
  ENDLOOP.
  lv_jobdocument = lo_result->get_document( ).
ENDIF.