GETGENERATEDTEMPLATE()`¶

About GetGeneratedTemplate¶

Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.

Method Signature¶

METHODS /AWS1/IF_FRM~GETGENERATEDTEMPLATE
  IMPORTING
    !IV_FORMAT TYPE /AWS1/FRMTEMPLATEFORMAT OPTIONAL
    !IV_GENERATEDTEMPLATENAME TYPE /AWS1/FRMGENERATEDTEMPLATENAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmgetgeneratedtmpl01
  RAISING
    /AWS1/CX_FRMGENERATEDTMPLNOT00
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_generatedtemplatename` `TYPE /AWS1/FRMGENERATEDTEMPLATENAME` `/AWS1/FRMGENERATEDTEMPLATENAME`¶

The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc.

Optional arguments:¶

`iv_format` `TYPE /AWS1/FRMTEMPLATEFORMAT` `/AWS1/FRMTEMPLATEFORMAT`¶

The language to use to retrieve for the generated template. Supported values are:

JSON

YAML

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_frmgetgeneratedtmpl01` `/AWS1/CL_FRMGETGENERATEDTMPL01`¶

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->getgeneratedtemplate(
  iv_format = |string|
  iv_generatedtemplatename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_generatedtemplatestatus = lo_result->get_status( ).
  lv_templatebody = lo_result->get_templatebody( ).
ENDIF.

To get a generated template in JSON format¶

This example gets a generated template ins JSON format.

DATA(lo_result) = lo_client->getgeneratedtemplate( iv_generatedtemplatename = |JazzyTemplate| ) .

To get a generated template in YAML format¶

This example gets a generated template in YAML format.

DATA(lo_result) = lo_client->getgeneratedtemplate(
  iv_format = |YAML|
  iv_generatedtemplatename = |JazzyTemplate|
).

/AWS1/IF_FRM=>GETGENERATEDTEMPLATE()¶